summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDevan Goodwin <dgoodwin@redhat.com>2015-11-03 09:20:04 -0400
committerDevan Goodwin <dgoodwin@redhat.com>2015-11-03 09:20:04 -0400
commitec31736606fc280de641e8909f03416c6b74e004 (patch)
tree0a333a4a35e35bea24ee45a9a8e18e39cedcb665
parent3f28361fdf56c9e7395fcbfe5c2698569f8a5684 (diff)
downloadopenshift-ec31736606fc280de641e8909f03416c6b74e004.tar.gz
openshift-ec31736606fc280de641e8909f03416c6b74e004.tar.bz2
openshift-ec31736606fc280de641e8909f03416c6b74e004.tar.xz
openshift-ec31736606fc280de641e8909f03416c6b74e004.zip
Document the new version field for installer config.
-rw-r--r--utils/docs/config.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/utils/docs/config.md b/utils/docs/config.md
index 9399409dd..ee4b157c9 100644
--- a/utils/docs/config.md
+++ b/utils/docs/config.md
@@ -7,6 +7,7 @@ The default location this config file will be written to ~/.config/openshift/ins
## Example
```
+version: v1
variant: openshift-enterprise
variant_version: 3.0
ansible_ssh_user: root
@@ -32,6 +33,10 @@ hosts:
## Primary Settings
+### version
+
+Indicates the version of configuration this file was written with. Current implementation is v1.
+
### variant
The OpenShift variant to install. Currently valid options are: