Merge pull request #41 from Tompage1994/readme-refresh

Refresh READMEs across the roles to ensure consistency

roles/backup/README.md

@@ -13,6 +13,10 @@ Available variables are listed below, along with default values defined (see def
 ```yaml
 tower_working_location: "/root/"
 backup_dest: "{{ tower_working_location }}/"
+
+# Use the default tower installation template
+pre_tasks_process_template: true
+
 # Tower variables
 tower_admin_password: "password"
 
@@ -21,7 +25,7 @@ tower_pg_database: "awx"
 tower_pg_username: "awx"
 tower_pg_password: "password"
 
-# RabbitMQ variables
+# RabbitMQ variables (Tower<=3.6)
 tower_rabbitmq_username: tower
 tower_rabbitmq_password: "password"
 tower_rabbitmq_cookie: "cookiemonster"
@@ -39,6 +43,40 @@ tower_database_host: ""
 tower_database_port: ""
 
 tower_ssh_connection_vars: ''
+
+# as long as the host name is empty, Automation Hub will NOT be installed
+tower_ah_hosts: []
+
+# the default configures an AH using the default database with similar defaults
+# as Tower
+tower_ah_admin_password: "{{ tower_admin_password }}"
+# if tower_database_host isn't defined or is empty,
+# the host where the installation takes place is deemed to host the DB
+tower_ah_pg_host: "{{ tower_database_host | default(ansible_host | default(inventory_hostname), true) }}"
+tower_ah_pg_port: "{{ tower_database_port }}"
+tower_ah_pg_database: 'automationhub'  # it is NOT supported to use the same name as for Tower!
+tower_ah_pg_username: "{{ tower_pg_username }}"
+tower_ah_pg_password: "{{ tower_pg_password }}"
+tower_ah_pg_sslmode: prefer
+
+# The below variables are unset, but can be used to affect certificates within the automation platform
+tower_ah_ssl_cert: <unset>
+tower_ah_ssl_key: <unset>
+tower_ssl_cert: <unset>
+tower_ssl_key: <unset>
+tower_pg_ssl_cert: <unset>
+tower_pg_ssl_key: <unset>
+tower_custom_ca_cert: <unset>
+
+# Set isolated groups for isolated nodes if required (commented out, an example setting)
+isolated_groups: <unset>
+  # - name: dmz1
+  #   hostnames:
+  #   - isolatednode0.dmz1.example.com
+  # - name: dmz2
+  #   hostnames:
+  #   - isolatednode0.dmz2.example.com
+  #   - isolatednode1.dmz2.example.com
 ```
 
 ## tower_ssh_connection_vars

roles/install/README.md

@@ -14,6 +14,12 @@ Available variables are listed below, along with default values defined (see def
 tower_working_location: "/root/"
 tower_force_setup: true
 
+tower_url: "https://localhost"
+tower_server: "{{ tower_url }}"
+
+# Use the default tower installation template
+pre_tasks_process_template: true
+
 # Tower variables
 tower_admin_password: "password"
 
@@ -22,7 +28,7 @@ tower_pg_database: "awx"
 tower_pg_username: "awx"
 tower_pg_password: "password"
 
-# RabbitMQ variables
+# RabbitMQ variables (Tower<=3.6)
 tower_rabbitmq_username: tower
 tower_rabbitmq_password: "password"
 tower_rabbitmq_cookie: "cookiemonster"
@@ -39,6 +45,8 @@ tower_hosts:
 tower_database_host: ""
 tower_database_port: ""
 
+tower_ssh_connection_vars: ''
+
 # as long as the host name is empty, Automation Hub will NOT be installed
 tower_ah_hosts: []
 
@@ -54,17 +62,24 @@ tower_ah_pg_username: "{{ tower_pg_username }}"
 tower_ah_pg_password: "{{ tower_pg_password }}"
 tower_ah_pg_sslmode: prefer
 
-tower_ssh_connection_vars: ''
-
-# Set isolated groups for isolated nodes if required
-isolated_groups:
-  - name: dmz1
-    hostnames:
-    - isolatednode0.dmz1.example.com
-  - name: dmz2
-    hostnames:
-    - isolatednode0.dmz2.example.com
-    - isolatednode1.dmz2.example.com
+# The below variables are unset, but can be used to affect certificates within the automation platform
+tower_ah_ssl_cert: <unset>
+tower_ah_ssl_key: <unset>
+tower_ssl_cert: <unset>
+tower_ssl_key: <unset>
+tower_pg_ssl_cert: <unset>
+tower_pg_ssl_key: <unset>
+tower_custom_ca_cert: <unset>
+
+# Set isolated groups for isolated nodes if required (commented out, an example setting)
+isolated_groups: <unset>
+  # - name: dmz1
+  #   hostnames:
+  #   - isolatednode0.dmz1.example.com
+  # - name: dmz2
+  #   hostnames:
+  #   - isolatednode0.dmz2.example.com
+  #   - isolatednode1.dmz2.example.com
 
 ```
 

roles/pre_tasks/README.md

@@ -24,7 +24,7 @@ tower_pg_database: "awx"
 tower_pg_username: "awx"
 tower_pg_password: "password"
 
-# RabbitMQ variables
+# RabbitMQ variables (Tower<=3.6)
 tower_rabbitmq_username: tower
 tower_rabbitmq_password: "password"
 tower_rabbitmq_cookie: "cookiemonster"
@@ -57,6 +57,25 @@ tower_ah_pg_database: 'automationhub'  # it is NOT supported to use the same nam
 tower_ah_pg_username: "{{ tower_pg_username }}"
 tower_ah_pg_password: "{{ tower_pg_password }}"
 tower_ah_pg_sslmode: prefer
+
+# The below variables are unset, but can be used to affect certificates within the automation platform
+tower_ah_ssl_cert: <unset>
+tower_ah_ssl_key: <unset>
+tower_ssl_cert: <unset>
+tower_ssl_key: <unset>
+tower_pg_ssl_cert: <unset>
+tower_pg_ssl_key: <unset>
+tower_custom_ca_cert: <unset>
+
+# Set isolated groups for isolated nodes if required (commented out, an example setting)
+isolated_groups: <unset>
+  # - name: dmz1
+  #   hostnames:
+  #   - isolatednode0.dmz1.example.com
+  # - name: dmz2
+  #   hostnames:
+  #   - isolatednode0.dmz2.example.com
+  #   - isolatednode1.dmz2.example.com
 ```
 
 > **CAUTION:** even if it is a list, it hasn't been tested that the installation of more than one AH is possible,

roles/restore/README.md

@@ -16,6 +16,9 @@ tower_working_location: "/root/"
 restore_file: "tower-backup-latest.tar.gz"
 restore_location: "{{ tower_working_location }}/{{ restore_file }}"
 
+# Use the default tower installation template
+pre_tasks_process_template: true
+
 # Tower variables
 tower_admin_password: "password"
 
@@ -24,7 +27,7 @@ tower_pg_database: "awx"
 tower_pg_username: "awx"
 tower_pg_password: "password"
 
-# RabbitMQ variables
+# RabbitMQ variables (Tower<=3.6)
 tower_rabbitmq_username: tower
 tower_rabbitmq_password: "password"
 tower_rabbitmq_cookie: "cookiemonster"
@@ -40,6 +43,42 @@ tower_hosts:
 
 tower_database_host: ""
 tower_database_port: ""
+
+tower_ssh_connection_vars: ''
+
+# as long as the host name is empty, Automation Hub will NOT be installed
+tower_ah_hosts: []
+
+# the default configures an AH using the default database with similar defaults
+# as Tower
+tower_ah_admin_password: "{{ tower_admin_password }}"
+# if tower_database_host isn't defined or is empty,
+# the host where the installation takes place is deemed to host the DB
+tower_ah_pg_host: "{{ tower_database_host | default(ansible_host | default(inventory_hostname), true) }}"
+tower_ah_pg_port: "{{ tower_database_port }}"
+tower_ah_pg_database: 'automationhub'  # it is NOT supported to use the same name as for Tower!
+tower_ah_pg_username: "{{ tower_pg_username }}"
+tower_ah_pg_password: "{{ tower_pg_password }}"
+tower_ah_pg_sslmode: prefer
+
+# The below variables are unset, but can be used to affect certificates within the automation platform
+tower_ah_ssl_cert: <unset>
+tower_ah_ssl_key: <unset>
+tower_ssl_cert: <unset>
+tower_ssl_key: <unset>
+tower_pg_ssl_cert: <unset>
+tower_pg_ssl_key: <unset>
+tower_custom_ca_cert: <unset>
+
+# Set isolated groups for isolated nodes if required (commented out, an example setting)
+isolated_groups: <unset>
+  # - name: dmz1
+  #   hostnames:
+  #   - isolatednode0.dmz1.example.com
+  # - name: dmz2
+  #   hostnames:
+  #   - isolatednode0.dmz2.example.com
+  #   - isolatednode1.dmz2.example.com
 ```
 
 ## Example Playbook