helm-charts

Redis™ Chart packaged by Bitnami

Redis™ is an advanced key-value cache and store. It is often referred to as a data structure server since keys can contain strings, hashes, lists, sets, sorted sets, bitmaps and hyperloglogs.

Disclaimer: REDIS® is a registered trademark of Redis Labs Ltd.Any rights therein are reserved to Redis Labs Ltd. Any use by Bitnami is for referential purposes only and does not indicate any sponsorship, endorsement, or affiliation between Redis Labs Ltd.

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/redis

Introduction

This chart bootstraps a Redis™ deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the BKPR.

Choose between Redis™ Helm Chart and Redis™ Cluster Helm Chart

You can choose any of the two Redis™ Helm charts for deploying a Redis™ cluster.

  1. Redis™ Helm Chart will deploy a master-slave cluster, with the option of enabling using Redis™ Sentinel.
  2. Redis™ Cluster Helm Chart will deploy a Redis™ Cluster topology with sharding.

The main features of each chart are the following:

Redis™ Redis™ Cluster
Supports multiple databases Supports only one database. Better if you have a big dataset
Single write point (single master) Multiple write points (multiple masters)
Redis™ Topology Redis™ Cluster Topology

Prerequisites

Installing the Chart

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

$ helm install my-release bitnami/redis

The command deploys Redis™ on the Kubernetes cluster in the default configuration. The Parameters 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 delete my-release

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

Parameters

Global parameters

Name Description Value
global.imageRegistry Global Docker image registry ""
global.imagePullSecrets Global Docker registry secret names as an array []
global.storageClass Global StorageClass for Persistent Volume(s) ""
global.redis.password Global Redis™ password (overrides auth.password) ""

Common parameters

Name Description Value
kubeVersion Override Kubernetes version ""
nameOverride String to partially override common.names.fullname ""
fullnameOverride String to fully override common.names.fullname ""
commonLabels Labels to add to all deployed objects {}
commonAnnotations Annotations to add to all deployed objects {}
clusterDomain Kubernetes cluster domain name cluster.local
extraDeploy Array of extra objects to deploy with the release []
diagnosticMode.enabled Enable diagnostic mode (all probes will be disabled and the command will be overridden) false
diagnosticMode.command Command to override all containers in the deployment ["sleep"]
diagnosticMode.args Args to override all containers in the deployment ["infinity"]

Redis™ Image parameters

Name Description Value
image.registry Redis™ image registry docker.io
image.repository Redis™ image repository bitnami/redis
image.tag Redis™ image tag (immutable tags are recommended) 6.2.6-debian-10-r49
image.pullPolicy Redis™ image pull policy IfNotPresent
image.pullSecrets Redis™ image pull secrets []
image.debug Enable image debug mode false

Redis™ common configuration parameters

Name Description Value
architecture Redis™ architecture. Allowed values: standalone or replication replication
auth.enabled Enable password authentication true
auth.sentinel Enable password authentication on sentinels too true
auth.password Redis™ password ""
auth.existingSecret The name of an existing secret with Redis™ credentials ""
auth.existingSecretPasswordKey Password key to be retrieved from existing secret ""
auth.usePasswordFiles Mount credentials as files instead of using an environment variable false
commonConfiguration Common configuration to be added into the ConfigMap ""
existingConfigmap The name of an existing ConfigMap with your custom configuration for Redis™ nodes ""

Redis™ master configuration parameters

Name Description Value
master.configuration Configuration for Redis™ master nodes ""
master.disableCommands Array with Redis™ commands to disable on master nodes []
master.command Override default container command (useful when using custom images) []
master.args Override default container args (useful when using custom images) []
master.preExecCmds Additional commands to run prior to starting Redis™ master []
master.extraFlags Array with additional command line flags for Redis™ master []
master.extraEnvVars Array with extra environment variables to add to Redis™ master nodes []
master.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Redis™ master nodes ""
master.extraEnvVarsSecret Name of existing Secret containing extra env vars for Redis™ master nodes ""
master.containerPort Container port to open on Redis™ master nodes 6379
master.livenessProbe.enabled Enable livenessProbe on Redis™ master nodes true
master.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 20
master.livenessProbe.periodSeconds Period seconds for livenessProbe 5
master.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
master.livenessProbe.failureThreshold Failure threshold for livenessProbe 5
master.livenessProbe.successThreshold Success threshold for livenessProbe 1
master.readinessProbe.enabled Enable readinessProbe on Redis™ master nodes true
master.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 20
master.readinessProbe.periodSeconds Period seconds for readinessProbe 5
master.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 1
master.readinessProbe.failureThreshold Failure threshold for readinessProbe 5
master.readinessProbe.successThreshold Success threshold for readinessProbe 1
master.customLivenessProbe Custom livenessProbe that overrides the default one {}
master.customReadinessProbe Custom readinessProbe that overrides the default one {}
master.resources.limits The resources limits for the Redis™ master containers {}
master.resources.requests The requested resources for the Redis™ master containers {}
master.podSecurityContext.enabled Enabled Redis™ master pods’ Security Context true
master.podSecurityContext.fsGroup Set Redis™ master pod’s Security Context fsGroup 1001
master.containerSecurityContext.enabled Enabled Redis™ master containers’ Security Context true
master.containerSecurityContext.runAsUser Set Redis™ master containers’ Security Context runAsUser 1001
master.schedulerName Alternate scheduler for Redis™ master pods ""
master.updateStrategy.type Redis™ master statefulset strategy type RollingUpdate
master.priorityClassName Redis™ master pods’ priorityClassName ""
master.hostAliases Redis™ master pods host aliases []
master.podLabels Extra labels for Redis™ master pods {}
master.podAnnotations Annotations for Redis™ master pods {}
master.shareProcessNamespace Share a single process namespace between all of the containers in Redis™ master pods false
master.podAffinityPreset Pod affinity preset. Ignored if master.affinity is set. Allowed values: soft or hard ""
master.podAntiAffinityPreset Pod anti-affinity preset. Ignored if master.affinity is set. Allowed values: soft or hard soft
master.nodeAffinityPreset.type Node affinity preset type. Ignored if master.affinity is set. Allowed values: soft or hard ""
master.nodeAffinityPreset.key Node label key to match. Ignored if master.affinity is set ""
master.nodeAffinityPreset.values Node label values to match. Ignored if master.affinity is set []
master.affinity Affinity for Redis™ master pods assignment {}
master.nodeSelector Node labels for Redis™ master pods assignment {}
master.tolerations Tolerations for Redis™ master pods assignment []
master.spreadConstraints Spread Constraints for Redis™ master pod assignment {}
master.lifecycleHooks for the Redis™ master container(s) to automate configuration before or after startup {}
master.extraVolumes Optionally specify extra list of additional volumes for the Redis™ master pod(s) []
master.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Redis™ master container(s) []
master.sidecars Add additional sidecar containers to the Redis™ master pod(s) []
master.initContainers Add additional init containers to the Redis™ master pod(s) []
master.persistence.enabled Enable persistence on Redis™ master nodes using Persistent Volume Claims true
master.persistence.medium Provide a medium for emptyDir volumes. ""
master.persistence.path The path the volume will be mounted at on Redis™ master containers /data
master.persistence.subPath The subdirectory of the volume to mount on Redis™ master containers ""
master.persistence.storageClass Persistent Volume storage class ""
master.persistence.accessModes Persistent Volume access modes []
master.persistence.size Persistent Volume size 8Gi
master.persistence.annotations Additional custom annotations for the PVC {}
master.persistence.selector Additional labels to match for the PVC {}
master.persistence.dataSource Custom PVC data source {}
master.persistence.existingClaim Use a existing PVC which must be created manually before bound ""
master.service.type Redis™ master service type ClusterIP
master.service.port Redis™ master service port 6379
master.service.nodePort Node port for Redis™ master ""
master.service.externalTrafficPolicy Redis™ master service external traffic policy Cluster
master.service.clusterIP Redis™ master service Cluster IP ""
master.service.loadBalancerIP Redis™ master service Load Balancer IP ""
master.service.loadBalancerSourceRanges Redis™ master service Load Balancer sources []
master.service.annotations Additional custom annotations for Redis™ master service {}
master.terminationGracePeriodSeconds Integer setting the termination grace period for the redis-master pods 30

Redis™ replicas configuration parameters

Name Description Value
replica.replicaCount Number of Redis™ replicas to deploy 3
replica.configuration Configuration for Redis™ replicas nodes ""
replica.disableCommands Array with Redis™ commands to disable on replicas nodes []
replica.command Override default container command (useful when using custom images) []
replica.args Override default container args (useful when using custom images) []
replica.preExecCmds Additional commands to run prior to starting Redis™ replicas []
replica.extraFlags Array with additional command line flags for Redis™ replicas []
replica.extraEnvVars Array with extra environment variables to add to Redis™ replicas nodes []
replica.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Redis™ replicas nodes ""
replica.extraEnvVarsSecret Name of existing Secret containing extra env vars for Redis™ replicas nodes ""
replica.containerPort Container port to open on Redis™ replicas nodes 6379
replica.livenessProbe.enabled Enable livenessProbe on Redis™ replicas nodes true
replica.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 20
replica.livenessProbe.periodSeconds Period seconds for livenessProbe 5
replica.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
replica.livenessProbe.failureThreshold Failure threshold for livenessProbe 5
replica.livenessProbe.successThreshold Success threshold for livenessProbe 1
replica.readinessProbe.enabled Enable readinessProbe on Redis™ replicas nodes true
replica.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 20
replica.readinessProbe.periodSeconds Period seconds for readinessProbe 5
replica.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 1
replica.readinessProbe.failureThreshold Failure threshold for readinessProbe 5
replica.readinessProbe.successThreshold Success threshold for readinessProbe 1
replica.customLivenessProbe Custom livenessProbe that overrides the default one {}
replica.customReadinessProbe Custom readinessProbe that overrides the default one {}
replica.resources.limits The resources limits for the Redis™ replicas containers {}
replica.resources.requests The requested resources for the Redis™ replicas containers {}
replica.podSecurityContext.enabled Enabled Redis™ replicas pods’ Security Context true
replica.podSecurityContext.fsGroup Set Redis™ replicas pod’s Security Context fsGroup 1001
replica.containerSecurityContext.enabled Enabled Redis™ replicas containers’ Security Context true
replica.containerSecurityContext.runAsUser Set Redis™ replicas containers’ Security Context runAsUser 1001
replica.schedulerName Alternate scheduler for Redis™ replicas pods ""
replica.updateStrategy.type Redis™ replicas statefulset strategy type RollingUpdate
replica.priorityClassName Redis™ replicas pods’ priorityClassName ""
replica.hostAliases Redis™ replicas pods host aliases []
replica.podLabels Extra labels for Redis™ replicas pods {}
replica.podAnnotations Annotations for Redis™ replicas pods {}
replica.shareProcessNamespace Share a single process namespace between all of the containers in Redis™ replicas pods false
replica.podAffinityPreset Pod affinity preset. Ignored if replica.affinity is set. Allowed values: soft or hard ""
replica.podAntiAffinityPreset Pod anti-affinity preset. Ignored if replica.affinity is set. Allowed values: soft or hard soft
replica.nodeAffinityPreset.type Node affinity preset type. Ignored if replica.affinity is set. Allowed values: soft or hard ""
replica.nodeAffinityPreset.key Node label key to match. Ignored if replica.affinity is set ""
replica.nodeAffinityPreset.values Node label values to match. Ignored if replica.affinity is set []
replica.affinity Affinity for Redis™ replicas pods assignment {}
replica.nodeSelector Node labels for Redis™ replicas pods assignment {}
replica.tolerations Tolerations for Redis™ replicas pods assignment []
replica.spreadConstraints Spread Constraints for Redis™ replicas pod assignment {}
replica.lifecycleHooks for the Redis™ replica container(s) to automate configuration before or after startup {}
replica.extraVolumes Optionally specify extra list of additional volumes for the Redis™ replicas pod(s) []
replica.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Redis™ replicas container(s) []
replica.sidecars Add additional sidecar containers to the Redis™ replicas pod(s) []
replica.initContainers Add additional init containers to the Redis™ replicas pod(s) []
replica.persistence.enabled Enable persistence on Redis™ replicas nodes using Persistent Volume Claims true
replica.persistence.medium Provide a medium for emptyDir volumes. ""
replica.persistence.path The path the volume will be mounted at on Redis™ replicas containers /data
replica.persistence.subPath The subdirectory of the volume to mount on Redis™ replicas containers ""
replica.persistence.storageClass Persistent Volume storage class ""
replica.persistence.accessModes Persistent Volume access modes []
replica.persistence.size Persistent Volume size 8Gi
replica.persistence.annotations Additional custom annotations for the PVC {}
replica.persistence.selector Additional labels to match for the PVC {}
replica.persistence.dataSource Custom PVC data source {}
replica.service.type Redis™ replicas service type ClusterIP
replica.service.port Redis™ replicas service port 6379
replica.service.nodePort Node port for Redis™ replicas ""
replica.service.externalTrafficPolicy Redis™ replicas service external traffic policy Cluster
replica.service.clusterIP Redis™ replicas service Cluster IP ""
replica.service.loadBalancerIP Redis™ replicas service Load Balancer IP ""
replica.service.loadBalancerSourceRanges Redis™ replicas service Load Balancer sources []
replica.service.annotations Additional custom annotations for Redis™ replicas service {}
replica.terminationGracePeriodSeconds Integer setting the termination grace period for the redis-replicas pods 30
replica.autoscaling.enabled Enable replica autoscaling settings false
replica.autoscaling.minReplicas Minimum replicas for the pod autoscaling 1
replica.autoscaling.maxReplicas Maximum replicas for the pod autoscaling 11
replica.autoscaling.targetCPU Percentage of CPU to consider when autoscaling ""
replica.autoscaling.targetMemory Percentage of Memory to consider when autoscaling ""

Redis™ Sentinel configuration parameters

Name Description Value
sentinel.enabled Use Redis™ Sentinel on Redis™ pods. false
sentinel.image.registry Redis™ Sentinel image registry docker.io
sentinel.image.repository Redis™ Sentinel image repository bitnami/redis-sentinel
sentinel.image.tag Redis™ Sentinel image tag (immutable tags are recommended) 6.2.6-debian-10-r49
sentinel.image.pullPolicy Redis™ Sentinel image pull policy IfNotPresent
sentinel.image.pullSecrets Redis™ Sentinel image pull secrets []
sentinel.image.debug Enable image debug mode false
sentinel.masterSet Master set name mymaster
sentinel.quorum Sentinel Quorum 2
sentinel.automateClusterRecovery Automate cluster recovery in cases where the last replica is not considered a good replica and Sentinel won’t automatically failover to it. false
sentinel.downAfterMilliseconds Timeout for detecting a Redis™ node is down 60000
sentinel.failoverTimeout Timeout for performing a election failover 18000
sentinel.parallelSyncs Number of replicas that can be reconfigured in parallel to use the new master after a failover 1
sentinel.configuration Configuration for Redis™ Sentinel nodes ""
sentinel.command Override default container command (useful when using custom images) []
sentinel.args Override default container args (useful when using custom images) []
sentinel.preExecCmds Additional commands to run prior to starting Redis™ Sentinel []
sentinel.extraEnvVars Array with extra environment variables to add to Redis™ Sentinel nodes []
sentinel.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for Redis™ Sentinel nodes ""
sentinel.extraEnvVarsSecret Name of existing Secret containing extra env vars for Redis™ Sentinel nodes ""
sentinel.containerPort Container port to open on Redis™ Sentinel nodes 26379
sentinel.livenessProbe.enabled Enable livenessProbe on Redis™ Sentinel nodes true
sentinel.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 20
sentinel.livenessProbe.periodSeconds Period seconds for livenessProbe 5
sentinel.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
sentinel.livenessProbe.failureThreshold Failure threshold for livenessProbe 5
sentinel.livenessProbe.successThreshold Success threshold for livenessProbe 1
sentinel.readinessProbe.enabled Enable readinessProbe on Redis™ Sentinel nodes true
sentinel.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 20
sentinel.readinessProbe.periodSeconds Period seconds for readinessProbe 5
sentinel.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 1
sentinel.readinessProbe.failureThreshold Failure threshold for readinessProbe 5
sentinel.readinessProbe.successThreshold Success threshold for readinessProbe 1
sentinel.customLivenessProbe Custom livenessProbe that overrides the default one {}
sentinel.customReadinessProbe Custom readinessProbe that overrides the default one {}
sentinel.resources.limits The resources limits for the Redis™ Sentinel containers {}
sentinel.resources.requests The requested resources for the Redis™ Sentinel containers {}
sentinel.containerSecurityContext.enabled Enabled Redis™ Sentinel containers’ Security Context true
sentinel.containerSecurityContext.runAsUser Set Redis™ Sentinel containers’ Security Context runAsUser 1001
sentinel.lifecycleHooks for the Redis™ sentinel container(s) to automate configuration before or after startup {}
sentinel.extraVolumes Optionally specify extra list of additional volumes for the Redis™ Sentinel []
sentinel.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Redis™ Sentinel container(s) []
sentinel.service.type Redis™ Sentinel service type ClusterIP
sentinel.service.port Redis™ service port for Redis™ 6379
sentinel.service.sentinelPort Redis™ service port for Sentinel 26379
sentinel.service.nodePorts.redis Node port for Redis™ ""
sentinel.service.nodePorts.sentinel Node port for Sentinel ""
sentinel.service.externalTrafficPolicy Redis™ Sentinel service external traffic policy Cluster
sentinel.service.clusterIP Redis™ Sentinel service Cluster IP ""
sentinel.service.loadBalancerIP Redis™ Sentinel service Load Balancer IP ""
sentinel.service.loadBalancerSourceRanges Redis™ Sentinel service Load Balancer sources []
sentinel.service.annotations Additional custom annotations for Redis™ Sentinel service {}
sentinel.terminationGracePeriodSeconds Integer setting the termination grace period for the redis-node pods 30

Other Parameters

Name Description Value
networkPolicy.enabled Enable creation of NetworkPolicy resources false
networkPolicy.allowExternal Don’t require client label for connections true
networkPolicy.extraIngress Add extra ingress rules to the NetworkPolicy []
networkPolicy.extraEgress Add extra ingress rules to the NetworkPolicy []
networkPolicy.ingressNSMatchLabels Labels to match to allow traffic from other namespaces {}
networkPolicy.ingressNSPodMatchLabels Pod labels to match to allow traffic from other namespaces {}
podSecurityPolicy.create Whether to create a PodSecurityPolicy. WARNING: PodSecurityPolicy is deprecated in Kubernetes v1.21 or later, unavailable in v1.25 or later false
podSecurityPolicy.enabled Enable PodSecurityPolicy’s RBAC rules false
rbac.create Specifies whether RBAC resources should be created false
rbac.rules Custom RBAC rules to set []
serviceAccount.create Specifies whether a ServiceAccount should be created true
serviceAccount.name The name of the ServiceAccount to use. ""
serviceAccount.automountServiceAccountToken Whether to auto mount the service account token true
serviceAccount.annotations Additional custom annotations for the ServiceAccount {}
pdb.create Specifies whether a PodDisruptionBudget should be created false
pdb.minAvailable Min number of pods that must still be available after the eviction 1
pdb.maxUnavailable Max number of pods that can be unavailable after the eviction ""
tls.enabled Enable TLS traffic false
tls.authClients Require clients to authenticate true
tls.autoGenerated Enable autogenerated certificates false
tls.existingSecret The name of the existing secret that contains the TLS certificates ""
tls.certificatesSecret DEPRECATED. Use existingSecret instead. ""
tls.certFilename Certificate filename ""
tls.certKeyFilename Certificate Key filename ""
tls.certCAFilename CA Certificate filename ""
tls.dhParamsFilename File containing DH params (in order to support DH based ciphers) ""

Metrics Parameters

Name Description Value
metrics.enabled Start a sidecar prometheus exporter to expose Redis™ metrics false
metrics.image.registry Redis™ Exporter image registry docker.io
metrics.image.repository Redis™ Exporter image repository bitnami/redis-exporter
metrics.image.tag Redis™ Redis™ Exporter image tag (immutable tags are recommended) 1.31.4-debian-10-r6
metrics.image.pullPolicy Redis™ Exporter image pull policy IfNotPresent
metrics.image.pullSecrets Redis™ Exporter image pull secrets []
metrics.redisTargetHost A way to specify an alternative Redis™ hostname localhost
metrics.extraArgs Extra arguments for Redis™ exporter, for example: {}
metrics.containerSecurityContext.enabled Enabled Redis™ exporter containers’ Security Context true
metrics.containerSecurityContext.runAsUser Set Redis™ exporter containers’ Security Context runAsUser 1001
metrics.extraVolumes Optionally specify extra list of additional volumes for the Redis™ metrics sidecar []
metrics.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the Redis™ metrics sidecar []
metrics.resources.limits The resources limits for the Redis™ exporter container {}
metrics.resources.requests The requested resources for the Redis™ exporter container {}
metrics.podLabels Extra labels for Redis™ exporter pods {}
metrics.podAnnotations Annotations for Redis™ exporter pods {}
metrics.service.type Redis™ exporter service type ClusterIP
metrics.service.port Redis™ exporter service port 9121
metrics.service.externalTrafficPolicy Redis™ exporter service external traffic policy Cluster
metrics.service.loadBalancerIP Redis™ exporter service Load Balancer IP ""
metrics.service.loadBalancerSourceRanges Redis™ exporter service Load Balancer sources []
metrics.service.annotations Additional custom annotations for Redis™ exporter service {}
metrics.serviceMonitor.enabled Create ServiceMonitor resource(s) for scraping metrics using PrometheusOperator false
metrics.serviceMonitor.namespace The namespace in which the ServiceMonitor will be created ""
metrics.serviceMonitor.interval The interval at which metrics should be scraped 30s
metrics.serviceMonitor.scrapeTimeout The timeout after which the scrape is ended ""
metrics.serviceMonitor.relabellings Metrics RelabelConfigs to apply to samples before scraping. []
metrics.serviceMonitor.metricRelabelings Metrics RelabelConfigs to apply to samples before ingestion. []
metrics.serviceMonitor.honorLabels Specify honorLabels parameter to add the scrape endpoint false
metrics.serviceMonitor.additionalLabels Additional labels that can be used so ServiceMonitor resource(s) can be discovered by Prometheus {}
metrics.prometheusRule.enabled Create a custom prometheusRule Resource for scraping metrics using PrometheusOperator false
metrics.prometheusRule.namespace The namespace in which the prometheusRule will be created ""
metrics.prometheusRule.additionalLabels Additional labels for the prometheusRule {}
metrics.prometheusRule.rules Custom Prometheus rules []

Init Container Parameters

Name Description Value
volumePermissions.enabled Enable init container that changes the owner/group of the PV mount point to runAsUser:fsGroup false
volumePermissions.image.registry Bitnami Shell image registry docker.io
volumePermissions.image.repository Bitnami Shell image repository bitnami/bitnami-shell
volumePermissions.image.tag Bitnami Shell image tag (immutable tags are recommended) 10-debian-10-r261
volumePermissions.image.pullPolicy Bitnami Shell image pull policy IfNotPresent
volumePermissions.image.pullSecrets Bitnami Shell image pull secrets []
volumePermissions.resources.limits The resources limits for the init container {}
volumePermissions.resources.requests The requested resources for the init container {}
volumePermissions.containerSecurityContext.runAsUser Set init container’s Security Context runAsUser 0
sysctl.enabled Enable init container to modify Kernel settings false
sysctl.image.registry Bitnami Shell image registry docker.io
sysctl.image.repository Bitnami Shell image repository bitnami/bitnami-shell
sysctl.image.tag Bitnami Shell image tag (immutable tags are recommended) 10-debian-10-r261
sysctl.image.pullPolicy Bitnami Shell image pull policy IfNotPresent
sysctl.image.pullSecrets Bitnami Shell image pull secrets []
sysctl.command Override default init-sysctl container command (useful when using custom images) []
sysctl.mountHostSys Mount the host /sys folder to /host-sys false
sysctl.resources.limits The resources limits for the init container {}
sysctl.resources.requests The requested resources for the init container {}

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

$ helm install my-release \
  --set auth.password=secretpassword \
    bitnami/redis

The above command sets the Redis™ server password to secretpassword.

NOTE: Once this chart is deployed, it is not possible to change the application’s access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application’s built-in administrative tools if available.

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

$ helm install my-release -f values.yaml bitnami/redis

Tip: You can use the default values.yaml

Configuration and installation details

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Use a different Redis™ version

To modify the application version used in this chart, specify a different version of the image using the image.tag parameter and/or a different repository using the image.repository parameter. Refer to the chart documentation for more information on these parameters and how to use them with images from a private registry.

Cluster topologies

Default: Master-Replicas

When installing the chart with architecture=replication, it will deploy a Redis™ master StatefulSet (only one master node allowed) and a Redis™ replicas StatefulSet. The replicas will be read-replicas of the master. Two services will be exposed:

In case the master crashes, the replicas will wait until the master node is respawned again by the Kubernetes Controller Manager.

Standalone

When installing the chart with architecture=standalone, it will deploy a standalone Redis™ StatefulSet (only one node allowed) and a Redis™ replicas StatefulSet. A single service will be exposed:

Master-Replicas with Sentinel

When installing the chart with architecture=replication and sentinel.enabled=true, it will deploy a Redis™ master StatefulSet (only one master allowed) and a Redis™ replicas StatefulSet. In this case, the pods will contain an extra container with Redis™ Sentinel. This container will form a cluster of Redis™ Sentinel nodes, which will promote a new master in case the actual one fails. In addition to this, only one service is exposed:

For read-only operations, access the service using port 6379. For write operations, it’s necessary to access the Redis™ Sentinel cluster and query the current master using the command below (using redis-cli or similar):

SENTINEL get-master-addr-by-name <name of your MasterSet. e.g: mymaster>

This command will return the address of the current master, which can be accessed from inside the cluster.

In case the current master crashes, the Sentinel containers will elect a new master node.

Using a password file

To use a password file for Redis™ you need to create a secret containing the password and then deploy the chart using that secret.

Refer to the chart documentation for more information on using a password file for Redis™.

Securing traffic using TLS

TLS support can be enabled in the chart by specifying the tls. parameters while creating a release. The following parameters should be configured to properly enable the TLS support in the chart:

Refer to the chart documentation for more information on creating the secret and a TLS deployment example.

Metrics

The chart optionally can start a metrics exporter for prometheus. The metrics endpoint (port 9121) is exposed in the service. Metrics can be scraped from within the cluster using something similar as the described in the example Prometheus scrape configuration. If metrics are to be scraped from outside the cluster, the Kubernetes API proxy can be utilized to access the endpoint.

If you have enabled TLS by specifying tls.enabled=true you also need to specify TLS option to the metrics exporter. You can do that via metrics.extraArgs. You can find the metrics exporter CLI flags for TLS here. For example:

You can either specify metrics.extraArgs.skip-tls-verification=true to skip TLS verification or providing the following values under metrics.extraArgs for TLS client authentication:

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

Host Kernel Settings

Redis™ may require some changes in the kernel of the host machine to work as expected, in particular increasing the somaxconn value and disabling transparent huge pages.

Refer to the chart documentation for more information on configuring host kernel settings with an example.

Persistence

By default, the chart mounts a Persistent Volume at the /data path. The volume is created using dynamic volume provisioning. If a Persistent Volume Claim already exists, specify it during installation.

Existing PersistentVolumeClaim

  1. Create the PersistentVolume
  2. Create the PersistentVolumeClaim
  3. Install the chart
$ helm install my-release --set master.persistence.existingClaim=PVC_NAME bitnami/redis

Backup and restore

Refer to the chart documentation for more information on backing up and restoring Redis™ deployments.

NetworkPolicy

To enable network policy for Redis™, install a networking plugin that implements the Kubernetes NetworkPolicy spec, and set networkPolicy.enabled to true.

Refer to the chart documenation for more information on enabling the network policy in Redis™ deployments.

Setting Pod’s affinity

This chart allows you to set your custom affinity using the XXX.affinity parameter(s). Find more infomation about Pod’s affinity in the Kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the XXX.podAffinityPreset, XXX.podAntiAffinityPreset, or XXX.nodeAffinityPreset parameters.

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions.

To 15.0.0

The parameter to enable the usage of StaticIDs was removed. The behavior is to always use StaticIDs.

To 14.8.0

The Redis™ sentinel exporter was removed in this version because the upstream project was deprecated. The regular Redis™ exporter is included in the sentinel scenario as usual.

To 14.0.0

Consequences:

Backwards compatibility is not guaranteed. To upgrade to 14.0.0, install a new release of the Redis™ chart, and migrate the data from your previous release. You have 2 alternatives to do so:

$ helm install redis bitnami/redis --set auth.password=[PASSWORD] --set master.persistence.existingClaim=[EXISTING_PVC]
Note: you need to substitute the placeholder [EXISTING_PVC] with the name of the PVC used on your previous release, and [PASSWORD] with the password used in your previous release.

To 13.0.0

This major version updates the Redis™ docker image version used from 6.0 to 6.2, the new stable version. There are no major changes in the chart and there shouldn’t be any breaking changes in it as 6.2 is basically a stricter superset of 6.0. For more information, please refer to Redis™ 6.2 release notes.

To 12.3.0

This version also introduces bitnami/common, a library chart as a dependency. More documentation about this new utility could be found here. Please, make sure that you have updated the chart dependencies before executing any upgrade.

To 12.0.0

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

What changes were introduced in this major version?

Considerations when upgrading to this version

Useful links

To 11.0.0

When deployed with sentinel enabled, only a group of nodes is deployed and the master/slave role is handled in the group. To avoid breaking the compatibility, the settings for this nodes are given through the slave.xxxx parameters in values.yaml

To 9.0.0

The metrics exporter has been changed from a separate deployment to a sidecar container, due to the latest changes in the Redis™ exporter code. Check the official page for more information. The metrics container image was changed from oliver006/redis_exporter to bitnami/redis-exporter (Bitnami’s maintained package of oliver006/redis_exporter).

To 7.0.0

In order to improve the performance in case of slave failure, we added persistence to the read-only slaves. That means that we moved from Deployment to StatefulSets. This should not affect upgrades from previous versions of the chart, as the deployments did not contain any persistence at all.

This version also allows enabling Redis™ Sentinel containers inside of the Redis™ Pods (feature disabled by default). In case the master crashes, a new Redis™ node will be elected as master. In order to query the current master (no redis master service is exposed), you need to query first the Sentinel cluster. Find more information in this section.

To 11.0.0

When using sentinel, a new statefulset called -node was introduced. This will break upgrading from a previous version where the statefulsets are called master and slave. Hence the PVC will not match the new naming and won’t be reused. If you want to keep your data, you will need to perform a backup and then a restore the data in this new version.

To 10.0.0

For releases with usePassword: true, the value sentinel.usePassword controls whether the password authentication also applies to the sentinel port. This defaults to true for a secure configuration, however it is possible to disable to account for the following cases:

If using a master/slave topology, or with usePassword: false, no action is required.

To 8.0.18

For releases with metrics.enabled: true the default tag for the exporter image is now v1.x.x. This introduces many changes including metrics names. You’ll want to use this dashboard now. Please see the redis_exporter github page for more details.

To 7.0.0

This version causes a change in the Redis™ Master StatefulSet definition, so the command helm upgrade would not work out of the box. As an alternative, one of the following could be done:

Previous versions of the chart were not using persistence in the slaves, so this upgrade would add it to them. Another important change is that no values are inherited from master to slaves. For example, in 6.0.0 slaves.readinessProbe.periodSeconds, if empty, would be set to master.readinessProbe.periodSeconds. This approach lacked transparency and was difficult to maintain. From now on, all the slave parameters must be configured just as it is done with the masters.

Some values have changed as well:

By default, the upgrade will not change the cluster topology. In case you want to use Redis™ Sentinel, you must explicitly set sentinel.enabled to true.

To 6.0.0

Previous versions of the chart were using an init-container to change the permissions of the volumes. This was done in case the securityContext directive in the template was not enough for that (for example, with cephFS). In this new version of the chart, this container is disabled by default (which should not affect most of the deployments). If your installation still requires that init container, execute helm upgrade with the --set volumePermissions.enabled=true.

To 5.0.0

The default image in this release may be switched out for any image containing the redis-server and redis-cli binaries. If redis-server is not the default image ENTRYPOINT, master.command must be specified.

Breaking changes

To 4.0.0

This version removes the chart label from the spec.selector.matchLabels which is immutable since StatefulSet apps/v1beta2. It has been inadvertently added, causing any subsequent upgrade to fail. See https://github.com/helm/charts/issues/7726.

It also fixes https://github.com/helm/charts/issues/7726 where a deployment extensions/v1beta1 can not be upgraded if spec.selector is not explicitly set.

Finally, it fixes https://github.com/helm/charts/issues/7803 by removing mutable labels in spec.VolumeClaimTemplate.metadata.labels so that it is upgradable.

In order to upgrade, delete the Redis™ StatefulSet before upgrading:

kubectl delete statefulsets.apps --cascade=false my-release-redis-master

And edit the Redis™ slave (and metrics if enabled) deployment:

kubectl patch deployments my-release-redis-slave --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
kubectl patch deployments my-release-redis-metrics --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
This site is open source. Improve this page.