bitnamicharts/redis-cluster

Bitnami Redis® Cluster 软件包

Redis®是一个开源、可扩展的分布式内存缓存应用，用于存储和提供字符串、哈希、列表、集合及有序集合形式的数据。

Redis® Cluster 概述

免责声明：Redis是Redis Ltd.的注册商标。其所有权利归Redis Ltd.所有。Bitnami的任何使用仅为参考目的，不表示Redis Ltd.的任何赞助、认可或关联。

快速开始

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

希望在生产环境中使用Redis® Cluster？请尝试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

介绍

此Chart使用Helm包管理器在Kubernetes集群上引导https://github.com/bitnami/containers/tree/main/bitnami/redis%E9%83%A8%E7%BD%B2%E3%80%82

Redis® Helm Chart与Redis® Cluster Helm Chart的选择

您可以选择以下两种Redis® Helm Chart部署Redis®集群： https://github.com/bitnami/charts/tree/main/bitnami/redis%E4%BD%BF%E7%94%A8Redis%C2%AE Sentinel部署主从集群，而https://github.com/bitnami/charts/tree/main/bitnami/redis-cluster%E9%83%A8%E7%BD%B2%E6%94%AF%E6%8C%81%E5%88%86%E7%89%87%E7%9A%84Redis%C2%AE%E9%9B%86%E7%BE%A4%E3%80%82%E4%B8%A4%E8%80%85%E7%9A%84%E4%B8%BB%E8%A6%81%E7%89%B9%E6%80%A7%E5%A6%82%E4%B8%8B%EF%BC%9A

前提条件

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

安装Chart

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

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/redis-cluster

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

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

注意：如果等待钩子完成时出现超时错误，请增加默认超时时间（300秒），例如：

console
helm install --timeout 600s myrelease oci://REGISTRY_NAME/REPOSITORY_NAME/redis-cluster

注意：需将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm Chart仓库和存储库的引用。例如，Bitnami的情况下，使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。 提示：使用helm list查看所有发布。

配置和安装细节

资源请求和限制

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

为简化此过程，Chart包含resourcesPreset值，可根据不同预设自动设置resources部分。有关这些预设，请查看https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_resources.tpl#L15%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%EF%BC%8C%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%E6%82%A8%E7%9A%84%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

Prometheus指标

通过将metrics.enabled设置为true，可将Chart与Prometheus集成。这将在所有Pod中部署带有https://github.com/oliver006/redis_exporter%E7%9A%84Sidecar%E5%AE%B9%E5%99%A8%E5%92%8C%60metrics%60%E6%9C%8D%E5%8A%A1%EF%BC%8C%E5%8F%AF%E5%9C%A8%60metrics.service%60%E9%83%A8%E5%88%86%E4%B8%8B%E9%85%8D%E7%BD%AE%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%E5%9C%A8%E9%9B%86%E7%BE%A4%E4%B8%AD%E8%BD%BB%E6%9D%BE%E9%83%A8%E7%BD%B2Prometheus%E3%80%82

与Prometheus Operator集成

通过设置metrics.serviceMonitor.enabled=true，Chart可部署ServiceMonitor对象以与Prometheus Operator集成。确保集群中已安装Prometheus Operator的CustomResourceDefinitions，否则将失败并显示以下错误：

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将发布新Chart更新其容器。

使用不同Redis®版本

要修改此Chart使用的应用版本，可通过image.tag参数指定不同的镜像版本，和/或通过image.repository参数指定不同的仓库。

集群拓扑

集群成功部署至少需要3个主节点。节点总数计算公式为：nodes = 主节点数 + 主节点数 * 副本数。因此，默认cluster.nodes=6和cluster.replicas=1表示将部署3个主节点和3个副本节点。

默认情况下，Redis® Cluster无法从Kubernetes集群外部访问。要从外部访问，需在部署时设置cluster.externalAccess.enabled=true。首次安装时将创建6个Load***服务（每个Redis®节点一个），获取每个服务的外部IP后，需通过cluster.externalAccess.service.loadbalancerIP数组传递这些IP进行升级。

副本是主节点的只读副本。默认情况下（不使用外部访问模式）仅公开一个服务。无论读写操作，客户端均连接到公开的服务。当写操作到达副本时，副本会将客户端重定向到正确的主节点。例如，使用redis-cli时需提供-c标志以自动跟随重定向。

使用外部访问模式时，可连接到任何Pod，从节点将以相同方式重定向客户端，但所有IP均为公共IP。

若主节点崩溃，其从节点之一将升级为主节点。崩溃主节点存储的槽位在从节点完成升级前不可用。若主节点及其所有从节点均崩溃，集群将不可用，直至其中一个节点恢复。要避免 downtime，可通过cluster.nodes和cluster.replicas配置Redis®节点数量。例如：

• cluster.nodes=9（3个主节点，每个主节点2个副本）
• cluster.replicas=2

注意：默认cluster.init=true以在首次安装时初始化Redis® Cluster。若仅测试部署或升级节点而避免创建集群，可设置cluster.init=false。

添加新节点到集群

可通过post-upgrade钩子执行作业添加新节点。需提供以下参数：

• 通过password参数提供安装时使用的密码。若未提供密码，可按照NOTES.txt中的说明获取生成的密码。
• 设置cluster.nodes为所需节点数。
• 设置cluster.update.currentNumberOfNodes为当前节点数。
• 设置cluster.update.addNodes=true。

以下是添加一个节点的示例：

console
helm upgrade --timeout 600s <release> --set "password=${REDIS_PASSWORD},cluster.nodes=7,cluster.update.addNodes=true,cluster.update.currentNumberOfNodes=6" oci://REGISTRY_NAME/REPOSITORY_NAME/redis-cluster

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

其中REDIS_PASSWORD是Helm Chart首次安装后显示的命令获取的密码。集群将在重启Pod时保持可用，前提是未丢失法定人数。

外部访问

使用外部访问时，添加新节点需执行两次升级。首次升级添加新Redis®节点并获取Load***IP服务：

console
helm upgrade <release> --set "password=${REDIS_PASSWORD},cluster.externalAccess.enabled=true,cluster.externalAccess.service.type=LoadBalancer,cluster.externalAccess.service.loadBalancerIP[0]=<loadBalancerip-0>,cluster.externalAccess.service.loadBalancerIP[1]=<loadbalanacerip-1>,cluster.externalAccess.service.loadBalancerIP[2]=<loadbalancerip-2>,cluster.externalAccess.service.loadBalancerIP[3]=<loadbalancerip-3>,cluster.externalAccess.service.loadBalancerIP[4]=<loadbalancerip-4>,cluster.externalAccess.service.loadBalancerIP[5]=<loadbalancerip-5>,cluster.externalAccess.service.loadBalancerIP[6]=,cluster.nodes=7,cluster.init=false" oci://REGISTRY_NAME/REPOSITORY_NAME/redis-cluster

注意：需将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm Chart仓库和存储库的引用。例如，Bitnami的情况下，使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。 重要：为避免索引错误，需为新节点的load***IP参数留空。

设置cluster.nodes=7并为新节点留空LoadIP，集群将提供正确的IP。此时，新Redis® Pod将处于crashLoopBackOff状态，直至提供新服务的LoadIP。

等待集群提供新服务的Load***IP后，执行第二次升级：

console
helm upgrade <release> --set "password=${REDIS_PASSWORD},cluster.externalAccess.enabled=true,cluster.externalAccess.service.type=LoadBalancer,cluster.externalAccess.service.loadBalancerIP[0]=<loadbalancerip-0>,cluster.externalAccess.service.loadBalancerIP[1]=<loadbalancerip-1>,cluster.externalAccess.service.loadBalancerIP[2]=<loadbalancerip-2>,cluster.externalAccess.service.loadBalancerIP[3]=<loadbalancerip-3>,cluster.externalAccess.service.loadBalancerIP[4]=<loadbalancerip-4>,cluster.externalAccess.service.loadBalancerIP[5]=<loadbalancerip-5>,cluster.externalAccess.service.loadBalancerIP[6]=<loadbalancerip-6>,cluster.nodes=7,cluster.init=false,cluster.update.addNodes=true,cluster.update.newExternalIPs[0]=<load-balancerip-6>" oci://REGISTRY_NAME/REPOSITORY_NAME/redis-cluster

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

需在cluster.update.newExternalIPs提供新IP，设置cluster.update.addNodes=true以启用添加节点的作业，并设置新服务的Load***IP（不再留空）。

注意：为避免再次创建初始化Redis® Cluster的作业，需提供cluster.init=false。

集群缩容

缩容Redis® Cluster步骤如下：

首先执行常规升级，将cluster.nodes设置为所需节点数。节点数不得少于6，且当前节点数与所需节点数之差应小于或等于cluster.replicas，以避免同时移除主节点及其从节点。还需通过password提供密码。例如，从多于6个节点缩容至6个节点：

console
helm upgrade --timeout 600s <release> --set "password=${REDIS_PASSWORD},cluster.nodes=6" .

只要未丢失法定人数，集群将在更新期间继续运行。

注意：为避免再次创建初始化Redis® Cluster的作业，需提供cluster.init=false。

所有节点就绪后，使用CLUSTER NODES命令获取集群节点列表。记录显示fail的节点ID，在每个集群节点上执行redis-cli -a $REDIS_PASSWORD CLUSTER FORGET NODE_ID。

使用密码文件

要使用密码文件，需创建包含密码的Secret（密码文件必须命名为redis-password），然后部署时指定：

text
usePassword=true
usePasswordFile=true
existingSecret=redis-password-secret
metrics.enabled=true

使用TLS加密流量

通过指定tls.参数启用TLS支持，需配置证书Secret、证书文件名等。示例：

console
kubectl create secret generic certificates-tls-secret --from-file=./cert.pem --from-file=./cert.key --from-file=./ca.pem

部署参数：

console
tls.enabled="true"
tls.existingSecret="certificates-tls-secret"
tls.certFilename="cert.pem"
tls.certKeyFilename="cert.key"
tls.certCAFilename="ca.pem"

Sidecar和Init容器

通过sidecars和initContainers参数添加额外容器，遵循Kubernetes容器规范。

其他配置

包括添加额外环境变量、主机内核设置、网络策略、Pod亲和性配置等，详情参见完整文档。

持久化

默认挂载Persistent Volume（动态供应），禁用时使用emptyDir（仅测试环境），因缺少nodes.conf文件可能导致节点独立运行。

注意：此Chart的README因超出DockerHub限制被截断。完整README请参见https://github.com/bitnami/charts/blob/main/bitnami/redis-cluster/README.md