Skip to content

Commit c247e3b

Browse files
committed
docs(roles/keepalived): document role scope and limitations
Add a "Scope" section to the README right after the introduction, spelling out what the role covers (single vrrp_instance, single VIP, PASS auth, smtp_alert, priorities 255/200) and what it intentionally does not (the net.ipv4.ip_nonlocal_bind sysctl, firewall rules for VRRP, tracking, notify_* hooks). Pointers to kernel_settings and firewall roles included. Follows CONTRIBUTING.md: "To understand/use a role, reading the README must be enough." Without the Scope block, admins assumed that firewall opening and ip_nonlocal_bind were handled by the role.
1 parent 5c8c75e commit c247e3b

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2525

2626
### Changed
2727

28+
* **role:keepalived**: Document role scope in the README. The role intentionally covers only a minimal VRRP setup (single `vrrp_instance`, single `virtual_ipaddress`, PASS auth, `smtp_alert`). It does not set the `net.ipv4.ip_nonlocal_bind` sysctl and does not open the firewall for VRRP; pointers to the `kernel_settings` and `firewall` roles are included
2829
* **all roles**: Rewrite all role READMEs to use the new standard format: replace markdown tables with bullet lists for tags and variables, convert HTML/blockquote subkeys to expanded indented format, standardize terminology (`Bool` not `Boolean`, `Mandatory` not `Required`)
2930
* **role:opensearch**: Rewrite README with step-by-step cluster setup guide, single-node section, post-installation steps, and improved variable documentation
3031
* **role:elasticsearch**: Improve README with single-node section and clearer explanation of the manual certificate approach for cluster setup

roles/keepalived/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,31 @@
33
This role installs and configures [keepalived](https://www.keepalived.org/).
44

55

6+
## Scope
7+
8+
The role intentionally covers a minimal VRRP setup:
9+
10+
* Deploys exactly one `vrrp_instance` (`VI_{{ keepalived__instance_id }}`) with a single
11+
`virtual_ipaddress`.
12+
* PASS authentication (`auth_type PASS`) between MASTER and BACKUP. Note that keepalived
13+
only evaluates the first eight characters of the password.
14+
* Priorities: `255` for MASTER, `200` for BACKUP.
15+
* `smtp_alert` for notifications; no `notify_*` hooks.
16+
* No tracking (no `track_process`, `track_file`, `track_interface` or `track_script`).
17+
18+
It does **not**:
19+
20+
* Set the `net.ipv4.ip_nonlocal_bind = 1` sysctl that services binding to the VIP typically
21+
need. Use [linuxfabrik.lfops.kernel_settings](https://github.com/Linuxfabrik/lfops/tree/main/roles/kernel_settings)
22+
or set it manually.
23+
* Open the firewall for VRRP (IP protocol 112). Use [linuxfabrik.lfops.firewall](https://github.com/Linuxfabrik/lfops/tree/main/roles/firewall)
24+
or similar.
25+
26+
For advanced setups (multiple VIPs, tracking-based priority adjustments, `notify_*` hooks),
27+
override the template in your own role or extend `/etc/keepalived/keepalived.conf`
28+
manually.
29+
30+
631
## Tags
732

833
`keepalived`

0 commit comments

Comments
 (0)