| .. | ||
| defaults | ||
| meta | ||
| tasks | ||
| README.md | ||
Role: etcd_remove
Remove ETCD Cluster Instance
| Module | ETCD |
|---|---|
| Docs | https://pigsty.io/docs/etcd/admin |
| Related Roles | etcd |
Overview
The etcd_remove role removes ETCD instances from a cluster:
- Deregister from Victoria Metrics
- Gracefully leave the cluster
- Stop etcd service
- Remove data directories
- Uninstall packages (optional)
WARNING: Removing etcd nodes can affect cluster quorum. Ensure you maintain majority before removal.
Playbooks
| Playbook | Description |
|---|---|
etcd-rm.yml |
Remove ETCD instance |
File Structure
roles/etcd_remove/
├── defaults/
│ └── main.yml # Default variables
├── meta/
│ └── main.yml # Role dependencies
└── tasks/
├── main.yml # Entry point
└── leave.yml # Graceful cluster leave
Tags
Tag Hierarchy
etcd_remove (full role)
│
├── etcd_safeguard # Safeguard check (always)
│
├── etcd_pause # Pause for confirmation (3s)
│
├── etcd_deregister # Deregister from monitoring
│ └── rm_metrics # Remove Victoria targets
│
├── etcd_leave # Leave cluster gracefully
│
├── etcd_svc # Stop etcd service
│
├── etcd_data # Remove data (if etcd_rm_data)
│
└── etcd_pkg # Uninstall (if etcd_rm_pkg)
Key Variables
| Variable | Default | Description |
|---|---|---|
etcd_safeguard |
false |
Prevent accidental removal |
etcd_rm_data |
true |
Remove data directories |
etcd_rm_pkg |
false |
Uninstall etcd package |
Safeguard Protection
Enable safeguard to prevent accidental removal:
etcd:
vars:
etcd_safeguard: true
Override with:
./etcd-rm.yml -l <target> -e etcd_safeguard=false
Removal Scope
| Component | What's Removed |
|---|---|
| Monitoring | /infra/targets/etcd/<name>.yml |
| Config | /etc/etcd/ |
| Data | /data/etcd/, /var/lib/etcd/ |
| Service | {{ systemd_dir }}/etcd.service |
| Environment | /etc/profile.d/etcdctl.sh |
| Vector | /etc/vector/etcd.yaml |
Cluster Leave Process
- Get current member ID
- Call
etcdctl member remove <id> - Stop local etcd service
- Clean up data (optional)
If graceful leave fails, the role continues with forced removal.
See Also
etcd: Deploy ETCD cluster- ETCD Admin: Administration guide