Make it clear that the byo inventory file is just an example

- move the inventory/byo/hosts file to inventory/byo/hosts.example
- add a .gitignore to inventory/byo to avoid a inventory/byo/hosts file from
  being re-added to the repo.

2 files changed, 16 insertions, 7 deletions

diff --git a/inventory/byo/.gitignore b/inventory/byo/.gitignore
new file mode 100644
index 000000000..6ff331c7e
--- /dev/null
+++ b/inventory/byo/.gitignore
@@ -0,0 +1 @@
+hosts
diff --git a/inventory/byo/hosts b/inventory/byo/hosts.example
index a9add6a60..41216dd89 100644
--- a/inventory/byo/hosts
+++ b/inventory/byo/hosts.example
@@ -8,20 +8,25 @@ etcd
 
 # Set variables common for all OSEv3 hosts
 [OSEv3:vars]
-# SSH user, this user should allow ssh based auth without requiring a password
+# SSH user, this user should allow ssh based auth without requiring a
+# password. If using ssh key based auth, then the key should be managed by an
+# ssh agent.
 ansible_ssh_user=root
 
-# If ansible_ssh_user is not root, ansible_sudo must be set to true
+# If ansible_ssh_user is not root, ansible_sudo must be set to true and the
+# user must be configured for passwordless sudo
 #ansible_sudo=true
 
-# To deploy origin, change deployment_type to origin
+# deployment type valid values are origin, online and enterprise
 deployment_type=enterprise
 
 # Pre-release registry URL
-oreg_url=docker-buildvm-rhose.usersys.redhat.com:5000/openshift3/ose-${component}:${version}
+#oreg_url=docker-buildvm-rhose.usersys.redhat.com:5000/openshift3/ose-${component}:${version}
 
-# Pre-release additional repo
-openshift_additional_repos=[{'id': 'ose-devel', 'name': 'ose-devel', 'baseurl': 'http://buildvm-devops.usersys.redhat.com/puddle/build/OpenShiftEnterprise/3.0/latest/RH7-RHOSE-3.0/$basearch/os', 'enabled': 1, 'gpgcheck': 0}]
+# Pre-release Dev puddle repo
+#openshift_additional_repos=[{'id': 'ose-devel', 'name': 'ose-devel', 'baseurl': 'http://buildvm-devops.usersys.redhat.com/puddle/build/OpenShiftEnterprise/3.0/latest/RH7-RHOSE-3.0/$basearch/os', 'enabled': 1, 'gpgcheck': 0}]
+
+# Pre-release Errata puddle repo
 #openshift_additional_repos=[{'id': 'ose-devel', 'name': 'ose-devel', 'baseurl': 'http://buildvm-devops.usersys.redhat.com/puddle/build/OpenShiftEnterpriseErrata/3.0/latest/RH7-RHOSE-3.0/$basearch/os', 'enabled': 1, 'gpgcheck': 0}]
 
 # Origin copr repo
@@ -30,12 +35,15 @@ openshift_additional_repos=[{'id': 'ose-devel', 'name': 'ose-devel', 'baseurl':
 # htpasswd auth
 #openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/openshift/htpasswd'}]
 
+# Allow all auth
+#openshift_master_identity_providers=[{'name': 'allow_all', 'login': 'true', 'challenge': 'true', 'kind': 'AllowAllPasswordIdentityProvider'}]
+
 # host group for masters
 [masters]
 ose3-master-ansible.test.example.com
 
 [etcd]
-#ose3-master-ansible.test.example.com
+ose3-etcd[1:3]-ansible.test.example.com
 
 # host group for nodes
 [nodes]