Module: REDIS

Deploy redis in standalone, cluster or sentinel mode.

Configuration

Redis Identity

Redis identity parameters are required parameters when defining a Redis cluster.

• redis_cluster: Redis cluster name, top-level namespace for cluster sources.
• redis_node: Redis node identity, integer the number of the node in the cluster.
• redis_instances: A Dict with the Key as redis port and the value as a instance level parameters.

Redis Mode

There are three redis_mode available in Pigsty:

• standalone: setup redis as standalone (master-slave) mode
• cluster: setup this redis cluster as a redis native cluster
• sentinel: setup redis as sentinel for standalone redis HA

Redis Definition

Here are three examples:

redis-ms: # redis classic primary & replica
  hosts: { 10.10.10.10: { redis_node: 1 , redis_instances: { 6501: { }, 6502: { replica_of: '10.10.10.10 6501' } } } }
  vars: { redis_cluster: redis-ms ,redis_max_memory: 64MB }
redis-meta: # redis sentinel x 3
  hosts: { 10.10.10.11: { redis_node: 1 , redis_instances: { 6001: { } ,6002: { } , 6003: { } } } }
  vars: { redis_cluster: redis-meta, redis_mode: sentinel ,redis_max_memory: 16MB }
redis-test: # redis native cluster: 3m x 3s
  hosts:
    10.10.10.12: { redis_node: 1 ,redis_instances: { 6501: { } ,6502: { } ,6503: { } } }
    10.10.10.13: { redis_node: 2 ,redis_instances: { 6501: { } ,6502: { } ,6503: { } } }
  vars: { redis_cluster: redis-test ,redis_mode: cluster, redis_max_memory: 32MB }

Limitation

• A redis node can only belong to one redis cluster
• You can not set different password for redis instances on same redis node (since redis_exporter only allows one password)

Playbook

There are two playbooks for redis:

• redis.yml: create redis cluster / node / instance
• redis-rm.yml: remove redis cluster /node /instance

You can also create & destroy redis cluster/node/instance with util scripts:

bin/redis-add redis-ms          # create redis cluster 'redis-ms'
bin/redis-add 10.10.10.10       # create redis node '10.10.10.10'
bin/redis-add 10.10.10.10 6501  # create redis instance '10.10.10.10:6501'
bin/redis-rm redis-ms           # remove redis cluster 'redis-ms'
bin/redis-rm 10.10.10.10        # remove redis node '10.10.10.10'
bin/redis-rm 10.10.10.10 6501   # remove redis instance '10.10.10.10:6501'

Administration

Init Cluster/Node/Instance

# init all redis instances on group <cluster>
./redis.yml -l <cluster>      # create redis cluster
# init redis node (package,dir,exporter)
./redis.yml -l 10.10.10.10    # create redis cluster
# init all redis instances specific node
./redis.yml -l 10.10.10.10    # create redis cluster
# init one specific instance 10.10.10.11:6501
./redis.yml -l 10.10.10.11 -e redis_port=6501 -t redis

You can also use wrapper script:

bin/redis-add redis-ms          # create redis cluster 'redis-ms'
bin/redis-add 10.10.10.10       # create redis node '10.10.10.10'
bin/redis-add 10.10.10.10 6501  # create redis instance '10.10.10.10:6501'

Remove Cluster/Node/Instance

# Remove cluster `redis-test`
redis-rm.yml -l redis-test
# Remove cluster `redis-test`, and uninstall packages
redis-rm.yml -l redis-test -e redis_uninstall=true
# Remove all instance on redis node 10.10.10.13
redis-rm.yml -l 10.10.10.13
# Remove one specific instance 10.10.10.13:6501
redis-rm.yml -l 10.10.10.13 -e redis_port=6501

You can also use wrapper script:

bin/redis-rm redis-ms          # remove redis cluster 'redis-ms'
bin/redis-rm 10.10.10.10       # remove redis node '10.10.10.10'
bin/redis-rm 10.10.10.10 6501  # remove redis instance '10.10.10.10:6501'

Dashboards

There are three dashboards for REDIS module.

Redis Overview

Overview of all Redis Instances

Redis Cluster

Overview of a redis cluster

Redis Instance

Detail information about a single redis instance

Parameters

There are 3 sections, 20 parameters about REDIS module.

• REDIS_ID : REDIS Identity Parameters
• REDIS_NODE : REDIS Node & Exporter
• REDIS_PROVISION : Config & Launch Redis Instances

Last modified 2023-02-27: add v2.0 images and docs (5b09f12)