{"id":14988213,"url":"https://github.com/apache/skywalking-helm","last_synced_at":"2026-01-12T02:35:57.997Z","repository":{"id":33865131,"uuid":"154606109","full_name":"apache/skywalking-helm","owner":"apache","description":"Apache SkyWalking Kubernetes Deployment Helm Chart","archived":false,"fork":false,"pushed_at":"2024-10-14T06:10:03.000Z","size":591,"stargazers_count":514,"open_issues_count":0,"forks_count":205,"subscribers_count":53,"default_branch":"master","last_synced_at":"2025-04-14T08:17:11.976Z","etag":null,"topics":["apm","dapper","distributed-tracing","helm","kubernetes","observability","service-mesh","skywalking"],"latest_commit_sha":null,"homepage":"https://skywalking.apache.org/","language":"Smarty","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-25T03:41:03.000Z","updated_at":"2025-04-12T08:11:33.000Z","dependencies_parsed_at":"2024-05-21T03:46:15.917Z","dependency_job_id":"da33c151-6782-406f-9311-c27dff2bb4d9","html_url":"https://github.com/apache/skywalking-helm","commit_stats":{"total_commits":176,"total_committers":38,"mean_commits":4.631578947368421,"dds":0.7386363636363636,"last_synced_commit":"6fe5e6f0d3b7686c6be0457733e825ee68cb9b35"},"previous_names":["apache/skywalking-helm","apache/skywalking-kubernetes"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-helm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-helm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-helm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-helm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/skywalking-helm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248843999,"owners_count":21170499,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apm","dapper","distributed-tracing","helm","kubernetes","observability","service-mesh","skywalking"],"created_at":"2024-09-24T14:16:18.127Z","updated_at":"2026-01-12T02:35:57.982Z","avatar_url":"https://github.com/apache.png","language":"Smarty","readme":"Apache SkyWalking Kubernetes Helm\n==========\n\n\u003cimg src=\"https://skywalking.apache.org/assets/logo.svg\" alt=\"Sky Walking logo\" height=\"90px\" align=\"right\" /\u003e\n\n[![GitHub stars](https://img.shields.io/github/stars/apache/skywalking.svg?style=for-the-badge\u0026label=Stars\u0026logo=github)](https://github.com/apache/skywalking)\n[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge\u0026label=Follow\u0026logo=twitter)](https://twitter.com/AsfSkyWalking)\n\nSkyWalking Kubernetes Helm repository provides ways to install and configure SkyWalking in a Kubernetes cluster.\nThe scripts are written in Helm 3.\n\n# Chart Detailed Configuration\n\nChart detailed configuration can be found at [Chart Readme](./chart/skywalking/README.md)\n\nThere are required values that you must set explicitly when deploying SkyWalking.\n\n| name | description | example |\n| ---- | ----------- | ------- |\n| `oap.image.tag` | the OAP docker image tag | `10.3.0` |\n| `oap.storageType` | the storage type of the OAP | `elasticsearch`, `postgresql`, `banyandb`, etc. |\n| `ui.image.tag` | the UI docker image tag | `10.3.0` |\n\nYou can set these required values via command line (e.g. `--set oap.image.tag=10.3.0 --set oap.storageType=elasticsearch`),\nor edit them in a separate file(e.g. [`values.yaml`](chart/skywalking/values.yaml), [`values-my-es.yaml`](chart/skywalking/values-my-es.yaml))\nand use `-f \u003cfilename\u003e` or `--values=\u003cfilename\u003e` to set them.\n\n# Install\n\nLet's set some variables for convenient use later.\n\n```shell\nexport SKYWALKING_RELEASE_VERSION=4.7.0  # change the release version according to your need\nexport SKYWALKING_RELEASE_NAME=skywalking  # change the release name according to your scenario\nexport SKYWALKING_RELEASE_NAMESPACE=default  # change the namespace to where you want to install SkyWalking\n```\n\n## Install released version using Docker Helm repository (\u003e= 4.3.0)\n\n```shell\nhelm install \"${SKYWALKING_RELEASE_NAME}\" \\\n  oci://registry-1.docker.io/apache/skywalking-helm \\\n  --version \"${SKYWALKING_RELEASE_VERSION}\" \\\n  -n \"${SKYWALKING_RELEASE_NAMESPACE}\" \\\n  --set oap.image.tag=10.3.0 \\\n  --set oap.storageType=elasticsearch \\\n  --set ui.image.tag=10.3.0\n```\n\nTo use BanyanDB as storage solution, you can try\n\n```shell\nhelm install \"${SKYWALKING_RELEASE_NAME}\" \\\n  oci://registry-1.docker.io/apache/skywalking-helm \\\n  --version \"${SKYWALKING_RELEASE_VERSION}\" \\\n  -n \"${SKYWALKING_RELEASE_NAMESPACE}\" \\\n  --set oap.image.tag=10.3.0 \\\n  --set oap.storageType=banyandb \\\n  --set ui.image.tag=10.3.0 \\\n  --set elasticsearch.enabled=false \\\n  --set banyandb.enabled=true \\\n  --set banyandb.image.tag=0.9.0\n```\n\nBanyanDB can be configured through various parameters. A comprehensive list of these parameters can be found in the configuration section of [BanyanDB Helm](https://github.com/apache/skywalking-banyandb-helm?tab=readme-ov-file#configuration) repository. These parameters allow you to customize aspects such as replication, resource allocation, persistence, and more to suit your specific deployment needs. Remember to prepend 'banyandb.' to all parameter names when applying the settings. For example, `banyandb.image.tag` can be used to specify the version of BanyanDB.\n\n\n## Install released version using Apache Jfrog Helm repository (\u003c= 4.3.0)\n\n```shell\nexport REPO=skywalking\nhelm repo add ${REPO} https://apache.jfrog.io/artifactory/skywalking-helm\n```\n\n## Install development version of SkyWalking using master branch\n\nThis is needed **only** when you want to install SkyWalking from master branch.\n\n```shell script\nexport REPO=chart\ngit clone https://github.com/apache/skywalking-helm\ncd skywalking-helm\nhelm repo add elastic https://helm.elastic.co\nhelm dep up ${REPO}/skywalking\n```\n\n## Install development version of SWCK Adapter using master branch\n\nThis is needed **only** when you want to install [SWCK Adapter](https://github.com/apache/skywalking-swck/tree/master/adapter) from master branch. \n\nSWCK Adapter chart detailed configuration can be found at [Adapter Chart Readme](./chart/adapter/README.md).\n\nYou can install the Adapter with the default configuration as follows.\n\n```shell script\nexport REPO=chart\ngit clone https://github.com/apache/skywalking-helm\ncd skywalking-helm\nhelm -n skywalking-custom-metrics-system install adapter ${REPO}/adapter --create-namespace\n```\n\n## Install development version of SWCK Operator using master branch\n\nThis is needed **only** when you want to install [SWCK Operator](https://github.com/apache/skywalking-swck/tree/master/operator) from master branch. \n\nBefore installing Operator, you have to install [cert-manager](https://cert-manager.io/) at first.\n\n```shell script\nkubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.9.1/cert-manager.yaml\n```\n\nSWCK Operator chart detailed configuration can be found at [Operator Chart Readme](./chart/operator/README.md).\n\nYou can install the Operator with the default configuration as follows.\n\n```shell script\nexport REPO=chart\ngit clone https://github.com/apache/skywalking-helm\ncd skywalking-helm\nhelm -n skywalking-swck-system install operator ${REPO}/operator\n```\n\n## Install a specific version of SkyWalking\n\nIn theory, you can deploy all versions of SkyWalking that are \u003e= 6.0.0-GA, by specifying the desired `oap.image.tag`/`ui.image.tag`.\n\nPlease note that some configurations that are added in the later versions of SkyWalking may not work in earlier versions, and thus if you\nspecify those configurations, they may take no effect.\n\nhere are some examples.\n\n- Deploy SkyWalking 10.3.0\n\n```shell script\nhelm install \"${SKYWALKING_RELEASE_NAME}\" ${REPO}/skywalking -n \"${SKYWALKING_RELEASE_NAMESPACE}\" \\\n  --set oap.image.tag=10.3.0 \\\n  --set oap.storageType=elasticsearch \\\n  --set ui.image.tag=10.3.0\n```\n\nBecause ElasticSearch recommends to use the corresponding Helm Chart version of the ElasticSearch version,\nif you want to use a specific version of ElasticSearch, you have to change the ElasticSearch Helm Chart version in\n`dependencies` section in `Chart.yaml` file, which requires you to install from the source codes.\nOr you should deploy the desired ElasticSearch version first by yourself, and then deploy SkyWalking to use the\nexisting ElasticSearch by setting the following section:\n\n```yaml\nelasticsearch:\n  enabled: true\n  config:               # For users of an existing elasticsearch cluster,takes effect when `elasticsearch.enabled` is false\n    port:\n      http: 9200\n    host: elasticsearch # es service on kubernetes or host\n    user: \"xxx\"         # [optional]\n    password: \"xxx\"     # [optional]\n```\n\nThe same goes for PostgreSQL and BanyanDB.\n\n## Install development version using ghcr.io Helm repository\n\nIf you are willing to help testing the latest codes that are not released yet, we provided a snapshot\nHelm repository on ghcr.io for convenient use, replace the full commit hash in the version option to\ndeploy the revision that you want to test.\n\n```shell\nhelm -n istio-system install skywalking \\\n  oci://ghcr.io/apache/skywalking-helm/skywalking-helm \\\n  --version \"0.0.0-b670c41d94a82ddefcf466d54bab5c492d88d772\" \\\n  -n \"${SKYWALKING_RELEASE_NAMESPACE}\" \\\n  --set oap.image.tag=10.3.0 \\\n  --set oap.storageType=elasticsearch \\\n  --set ui.image.tag=10.3.0\n```\n\n## Install development version using source codes\n\nThis is needed **only** when you want to install source codes.\n\n```shell script\nhelm install \"${SKYWALKING_RELEASE_NAME}\" ${REPO}/skywalking -n \"${SKYWALKING_RELEASE_NAMESPACE}\" \n```\n\n## Install a specific version of SkyWalking with an existing database\n\nIf you want to use a specific version of ElasticSearch as storage solution, for instance, modify the connection information to the existing ElasticSearch cluster in file [`values-my-es.yaml`](chart/skywalking/values-my-es.yaml).\n\n```shell script\nhelm install \"${SKYWALKING_RELEASE_NAME}\" ${REPO}/skywalking -n \"${SKYWALKING_RELEASE_NAMESPACE}\" \\\n  -f ./skywalking/values-my-es.yaml\n```\n\n## Install SkyWalking with Satellite\n\nEnable the satellite as gateway, and set the satellite image tag.\n\n```shell script\nhelm install \"${SKYWALKING_RELEASE_NAME}\" ${REPO}/skywalking -n \"${SKYWALKING_RELEASE_NAMESPACE}\" \\\n  --set satellite.enabled=true \\\n  --set satellite.image.tag=v0.4.0\n```\n\nAfter satellite have been installed, you should replace the `oap` address to the `satellite` address, the address from agent or `istio`, such as `skywalking-satellite.istio-system:11800`.\n\n## Customization\n\n- Override configuration files\n\nYou can override the configuration files for OAP or Satellite by adding configuration section `oap.config` and `satellite.config`,\ncheck [the examples](chart/skywalking/values.yaml), search keyword `config: {}`.\n\n- Pass environment variables to OAP\n\nThe SkyWalking OAP exposes many configurations that can be specified by environment variables, as listed in [the main repo](https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/configuration-vocabulary.md).\nYou can set those environment variables by `--set oap.env.\u003cENV_NAME\u003e=\u003cENV_VALUE\u003e`, such as `--set oap.env.SW_ENVOY_METRIC_ALS_HTTP_ANALYSIS=k8s-mesh`.\n\n\u003e The environment variables take priority over the overrode configuration files.\n\n## Rerun OAP init job\n\nKubernetes Job cannot be rerun by default, if you want to rerun the OAP init\njob, you need to delete the Job and recreate it.\n\n```shell\n# Make sure to export the Job manifest to a file before deleting it.\nkubectl get job -n \"${SKYWALKING_RELEASE_NAMESPACE}\" -l release=$SKYWALKING_RELEASE_NAME -o yaml \u003e oap-init.job.yaml\n# Trim the Job manifest to keep only the Job part, you can either download yq from https://github.com/mikefarah/yq or\n# manually remove the fields that are not needed.\nyq 'del(.items[0].metadata.creationTimestamp,.items[0].metadata.resourceVersion,.items[0].metadata.uid,.items[0].status,.items[0].spec.template.metadata.labels.\"batch.kubernetes.io/controller-uid\",.items[0].spec.template.metadata.labels.\"controller-uid\",.items[0].spec.selector.matchLabels.\"batch.kubernetes.io/controller-uid\")' oap-init.job.yaml \u003e oap-init.job.trimmed.yaml\n# Check the file oap-init.job.trimmed.yaml to make sure it has correct content\n# Delete the Job\nkubectl delete job -n \"${SKYWALKING_RELEASE_NAMESPACE}\" -l release=$SKYWALKING_RELEASE_NAME\n# Create the Job\nkubectl -n \"${SKYWALKING_RELEASE_NAMESPACE}\" apply -f oap-init.job.trimmed.yaml\n```\n\n# Contact Us\n* Submit an [issue](https://github.com/apache/skywalking/issues)\n* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.\n* Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in.\n* For Chinese speaker, send `[CN] Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in.\n* Twitter, [ASFSkyWalking](https://twitter.com/AsfSkyWalking)\n* [bilibili B站 视频](https://space.bilibili.com/390683219)\n\n# LICENSE\nApache 2.0\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fskywalking-helm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fskywalking-helm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fskywalking-helm/lists"}