ansible-role-awx_casc

Import AWX configuration using Configuration-as-Code

Dependencies

Roles

• deitkrachten.awx_cli

Collections

• awx.awx

Platforms

Supported platforms

• Red Hat Enterprise Linux 8¹
• Red Hat Enterprise Linux 9¹
• Red Hat Enterprise Linux 10¹
• RockyLinux 8¹
• RockyLinux 9¹
• RockyLinux 10¹
• OracleLinux 8¹
• OracleLinux 9¹
• OracleLinux 10¹
• AlmaLinux 8¹
• AlmaLinux 9¹
• AlmaLinux 10¹
• Debian 11 (Bullseye)¹
• Debian 12 (Bookworm)¹
• Debian 13 (Trixie)¹
• Ubuntu 20.04 LTS¹
• Ubuntu 22.04 LTS¹
• Ubuntu 24.04 LTS¹
• Ubuntu 26.04 LTS¹
• Fedora 42¹
• Fedora 43¹

Note: ¹ : no automated testing is performed on these platforms

Role Variables

defaults/main.yml

# Use non default virtual env
# awx_python_interpreter: /virtenv/awx/bin/python3

# For inventory/host/group, you can replace variable values during creation
# In order not to replace intended dynamic variables, use the following markers
# awx_variable_jinja_block_start: "<%"
# awx_variable_jinja_block_end: "%>"
# awx_variable_jinja_variable_start: "<="
# awx_variable_jinja_variable_end: "=>"

# Full path to the awxkit / awx command
awx_command: awx

# Host to execute code from
awx_execution_host: localhost

# Should creation of AWX hosts be created
awx_create_hosts: true

# Check if hosts exist in DNS
awx_host_dns_check: false

# List of hosts that no longer exists (dynamically created)
awx_hosts_non_existing: []

# AWX url
awx_url: https://127.0.0.1

# AWX username to use
awx_username: admin

# AWX password to use
awx_password: admin

# Should SSL/TLS verification be done
awx_verify_ssl: false

# Location where to get configuration files from
# awx_config_path: /tmp/awx

# Skip creating hosts and assigning hosts to groups
awx_casc_skip_hosts: false

# Forcingly recreate workflow templates
awx_workflow_job_template_recreate: false

# Format for variables & input files and extra vars of job templates
awx_vars_format: json
awx_inputs_format: json
awx_template_format: yaml

# List of resources to export
awx_casc_resources:
  - settings
  - organizations
  - credential_types
  - credentials
  - execution_environments
  - inventory
  - inventory_sources
  - { name: projects, ignore_errors: true }
  - { name: job_templates, ignore_errors: true }
  - notification_templates
  - organizations
  - teams
  - users
  - workflow_job_templates
  # - roles  ## not yet
  - schedules
  # - applications  ## not yet
  # - system_job_templates  ## not yet
  - hosts
  - groups

Example Playbook

molecule/default/converge.yml

- name: sample playbook for role 'awx_casc' pre playbook
  ansible.builtin.import_playbook: converge-pre.yml
  when: molecule_converge_pre is undefined or molecule_converge_pre | bool
- name: sample playbook for role 'awx_casc'
  hosts: all
  become: 'no'
  vars:
    molecule_driver: '{{ lookup(''env'', ''MOLECULE_DRIVER_NAME'') }}'
    awx_venv_root: /usr/local/venv/awxkit
    awx_command: /usr/local/bin/awx
    awx_config_path: /tmp/awx-config
    awx_password: Admin123!
  tasks:
    - name: Include role 'awx_casc'
      ansible.builtin.include_role:
        name: awx_casc