Improve ipfailover configurability

Add options to 'oadm ipfailover' to configure the check script and
notify scripts and also control the period the check script runs.

Keepalived periodically checks whether the application is running
properly.  In the default case the test is a simple verification
that something is listening on the watch port. This PR permits the
user to supply an additional check script that is run in the
ipfailover container context to verify that the application is
operating properly. For example, a web server can be tested by
accessing the watch port and verifying the response.

Whenever a node changes state to MASTER, BACKUP, or FAULT a notify
script can be called. This script has 3 parameters filled in by
keepalived:
$1 - "GROUP"|"INSTANCE"
$2 - name of group or instance
$3 - target state of transition ("MASTER"|"BACKUP"|"FAULT")

--check-script="check_script"
The check script is a script in the keepalived container that verifies
the service is running properly. These checks are in addition to verifying
that the watch port is listening.

--notify-script="notify_script"
The notify script is a script in the keepalived container that is
called whenever the keepalived state transitions to (MASTER|BACKUP|FAULT)

--check-interval=<n>
The check script is run every <n> seconds. Default is 2.

Note: the scripts name is the full path to the script.

Resolves 1362163

Signed-off-by: Phil Cameron <[email protected]>

Author: pecameron

contrib/completions/bash/oadm

@@ -2321,6 +2321,10 @@ _oadm_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -2334,6 +2338,8 @@ _oadm_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")

contrib/completions/bash/oc

@@ -2408,6 +2408,10 @@ _oc_adm_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -2421,6 +2425,8 @@ _oc_adm_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")

contrib/completions/bash/openshift

@@ -2321,6 +2321,10 @@ _openshift_admin_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -2334,6 +2338,8 @@ _openshift_admin_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")
@@ -6938,6 +6944,10 @@ _openshift_cli_adm_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -6951,6 +6961,8 @@ _openshift_cli_adm_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")
@@ -19661,6 +19673,10 @@ _openshift_ex_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -19674,6 +19690,8 @@ _openshift_ex_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")

contrib/completions/zsh/oadm

@@ -2482,6 +2482,10 @@ _oadm_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -2495,6 +2499,8 @@ _oadm_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")

contrib/completions/zsh/oc

@@ -2569,6 +2569,10 @@ _oc_adm_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -2582,6 +2586,8 @@ _oc_adm_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")

contrib/completions/zsh/openshift

@@ -2482,6 +2482,10 @@ _openshift_admin_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -2495,6 +2499,8 @@ _openshift_admin_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")
@@ -7099,6 +7105,10 @@ _openshift_cli_adm_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -7112,6 +7122,8 @@ _openshift_cli_adm_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")
@@ -19822,6 +19834,10 @@ _openshift_ex_ipfailover()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--check-interval=")
+    local_nonpersistent_flags+=("--check-interval=")
+    flags+=("--check-script=")
+    local_nonpersistent_flags+=("--check-script=")
     flags+=("--create")
     local_nonpersistent_flags+=("--create")
     flags+=("--dry-run")
@@ -19835,6 +19851,8 @@ _openshift_ex_ipfailover()
     local_nonpersistent_flags+=("--iptables-chain=")
     flags+=("--latest-images")
     local_nonpersistent_flags+=("--latest-images")
+    flags+=("--notify-script=")
+    local_nonpersistent_flags+=("--notify-script=")
     flags+=("--output=")
     two_word_flags+=("-o")
     local_nonpersistent_flags+=("--output=")

docs/man/man1/oadm-ipfailover.1

@@ -23,6 +23,14 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 
 
 .SH OPTIONS
+.PP
+\fB\-\-check\-interval\fP=2
+    Run the check\-script at this interval (seconds)
+
+.PP
+\fB\-\-check\-script\fP=""
+    Run this script at the check\-interval to verify service is OK
+
 .PP
 \fB\-\-create\fP=false
     Create the configuration if it does not exist.
@@ -51,6 +59,10 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 \fB\-\-latest\-images\fP=false
     If true, attempt to use the latest images instead of the current release
 
+.PP
+\fB\-\-notify\-script\fP=""
+    Run this script when state changes.
+
 .PP
 \fB\-o\fP, \fB\-\-output\fP=""
     Output results as yaml or json instead of executing, or use name for succint output (resource/name).

docs/man/man1/oc-adm-ipfailover.1

@@ -23,6 +23,14 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 
 
 .SH OPTIONS
+.PP
+\fB\-\-check\-interval\fP=2
+    Run the check\-script at this interval (seconds)
+
+.PP
+\fB\-\-check\-script\fP=""
+    Run this script at the check\-interval to verify service is OK
+
 .PP
 \fB\-\-create\fP=false
     Create the configuration if it does not exist.
@@ -51,6 +59,10 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 \fB\-\-latest\-images\fP=false
     If true, attempt to use the latest images instead of the current release
 
+.PP
+\fB\-\-notify\-script\fP=""
+    Run this script when state changes.
+
 .PP
 \fB\-o\fP, \fB\-\-output\fP=""
     Output results as yaml or json instead of executing, or use name for succint output (resource/name).

docs/man/man1/openshift-admin-ipfailover.1

@@ -23,6 +23,14 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 
 
 .SH OPTIONS
+.PP
+\fB\-\-check\-interval\fP=2
+    Run the check\-script at this interval (seconds)
+
+.PP
+\fB\-\-check\-script\fP=""
+    Run this script at the check\-interval to verify service is OK
+
 .PP
 \fB\-\-create\fP=false
     Create the configuration if it does not exist.
@@ -51,6 +59,10 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 \fB\-\-latest\-images\fP=false
     If true, attempt to use the latest images instead of the current release
 
+.PP
+\fB\-\-notify\-script\fP=""
+    Run this script when state changes.
+
 .PP
 \fB\-o\fP, \fB\-\-output\fP=""
     Output results as yaml or json instead of executing, or use name for succint output (resource/name).

docs/man/man1/openshift-cli-adm-ipfailover.1

@@ -23,6 +23,14 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 
 
 .SH OPTIONS
+.PP
+\fB\-\-check\-interval\fP=2
+    Run the check\-script at this interval (seconds)
+
+.PP
+\fB\-\-check\-script\fP=""
+    Run this script at the check\-interval to verify service is OK
+
 .PP
 \fB\-\-create\fP=false
     Create the configuration if it does not exist.
@@ -51,6 +59,10 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 \fB\-\-latest\-images\fP=false
     If true, attempt to use the latest images instead of the current release
 
+.PP
+\fB\-\-notify\-script\fP=""
+    Run this script when state changes.
+
 .PP
 \fB\-o\fP, \fB\-\-output\fP=""
     Output results as yaml or json instead of executing, or use name for succint output (resource/name).

docs/man/man1/openshift-ex-ipfailover.1

@@ -23,6 +23,14 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 
 
 .SH OPTIONS
+.PP
+\fB\-\-check\-interval\fP=2
+    Run the check\-script at this interval (seconds)
+
+.PP
+\fB\-\-check\-script\fP=""
+    Run this script at the check\-interval to verify service is OK
+
 .PP
 \fB\-\-create\fP=false
     Create the configuration if it does not exist.
@@ -51,6 +59,10 @@ If an IP failover configuration does not exist with the given name, the \-\-crea
 \fB\-\-latest\-images\fP=false
     If true, attempt to use the latest images instead of the current release
 
+.PP
+\fB\-\-notify\-script\fP=""
+    Run this script when state changes.
+
 .PP
 \fB\-o\fP, \fB\-\-output\fP=""
     Output results as yaml or json instead of executing, or use name for succint output (resource/name).