summaryrefslogtreecommitdiffstats
path: root/roles/openshift_sanitize_inventory/README.md
diff options
context:
space:
mode:
authorLuke Meyer <lmeyer@redhat.com>2017-03-22 15:23:29 -0400
committerLuke Meyer <lmeyer@redhat.com>2017-03-29 11:59:47 -0400
commitf5827111a7609b3c6f7f72a03c8bc13fee2bbb60 (patch)
tree8b1cacfc6290c3a9d33c5a23c56e2715a4d2c399 /roles/openshift_sanitize_inventory/README.md
parentd77a9a685c3add9ef9c4d659ee47ebf35e145fe4 (diff)
downloadopenshift-f5827111a7609b3c6f7f72a03c8bc13fee2bbb60.tar.gz
openshift-f5827111a7609b3c6f7f72a03c8bc13fee2bbb60.tar.bz2
openshift-f5827111a7609b3c6f7f72a03c8bc13fee2bbb60.tar.xz
openshift-f5827111a7609b3c6f7f72a03c8bc13fee2bbb60.zip
validate and normalize inventory variables
In openshift_repos and everywhere, ensure deployment_type and openshift_deployment_type are defined and the same. We really want to set openshift_deployment_type, but users will likely still have just deployment_type, so accept both. And don't make every playbook default openshift_deployment_type to deployment_type. This introduces the openshift_sanitize_inventory role to run before anything else.
Diffstat (limited to 'roles/openshift_sanitize_inventory/README.md')
-rw-r--r--roles/openshift_sanitize_inventory/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/roles/openshift_sanitize_inventory/README.md b/roles/openshift_sanitize_inventory/README.md
new file mode 100644
index 000000000..23f6b84fc
--- /dev/null
+++ b/roles/openshift_sanitize_inventory/README.md
@@ -0,0 +1,37 @@
+OpenShift Inventory
+===================
+
+Provides a role to validate and normalize the variables the user has
+provided. This role should run before pretty much everything else so that
+this kind of logic only has to be in one place. However, complicated
+business logic should usually be left to other roles.
+
+Requirements
+------------
+
+None
+
+Role Variables
+--------------
+
+None
+
+Dependencies
+------------
+
+None
+
+Example Playbook
+----------------
+
+TODO
+
+License
+-------
+
+Apache License, Version 2.0
+
+Author Information
+------------------
+
+OpenShift dev (dev@lists.openshift.redhat.com)