summaryrefslogtreecommitdiffstats
path: root/roles/openshift_health_checker/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/openshift_health_checker/README.md')
-rw-r--r--roles/openshift_health_checker/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/roles/openshift_health_checker/README.md b/roles/openshift_health_checker/README.md
new file mode 100644
index 000000000..745e45b50
--- /dev/null
+++ b/roles/openshift_health_checker/README.md
@@ -0,0 +1,43 @@
+OpenShift Health Checker
+========================
+
+This role detects common problems with OpenShift installations or with
+environments prior to install.
+
+Requirements
+------------
+
+* Ansible 2.2+
+
+Role Variables
+--------------
+
+None
+
+Dependencies
+------------
+
+- openshift_facts
+
+Example Playbook
+----------------
+
+```yaml
+---
+- hosts: OSEv3
+ name: run OpenShift health checks
+ roles:
+ - openshift_health_checker
+ post_tasks:
+ - action: openshift_health_check
+```
+
+License
+-------
+
+Apache License Version 2.0
+
+Author Information
+------------------
+
+Customer Success team (dev@lists.openshift.redhat.com)