observability.svc.plus/roles/redis_remove
2026-02-01 20:53:55 +08:00
..
defaults Remove sensitive files 2026-02-01 20:53:55 +08:00
meta Remove sensitive files 2026-02-01 20:53:55 +08:00
tasks Remove sensitive files 2026-02-01 20:53:55 +08:00
README.md Remove sensitive files 2026-02-01 20:53:55 +08:00

Role: redis_remove

Remove Redis Instances from Node

Module REDIS
Docs https://pigsty.io/docs/redis/admin
Related Roles redis

Overview

The redis_remove role removes Redis instances from a node:

  • Check safeguard protection (redis_safeguard)
  • Deregister from Victoria Metrics
  • Deregister from Vector logging
  • Stop redis_exporter service
  • Stop Redis instance services
  • Remove data directories (redis_rm_data)
  • Uninstall packages (redis_rm_pkg)

Only nodes with redis_cluster defined will be affected. Supports removing single instance (via redis_port) or entire node.

Playbooks

Playbook Description
redis-rm.yml Remove Redis instance

File Structure

roles/redis_remove/
├── defaults/
│   └── main.yml              # Default variables
├── meta/
│   └── main.yml              # Role dependencies
└── tasks/
    └── main.yml              # Removal logic

Tags

Tag Hierarchy

redis_remove (full role)
│
├── redis_safeguard            # Safeguard check (always)
│
├── redis_deregister           # Deregister from monitoring
│   ├── rm_metrics             # Remove Victoria targets
│   └── rm_logs                # Remove Vector config
│
├── redis_exporter             # Stop redis_exporter
│
├── redis                      # Stop Redis services
│
├── redis_data                 # Remove data directories
│
└── redis_pkg                  # Uninstall packages

Key Variables

Variable Default Description
redis_safeguard false Prevent accidental removal
redis_rm_data true Remove data directories
redis_rm_pkg false Uninstall Redis packages

CLI Arguments

Remove Entire Node

./redis-rm.yml -l <host>

Remove Single Instance

./redis-rm.yml -l <host> -e redis_port=6379

Safeguard Protection

Enable safeguard to prevent accidental removal:

redis-cluster:
  vars:
    redis_safeguard: true

Override with:

./redis-rm.yml -l <target> -e redis_safeguard=false

Removal Scope

Component What's Removed
Monitoring /infra/targets/redis/<cluster>-<node>.yml
Logging /etc/vector/redis.yaml
Data /data/redis/ (all instances)
Packages redis, redis_exporter (if enabled)

See Also