{"id":14987821,"url":"https://github.com/apache/skywalking-banyandb-helm","last_synced_at":"2026-02-09T04:11:41.548Z","repository":{"id":187643178,"uuid":"677294102","full_name":"apache/skywalking-banyandb-helm","owner":"apache","description":"BanyanDB Helm Chart repository provides ways to install and configure BanyanDB running in a cluster natively on Kubernetes.","archived":false,"fork":false,"pushed_at":"2026-02-04T13:44:40.000Z","size":238,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":34,"default_branch":"master","last_synced_at":"2026-02-04T22:53:33.579Z","etag":null,"topics":["apm","dapper","distributed-tracing","helm","kubernetes","observability","service-mesh","skywalking"],"latest_commit_sha":null,"homepage":"https://skywalking.apache.org/","language":"Go Template","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,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-08-11T07:59:30.000Z","updated_at":"2026-02-04T13:13:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"d815e2f0-3214-45c5-9c32-e43dcf2856b2","html_url":"https://github.com/apache/skywalking-banyandb-helm","commit_stats":null,"previous_names":["apache/skywalking-banyandb-helm"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/apache/skywalking-banyandb-helm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-banyandb-helm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-banyandb-helm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-banyandb-helm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-banyandb-helm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/skywalking-banyandb-helm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fskywalking-banyandb-helm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29256173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T03:07:45.136Z","status":"ssl_error","status_checked_at":"2026-02-09T03:07:24.123Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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:15:30.801Z","updated_at":"2026-02-09T04:11:41.477Z","avatar_url":"https://github.com/apache.png","language":"Go Template","funding_links":[],"categories":[],"sub_categories":[],"readme":"Apache SkyWalking BanyanDB Helm Chart\n==========\n\n\n![](https://github.com/apache/skywalking-banyandb-helm/workflows/Build/badge.svg?branch=master)\n\nBanyanDB, as an observability database, aims to ingest, analyze, and store Metrics, Tracing, and Logging data.\nIt's designed to handle observability data generated by observability platforms and APM systems, like [Apache SkyWalking](https://github.com/apache/skywalking) etc.\n\nBanyanDB Helm Chart repository provides ways to install and configure BanyanDB running in a cluster natively on Kubernetes. The scripts are written in Helm 3.\n\n# Chart Detailed Configuration\n\n## Introduction\n\nThis chart bootstraps an Apache Skywalking BanyanDB deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.\nThe released versions of the helm chart can be found on [Docker Hub](https://hub.docker.com/r/apache/skywalking-banyandb-helm).\n\n## Prerequisites\n\n - Kubernetes 1.24.0+\n - Helm 3\n\n## Installing the Chart\n\n`image.tag` is the required value for the chart.\n\nYou can set these required values via command line (e.g. `--set image.tag=0.8.0`), or edit them in a separate file(e.g. [`values.yaml`](chart/values.yaml))\nand use `-f \u003cfilename\u003e` or `--values=\u003cfilename\u003e` to set it.\n\nTo install the chart with the release name `my-release`:\n\n```shell\ngit clone https://github.com/apache/skywalking-banyandb-helm\ncd ./skywalking-banyandb-helm\nhelm install my-release \\\n  chart \\\n  -n \u003cnamespace\u003e \\\n  --set image.tag=\u003cimage-tag\u003e\n```\n\nThe command deploys BanyanDB on the Kubernetes cluster with the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.\n\n\u003e **Tip**: List all releases using `helm list`\n\n## Uninstalling the Chart\n\nTo uninstall/delete the `my-release` deployment:\n\n```shell\n$ helm uninstall my-release -n \u003cnamespace\u003e\n```\n\nThe command removes all the banyandb components associated with the chart and deletes the release.\n\n## Compatibility\n\n| Chart Version | Supported BanyanDB Version |\n|---------------|----------------------------|\n| 0.5.x         | 0.9.x                      |\n| 0.4.0         | 0.8.x                      |\n| 0.3.0         | 0.7.x                      |\n| 0.4.0 or later| 0.8.0 or later             |\n\n## Configuration\n\nThe `parameters` are described in [parameters.md](./doc/parameters.md).\n\nSpecify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,\n\n**Note** You could refer to the [helm install](https://helm.sh/docs/helm/helm_install/) for more command information.\n\n```console\n$ helm install my-release \\\n  chart \\\n  -n \u003cnamespace\u003e \\\n  --set image.tag=\u003cimage-tag\u003e \\\n  --set fullnameOverride=newBanyanDB\n```\n\nAlternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,\n\n```console\n$ helm install my-release \\\n  chart \\\n  -n \u003cnamespace\u003e \\\n  --set image.tag=\u003cimage-tag\u003e \\\n  -f values.yaml\n```\n\n\u003e **Tip**: You can use the default [values.yaml](chart/values.yaml)\n\n## Authentication\n\nBasic authentication can be enabled for liaison and standalone modes. When enabled, the chart mounts a credentials file and adds `--auth-config-file` to BanyanDB.\n\n- Enable auth and provide users (plaintext passwords):\n\n```yaml\nauth:\n  enabled: true\n  users:\n    - username: admin\n      password: \"changeme\"\n```\n\n- Use an existing Secret (recommended for production). The Secret must contain a key `credentials.yaml` (configurable via `auth.credentialsFileKey`) whose value is the YAML content in the format required by BanyanDB ([docs](https://github.com/apache/skywalking-banyandb/blob/main/docs/operation/security.md#basic-authentication)):\n\n```yaml\nauth:\n  enabled: true\n  existingSecret: my-banyandb-auth\n  credentialsFileKey: credentials.yaml\n```\n\nThe Secret name defaults to `\u003crelease\u003e-banyandb-auth` when auto-created.\n\n### Retrieve credentials after install\n\nIf the chart created the Secret (no `auth.existingSecret`), you can decode it:\n\n```bash\nkubectl get secret \u003crelease-name\u003e-banyandb-auth -n \u003cnamespace\u003e -o jsonpath='{.data.credentials\\.yaml}' | base64 --decode\n```\n\nAdjust the key if you changed `auth.credentialsFileKey`.\n\n## Use external certificate authorities for TLS\nIf you'd like to use external certificate authorities, such as Vault, corresponding annotations can be injected into [banyandb](./chart/templates/statefulset.yaml).\n\n## Setup certificate for etcd TLS\nTo establish secure communication for etcd, you can leverage cert-manager to generate the necessary TLS certificates. This tool simplifies the process of creating and managing certificates. You can install cert-manager with the following command.\n```console\nkubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.4/cert-manager.yaml\n```\n\nA Certificate can be created with the following configurations. In this setup, each dnsName includes a wildcard that enables resolution of all etcd pods' DNS names within the specified namespace, along with the service name of etcd and its corresponding namespace. Here, 'svc' represents a service, while 'cluster.local' serves as the domain suffix for the Kubernetes cluster.\n```yaml\napiVersion: cert-manager.io/v1\nkind: Certificate\nmetadata:\n  name: etcd-client\n  namespace: banyandb\nspec:\n  secretName: etcd-client-tls\n  duration: 17520h\n  renewBefore: 4320h\n  issuerRef:\n    name: banyandb-issuer\n    kind: Issuer\n  usages:\n    - server auth\n    - client auth\n  dnsNames:\n    - \"*.banyandb-etcd.banyandb.svc.cluster.local\"\n    - \"*.banyandb-etcd-headless.banyandb.svc.cluster.local\"\n```\n\n## Backup and Restore\n\nThe backup and restore functionalities are supported in the BanyanDB Helm Chart. The detailed configuration can be found in [backup.md](./doc/backup.md).\n\n## Lifecycle Management\n\nThe lifecycle management functionalities are supported in the BanyanDB Helm Chart. The detailed configuration can be found in [lifecycle.md](./doc/lifecycle.md).\n\n# Install the development version of BanyanDB using the master branch\n\nThis is needed **only** when you want to install [BanyanDB](https://github.com/apache/skywalking-banyandb/tree/main) from the master branch. \n\nYou can install BanyanDB with the default configuration as follows.\n\n```shell script\nexport REPO=chart\ngit clone https://github.com/apache/skywalking-banyandb-helm\ncd skywalking-banyandb-helm\nhelm dependency build ${REPO}\nhelm install banyandb ${REPO}\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fskywalking-banyandb-helm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fskywalking-banyandb-helm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fskywalking-banyandb-helm/lists"}