Module: REDIS

Deploy Redis or Valkey through one REDIS module, with standalone replication, native cluster, and Sentinel modes.

REDIS is Pigsty’s Redis-compatible cache module. Choose Redis or Valkey with redis_type; the default remains redis. Both engines support primary-replica replication, Sentinel, and native cluster mode while sharing configuration paths, instance service names, monitoring, and log entry points.

redis_type: redis   # default; valkey is also supported

The role installs the selected engine and redis-exporter. Instance processes use redis-server / redis-cli or valkey-server / valkey-cli, respectively. Changing redis_type changes packages and binaries; it does not automatically validate data formats, replication topology, or rollback. Rehearse any existing-cluster switch, and use one engine consistently across a logical cluster.

The default Redis package remains on the 7.2 BSD branch. Patch versions can differ by operating-system repository; treat the target repository metadata as authoritative.


Configuration

Choose the appropriate Redis mode for your use case and express your requirements through the inventory

Parameters

The REDIS module provides 19 deployment and 3 removal parameters, with Redis or Valkey as the engine.

Playbook

Manage Redis clusters with Ansible playbooks and quick command reference.

Administration

Redis cluster management SOPs for creating, destroying, scaling, and configuring high availability

Monitoring

How to monitor Redis? What alert rules are worth paying attention to?

Metrics

Complete list of monitoring metrics provided by the Pigsty REDIS module with explanations

FAQ

Frequently asked questions about the Pigsty REDIS module


Last Modified: 2026-08-10: calibrate for pigsty 4.5 (3683ee2b)