From 99e1add6b4ccb93ca09c1c73805edb87b49e493c Mon Sep 17 00:00:00 2001 From: Jeffrey Sica Date: Fri, 21 Jul 2017 14:25:16 -0400 Subject: [PATCH] added variables table to readme --- infra-templates/keepalived/README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) mode change 100644 => 100755 infra-templates/keepalived/README.md diff --git a/infra-templates/keepalived/README.md b/infra-templates/keepalived/README.md old mode 100644 new mode 100755 index d97addd..f8aab6b --- a/infra-templates/keepalived/README.md +++ b/infra-templates/keepalived/README.md @@ -1,7 +1,20 @@ ## Keepalived -Manages VRRP failover +Manages VRRP failover within Rancher. -### Usage +This is useful for highly available load balancers or other HA services that you can't load balance. + +### Form Fields + +| Variable | Description | +| ----------------- | ---------------------------------------- | +| Host Label | Host Label used to schedule keepalived master and backup instances | +| Master Host Label | Keepalived Host Label to signifify the master instance | +| Backup Host Label | Keepalived Host Label to signifify the backup instance | +| Master IP | Host IP of master edge node | +| Backup IP | Host IP of backup edge node | +| Virtual IP | Virtual IP to be created | + +### Advanced Usage This service is intended to be deployed to edge nodes with a MASTER and BACKUP deployed respectively. Additional IPs should be managed via environment variables once deployed with entries following the below pattern: @@ -9,4 +22,4 @@ Additional IPs should be managed via environment variables once deployed with en `KEEPALIVED_VIRTUAL_IPADDRESS_[0-9]{1,3}` Format should mimic the ip command -`10.255.33.100/24 dev eth0` +`10.255.33.100/24 dev eth0` \ No newline at end of file