diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70113e45b..7bb33ec53 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -14,7 +14,7 @@ repos: # types: # - yaml - repo: 'https://github.com/ansible-community/ansible-lint.git' - rev: v6.8.2 + rev: v6.8.4 hooks: # see discussions here about what arguments are used, and behavior # https://github.com/ansible/ansible-lint/issues/649 @@ -34,7 +34,7 @@ repos: hooks: - id: markdownlint-cli2 - repo: https://github.com/ambv/black - rev: 22.8.0 + rev: 22.10.0 hooks: - id: black name: black diff --git a/README.md b/README.md index a297f9305..5a646d220 100644 --- a/README.md +++ b/README.md @@ -23,14 +23,13 @@ The AWX.AWX OR ANSIBLE.CONTROLLER collections MUST be installed in order for thi ## Redhat Communities of Practice Configuration Collections Suite - |Collection Name|Purpose| |:---:|:---:| |[Controller Configuration](https://galaxy.ansible.com/redhat_cop/controller_configuration)|Automation controller configuration| |[Hub Configuration](https://galaxy.ansible.com/redhat_cop/ah_configuration)|Automation hub configuration| |[EE Utilities](https://galaxy.ansible.com/redhat_cop/ee_utilities)|Execution Environment creation utilities| |[AAP installation Utilities](https://galaxy.ansible.com/redhat_cop/aap_utilities)|Ansible Automation Platform Utilities| -|[AAP Configuration Template](https://galaxy.ansible.com/redhat_cop/aap_configuration_template)|Configuration Template for this suite| +|[AAP Configuration Template](https://github.com/redhat-cop/aap_configuration_template)|Configuration Template for this suite| ## Included content diff --git a/examples/configs/inventory_sources.yml b/examples/configs/inventory_sources.yml index 4b0350e6e..42a684172 100644 --- a/examples/configs/inventory_sources.yml +++ b/examples/configs/inventory_sources.yml @@ -1,4 +1,6 @@ --- +controller_configuration_inventory_source_update_async_retries: 60 +controller_configuration_inventory_source_update_async_delay: 2 controller_inventory_sources: - name: RHVM-01 source: scm diff --git a/examples/configure_controller.yml b/examples/configure_controller.yml index 3a9db14d7..15aefaa1a 100644 --- a/examples/configure_controller.yml +++ b/examples/configure_controller.yml @@ -128,13 +128,13 @@ - name: "Error out on empty list" ansible.builtin.set_fact: - error_empty_diff: "{{ lookup('controller_object_diff', api_list=controller_api_results, compare_list=differential_test_items, warn_on_empty_api=false) }}" + error_empty_diff: "{{ lookup('redhat_cop.controller_configuration.controller_object_diff', api_list=controller_api_results, compare_list=differential_test_items, warn_on_empty_api=false) }}" ignore_errors: true register: error_results - name: "Warn out on empty list" ansible.builtin.set_fact: - warn_empty_diff: "{{ lookup('controller_object_diff', api_list=controller_api_results, compare_list=differential_test_items) }}" + warn_empty_diff: "{{ lookup('redhat_cop.controller_configuration.controller_object_diff', api_list=controller_api_results, compare_list=differential_test_items) }}" register: warn_results - name: "Assert that the empty list error correctly" diff --git a/examples/tasks/differential.yml b/examples/tasks/differential.yml index 7f46d0402..40c443e2f 100644 --- a/examples/tasks/differential.yml +++ b/examples/tasks/differential.yml @@ -1,16 +1,20 @@ --- - name: "Get the API list in the Default Organization of all {{ differential_item.name }}" ansible.builtin.set_fact: - controller_api_results: "{{ lookup('awx.awx.controller_object_diff', differential_item.name, query_params={'organization': controller_organization_id.id}, host=controller_hostname, username=controller_username, password=controller_password, verify_ssl=false) }}" + controller_api_results: "{{ lookup(controller_api_plugin, differential_item.name, query_params={'organization': controller_organization_id.id}, host=controller_hostname, username=controller_username, password=controller_password, verify_ssl=false) }}" - name: "Find the difference between what is on the Controller versus curated list of {{ differential_item.name }}" ansible.builtin.set_fact: - set_absent_diff: "{{ lookup('awx.awx.controller_object_diff', api_list=controller_api_results, compare_list=differential_item.differential_test_items, with_present=differential_item.with_present) }}" + set_absent_diff: "{{ lookup('redhat_cop.controller_configuration.controller_object_diff', api_list=controller_api_results, compare_list=differential_item.differential_test_items, with_present=differential_item.with_present) }}" - name: Display set_absent_diff ansible.builtin.debug: var: set_absent_diff +- name: Display differential_item.expected_test_result + ansible.builtin.debug: + var: differential_item.expected_test_result + - name: "Assert that the expected results match for {{ differential_item.name }}" ansible.builtin.assert: that: diff --git a/playbooks/README.md b/playbooks/README.md index 8d2974882..4b98e85e3 100644 --- a/playbooks/README.md +++ b/playbooks/README.md @@ -35,7 +35,7 @@ Examples of the playbooks in use can be found in the examples folder. ### Standard Controller Variables |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overriden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| diff --git a/roles/ad_hoc_command/README.md b/roles/ad_hoc_command/README.md index 217aa59b6..0625d5604 100644 --- a/roles/ad_hoc_command/README.md +++ b/roles/ad_hoc_command/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| |`controller_ad_hoc_commands`|`see below`|yes|Data structure describing your ad hoc commands to run Described below.|| ### Secure Logging Variables diff --git a/roles/ad_hoc_command_cancel/README.md b/roles/ad_hoc_command_cancel/README.md index e2191cab5..9b0d7a9e6 100644 --- a/roles/ad_hoc_command_cancel/README.md +++ b/roles/ad_hoc_command_cancel/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| |`controller_ad_hoc_commands_cancel`|`see below`|yes|Data structure describing your ad hoc jobs to cancel Described below.|| ### Secure Logging Variables diff --git a/roles/applications/README.md b/roles/applications/README.md index 6f5880788..d18338d81 100644 --- a/roles/applications/README.md +++ b/roles/applications/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| |`controller_applications`|`see below`|yes|Data structure describing your applications, described below.|| ### Secure Logging Variables diff --git a/roles/credential_input_sources/README.md b/roles/credential_input_sources/README.md index 59373414c..4849a3939 100644 --- a/roles/credential_input_sources/README.md +++ b/roles/credential_input_sources/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| |`controller_credential_input_sources`|`see below`|yes|Data structure describing your credential input sources Described below.|| ### Secure Logging Variables diff --git a/roles/credential_types/README.md b/roles/credential_types/README.md index a0d6cf233..dc588981f 100644 --- a/roles/credential_types/README.md +++ b/roles/credential_types/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| |`controller_credential_types`|`see below`|yes|Data structure describing your credential types Described below.|| ### Secure Logging Variables diff --git a/roles/credentials/README.md b/roles/credentials/README.md index 48052ec12..8929d84f6 100644 --- a/roles/credentials/README.md +++ b/roles/credentials/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| |`controller_credentials`|`see below`|yes|Data structure describing your credentials Described below.|| ### Secure Logging Variables diff --git a/roles/dispatch/README.md b/roles/dispatch/README.md index 4a3737d1b..0d2be4d6d 100644 --- a/roles/dispatch/README.md +++ b/roles/dispatch/README.md @@ -54,13 +54,13 @@ It is possible to redefine this variable with a subset of roles or with differen ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| ### Secure Logging Variables diff --git a/roles/execution_environments/README.md b/roles/execution_environments/README.md index 723bd7267..3b0436a2f 100644 --- a/roles/execution_environments/README.md +++ b/roles/execution_environments/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| |`controller_execution_environments`|`see below`|yes|Data structure describing your organization or organizations Described below.|| ### Secure Logging Variables diff --git a/roles/groups/README.md b/roles/groups/README.md index 049cc0938..198e905c4 100644 --- a/roles/groups/README.md +++ b/roles/groups/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_groups`|`see below`|yes|Data structure describing your group or groups Described below.|| ### Secure Logging Variables diff --git a/roles/hosts/README.md b/roles/hosts/README.md index 3822094fb..e8f1fffe5 100644 --- a/roles/hosts/README.md +++ b/roles/hosts/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_hosts`|`see below`|yes|Data structure describing your host entries described below.|| ### Secure Logging Variables diff --git a/roles/instance_groups/README.md b/roles/instance_groups/README.md index 9077357d4..3e1699f13 100644 --- a/roles/instance_groups/README.md +++ b/roles/instance_groups/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_instance_groups`|`see below`|yes|Data structure describing your instance groups Described below.|| ### Secure Logging Variables diff --git a/roles/inventories/README.md b/roles/inventories/README.md index c0bbaff69..533b62eb6 100644 --- a/roles/inventories/README.md +++ b/roles/inventories/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_inventories`|`see below`|yes|Data structure describing your inventories described below.|| ### Secure Logging Variables diff --git a/roles/inventory_source_update/README.md b/roles/inventory_source_update/README.md index 0abda5a23..4aacab94f 100644 --- a/roles/inventory_source_update/README.md +++ b/roles/inventory_source_update/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_inventory_sources`|`see below`|yes|Data structure describing controller inventory sources to update Described below.|| ### Secure Logging Variables diff --git a/roles/inventory_sources/README.md b/roles/inventory_sources/README.md index 9b623b2cb..62e365c8d 100644 --- a/roles/inventory_sources/README.md +++ b/roles/inventory_sources/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_inventory_sources`|`see below`|yes|Data structure describing your inventory sources Described below.|| ### Secure Logging Variables diff --git a/roles/job_launch/README.md b/roles/job_launch/README.md index 9c1730ed1..8bf91c92e 100644 --- a/roles/job_launch/README.md +++ b/roles/job_launch/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_launch_jobs`|`see below`|yes|Data structure describing the jobs to launch Described below.|| ### Secure Logging Variables diff --git a/roles/job_templates/README.md b/roles/job_templates/README.md index b480e3528..9c220fbea 100644 --- a/roles/job_templates/README.md +++ b/roles/job_templates/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_templates`|`see below`|yes|Data structure describing your job template or job templates Described below.|| ### Secure Logging Variables diff --git a/roles/jobs_cancel/README.md b/roles/jobs_cancel/README.md index d7d76d5c0..d3e2f9a3f 100644 --- a/roles/jobs_cancel/README.md +++ b/roles/jobs_cancel/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_cancel_jobs`|`see below`|yes|Data structure describing jobs to cancel Described below.|| ### Secure Logging Variables diff --git a/roles/labels/README.md b/roles/labels/README.md index eae9a7ae5..1f0123d59 100644 --- a/roles/labels/README.md +++ b/roles/labels/README.md @@ -15,13 +15,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_labels`|`see below`|yes|Data structure describing your label or labels Described below.|| ### Secure Logging Variables diff --git a/roles/license/README.md b/roles/license/README.md index 18afa8ee4..23e074957 100644 --- a/roles/license/README.md +++ b/roles/license/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_license`|`see below`|yes|Data structure describing your license for controller, described below.|| ### Secure Logging Variables diff --git a/roles/master_role_example/README.md b/roles/master_role_example/README.md index 530609074..5a1b12f84 100644 --- a/roles/master_role_example/README.md +++ b/roles/master_role_example/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_************`|`see below`|yes|Data structure describing your organization or organizations Described below.|| ### Secure Logging Variables diff --git a/roles/notification_templates/README.md b/roles/notification_templates/README.md index 8df45057d..4998b0f51 100644 --- a/roles/notification_templates/README.md +++ b/roles/notification_templates/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_notifications`|`see below`|yes|Data structure describing your notification entries described below.|| ### Secure Logging Variables diff --git a/roles/organizations/README.md b/roles/organizations/README.md index 2c7389658..5f33c7447 100644 --- a/roles/organizations/README.md +++ b/roles/organizations/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_organizations`|`see below`|yes|Data structure describing your organization or organizations Described below.|| ### Secure Logging Variables diff --git a/roles/project_update/README.md b/roles/project_update/README.md index 6361e921e..a6854cba5 100644 --- a/roles/project_update/README.md +++ b/roles/project_update/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_projects`|`see below`|yes|Data structure describing the project to update Described below.|| ### Secure Logging Variables diff --git a/roles/projects/README.md b/roles/projects/README.md index 251c92a7f..e74b29611 100644 --- a/roles/projects/README.md +++ b/roles/projects/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_projects`|`see below`|yes|Data structure describing your project or projects Described below.|| ### Secure Logging Variables diff --git a/roles/roles/README.md b/roles/roles/README.md index 5316f4f79..c747e1dbb 100644 --- a/roles/roles/README.md +++ b/roles/roles/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_roles`|`see below`|yes|Data structure describing your RBAC entries described below.|| ### Secure Logging Variables diff --git a/roles/schedules/README.md b/roles/schedules/README.md index cc282b603..18bd68221 100644 --- a/roles/schedules/README.md +++ b/roles/schedules/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_schedules`|`see below`|yes|Data structure describing your schedule or schedules Described below.|| ### Secure Logging Variables diff --git a/roles/settings/README.md b/roles/settings/README.md index 88149548c..fd3b977c8 100644 --- a/roles/settings/README.md +++ b/roles/settings/README.md @@ -15,13 +15,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_settings`|`see below`|yes|Data structure describing your settings described below.|| ### Secure Logging Variables diff --git a/roles/teams/README.md b/roles/teams/README.md index a9f1ac684..abfc93615 100644 --- a/roles/teams/README.md +++ b/roles/teams/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_teams`|`see below`|yes|Data structure describing your Teams described below.|| ### Secure Logging Variables diff --git a/roles/users/README.md b/roles/users/README.md index c119b5e28..2ee70cfe0 100644 --- a/roles/users/README.md +++ b/roles/users/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_user_accounts`|`see below`|yes|Data structure describing your user entries described below.|| ### Secure Logging Variables diff --git a/roles/workflow_job_templates/README.md b/roles/workflow_job_templates/README.md index 0b6b965e3..38694e44b 100644 --- a/roles/workflow_job_templates/README.md +++ b/roles/workflow_job_templates/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`workflow_job_templates`|`see below`|yes|Data structure describing your workflow job templates described below.|| ### Secure Logging Variables diff --git a/roles/workflow_launch/README.md b/roles/workflow_launch/README.md index 6aa387df3..d87318014 100644 --- a/roles/workflow_launch/README.md +++ b/roles/workflow_launch/README.md @@ -17,13 +17,13 @@ Currently: ### Authentication |Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| +|:---|:---:|:---:|:---|:---| |`controller_state`|"present"|no|The state all objects will take unless overridden by object default|'absent'| |`controller_hostname`|""|yes|URL to the Ansible Controller Server.|127.0.0.1| |`controller_validate_certs`|`True`|no|Whether or not to validate the Ansible Controller Server's SSL certificate.|| -|`controller_username`|""|yes|Admin User on the Ansible Controller Server.|| -|`controller_password`|""|yes|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook.|| -|`controller_oauthtoken`|""|yes|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook.|| +|`controller_username`|""|no|Admin User on the Ansible Controller Server. Either username / password or oauthtoken need to be specified.|| +|`controller_password`|""|no|Controller Admin User's password on the Ansible Controller Server. This should be stored in an Ansible Vault at vars/controller-secrets.yml or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.|| +|`controller_oauthtoken`|""|no|Controller Admin User's token on the Ansible Controller Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified.||| |`controller_workflow_launch_jobs`|`see below`|yes|Data structure describing workflow or workflows to launch Described below.|| ### Secure Logging Variables