Skip to main content

Overview

Redis Multi-Location deploys a master-replica Redis cluster with Redis Sentinel across multiple Control Plane locations, providing geographic distribution and automatic failover. Unlike the standard Redis template, this template creates its own GVC spanning the configured locations.
This template creates a new GVC. At least 2 locations are required.

What Gets Created

  • GVC — A new GVC spanning the configured locations.
  • Stateful Workload — Redis (RELEASE_NAME-redis): replica 0 starts as the primary; all others replicate from it. The per-location replica count is independently configurable.
  • Stateful Workload — Sentinel (RELEASE_NAME-sentinel): 1 replica per location monitors the Redis cluster and orchestrates automatic failover.
  • Volume Set — Persistent storage for Redis data (configurable capacity).
  • Volume Set — Persistent storage for Sentinel state (10 GiB, fixed).
  • Secret — An opaque secret containing the Redis configuration (redis.conf), mounted into each Redis container.
  • Secret — An opaque secret containing the Sentinel configuration (sentinel.conf), mounted into each Sentinel container.
  • Identity & Policy — Separate identities and policies for the Redis and Sentinel workloads, each with reveal access to their respective secrets.

Installation

To install, follow the instructions for your preferred method:

Configuration

The default values.yaml for this template:
gvc:
  name: my-redis-gvc
  locations: # Replica count applies to the Redis workload only; Sentinel always runs 1 per location
    - name: aws-eu-central-1
      replicas: 2
    - name: aws-us-west-2
      replicas: 2
    - name: aws-us-east-1
      replicas: 2

redis:
  image: redis:7.2
  resources:
    cpu: 200m
    memory: 256Mi
  # serverCommand: redis-server  # Override for different Redis/Valkey image variants
  # extraArgs: "--maxclients 20000 --maxmemory 200mb --maxmemory-policy allkeys-lru"
  # password: your-redis-password
  volumeset:
    initialCapacity: 20 # GiB
    autoscaling:
      enabled: false
      maxCapacity: 100 # GiB
      minFreePercentage: 10
      scalingFactor: 1.2

sentinel:
  image: redis:7.2
  resources:
    cpu: 200m
    memory: 256Mi
  quorum: 2
  # extraArgs: "--sentinel down-after-milliseconds mymaster 5000 --sentinel failover-timeout mymaster 10000"
  # password: your-sentinel-password

# Applies to both Redis and Sentinel workloads
firewall:
  internalAllowType: same-gvc # options: same-gvc, same-org, workload-list
  # workloads:
  #   - //gvc/GVC_NAME/workload/WORKLOAD_NAME

Locations

  • gvc.name — Name of the GVC to create. Must be unique within your organization if deploying multiple instances.
  • gvc.locations — List of Control Plane locations to deploy into. At least 2 locations are required.
  • locations[].name — Location identifier (e.g. aws-us-east-1).
  • locations[].replicas — Number of Redis replicas to run in that location. Sentinel always runs exactly 1 replica per location regardless of this setting.

Authentication

Authentication is disabled by default. Redis and Sentinel can be configured with independent passwords.
  • redis.password — Password applied as both requirepass and masterauth in the Redis configuration.
  • sentinel.password — Optional separate password for Sentinel-to-Sentinel communication (requirepass on the Sentinel process).

Redis

  • redis.image — Redis (or Valkey) image to use.
  • redis.resources.cpu / redis.resources.memory — CPU and memory allocated per Redis replica.
  • redis.serverCommand — Override the server command (e.g. valkey-server for Valkey images).
  • redis.extraArgs — Additional server arguments appended to the startup command.

Sentinel

Sentinel monitors the Redis primary and promotes a replica on failure. The quorum must be set to a value that can form a majority across all running Sentinel instances.
  • sentinel.image — Redis (or Valkey) image to use for Sentinel.
  • sentinel.resources.cpu / sentinel.resources.memory — CPU and memory allocated per Sentinel replica.
  • sentinel.quorum — Number of Sentinel instances that must agree before a failover is initiated. For 3 locations (3 Sentinel replicas), a quorum of 2 is recommended.
  • sentinel.extraArgs — Additional Sentinel arguments (e.g. custom down-after-milliseconds or failover-timeout).

Storage

  • redis.volumeset.initialCapacity — Initial volume size in GiB for Redis data (default 20).
  • redis.volumeset.autoscaling.enabled — Automatically expand the volume as it fills. When enabled:
    • maxCapacity — Maximum volume size in GiB.
    • minFreePercentage — Trigger a scale-up when free space drops below this percentage.
    • scalingFactor — Multiply current capacity by this factor when scaling up.
Sentinel state storage is always provisioned at 10 GiB with no autoscaling.

Firewall

A single firewall configuration applies to both the Redis and Sentinel workloads.
  • firewall.internalAllowType — Controls which workloads can connect:
ValueDescription
same-gvcAllow access from all workloads in the same GVC (recommended)
same-orgAllow access from all workloads in the same organization
workload-listAllow access only from specific workloads listed in workloads
  • firewall.workloads — List of specific workload links, used when internalAllowType is workload-list.

Connecting to Redis

Connect to Redis from within the same GVC using:
RELEASE_NAME-redis.GVC_NAME.cpln.local:6379
For Sentinel-aware clients, connect through Sentinel to always route to the current primary:
RELEASE_NAME-sentinel.GVC_NAME.cpln.local:26379
The Sentinel master name is mymaster.

Ports

WorkloadPortProtocolDescription
Redis6379TCPRedis data port
Sentinel26379TCPSentinel discovery port

External References