Google Git
Sign in
apache / skywalking-swck / 5b958c71e252de3c2be8e57c5dc410e743c55571
commit5b958c71e252de3c2be8e57c5dc410e743c55571[log] [tgz]
authorYe Cao <dashanjic@gmail.com>Thu Nov 17 22:24:12 2022 +0800
committerGitHub <noreply@github.com>Thu Nov 17 22:24:12 2022 +0800
tree9ed2fe0f215488bab308a0e348b7dd5eead11f6d
parenta07d01b23a538854d71c362090500ac7b34b5a77 [diff]
Add the guide to add new CRD and Controller in SWCK (#75)

* Add the guide to add new CRD and Controller in SWCK

Signed-off-by: dashanji <dashanjic@gmail.com>
Co-authored-by: Ye Cao <dashanjic@gamil.com>
Co-authored-by: Gao Hongtao <hanahmily@gmail.com>
2 files changed
tree: 9ed2fe0f215488bab308a0e348b7dd5eead11f6d
  1. .github/
  2. adapter/
  3. build/
  4. dist/
  5. docs/
  6. hack/
  7. operator/
  8. test/
  9. .asf.yaml
  10. .dockerignore
  11. .gitignore
  12. .licenserc.yaml
  13. CHANGES.md
  14. CONTRIBUTING.md
  15. golangci.yml
  16. LICENSE
  17. Makefile
  18. NOTICE
  19. README.md
README.md

Apache SkyWalking Cloud on Kubernetes

A bridge project between Apache SkyWalking and Kubernetes.

SWCK is a platform for the SkyWalking user that provisions, upgrades, maintains SkyWalking relevant components, and makes them work natively on Kubernetes.

Features

  • Java Agent Injector: Inject the java agent into the application pod natively.
    • Inject the java agent into the application pod.
    • Leverage a global configuration to simplify the agent and injector setup.
    • Use the annotation to customize specific workloads.
    • Synchronize injecting status to JavaAgent CR for monitoring purposes.
  • Operator: Provision and maintain SkyWalking backend components.
  • Custom Metrics Adapter: Provides custom metrics coming from SkyWalking OAP cluster for autoscaling by Kubernetes HPA

Quick Start

  • Go to the download page to download the latest release binary, skywalking-swck-<SWCK_VERSION>-bin.tgz. Unarchive the package to a folder named skywalking-swck-<SWCK_VERSION>-bin

Java Agent Injector

  • Install the Operator
  • Label the namespace with swck-injection=enabled
$ kubectl label namespace default(your namespace) swck-injection=enabled
  • Add label swck-java-agent-injected: "true" to the workloads

For more details, please read Java agent injector

Operator

  • To install the operator in an existing cluster, ensure you have cert-manager installed.
  • Apply the manifests for the Controller and CRDs in release/config:
kubectl apply -f skywalking-swck-<SWCK_VERSION>-bin/config/operator-bundle.yaml

For more details, please refer to deploy operator

Custom Metrics Adapter

  • Deploy the OAP server by referring to Operator Quick Start.
  • Apply the manifests for an adapter in release/adapter/config:
kubectl apply -f skywalking-swck-<SWCK_VERSION>-bin/config/adapter-bundle.yaml

For more details, please read Custom metrics adapter

Contributing

For developers who want to contribute to this project, see Contribution Guide. What's more, we have a guide about how to add new CRDs and Controllers, see How to add new CRD and Controller in SWCK.

License

Apache 2.0 License.