Redis Operator automates the creation, configuration, and management of highly available Redis clusters with Sentinel failover on Kubernetes.
Redis Operator creates/configures/manages high availability redis with sentinel automatic failover atop Kubernetes.
This tool is used by DevOps and Kubernetes administrators to deploy and manage Redis failover clusters seamlessly within Kubernetes environments. It simplifies Redis high availability setup by automating failover management and resource handling, ensuring resilient Redis deployments without manual intervention.
Ensure Kubernetes cluster version is 1.21 or higher and Redis version is 6 or higher for compatibility. It is recommended to pin the operator version in deployment manifests to prevent unexpected issues from upstream changes. When upgrading, manually update CRDs before upgrading the Helm release to avoid inconsistencies. The operator supports Prometheus monitoring integration via ServiceMonitor resources for observability.
Add the Helm repository: helm repo add redis-operator https://spotahome.github.io/redis-operator
Update Helm repositories: helm repo update
Install the operator using Helm: helm install redis-operator redis-operator/redis-operator
To update CRDs, replace them directly using kubectl with the manifest URL
Upgrade the Helm release: helm upgrade redis-operator redis-operator/redis-operator
Alternatively, deploy using kubectl with the operator manifest URLs
Use kustomize to build and deploy overlays (default, minimal, full) for customized installations
Pin operator version in kustomize builds to ensure stabilityhelm repo add redis-operator https://spotahome.github.io/redis-operator
Adds the redis-operator Helm chart repository.
helm repo update
Updates Helm repositories to get the latest charts.
helm install redis-operator redis-operator/redis-operator
Installs the Redis Operator on the Kubernetes cluster using Helm.
kubectl replace -f https://raw.githubusercontent.com/spotahome/redis-operator/v1.3.0/manifests/databases.spotahome.com_redisfailovers.yaml
Updates the Custom Resource Definitions (CRDs) for Redis failovers.
helm upgrade redis-operator redis-operator/redis-operator
Upgrades the Redis Operator Helm deployment to a newer version.
kubectl create -f https://raw.githubusercontent.com/spotahome/redis-operator/v1.3.0/manifests/databases.spotahome.com_redisfailovers.yaml
Creates the Redis failover CRD using kubectl.
kubectl apply -f https://raw.githubusercontent.com/spotahome/redis-operator/v1.3.0/example/operator/all-redis-operator-resources.yaml
Deploys all necessary Redis Operator resources including deployment and RBAC.
kustomize build github.com/spotahome/redis-operator/manifests/kustomize/overlays/default
Builds the default overlay configuration for Redis Operator deployment using kustomize.
kustomize build github.com/spotahome/redis-operator/manifests/kustomize/overlays/default?ref=v1.2.4
Builds a version-pinned default overlay for stable Redis Operator deployment.