bitnamicharts/keydb

Bitnami KeyDB 软件包

KeyDB 是 Redis 的高性能分支，专注于多线程、内存效率和高吞吐量。

https://github.com/Snapchat/KeyDB

商标：本软件列表由Bitnami打包。产品中提及的相关商标归各自公司所有，使用这些商标并不意味着任何关联或背书。

快速开始

console
helm install my-release oci://registry-1.docker.io/bitnamicharts/keydb

希望在生产环境中使用KeyDB？请尝试VMware Tanzu Application Catalog，即Bitnami目录的商业版。

⚠️ 重要通知：Bitnami目录即将变更

自2025年8月28日起，Bitnami将升级其公共目录，在新的Bitnami Secure Images计划下提供精选的强化、安全聚焦镜像集。作为此次过渡的一部分：

• 首次向社区用户提供热门容器镜像的安全优化版本。
• Bitnami将开始在其免费层中弃用对非强化、基于Debian的软件镜像的支持，并将逐步从公共目录中移除非最新标签。因此，社区用户将只能访问数量减少的强化镜像，这些镜像仅以“latest”标签发布，适用于开发目的。
• 从8月28日开始，在两周内，所有现有容器镜像（包括旧版本或版本化标签，如2.50.0、10.6）将从公共目录（docker.io/bitnami）迁移到“Bitnami Legacy”仓库（docker.io/bitnamilegacy），且不再接收更新。
• 对于生产工作负载和长期支持，建议用户采用Bitnami Secure Images，包括强化容器、更小的***面、CVE透明度（通过VEX/KEV）、SBOM以及企业支持。

这些变更旨在通过推广软件供应链完整性和最新部署的最佳实践，提高所有Bitnami用户的安全态势。更多详情，请访问https://github.com/bitnami/containers/issues/83267%E3%80%82

介绍

Bitnami Helm Charts经过精心设计、积极维护，是在Kubernetes集群上部署容器的最快、最简单方式，可直接用于处理生产工作负载。

本Chart使用Helm包管理器在Kubernetes集群中引导https://github.com/Snapchat/KeyDB%E9%83%A8%E7%BD%B2%E3%80%82

前提条件

• Kubernetes 1.23+
• Helm 3.8.0+
• 底层基础设施支持PV供应器

安装Chart

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

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/keydb

注意：需要将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm Chart仓库和存储库的引用。例如，对于Bitnami，需使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。

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

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

配置和安装详情

集群拓扑

默认：主从复制

当使用architecture=replication安装Chart时，将部署KeyDB主节点有状态集和KeyDB从节点有状态集。主节点负责所有写操作，从节点复制主节点的写操作并处理读操作。将公开两个服务：

• KeyDB主节点服务：指向主节点，可执行读写操作
• KeyDB从节点服务：指向从节点，默认仅允许读操作

若主节点崩溃，从节点将等待Kubernetes控制器管理器重新生成主节点。

主动副本

与主从复制架构类似，但允许在副本上执行读写操作。通过设置replica.activeReplica=true实现。有关此机制的更多信息，请参见KeyDB文档。

独立模式

当使用architecture=standalone安装Chart时，将部署独立的KeyDB主节点有状态集。将公开一个服务：

• KeyDB主节点服务：指向主节点，可执行读写操作

多主复制

与主从复制架构类似，此架构同时部署KeyDB主节点有状态集和KeyDB从节点有状态集。但在此架构中，可部署N个主节点副本，KeyDB副本配置为跟随多个主节点。通过将master.replicaCount设置为大于1的值并设置replica.activeReplica=true实现（注意使用多主模式时必须启用主动复制）。

有关此机制的更多信息，请参见KeyDB文档。

Prometheus指标

通过将metrics.enabled设置为true，本Chart可与Prometheus集成。这将在所有Pod中部署带有https://github.com/oliver006/redis_exporter%E7%9A%84%E8%BE%B9%E8%BD%A6%E5%AE%B9%E5%99%A8%EF%BC%8C%E4%BB%A5%E5%8F%8A%E5%8F%AF%E5%9C%A8%60metrics.service%60%E9%83%A8%E5%88%86%E9%85%8D%E7%BD%AE%E7%9A%84%60metrics%60%E6%9C%8D%E5%8A%A1%E3%80%82%E6%AD%A4%60metrics%60%E6%9C%8D%E5%8A%A1%E5%B0%86%E5%8C%85%E5%90%AB%E5%BF%85%E8%A6%81%E7%9A%84%E6%B3%A8%E8%A7%A3%EF%BC%8C%E4%BB%A5%E4%BE%BF%E8%A2%ABPrometheus%E8%87%AA%E5%8A%A8%E6%8A%93%E5%8F%96%E3%80%82

Prometheus要求

集成需确保Prometheus或Prometheus Operator已正确安装。安装https://github.com/bitnami/charts/tree/main/bitnami/prometheus%E6%88%96https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus%EF%BC%8C%E5%8F%AF%E8%BD%BB%E6%9D%BE%E5%9C%A8%E9%9B%86%E7%BE%A4%E4%B8%AD%E9%83%A8%E7%BD%B2Prometheus%E3%80%82

与Prometheus Operator集成

本Chart可部署ServiceMonitor对象，用于与Prometheus Operator集成。需将metrics.serviceMonitor.enabled设置为true。确保集群中已安装Prometheus OperatorCustomResourceDefinitions，否则将失败并显示以下错误：

text
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

安装https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus%E4%BB%A5%E8%8E%B7%E5%8F%96%E5%BF%85%E8%A6%81%E7%9A%84CRD%E5%92%8CPrometheus Operator。

更新凭据

Bitnami KeyDB Chart在升级时，会重用之前由Chart生成的密钥或auth.existingSecret中指定的密钥。要更新凭据，请使用以下方法之一：

• 运行helm upgrade并在auth.password中指定新密码
• 运行helm upgrade并在auth.existingSecret中指定新密钥

使用密码文件

要为KeyDB使用密码文件，需创建包含密码的密钥，然后使用该密钥部署Chart。请按照以下步骤操作：

• 创建密钥：

console
kubectl create secret generic keydb-password-secret --from-literal=keydb-password=KEYDB_PASSWORD

注意：将KEYDB_PASSWORD占位符替换为实际使用的密码。

• 使用密钥名称作为参数部署Helm Chart：

text
auth.enabled=true
auth.existingSecret=keydb-password-secret
auth.existingSecretPasswordKey=keydb-password
auth.usePasswordFiles=true

使用TLS加密流量

本Chart支持使用TLS加密通信。要启用此功能，设置tls.enabled。

需创建包含TLS证书的密钥，并通过tls.existingCASecret、tls.master.existingSecret和tls.replica.existingSecret（仅适用于复制架构）参数将其传递给Chart。每个密钥应包含tls.crt和tls.key键，分别包含证书和密钥文件。例如：使用证书文件创建CA密钥：

console
kubectl create secret generic ca-tls-secret --from-file=./tls.crt --from-file=./tls.key

可手动创建所需的TLS证书，或依赖Chart的自动生成功能。Chart支持两种自动生成证书的方式：

• 使用Helm功能：通过将tls.autoGenerated.enabled设置为true并将tls.autoGenerated.engine设置为helm启用此功能。
• 依赖CertManager（需在K8s集群中安装CertManager）：通过将tls.autoGenerated.enabled设置为true并将tls.autoGenerated.engine设置为cert-manager启用此功能。可通过设置tls.autoGenerated.certManager.existingIssuer和tls.autoGenerated.certManager.existingIssuerKind参数，使用现有Issuer/ClusterIssuer颁发TLS证书。

指标

Chart可选择启动prometheus指标导出器。可使用类似于https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus-kubernetes.yml%E4%B8%AD%E6%8F%8F%E8%BF%B0%E7%9A%84%E6%96%B9%E6%B3%95%E4%BB%8E%E9%9B%86%E7%BE%A4%E5%86%85%E6%8A%93%E5%8F%96%E6%8C%87%E6%A0%87%E3%80%82%E8%8B%A5%E8%A6%81%E4%BB%8E%E9%9B%86%E7%BE%A4%E5%A4%96%E6%8A%93%E5%8F%96%E6%8C%87%E6%A0%87%EF%BC%8C%E5%8F%AF%E4%BD%BF%E7%94%A8Kubernetes API代理访问端点。

如果通过指定tls.enabled=true启用了TLS，则还需向指标导出器指定TLS选项。可通过metrics.extraArgs进行设置。TLS的指标导出器CLI标志可在https://github.com/oliver006/redis_exporter#command-line-flags%E6%89%BE%E5%88%B0%E3%80%82%E4%BE%8B%E5%A6%82%EF%BC%9A

可指定metrics.extraArgs.skip-tls-verification=true跳过TLS验证，或在metrics.extraArgs下提供以下TLS客户端认证值：

console
tls-client-key-file
tls-client-cert-file
tls-ca-cert-file

滚动标签与不可变标签

强烈建议在生产环境中使用不可变标签。这可确保如果相同标签使用不同镜像更新，部署不会自动更改。

如果主容器有新版本、重大变更或严重漏洞，Bitnami将发布新Chart更新其容器。

资源请求和限制

Bitnami Charts允许为Chart部署内的所有容器设置资源请求和限制。这些设置位于resources值中（参见参数表）。为生产工作负载设置请求至关重要，且应根据具体用例进行调整。

为简化此过程，Chart包含resourcesPreset值，可根据不同预设自动设置resources部分。请在https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_resources.tpl#L15%E4%B8%AD%E6%9F%A5%E7%9C%8B%E8%BF%99%E4%BA%9B%E9%A2%84%E8%AE%BE%E3%80%82%E4%BD%86%E5%9C%A8%E7%94%9F%E4%BA%A7%E5%B7%A5%E4%BD%9C%E8%B4%9F%E8%BD%BD%E4%B8%AD%E4%B8%8D%E5%BB%BA%E8%AE%AE%E4%BD%BF%E7%94%A8%60resourcesPreset%60%EF%BC%8C%E5%9B%A0%E4%B8%BA%E5%AE%83%E5%8F%AF%E8%83%BD%E6%97%A0%E6%B3%95%E5%AE%8C%E5%85%A8%E9%80%82%E5%BA%94%E5%85%B7%E4%BD%93%E9%9C%80%E6%B1%82%E3%80%82%E6%9C%89%E5%85%B3%E5%AE%B9%E5%99%A8%E8%B5%84%E6%BA%90%E7%AE%A1%E7%90%86%E7%9A%84%E6%9B%B4%E5%A4%9A%E4%BF%A1%E6%81%AF%EF%BC%8C%E8%AF%B7%E5%8F%82%E8%A7%81Kubernetes%E5%AE%98%E6%96%B9%E6%96%87%E6%A1%A3%E3%80%82

额外环境变量

若要添加额外环境变量（用于高级操作，如自定义初始化脚本），可使用extraEnvVars属性。

yaml
master:
  extraEnvVars:
  - name: LOG_LEVEL
    value: error

或者，可使用ConfigMap或Secret存储环境变量。为此，使用extraEnvVarsCM或extraEnvVarsSecret值。

边车容器（Sidecars）

若需在KeyDB所在的Pod中添加额外容器（如额外的指标或日志导出器），可使用sidecars参数定义。

yaml
master:
  sidecars:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
    - name: portname
      containerPort: 1234

如果这些边车容器公开额外端口，可使用service.extraPorts参数（如可用）添加额外端口定义，如下例所示：

yaml
master:
  service:
    extraPorts:
    - name: extraPort
      port: 11311
      targetPort: 11311

注意：此Helm Chart已包含Prometheus导出器的边车容器（如适用）。可在部署时将metrics.enabled参数设置为true激活这些容器。因此，sidecars参数应仅用于额外的边车容器。

若需在同一Pod中添加额外的初始化容器，可使用initContainers参数定义。例如：

yaml
master:
  initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

了解更多关于边车容器和初始化容器的信息。

Pod亲和性

本Chart允许使用affinity参数设置自定义亲和性。有关Pod亲和性的更多信息，请参见kubernetes文档。

作为替代方案，可使用https://github.com/bitnami/charts/tree/main/bitnami/common#affinities chart中提供的Pod亲和性、Pod反亲和性和节点亲和性预设配置。为此，设置podAffinityPreset、podAntiAffinityPreset或nodeAffinityPreset参数。

备份和恢复

要在Kubernetes上备份和恢复Helm Chart部署，需使用Velero（Kubernetes备份/恢复工具）备份源部署的持久卷，并将其附加到新部署。有关使用Velero的说明，请参见本指南。

持久性

https://github.com/bitnami/containers/tree/main/bitnami/keydb%E9%95%9C%E5%83%8F%E5%B0%86KeyDB%E6%95%B0%E6%8D%AE%E5%92%8C%E9%85%8D%E7%BD%AE%E5%AD%98%E5%82%A8%E5%9C%A8%E5%AE%B9%E5%99%A8%E7%9A%84%60/bitnami/keydb/data%60%E8%B7%AF%E5%BE%84%E4%B8%8B%E3%80%82%E6%8C%81%E4%B9%85%E5%8D%B7%E5%A3%B0%E6%98%8E%E7%94%A8%E4%BA%8E%E5%9C%A8%E9%83%A8%E7%BD%B2%E4%B9%8B%E9%97%B4%E4%BF%9D%E7%95%99%E6%95%B0%E6%8D%AE%E3%80%82

如果在使用持久卷时遇到错误，请参考我们的持久卷故障排除指南。

参数

全局参数

通用参数

KeyDB镜像参数

KeyDB通用配置参数