summaryrefslogtreecommitdiffstats
path: root/playbooks/byo/openshift-checks/README.md
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2017-06-23 15:31:12 +0200
committerRodolfo Carvalho <rhcarvalho@gmail.com>2017-08-24 14:59:50 +0200
commit25276bda8c002f4279e5c1748f64a9fd1ee999a4 (patch)
tree227dfc6dbdb776c89f9911fe984aea5b4db08330 /playbooks/byo/openshift-checks/README.md
parentf98c978bd49f2473ce271d4fc69be7e4eea78125 (diff)
downloadopenshift-25276bda8c002f4279e5c1748f64a9fd1ee999a4.tar.gz
openshift-25276bda8c002f4279e5c1748f64a9fd1ee999a4.tar.bz2
openshift-25276bda8c002f4279e5c1748f64a9fd1ee999a4.tar.xz
openshift-25276bda8c002f4279e5c1748f64a9fd1ee999a4.zip
List existing health checks when none is requested
This is a simple mechanism to learn what health checks are available. Note that we defer task_vars verification, so that we can compute requested_checks and resolved_checks earlier, allowing us to list checks even if openshift_facts has not run.
Diffstat (limited to 'playbooks/byo/openshift-checks/README.md')
-rw-r--r--playbooks/byo/openshift-checks/README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/playbooks/byo/openshift-checks/README.md b/playbooks/byo/openshift-checks/README.md
index c17f5b6b7..b26e7d7ed 100644
--- a/playbooks/byo/openshift-checks/README.md
+++ b/playbooks/byo/openshift-checks/README.md
@@ -26,7 +26,8 @@ callback plugin summarizes execution errors at the end of a playbook run.
3. Certificate expiry playbooks ([certificate_expiry](certificate_expiry)) -
check that certificates in use are valid and not expiring soon.
-4. Adhoc playbook ([adhoc.yml](adhoc.yml)) - use it to run adhoc checks.
+4. Adhoc playbook ([adhoc.yml](adhoc.yml)) - use it to run adhoc checks or to
+ list existing checks.
See the [next section](#the-adhoc-playbook) for a usage example.
## Running
@@ -89,6 +90,13 @@ $ ansible-playbook -i <inventory file> playbooks/byo/openshift-checks/adhoc.yml
It is valid to specify multiple check tags and individual check names together
in a comma-separated list.
+To list all of the available checks and tags, run the adhoc playbook without
+setting the `openshift_checks` variable:
+
+```console
+$ ansible-playbook -i <inventory file> playbooks/byo/openshift-checks/adhoc.yml
+```
+
## Running in a container
This repository is built into a Docker image including Ansible so that it can