Skip to content

Commit

Permalink
Merge pull request #313 from Tompage1994/controllerification
Browse files Browse the repository at this point in the history
Update docs and tests with Tower references to Controller
  • Loading branch information
djdanielsson authored Apr 26, 2022
2 parents 762de7d + e27777a commit c509c72
Show file tree
Hide file tree
Showing 47 changed files with 54 additions and 54 deletions.
4 changes: 2 additions & 2 deletions examples/configs/controller_auth.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# User may add tower auth creds to this file and encrypt it using `ansible-vault`
# User may add controller auth creds to this file and encrypt it using `ansible-vault`
---
# controller_hostname: ansible-tower-web-svc-test-project.example.com
# controller_hostname: ansible-controller-web-svc-test-project.example.com
controller_username: admin
controller_password: password
controller_validate_certs: false
Expand Down
6 changes: 3 additions & 3 deletions examples/configs/templates.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
# Only Job name, type, project and playbook are required
# Survey spec can be exported from existing job template using:
# tower-cli job_template survey --name="my job template" -f yaml
# https://github.com/ansible/tower-cli/blob/master/docs/source/cli_ref/usage/SURVEYS.rst
# Survey spec can be exported from existing job template querying the API.
# Find the ID of the job template and use the following URL:
# https://<controller_url>/api/v2/job_templates/<ID>/survey_spec/
controller_templates:
- name: test-template-1
description: created by Ansible Playbook
Expand Down
2 changes: 1 addition & 1 deletion examples/configs_export_model/auth.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# User may add tower auth creds to this file and encrypt it using `ansible-vault`
# User may add controller auth creds to this file and encrypt it using `ansible-vault`
---
# controller_hostname: ansible-tower-web-svc-test-project.example.com
controller_username: admin
Expand Down
2 changes: 1 addition & 1 deletion examples/configure_controller_export_model.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# controller_password: changeme
pre_tasks:

- name: Wait for Tower to come up
- name: Wait for Controller to come up
uri:
url: "{{ controller_hostname }}/api/v2/ping"
status_code: 200
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/collections/requirements.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
collections:
- name: awx.awx
- name: ansible.tower
- name: ansible.controller
- name: redhat_cop.controller_configuration
...
2 changes: 1 addition & 1 deletion examples/templates/tasks/manage_organizations.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
- name: Get list of organizations from Tower
- name: Get list of organizations from Controller
uri:
force_basic_auth: true
method: GET
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_credential_types.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/credential_types
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/credential_types
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_credentials.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/credentials
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/credentials
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_groups.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/groups
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/groups
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_hosts.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/hosts
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/hosts
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_inventories.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/inventories
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/inventories
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_inventory_sources.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/inventory_sources
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/inventory_sources
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_job_templates.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/job_templates
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/job_templates
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_labels.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/labels
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/labels
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_ldap_configuration.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/settings
// Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/settings
// if you need help customizing these settings.

{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/falsetification_templates
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/falsetification_templates
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_organizations.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/organizations
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/organizations
# for documentation and additional parameter information

---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/organizations
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/organizations
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_projects.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/projects
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/projects
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_schedules.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/schedules
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/schedules
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_users.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/users
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/users
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/vars/controller_workflows.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Refer to https://github.com/redhat-cop/tower_configuration/tree/devel/roles/workflow_job_templates
# Refer to https://github.com/redhat-cop/controller_configuration/tree/devel/roles/workflow_job_templates
# for documentation and additional parameter information

---
Expand Down
2 changes: 1 addition & 1 deletion playbooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Examples of the playbooks in use can be found in the examples folder.

## Variables

### Standard Tower Variables
### 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'|
Expand Down
2 changes: 1 addition & 1 deletion roles/applications/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the license role

# a list of dictionaries describing the Tower applications
# a list of dictionaries describing the Controller applications
controller_applications: []
# possible fields:
# - name: "app_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/credential_input_sources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This also speeds up the overall role.
|`description`|`False`|no|str|Description to use for the credential input source.|
|`state`|`present`|no|str|Desired state of the resource.|

For further details on fields see https://docs.ansible.com/ansible-tower/latest/html/userguide/credential_plugins.html
For further details on fields see https://docs.ansible.com/automation-controller/latest/html/userguide/credential_plugins.html

### Standard Project Data Structure
#### Json Example
Expand Down
2 changes: 1 addition & 1 deletion roles/credential_input_sources/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# controller_validate_certs: false

# These are the default variables specific to the license role
# list of dicts describing Tower credential input sources
# list of dicts describing Controller credential input sources
controller_credential_input_sources: []
# possible values:
# - target_credential: "credential_name" # mandatory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
tower_credential_input_sources:
controller_credential_input_sources:
- source_credential: cyberark
target_credential: gitlab
input_field_name: password
Expand Down
2 changes: 1 addition & 1 deletion roles/credential_input_sources/tests/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@
extensions: ["yml"]

roles:
- {role: ../.., when: tower_credential_input_sources is defined}
- {role: ../.., when: controller_credential_input_sources is defined}
...
2 changes: 1 addition & 1 deletion roles/credential_types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The workaround is to use the following format:
The role will strip the double space between the curly bracket in order to provide controller with the correct format for the Injectors.

### Input and Injector Schema
The following detais the data format to use for inputs and injectors. These can be in either YAML or JSON For the most up to date information and more details see [Custom Credential Types - Ansible Tower Documentation](https://docs.ansible.com/ansible-tower/latest/html/userguide/credential_types.html)
The following detais the data format to use for inputs and injectors. These can be in either YAML or JSON For the most up to date information and more details see [Custom Credential Types - Ansible Controller Documentation](https://docs.ansible.com/automation-controller/latest/html/userguide/credential_plugins.html)

#### Input Schema
```yaml
Expand Down
2 changes: 1 addition & 1 deletion roles/credential_types/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# controller_validate_certs: false

# These are the default variables specific to the license role
# list of dict to define Tower credential types
# list of dict to define Controller credential types
controller_credential_types: []
# possible fields:
# - name: "cred_type_name" # mandatory
Expand Down
4 changes: 2 additions & 2 deletions roles/credentials/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@

# These are the default variables specific to the license role

# a list of dics describing Tower credentials
# a list of dicts describing Controller credentials
controller_credentials: []
# possible fields
# - name: "cred_name" # mandatory
# new_name: "new_name" # optional
# description: "some description" # optional
# organization: "Default" # optional (str or org dict with name field)
# credential_type: "ssh" # optional, choices: ssh (i.e. Machine), vault, net, scm, aws, vmware, satellite6, cloudforms, gce, azure_rm, openstack, rhv, insights, tower (str or cred type dict with name field)
# credential_type: "ssh" # optional, choices: ssh (i.e. Machine), vault, net, scm, aws, vmware, satellite6, cloudforms, gce, azure_rm, openstack, rhv, insights, controller (str or cred type dict with name field)
# kind: # deprecated, use credential_type (str or cred type dict with kind field)
# inputs: {} # optional, dictionary of input fields
# user: "owner_name" # optional, user owning the credential (str or user dict with username field)
Expand Down
2 changes: 1 addition & 1 deletion roles/groups/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# controller_validate_certs: false

# These are the default variables specific to the license role
# list of dicts to describe Tower inventory groups
# list of dicts to describe Controller inventory groups
controller_groups: []
# possible fields are:
# - name: "group_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/hosts/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the license role

# list of dicts to describe Tower inventory hosts
# list of dicts to describe Controller inventory hosts
controller_hosts: []
# possible fields:
# - name: "host_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/inventories/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the license role

# list of dicts to describe Tower inventories
# list of dicts to describe Controller inventories
controller_inventories: []
# possible fields:
# - name: "inventory_name" # mandatory
Expand Down
6 changes: 3 additions & 3 deletions roles/inventory_sources/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@
# controller_validate_certs: false

# These are the default variables specific to the license role
# list of dict to describe Tower inventory sources
# list of dict to describe Controller inventory sources
controller_inventory_sources: []
# - name: "inv_source_name" # mandatory
# inventory: "inventory_name" # mandatory, str or inventory dict with name field
# organization: "Default" # optional, str or organization dict with name field
# new_name: "new_name" # optional
# description: "some description" # optional
# source: "" # optional, choices: scm, ec2, gce, azure_rm, vmware, satellite6, openstack, rhv, tower, custom
# source: "" # optional, choices: scm, ec2, gce, azure_rm, vmware, satellite6, openstack, rhv, controller, custom
# source_project: "project_name" # optional, for scm str or project dict with name field
# source_path: "inventory/hosts" # optional, for scm type relative path to inventory
# source_script: "some_custom_script" # optional, for custom type name of custom inventory script (obsolete!)
# source_vars: {} # optional, dict of (environment) variables to apply
# credential: "credential_name" # optional
# overwrite: false # optional, boolean
# overwrite_vars: false # optional, boolean
# custom_virtualenv: "/var/lib/awx/myvirtualenv" # optional, absolute path to virtualenv on Tower
# custom_virtualenv: "/var/lib/awx/myvirtualenv" # optional, absolute path to virtualenv on Controller
# timeout: 0 # optional, in seconds
# verbosity: 0 # optional, choices: 0, 1, 2
# update_on_launch: false # optional, boolean
Expand Down
2 changes: 1 addition & 1 deletion roles/job_templates/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the job_templates role

# list of dict describing Tower job templates:
# list of dict describing Controller job templates:
controller_templates: []
# possible fields:
# - name: "job_template_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/license/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ controller_configuration_license_secure_logging defaults to the value of control
|`eula_accepted`|""|yes|bool|DEPRECATED since Tower 3.8 - Whether to accept the End User License Agreement for Ansible controller|
|`force`|`False`|no|bool|By default, the license manifest will only be applied if controller is currently unlicensed or trial licensed. When force=true, the license is always applied.|

For further details on fields see https://docs.ansible.com/ansible-tower/latest/html/userguide/credential_plugins.html
For further details on fields see https://docs.ansible.com/automation-controller/latest/html/userguide/credential_plugins.html

### Standard Project Data Structure
#### Json Example
Expand Down
2 changes: 1 addition & 1 deletion roles/notification_templates/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the notification_templates role

# list of dict to describe Tower notification templates
# list of dict to describe Controller notification templates
controller_notifications: []
# possible fields:
# - name: "notif_name" # mandatory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
controller_notification_templates:
- name: Email notification
description: Send out emails for tower jobs
description: Send out emails for Controller jobs
organization: Default
notification_type: email
notification_configuration:
Expand Down
2 changes: 1 addition & 1 deletion roles/projects/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the projects role

# list of dict describing Tower projects
# list of dict describing Controller projects
controller_projects: []
# possible fields:
# - name: "project_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/roles/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the controller_role role

# list of dict describing a Tower access controle rule
# list of dict describing a Controller access control rule
controller_roles: []
# possible fields:
# - role: # mandatory, choices: admin, read, member, execute, adhoc, update, use, auditor, project_admin,
Expand Down
2 changes: 1 addition & 1 deletion roles/schedules/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the license role

# list of dict describing Tower schedules:
# list of dict describing Controller schedules:
controller_schedules: []
# possible fields:
# - name: "schedule_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/settings/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the controller_settings role

# list of dicts (or a single dict) describing the Tower settings
# list of dicts (or a single dict) describing the Controller settings
controller_settings: []
# possible fields:
# - settings: # either this field or name/value is mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/teams/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the teams role

# list of dicts describing the Tower teams
# list of dicts describing the Controller teams
controller_teams: []
# possible fields:
# - name: "team_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/users/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the users role

# list of dicts describing Tower users
# list of dicts describing Controller users
controller_user_accounts: []
# possible fields:
# - username: "user_name" # mandatory
Expand Down
2 changes: 1 addition & 1 deletion roles/workflow_job_templates/defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

# These are the default variables specific to the workflow_job_templates role

# list of dicts describing Tower workflow templates
# list of dicts describing Controller workflow templates
controller_workflows: []
# - name: "workflow_template_name" # mandatory
# new_name: "new_name" # optional
Expand Down
4 changes: 2 additions & 2 deletions roles/workflow_launch/tasks/main.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# Launch tower Workflow
- name: Launch a Tower Workflow
# Launch Controller Workflow
- name: Launch a Controller Workflow
workflow_launch:
name: "{{ __workflow_launch_item.name }}"
organization: "{{ __workflow_launch_item.organization | default(omit, true) }}"
Expand Down

0 comments on commit c509c72

Please sign in to comment.