apache/skywalking-banyandb-helm

Apache SkyWalking BanyanDB Helm Chart

!https://github.com/apache/skywalking-banyandb-helm/workflows/Build/badge.svg?branch=master

BanyanDB 是一个可观测性数据库，旨在摄入、分析和存储指标（Metrics）、追踪（Tracing）和日志（Logging）数据。它设计用于处理可观测性平台和APM系统（如 https://github.com/apache/skywalking 等）生成的可观测性数据。

BanyanDB Helm Chart 仓库提供了在 Kubernetes 集群上原生安装和配置 BanyanDB 的方法。脚本基于 Helm 3 编写。

Chart 详细配置

简介

此 Chart 使用 Helm 包管理器在 Kubernetes 集群上引导部署 Apache SkyWalking BanyanDB。Helm Chart 的发布版本可在 https://hub.docker.com/r/apache/skywalking-banyandb-helm 上找到。

前提条件

• Kubernetes 1.24.0+
• Helm 3

安装 Chart

image.tag 是 Chart 的必填值。

您可以通过命令行设置这些必填值（例如 --set image.tag=0.8.0），或在单独的文件（如 values.yaml）中编辑它们，然后使用 -f <文件名> 或 --values=<文件名> 进行设置。

要使用发布名称 my-release 安装 Chart：

shell
git clone https://github.com/apache/skywalking-banyandb-helm
cd ./skywalking-banyandb-helm
helm install my-release \
  chart \
  -n <namespace> \
  --set image.tag=<image-tag>

该命令使用默认配置在 Kubernetes 集群上部署 BanyanDB。配置 部分列出了安装过程中可配置的参数。

提示：使用 helm list 列出所有发布版本

卸载 Chart

要卸载/删除 my-release 部署：

shell
helm uninstall my-release -n <namespace>

此命令将移除与该 Chart 关联的所有 BanyanDB 组件并删除发布版本。

兼容性

配置

参数说明详见 https://github.com/apache/skywalking-banyandb-helm/blob/v0.5.0-rc0/doc/parameters.md%E3%80%82

可使用 --set key=value[,key=value] 参数在 helm install 命令中指定各个参数。例如：

注意 您可参考 helm install 获取更多命令信息。

console
helm install my-release \
  chart \
  -n <namespace> \
  --set image.tag=<image-tag> \
  --set fullnameOverride=newBanyanDB

或者，在安装 Chart 时可提供一个 YAML 文件，指定上述参数的值。例如：

console
helm install my-release \
  chart \
  -n <namespace> \
  --set image.tag=<image-tag> \
  -f values.yaml

提示：您可使用默认的 https://github.com/apache/skywalking-banyandb-helm/blob/v0.5.0-rc0/chart/values.yaml

TLS 配置

使用外部证书机构（CA）进行 TLS

如果需要使用外部证书机构（如 Vault），可将相应的注解注入到 https://github.com/apache/skywalking-banyandb-helm/blob/v0.5.0-rc0/chart/templates/cluster_data_statefulset.yaml 中。

为 etcd 设置 TLS 证书

要为 etcd 建立安全通信，可使用 cert-manager 生成必要的 TLS 证书。该工具简化了证书的创建和管理流程。可通过以下命令安装 cert-manager：

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

可使用以下配置创建证书。在此设置中，每个 dnsName 包含通配符，以便解析指定命名空间内所有 etcd Pod 的 DNS 名称，以及 etcd 的服务名称及其对应命名空间。其中，svc 表示服务，cluster.local 是 Kubernetes 集群的域名后缀。

yaml
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"

备份与恢复

BanyanDB Helm Chart 支持备份和恢复功能。详细配置可参见 https://github.com/apache/skywalking-banyandb-helm/blob/v0.5.0-rc0/doc/backup.md%E3%80%82

生命周期管理

BanyanDB Helm Chart 支持生命周期管理功能。详细配置可参见 https://github.com/apache/skywalking-banyandb-helm/blob/v0.5.0-rc0/doc/lifecycle.md%E3%80%82

使用 master 分支安装 BanyanDB 开发版本

仅当需要从 https://github.com/apache/skywalking-banyandb 的 master 分支安装时，才需要执行以下步骤。

可按如下方式使用默认配置安装 BanyanDB：

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

联系我们

• 提交 https://github.com/apache/skywalking/issues
• 邮件列表：*******。发送邮件至 dev-subscribe@skywalking.apache.org，按照回复订阅邮件列表。
• 发送“Request to join SkyWalking slack”邮件至邮件列表（dev@skywalking.apache.org），我们将邀请您加入。
• 中文用户请发送“[CN] Request to join SkyWalking slack”邮件至邮件列表（dev@skywalking.apache.org），我们将邀请您加入。
• ***：ASFSkyWalking
• bilibili B站 视频

许可证

Apache 2.0