Redis Distributed

This Helm chart deploys a Distributed Redis cluster on Kubernetes with master-slave replication, high availability, and monitoring capabilities. Below is a detailed guide to the configuration options available.

Prerequisites

• Kubernetes 1.19+
• Helm 3.0+
• Prometheus Operator (for monitoring and alerts)

Add Helm Repository

Add the Helm repository by running:

helm repo add zopdev https://helm.zop.dev
helm repo update

For more details, see the Helm Repository Documentation.

Install Helm Chart

To deploy the Redis Distributed Helm chart, use the following command:

helm install [RELEASE_NAME] zopdev/redisdistributed

Replace [RELEASE_NAME] with your desired release name. Example:

helm install my-redis-distributed zopdev/redisdistributed

You can override default values during installation by providing a values.yaml file.

Refer to the Helm Install Documentation for further details.

Uninstall Helm Chart

To remove the Redis Distributed Helm chart and associated resources, run:

helm uninstall [RELEASE_NAME]

Example:

helm uninstall my-redis-distributed

Check the Helm Uninstall Documentation for more information.

Configuration

The table below outlines the essential global configuration options. For specific master and slave configurations, refer to their respective sections below.

Global Configuration

Master Configuration

Slave Configuration

Example values.yaml

version: "6.2.13"

master:
  resources:
    requests:
      cpu: "100m"
      memory: "500Mi"
    limits:
      cpu: "500m"
      memory: "1000Mi"

  persistence:
    size: 10Gi

slave:
  enable : true
  count: 1
  resources:
    requests:
      cpu: "100m"
      memory: "500Mi"
    limits:
      cpu: "500m"
      memory: "1000Mi"

  persistence:
    size: 10Gi

Features

• Deploy Redis master-slave architecture with high availability on Kubernetes.
• Configurable master and slave resources, persistence, and scaling options.
• Built-in health monitoring with liveness and readiness probes.
• Automatic failover and replication management for data reliability.
• Comprehensive monitoring with Redis Exporter and Prometheus integration.
• Customizable service types and ports for flexible networking.
• Rolling updates with zero downtime for seamless deployments.
• Persistent storage for both master and slave nodes.

Monitoring

The chart includes a Redis Exporter container that exposes metrics on port 2121. These metrics are automatically collected by Prometheus when using the Prometheus Operator.

Key metrics include:

• Redis instance information
• Connected slaves count
• Memory usage
• Command statistics
• Replication status
• Connection metrics

Pod Scheduling

nodeSelector, tolerations and affinity are passed straight through to the pod spec. All three are empty by default and render nothing, so leaving them unset changes nothing for an existing release.

They apply to both the master and the slave StatefulSet.

Together they place the workload on a dedicated node pool — the nodeSelector picks the pool, the toleration gets past its taint:

nodeSelector:
  workload: stateful

tolerations:
  - key: workload
    operator: Equal
    value: stateful
    effect: NoSchedule

affinity takes a full Affinity object and is rendered verbatim.

Contributing

We welcome contributions to improve this Helm chart. Please refer to the CONTRIBUTING.md file for contribution guidelines.

Code of Conduct

To maintain a healthy and collaborative community, please adhere to our Code of Conduct.

License

This project is licensed under the LICENSE. Please review it for terms of use.

Connection Config

• REDIS_PORT : Port on which Redis is exposed inside the cluster.Default 6379.
• REDIS_HOST : Internal DNS name for the Redis headless service.
• REDIS_URL : Redis connection string.