summaryrefslogtreecommitdiffstats
path: root/roles/openshift_preflight/README.md
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2017-01-06 20:53:05 +0100
committerRodolfo Carvalho <rhcarvalho@gmail.com>2017-01-12 14:23:19 +0100
commit9041a816210132b1dad86217ecfef5f9fec4a8d2 (patch)
tree9cfc4a208e8d90ee198cd72f6e4ffeb443f8e794 /roles/openshift_preflight/README.md
parentfeeeb48f45ecbde3e5bcc2a66c7f947080d433e5 (diff)
downloadopenshift-9041a816210132b1dad86217ecfef5f9fec4a8d2.tar.gz
openshift-9041a816210132b1dad86217ecfef5f9fec4a8d2.tar.bz2
openshift-9041a816210132b1dad86217ecfef5f9fec4a8d2.tar.xz
openshift-9041a816210132b1dad86217ecfef5f9fec4a8d2.zip
Refactor preflight check into roles
Diffstat (limited to 'roles/openshift_preflight/README.md')
-rw-r--r--roles/openshift_preflight/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/roles/openshift_preflight/README.md b/roles/openshift_preflight/README.md
new file mode 100644
index 000000000..a3d734e32
--- /dev/null
+++ b/roles/openshift_preflight/README.md
@@ -0,0 +1,53 @@
+OpenShift Preflight Checks
+==========================
+
+This role detects common problems prior to installing OpenShift.
+
+Requirements
+------------
+
+* Ansible 2.2+
+
+Role Variables
+--------------
+
+None
+
+Dependencies
+------------
+
+None
+
+Example Playbook
+----------------
+
+```yaml
+---
+- hosts: OSEv3
+ gather_facts: no
+ roles:
+ - openshift_preflight/facts
+
+- hosts: OSEv3
+ name: checks that apply to all hosts
+ gather_facts: no
+ ignore_errors: yes
+ roles:
+ - openshift_preflight/common
+
+- hosts: OSEv3
+ name: verify check results
+ gather_facts: no
+ roles:
+ - openshift_preflight/verify_status
+```
+
+License
+-------
+
+Apache License Version 2.0
+
+Author Information
+------------------
+
+Customer Success team (dev@lists.openshift.redhat.com)