infra.aap_configuration.credential_input_sources

Description

An Ansible Role to create/update/remove credential input sources on Ansible Controller, the below example is for CyberArk as an input source, change accordingly to match your input source type.

Requirements

ansible-galaxy collection install -r tests/collections/requirements.yml to be installed Currently: awx.awx or ansible.controller

Variables

Variable Name Default Value Required Description Example
platform_state “present” no The state all objects will take unless overridden by object default ‘absent’
aap_hostname ”” yes URL to the Ansible Automation Platform Server. 127.0.0.1
aap_validate_certs true no Whether or not to validate the Ansible Automation Platform Server’s SSL certificate.  
aap_username ”” no Admin User on the Ansible Automation Platform Server. Either username / password or oauthtoken need to be specified.  
aap_password ”” no Platform Admin User’s password on the Server. This should be stored in an Ansible Vault at vars/platform-secrets.yml or elsewhere and called from a parent playbook.  
aap_token ”” no Controller Admin User’s token on the Ansible Automation Platform 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.  
aap_request_timeout 10 no Specify the timeout in seconds Ansible should use in requests to the Ansible Automation Platform host.  
controller_credential_input_sources see below yes Data structure describing your credential input sources Described below.  

Enforcing defaults

The following Variables compliment each other. If Both variables are not set, enforcing default values is not done. Enabling these variables enforce default values on options that are optional in the controller API. This should be enabled to enforce configuration and prevent configuration drift. It is recomended to be enabled, however it is not enforced by default.

Enabling this will enforce configurtion without specifying every option in the configuration files.

‘controller_configuration_credential_input_sources_enforce_defaults’ defaults to the value of ‘aap_configuration_enforce_defaults’ if it is not explicitly called. This allows for enforced defaults to be toggled for the entire suite of controller configuration roles with a single variable, or for the user to selectively use it.

Variable Name Default Value Required Description
controller_configuration_credential_input_sources_enforce_defaults false no Whether or not to enforce default option values on only the applications role
aap_configuration_enforce_defaults false no This variable enables enforced default values as well, but is shared across multiple roles, see above.

Secure Logging Variables

The following Variables compliment each other. If Both variables are not set, secure logging defaults to false. The role defaults to false as normally the add credential input source task does not include sensitive information. controller_configuration_credential_input_sources_secure_logging defaults to the value of aap_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of controller configuration roles with a single variable, or for the user to selectively use it.

Variable Name Default Value Required Description
controller_configuration_credential_input_sources_secure_logging false no Whether or not to include the sensitive credential_input_source role tasks in the log. Set this value to true if you will be providing your sensitive values from elsewhere.
aap_configuration_secure_logging false no This variable enables secure logging as well, but is shared across multiple roles, see above.

Asynchronous Retry Variables

The following Variables set asynchronous retries for the role. If neither of the retries or delay or retries are set, they will default to their respective defaults. This allows for all items to be created, then checked that the task finishes successfully. This also speeds up the overall role.

Variable Name Default Value Required Description
aap_configuration_async_retries 30 no This variable sets the number of retries to attempt for the role globally.
controller_configuration_credential_input_sources_async_retries `` no This variable sets the number of retries to attempt for the role.
aap_configuration_async_delay 1 no This sets the delay between retries for the role globally.
controller_configuration_credential_input_sources_async_delay aap_configuration_async_delay no This sets the delay between retries for the role.
aap_configuration_loop_delay 0 no This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded.
controller_configuration_credential_input_sources_loop_delay aap_configuration_loop_delay no This sets the pause between each item in the loop for the role. To help when API is getting overloaded.
aap_configuration_async_dir null no Sets the directory to write the results file for async tasks. The default value is set to null which uses the Ansible Default of /root/.ansible_async/.

Data Structure

Credential Input Source Variables

Variable Name Default Value Required Type Description
target_credential ”” yes str Name of credential to have the input source applied
input_field_name ”” yes str Name of field which will be written by the input source
source_credential ”” no str Name of the source credential which points to an external secret lookup credential
metadata ”” no dict The metadata applied to the source.
description ”” 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/automation-controller/latest/html/userguide/credential_plugins.html. The input accepted by the metadata field will differ depending on the credential plugin being used.

Standard Credential Input Source Data Structure

Json Example

{
    "controller_credential_input_sources": [
      {
        "source_credential": "cyberark",
        "target_credential": "gitlab",
        "input_field_name": "password",
        "metadata": {
          "object_query": "Safe=MY_SAFE;Object=AWX-user",
          "object_query_format": "Exact"
        },
        "description": "Fill the gitlab credential from CyberArk"
      },
      {
        "source_credential": "hashivault",
        "target_credential": "gitlab",
        "input_field_name": "password",
        "metadata": {
          "secret_backend": "mykv",
          "secret_path": "vault/path/to/gitlab/secret",
          "auth_path": "approle",
          "secret_key": "GITLAB_PASSWORD_FROM_HASHI_VAULT",
          "secret_version": "v2"
        },
        "description": "Fill the gitlab credential from HashiCorp Vault"
      }
    ]
}

Yaml Example

controller_credential_input_sources:
  - source_credential: hashivault
    target_credential: gitlab
    input_field_name: password
    metadata:
      secret_backend: mykv
      secret_path: vault/path/to/gitlab/secret
      auth_path: approle
      secret_key: GITLAB_PASSWORD_FROM_HASHI_VAULT
      secret_version
    description: Fill the gitlab credential from HashiCorp Vault
  - source_credential: cyberark
    target_credential: gitlab
    input_field_name: password
    metadata:
      object_query: "Safe=MY_SAFE;Object=AWX-user"
      object_query_format: "Exact"
    description: Fill the gitlab credential from CyberArk

Playbook Examples

Standard Role Usage

- name: Playbook to configure ansible controller post installation
  hosts: localhost
  connection: local
  # Define following vars here, or in platform_configs/controller_auth.yml
  # aap_hostname: ansible-controller-web-svc-test-project.example.com
  # aap_username: admin
  # aap_password: changeme
  pre_tasks:
    - name: Include vars from platform_configs directory
      ansible.builtin.include_vars:
        dir: ./yaml
        ignore_files: [controller_config.yml.template]
        extensions: ["yml"]
  roles:
    - {role: infra.aap_configuration.credential_input_sources, when: controller_credential_input_sources is defined}

License

GPL-3.0

Author

Tom Page