docs: standardize readme format

This commit is contained in:
Simon Cornet 2026-04-10 09:00:13 +02:00
commit 617e298cda

View file

@ -1,14 +1,37 @@
# Overview
# Ansible Role: Keepalived
This role configures KeepaliveD.
Install and configure [Keepalived](https://www.keepalived.org/) for VRRP high availability.
## Supported Operating Systems
## Variables
| Operating System | Version |
| --- | ----- |
| Alpine | 3.23 |
| Debian | 13 |
| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `keepalived_auth_pass` | Yes | `SuperSecurePassword` | VRRP authentication password |
| `keepalived_chk_service` | Yes | - | Service name to check for health |
| `keepalived_id` | Yes | - | Keepalived instance identifier |
| `keepalived_interface` | Yes | `eth0` | Network interface for VRRP |
| `keepalived_priority` | Yes | `101` | VRRP priority (higher = master) |
| `keepalived_state` | Yes | `MASTER` | Initial state (MASTER/BACKUP) |
| `keepalived_unicast_peer` | Yes | - | Peer IP address for unicast VRRP |
| `keepalived_unicast_src_ip` | Yes | - | Source IP address for unicast VRRP |
| `keepalived_virtual_ipaddress` | Yes | - | Virtual IP address to manage |
| `keepalived_virtual_ipaddress_interface` | Yes | `eth0` | Interface for virtual IP |
| `keepalived_vr_id` | Yes | `1` | VRRP virtual router ID |
| `keepalived_vrrp_instance` | Yes | `VI_01` | VRRP instance name |
## Tags
## Example
This role has no tags.
```yaml
keepalived_auth_pass: "SecurePassword123"
keepalived_chk_service: "nginx"
keepalived_id: "web01"
keepalived_interface: "eth0"
keepalived_priority: "100"
keepalived_state: "BACKUP"
keepalived_unicast_peer: "192.168.1.11"
keepalived_unicast_src_ip: "192.168.1.10"
keepalived_virtual_ipaddress: "192.168.1.100"
keepalived_virtual_ipaddress_interface: "eth0"
keepalived_vr_id: "51"
keepalived_vrrp_instance: "VI_WEB"
```