Initial READMEs for openshift_{common, node, master}

3 files changed, 69 insertions, 40 deletions

diff --git a/roles/openshift_common/README.md b/roles/openshift_common/README.md
index 225dd44b9..c2ae609ff 100644
--- a/roles/openshift_common/README.md
+++ b/roles/openshift_common/README.md
@@ -1,38 +1,42 @@
-Role Name
-=========
+OpenShift Common
+================
 
-A brief description of the role goes here.
+OpenShift common installation and configuration tasks.
 
 Requirements
 ------------
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+A RHEL 7.1 host pre-configured with access to the rhel-7-server-rpms,
+rhel-7-server-extra-rpms, and rhel-7-server-ose-beta-rpms repos.
 
 Role Variables
 --------------
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+| Name                          | Default value                |                                        |
+|-------------------------------|------------------------------|----------------------------------------|
+| openshift_bind_ip             | ansible_default_ipv4.address | IP to use for local binding            |
+| openshift_debug_level         | 0                            | Global openshift debug log verbosity   |
+| openshift_hostname_workaround | True                         | Workaround needed to set hostname to IP address |
+| openshift_hostname            | openshift_public_ip if openshift_hostname_workaround else ansible_fqdn | hostname to use for this instance |
+| openshift_public_ip           | UNDEF (Required)             | Public IP address to use for this host |
+| openshift_env                 | default                      | Envrionment name if multiple OpenShift instances |
 
 Dependencies
 ------------
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+os_firewall
 
 Example Playbook
 ----------------
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+TODO
 
 License
 -------
 
-BSD
+Apache License, Version 2.0
 
 Author Information
 ------------------
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+TODO
diff --git a/roles/openshift_master/README.md b/roles/openshift_master/README.md
index 225dd44b9..5a1b889b2 100644
--- a/roles/openshift_master/README.md
+++ b/roles/openshift_master/README.md
@@ -1,38 +1,50 @@
-Role Name
-=========
+OpenShift Master
+================
 
-A brief description of the role goes here.
+OpenShift Master service installation
 
 Requirements
 ------------
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+A RHEL 7.1 host pre-configured with access to the rhel-7-server-rpms,
+rhel-7-server-extras-rpms, and rhel-server-7-ose-beta-rpms repos.
 
 Role Variables
 --------------
 
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+From this role:
+| Name                                     | Default value         |
+|
+|------------------------------------------|-----------------------|----------------------------------------|
+| openshift_master_manage_service_externally | False                 | Should the openshift-master role manage the openshift-master service? |
+| openshift_master_debug_level               | openshift_debug_level | Verbosity of the debug logs for openshift-master |
+| openshift_node_ips                         | []                    | List of the openshift node ip addresses, that we want to pre-register to the system when openshift-master starts up |
+| openshift_registry_url                     | UNDEF (Optional)      | Default docker registry to use |
+
+From openshift_common:
+| Name                          |  Default Value      |                     |
+|-------------------------------|---------------------|---------------------|
+| openshift_debug_level         | 0                   | Global openshift debug log verbosity |
+| openshift_hostname_workaround | True                |                     |
+| openshift_public_ip           | UNDEF (Required)    | Public IP address to use for this host |
+| openshift_hostname            | openshift_public_ip if openshift_hostname_workaround else ansible_fqdn | hostname to use for this instance |
 
 Dependencies
 ------------
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+openshift_common
 
 Example Playbook
 ----------------
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+TODO
 
 License
 -------
 
-BSD
+Apache License, Version 2.0
 
 Author Information
 ------------------
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+TODO
diff --git a/roles/openshift_node/README.md b/roles/openshift_node/README.md
index 225dd44b9..87913a0d5 100644
--- a/roles/openshift_node/README.md
+++ b/roles/openshift_node/README.md
@@ -1,38 +1,51 @@
-Role Name
-=========
+OpenShift Node
+==============
 
-A brief description of the role goes here.
+OpenShift Node service installation
 
 Requirements
 ------------
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+One or more OpenShift Master servers.
+
+A RHEL 7.1 host pre-configured with access to the rhel-7-server-rpms,
+rhel-7-server-extras-rpms, and rhel-server-7-ose-beta-rpms repos.
 
 Role Variables
 --------------
-
-A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+From this role:
+| Name                                     | Default value         |                                        |
+|------------------------------------------|-----------------------|----------------------------------------|
+| openshift_node_manage_service_externally | False                 | Should the openshift-node role manage the openshift-node service? |
+| openshift_node_debug_level               | openshift_debug_level | Verbosity of the debug logs for openshift-node |
+| openshift_master_public_ips              | UNDEF (Required)      | List of the public IPs for the openhift-master hosts |
+| openshift_master_ips                     | UNDEF (Required)      | List of IP addresses for the openshift-master hosts to be used for node -> master communication |
+| openshift_registry_url                   | UNDEF (Optional)      | Default docker registry to use |
+
+From openshift_common:
+| Name                          |  Default Value      |                     | 
+|-------------------------------|---------------------|---------------------|
+| openshift_debug_level         | 0                   | Global openshift debug log verbosity |
+| openshift_hostname_workaround | True                |                     |
+| openshift_public_ip           | UNDEF (Required)    | Public IP address to use for this host |
+| openshift_hostname            | openshift_public_ip if openshift_hostname_workaround else ansible_fqdn | hostname to use for this instance |
 
 Dependencies
 ------------
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+openshift_common
 
 Example Playbook
 ----------------
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: username.rolename, x: 42 }
+TODO
 
 License
 -------
 
-BSD
+Apache License, Version 2.0
 
 Author Information
 ------------------
 
-An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+TODO