Apache SkyWalking BanyanDB Helm Chart

BanyanDB, as an observability database, aims to ingest, analyze, and store Metrics, Tracing, and Logging data. It's designed to handle observability data generated by observability platforms and APM systems, like Apache SkyWalking etc.

BanyanDB Helm Chart repository provides ways to install and configure BanyanDB running in a cluster natively on Kubernetes. The scripts are written in Helm 3.

Chart Detailed Configuration

Introduction

This chart bootstraps an Apache Skywalking BanyanDB deployment on a Kubernetes cluster using the Helm package manager. The released versions of the helm chart can be found on Docker Hub.

Prerequisites

• Kubernetes 1.24.0+
• Helm 3

Installing the Chart

To install the chart with the release name my-release:

$ helm install my-release banyandb -n <namespace>

The command deploys BanyanDB on the Kubernetes cluster with the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm uninstall my-release -n <namespace>

The command removes all the banyandb components associated with the chart and deletes the release.

Configuration

Key	Type	Default	Description
cluster.data.affinity	object	{}
cluster.data.env	list	[]
cluster.data.grpcSvc.annotations	object	{}
cluster.data.grpcSvc.labels	object	{}
cluster.data.grpcSvc.port	int	17912
cluster.data.name	string	"banyandb"
cluster.data.nodeSelector	list	[]
cluster.data.podAnnotations	string	nil
cluster.data.podDisruptionBudget	object	{}
cluster.data.priorityClassName	string	""
cluster.data.replicas	int	3
cluster.data.resources.limits	list	[]
cluster.data.resources.requests	list	[]
cluster.data.role	string	"data"
cluster.data.securityContext	object	{}
cluster.data.sidecar	list	[]
cluster.data.tolerations	list	[]
cluster.enabled	bool	true
cluster.etcdEndpoints	list	[]
cluster.liaison.affinity	object	{}
cluster.liaison.env	list	[]
cluster.liaison.grpcSvc.annotations	object	{}
cluster.liaison.grpcSvc.labels	object	{}
cluster.liaison.grpcSvc.port	int	17912
cluster.liaison.httpSvc.annotations	object	{}
cluster.liaison.httpSvc.externalIPs	list	[]
cluster.liaison.httpSvc.labels	object	{}
cluster.liaison.httpSvc.loadBalancerIP	string	nil
cluster.liaison.httpSvc.loadBalancerSourceRanges	list	[]
cluster.liaison.httpSvc.port	int	17913
cluster.liaison.httpSvc.type	string	"LoadBalancer"
cluster.liaison.ingress.annotations	object	{}
cluster.liaison.ingress.enabled	bool	false
cluster.liaison.ingress.labels	object	{}
cluster.liaison.ingress.rules	list	[]
cluster.liaison.ingress.tls	list	[]
cluster.liaison.name	string	"banyandb"
cluster.liaison.nodeSelector	list	[]
cluster.liaison.podAnnotations	string	nil
cluster.liaison.podDisruptionBudget	object	{}
cluster.liaison.priorityClassName	string	""
cluster.liaison.replicas	int	2
cluster.liaison.resources.limits	list	[]
cluster.liaison.resources.requests	list	[]
cluster.liaison.role	string	"liaison"
cluster.liaison.securityContext	object	{}
cluster.liaison.tolerations	list	[]
etcd.auth.client.caFilename	string	""
etcd.auth.client.certFilename	string	"tls.crt"
etcd.auth.client.certKeyFilename	string	"tls.key"
etcd.auth.client.enableAuthentication	bool	false
etcd.auth.client.existingSecret	string	""
etcd.auth.client.secureTransport	bool	false
etcd.auth.rbac.allowNoneAuthentication	bool	false
etcd.auth.rbac.create	bool	true
etcd.auth.rbac.rootPassword	string	"banyandb"
etcd.enabled	bool	true
etcd.replicaCount	int	1
fullnameOverride	string	"banyandb"
image.pullPolicy	string	"IfNotPresent"
image.repository	string	"docker.io/apache/skywalking-banyandb"
image.tag	string	"0.6.0"
serviceAccount.annotations	object	{}
serviceAccount.create	bool	true
serviceAccount.name	string	""
standalone.affinity	object	{}
standalone.enabled	bool	false
standalone.env	list	[]
standalone.grpcSvc.annotations	object	{}
standalone.grpcSvc.labels	object	{}
standalone.grpcSvc.port	int	17912
standalone.httpSvc.annotations	object	{}
standalone.httpSvc.externalIPs	list	[]
standalone.httpSvc.labels	object	{}
standalone.httpSvc.loadBalancerIP	string	nil
standalone.httpSvc.loadBalancerSourceRanges	list	[]
standalone.httpSvc.port	int	17913
standalone.httpSvc.type	string	"LoadBalancer"
standalone.ingress.annotations	object	{}
standalone.ingress.enabled	bool	false
standalone.ingress.labels	object	{}
standalone.ingress.rules	list	[]
standalone.ingress.tls	list	[]
standalone.name	string	"banyandb"
standalone.nodeSelector	list	[]
standalone.podAnnotations.example	string	"banyandb-foo"
standalone.podDisruptionBudget	object	{}
standalone.priorityClassName	string	""
standalone.resources.limits	list	[]
standalone.resources.requests	list	[]
standalone.securityContext	object	{}
standalone.sidecar	list	[]
standalone.tls.grpcSecretName	string	""
standalone.tls.httpSecretName	string	""
standalone.tolerations	list	[]
storage.enabled	bool	false
storage.persistentVolumeClaims[0].accessModes[0]	string	"ReadWriteOnce"
storage.persistentVolumeClaims[0].claimName	string	"data"
storage.persistentVolumeClaims[0].existingClaimName	string	nil
storage.persistentVolumeClaims[0].mountTargets[0]	string	"measure"
storage.persistentVolumeClaims[0].mountTargets[1]	string	"stream"
storage.persistentVolumeClaims[0].size	string	"50Gi"
storage.persistentVolumeClaims[0].storageClass	string	nil
storage.persistentVolumeClaims[0].volumeMode	string	"Filesystem"
storage.persistentVolumeClaims[1].accessModes[0]	string	"ReadWriteOnce"
storage.persistentVolumeClaims[1].claimName	string	"meta"
storage.persistentVolumeClaims[1].existingClaimName	string	nil
storage.persistentVolumeClaims[1].mountTargets[0]	string	"metadata"
storage.persistentVolumeClaims[1].size	string	"5Gi"
storage.persistentVolumeClaims[1].storageClass	string	nil
storage.persistentVolumeClaims[1].volumeMode	string	"Filesystem"

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

Note You could refer to the helm install for more command information.

$ helm install myrelease banyandb --set fullnameOverride=newBanyanDB

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install my-release banyandb -f values.yaml

Tip: You can use the default values.yaml

Use external certificate authorities for TLS

If you'd like to use external certificate authorities, such as Vault, corresponding annotations can be injected into banyandb.

Setup certificate for etcd TLS

To 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.

kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.4/cert-manager.yaml

A 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.

apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
  name: etcd-client
  namespace: banyandb
spec:
  secretName: etcd-client-tls
  duration: 17520h
  renewBefore: 4320h
  issuerRef:
    name: banyandb-issuer
    kind: Issuer
  usages:
    - server auth
    - client auth
  dnsNames:
    - "*.banyandb-etcd.banyandb.svc.cluster.local"
    - "*.banyandb-etcd-headless.banyandb.svc.cluster.local"

Install the development version of BanyanDB using the master branch

This is needed only when you want to install BanyanDB from the master branch.

You can install BanyanDB with the default configuration as follows.

export REPO=chart
git clone https://github.com/apache/skywalking-banyandb-helm
cd skywalking-banyandb-helm
helm install banyandb ${REPO}

Contact Us

• Submit an issue
• Mail list: dev@skywalking.apache.org. Mail to dev-subscribe@skywalking.apache.org, follow the reply to subscribe the mail list.
• Send Request to join SkyWalking slack mail to the mail list(dev@skywalking.apache.org), we will invite you in.
• For Chinese speaker, send [CN] Request to join SkyWalking slack mail to the mail list(dev@skywalking.apache.org), we will invite you in.
• Twitter, ASFSkyWalking
• bilibili B站 视频

LICENSE

Apache 2.0