Module: REDIS

Deploy redis in standalone, cluster or sentinel mode.

Configuration

Redis Identity

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

Name Attribute Description Example
redis_cluster REQUIRED, cluster level cluster name redis-test
redis_node REQUIRED，node level Node Sequence Number 1,2
redis_instances REQUIRED，node level Instance Definition { 6001 : {} ,6002 : {}}
  • 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:

1. redis-ms: # redis classic primary & replica
2. hosts: { 10.10.10.10: { redis_node: 1 , redis_instances: { 6501: { }, 6502: { replica_of: '10.10.10.10 6501' } } } }
3. vars: { redis_cluster: redis-ms ,redis_max_memory: 64MB }

5. redis-meta: # redis sentinel x 3
6. hosts: { 10.10.10.11: { redis_node: 1 , redis_instances: { 6001: { } ,6002: { } , 6003: { } } } }
7. vars: { redis_cluster: redis-meta, redis_mode: sentinel ,redis_max_memory: 16MB }

9. redis-test: # redis native cluster: 3m x 3s
10. hosts:
11. 10.10.10.12: { redis_node: 1 ,redis_instances: { 6501: { } ,6502: { } ,6503: { } } }
12. 10.10.10.13: { redis_node: 2 ,redis_instances: { 6501: { } ,6502: { } ,6503: { } } }
13. 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:

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

1. bin/redis-add redis-ms          # create redis cluster 'redis-ms'
2. bin/redis-add 10.10.10.10       # create redis node '10.10.10.10'
3. bin/redis-add 10.10.10.10 6501  # create redis instance '10.10.10.10:6501'

5. bin/redis-rm redis-ms           # remove redis cluster 'redis-ms'
6. bin/redis-rm 10.10.10.10        # remove redis node '10.10.10.10'
7. bin/redis-rm 10.10.10.10 6501   # remove redis instance '10.10.10.10:6501'

Administration

Init Cluster/Node/Instance

1. # init all redis instances on group <cluster>
2. ./redis.yml -l <cluster>      # create redis cluster

4. # init redis node (package,dir,exporter)
5. ./redis.yml -l 10.10.10.10    # create redis cluster

7. # init all redis instances specific node
8. ./redis.yml -l 10.10.10.10    # create redis cluster

10. # init one specific instance 10.10.10.11:6501
11. ./redis.yml -l 10.10.10.11 -e redis_port=6501 -t redis

You can also use wrapper script:

1. bin/redis-add redis-ms          # create redis cluster 'redis-ms'
2. bin/redis-add 10.10.10.10       # create redis node '10.10.10.10'
3. bin/redis-add 10.10.10.10 6501  # create redis instance '10.10.10.10:6501'

Remove Cluster/Node/Instance

1. # Remove cluster `redis-test`
2. redis-rm.yml -l redis-test

4. # Remove cluster `redis-test`, and uninstall packages
5. redis-rm.yml -l redis-test -e redis_uninstall=true

7. # Remove all instance on redis node 10.10.10.13
8. redis-rm.yml -l 10.10.10.13

10. # Remove one specific instance 10.10.10.13:6501
11. redis-rm.yml -l 10.10.10.13 -e redis_port=6501

You can also use wrapper script:

1. bin/redis-rm redis-ms          # remove redis cluster 'redis-ms'
2. bin/redis-rm 10.10.10.10       # remove redis node '10.10.10.10'
3. 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

Module: REDIS - 图1

Redis Cluster

Overview of a redis cluster

Module: REDIS - 图2

Redis Instance

Detail information about a single redis instance

Module: REDIS - 图3

Parameters

There are 3 sections, 20 parameters about REDIS module.

Parameter Type Level Comment
redis_cluster string C redis cluster name, required identity parameter
redis_instances dict I redis instances definition on this redis node
redis_node int I redis node sequence number, node int id required
redis_fs_main path C redis main data mountpoint, /data by default
redis_exporter_enabled bool C install redis exporter on redis nodes?
redis_exporter_port port C redis exporter listen port, 9121 by default
redis_exporter_options string C/I cli args and extra options for redis exporter
redis_safeguard bool C prevent purging running redis instance?
redis_clean bool C purging existing redis during init?
redis_rmdata bool A remove redis data when purging redis server?
redis_mode enum C redis mode: standalone,cluster,sentinel
redis_conf string C redis config template path, except sentinel
redis_bind_address ip C redis bind address, empty string will use host ip
redis_max_memory size C/I max memory used by each redis instance
redis_mem_policy enum C redis memory eviction policy
redis_password password C redis password, empty string will disable password
redis_rdb_save string[] C redis rdb save directives, disable with empty list
redis_aof_enabled bool C enable redis append only file?
redis_rename_commands dict C rename redis dangerous commands
redis_cluster_replicas int C replica number for one master in redis cluster

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