Red Hat Ansible Automation Platform

https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/
Admin
Red Hat Ansible Automation Platform is an enterprise automation foundation for implementing...
Tokens:667,457
Snippets:10,170
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example GitHub App Installation Access Token Lookup Credential

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/configuring_automation_execution/assembly-controller-secret-management

This is an example of a configured GitHub App Installation Access Token Lookup credential. It requires GitHub App ID, GitHub App Installation ID, and the RSA Private Key.

```yaml
credential:
  name: "my-github-app-credential"
  kind: "github_app_installation_access_token"
  inputs:
    github_app_id: "12345"
    github_app_installation_id: "67890"
    rsa_private_key: "-----BEGIN RSA PRIVATE KEY-----\nMIICXgIBAAKBgQC...\n-----END RSA PRIVATE KEY-----"
```

--------------------------------

### Copy and Edit Inventory File

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_dashboard/assembly-view-key-metrics

Copy the example inventory file and then edit it before running the installation program. This is a common first step for configuring installations.

```bash
cp -i inventory.example inventory
vi inventory
```

--------------------------------

### Example of controller_extra_settings

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars

This example demonstrates how to define additional settings for Automation Controller during installation using the `controller_extra_settings` variable. It shows a specific setting for `USE_X_FORWARDED_HOST`.

```yaml
controller_extra_settings=[{"setting": "USE_X_FORWARDED_HOST", "value": True}]
```

--------------------------------

### Run Ansible Automation Platform setup script

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/appendix-troubleshoot-rpm-aap

Execute the setup script to connect to nodes, install `sos`, and generate logs. Use this command to initiate the troubleshooting log collection process.

```bash
$ ./setup.sh -s
```

--------------------------------

### Run setup script with encrypted credentials

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/planning_your_installation/con-inventory-introduction_planning

Execute the installation script, providing the encrypted `credentials.yml` file and prompting for the vault password using `--ask-vault-pass`. This ensures sensitive data is handled securely during installation.

```bash
$ ANSIBLE_BECOME_METHOD='sudo' ANSIBLE_BECOME=True ANSIBLE_HOST_KEY_CHECKING=False ./setup.sh -e @credentials.yml -- --ask-vault-pass
```

--------------------------------

### Example execution-environment.yml and requirements.yml

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/creating_and_using_execution_environments/index

This example shows a basic `execution-environment.yml` file specifying dependencies from a `requirements.yml` file, which in turn lists Ansible collections. This serves as a starting point for defining an execution environment.

```yaml
version: 3
dependencies:
  galaxy:
    - requirements.yml
```

```yaml
---
collections:
  - name: awx.awx
```

--------------------------------

### Run the install playbook

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/installing-containerized-aap

Execute the main playbook to begin the containerized installation. Ensure your inventory file is correctly configured.

```bash
ansible-playbook -i <inventory_file_name> ansible.containerized_installer.install
```

```bash
ansible-playbook -i inventory ansible.containerized_installer.install
```

--------------------------------

### Run setup.sh to Apply Configuration

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/operating_ansible_automation_platform/assembly-configure-egress-proxy

Execute the `setup.sh` script again to apply the changes, including the custom execution environment configuration.

```bash
# ./setup.sh
```

--------------------------------

### Base URL for API Examples

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/automation_execution_api_overview/controller-api-sorting

This is the base URL used for all API examples in this guide.

```text
https://<gateway server name>/api/controller/v2/groups/
```

--------------------------------

### Backup Source Environment

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/ansible_automation_platform_migration/source-environment

Execute the setup script with the backup destination and flag to create a complete backup of the source environment.

```bash
$ ./setup.sh -e 'backup_dest=/path/to/backup_dir/' -b
```

--------------------------------

### Run Ansible Automation Platform Installer Setup Script

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/automation_mesh_for_vm_environments/setting-up

Execute the setup script to begin the installation of Red Hat Ansible Automation Platform. Ensure you have updated the inventory file with the required parameters before running.

```bash
$ sudo ./setup.sh
```

--------------------------------

### Apply Example Site Configuration to a Device

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/managing_device_fleets_with_the_red_hat_edge_manager/assembly-edge-manager-manage-devices

Update a device's specification to apply a configuration named 'example-site' from a Git repository. This configuration will be sourced from the 'production' branch and placed in the root directory.

```yaml
apiVersion: flightctl.io/v1alpha1
kind: Device
metadata:
  name: <device_name>
spec:
[...] 
  config: 
    - name: example-site
      configType: GitConfigProviderSpec
      gitRef:
        repository: site-settings
        targetRevision: production
        path: /etc/example-site 

```

--------------------------------

### Start Activation Log Example

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/using_automation_decisions/index

Log output demonstrating the successful request and initiation of starting an activation.

```log
1. Start
    1. 2024-08-15 14:21:29,076 aap_eda.services.activation.activation_manager INFO     Requested to start activation 1, starting.
    2024-08-15 14:21:29,093 aap_eda.services.activation.activation_manager INFO     Creating a new activation instance for activation: 1
    2024-08-15 14:21:29,104 aap_eda.services.activation.activation_manager INFO     Starting container for activation instance: 1
```

--------------------------------

### Access Module Documentation Examples

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_content_navigator/assembly-review-collections-navigator_installing-devtools

Jump to the documentation examples for a specific module within the automation content navigator.

```bash
:{{ examples }}
```

--------------------------------

### Navigate to Online Installer Directory

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_upgrade_and_migration/aap-upgrading-platform

Change directory to the Ansible Automation Platform setup directory for the online installer.

```bash
$ cd ansible-automation-platform-setup-2.5-4
```

--------------------------------

### Example: Connect to PostgreSQL Server

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/advanced-configuration-containerized

An example of connecting to a PostgreSQL server using `psql`.

```bash
# psql -h db.example.com -U superuser -p 5432
```

--------------------------------

### Navigate to Bundled Installer Directory

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_upgrade_and_migration/aap-upgrading-platform

Change directory to the Ansible Automation Platform setup bundle for the bundled installer.

```bash
$ cd ansible-automation-platform-setup-bundle-2.5-4-x86_64
```

--------------------------------

### Example of controller_extra_settings

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars

Use `controller_extra_settings` to define additional settings for Automation Controller during installation. This example shows how to set `USE_X_FORWARDED_HOST`.

```yaml
controller_extra_settings=[
    {"setting": "USE_X_FORWARDED_HOST", "value": True}
]
```

--------------------------------

### Test Podman Desktop installation

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/developing_automation_content/installing-devtools

Runs a simple 'hello-world' container using Podman to confirm that Podman Desktop is installed and functioning correctly.

```bash
$ podman run hello
```

--------------------------------

### Automation Hub Extra Settings Example

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars

Defines additional settings for use by Automation Hub during installation. This is an example structure.

```yaml
hub_extra_settings:
  some_setting: "value"
  another_setting:
    nested_value: 123
```

--------------------------------

### Example Output: hstore Extension Available

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/installing_on_openshift_container_platform/index

This is an example output indicating that the `hstore` extension is available on the PostgreSQL server.

```text
name  | default_version | installed_version |comment
------+-----------------+-------------------+---------------------------------------------------
hstore | 1.7           |                   | data type for storing sets of (key, value) pairs
(1 row)
```

--------------------------------

### Example of creating a new OpenShift project

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/installing_self-service_automation_portal/index

This example demonstrates the output after successfully creating a new project named `<my-project>` using the `oc new-project` command. It confirms the project creation and the current active project.

```text
$ oc new-project <my-project>

Now using project "my-project" on server "https://openshift.example.com:6443".
```

--------------------------------

### Extract Bundle Installer

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/planning_your_installation/choosing_and_obtaining_a_red_hat_ansible_automation_platform_installer

Extract the files from the Ansible Automation Platform Setup Bundle installer, which is used for installations without internet access. Replace the placeholder with the latest version.

```bash
$ tar xvzf ansible-automation-platform-setup-bundle-<latest-version>.tar.gz
```

--------------------------------

### Open Module Example in Editor

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_content_navigator/assembly-review-collections-navigator_installing-devtools

Use this command within the automation content navigator to open the current module's documentation example in your editor.

```bash
:open
```

--------------------------------

### Example of eda_extra_settings variable

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/appendix-inventory-files-vars

Use this variable to define additional settings for Event-Driven Ansible during installation. This example shows how to set the RULEBOOK_READINESS_TIMEOUT_SECONDS.

```yaml
eda_extra_settings=[{"setting": "RULEBOOK_READINESS_TIMEOUT_SECONDS", "value": 120}]
```

--------------------------------

### Podman Mount Command Example

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_execution/assembly-controller-execution-environments

This example demonstrates a Podman command for mounting a directory into the execution environment, ensuring the SSH command works as expected.

```bash
podman run -v /ssh_config:/etc/ssh/ssh_config.d/:O ...
```

--------------------------------

### Activation Start and Stop Logs

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_decisions/eda-logging-strategy

Shows example log output when an activation is started and stopped. This helps in monitoring the lifecycle of EDA activations.

```log
1. Start
    1. 2024-08-15 14:21:29,076 aap_eda.services.activation.activation_manager INFO     Requested to start activation 1, starting.
    2024-08-15 14:21:29,093 aap_eda.services.activation.activation_manager INFO     Creating a new activation instance for activation: 1
    2024-08-15 14:21:29,104 aap_eda.services.activation.activation_manager INFO     Starting container for activation instance: 1
2. Stop
    1. eda-activation-worker-1  | 2024-08-15 14:40:52,547 aap_eda.services.activation.activation_manager INFO     Stop operation requested for activation id: 2 Stopping activation.
    eda-activation-worker-1  | 2024-08-15 14:40:52,550 aap_eda.services.activation.activation_manager INFO     Activation 2 is already stopped.
    eda-activation-worker-1  | 2024-08-15 14:40:52,550 aap_eda.services.activation.activation_manager INFO     Activation manager activation id: 2 Activation restart scheduled for 1 second.
    eda-activation-worker-1  | 2024-08-15 14:40:52,562 rq.worker INFO     activation: Job OK (activation-2)
```

--------------------------------

### Run RPM-based Installation with Vault

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/hardening_and_compliance/hardening-aap

Command to execute the setup script for an RPM-based installation, using an external vault file and prompting for the vault password.

```bash
./setup.sh -e @vault.yml –ask-vault-pass
```

--------------------------------

### Example: Execute a specific playbook on an execution environment

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/developing_automation_content/writing-running-playbook_installing-devtools

This example demonstrates how to run the 'site.yml' playbook using the 'ee-minimal-rhel8' execution environment. It's a practical application of testing playbooks in a controlled environment.

```bash
ansible-navigator run site.yml --eei ee-minimal-rhel8
```

--------------------------------

### Install FIO storage performance benchmarking tool

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/platform-system-requirements

Installs the Flexible I/O Tester (fio) using yum. Run this command as the root user.

```bash
# yum -y install fio
```

--------------------------------

### Navigate to Installer Directory (Bundled)

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/automation_mesh_for_vm_environments/setting-up

Use this command to navigate to the installer directory when using the bundled installer.

```bash
$ cd ansible-automation-platform-setup-bundle-<latest-version>
```

--------------------------------

### Example Device Status Output

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/managing_device_fleets_with_the_red_hat_edge_manager/edge-manager-manage-apps

This is an example of the output from `flightctl get device -o yaml`, showing application specifications and their current status on the device.

```yaml
...
spec:
  applications:
  - name: example-app
    image: quay.io/flightctl-demos/example-app:v1
status:
  applications:
  - name: example-app
    ready: 3/3
    restarts: 0
    status: Running
  applicationsSummary:
    info: All application workloads are healthy.
    status: Healthy
...
```

--------------------------------

### Example Ansible Navigator Settings File (YAML)

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_content_navigator/assembly-settings-navigator_installing-devtools

This YAML file provides a comprehensive example of how to configure various settings for Ansible Navigator. Uncomment lines to enable specific configurations.

```yaml
---
ansible-navigator:
#   ansible:
#     config: /tmp/ansible.cfg
#     cmdline: "--forks 15"
#     inventories:
#     - /tmp/test_inventory.yml
#     playbook: /tmp/test_playbook.yml
#   ansible-runner:
#     artifact-dir: /tmp/test1
#     rotate-artifacts-count: 10
#     timeout: 300
#   app: run
#   collection-doc-cache-path: /tmp/cache.db
#   color:
#     enable: False
#     osc4: False
#   editor:
#     command: vim_from_setting
#     console: False
#   documentation:
#     plugin:
#       name: shell
#       type: become
#   execution-environment:
#     container-engine: podman
#     enabled: False
#     environment-variables:
#       pass:
#         - ONE
#         - TWO
#         - THREE
#       set:
#         KEY1: VALUE1
#         KEY2: VALUE2
#         KEY3: VALUE3
#     image: test_image:latest
#     pull-policy: never
#     volume-mounts:
#     - src: "/test1"
#       dest: "/test1"
#       label: "Z"
#   help-config: True
#   help-doc: True
#   help-inventory: True
#   help-playbook: False
#   inventory-columns:
#     - ansible_network_os
#     - ansible_network_cli_ssh_type
#     - ansible_connection
  logging:
#     append: False
    level: critical
#     file: /tmp/log.txt
#   mode: stdout
#   playbook-artifact:
#     enable: True
#     replay: /tmp/test_artifact.json
#     save-as: /tmp/test_artifact.json

```

--------------------------------

### Start Redis Services

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/ansible_automation_platform_migration/target-environment

Starts the Redis services, either `redis-unix` or `redis-tcp`, depending on the configuration. Run on the Redis node(s) for standalone or clustered Redis setups.

```bash
$ systemctl --user start redis-unix redis-tcp
```

--------------------------------

### Example Output: hstore Extension Not Available

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html-single/installing_on_openshift_container_platform/index

This is an example output indicating that the `hstore` extension is not available on the PostgreSQL server.

```text
 name | default_version | installed_version | comment
------+-----------------+-------------------+---------
(0 rows)
```

--------------------------------

### Example of Execution Environment Mount Configuration

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_execution/assembly-controller-execution-environments

This example shows how to configure paths to be exposed to isolated jobs, allowing volumes to be mounted from execution or hybrid nodes to job containers. It includes a specific mount with options.

```json
[
  "/var/lib/awx/.ssh:/root/.ssh:O"
]
```

--------------------------------

### Example OpenShift Route Output

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/installing_on_openshift_container_platform/install-aap-gateway_operator-install-operator

An example output from the 'oc get routes' command, illustrating the format and identifying the platform gateway's host address.

```bash
$ oc get routes -n ansible-automation-platform

NAME      HOST/PORT                                              PATH   SERVICES          PORT   TERMINATION     WILDCARD
example   example-ansible-automation-platform.apps-crc.testing          example-service   http   edge/Redirect   None
```

--------------------------------

### Sample Project Structure

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_execution/assembly-controller-project-signing

Displays the directory structure of a sample Ansible project before signing.

```bash
$ cd sample-project/
$ tree -a .
```

--------------------------------

### Configure Inventory for Disconnected Installation

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/containerized_installation/aap-containerized-disconnected-installation

Add these variables to the `[all:vars]` group in your inventory file for a disconnected installation. Ensure `bundle_dir` points to the correct location of your setup bundle.

```yaml
bundle_install=true
# The bundle directory must include /bundle in the path
bundle_dir='{{ lookup("ansible.builtin.env", "PWD") }}/bundle'
```

--------------------------------

### Extract Installation Source

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/using_automation_dashboard/assembly-view-key-metrics

Extracts the automation dashboard installation source files. This requires approximately 500MB of disk space. The example uses the user's home directory.

```bash
tar -xzvf ansible-automation-dashboard-containerized-setup-bundle-0.1-x86_64.tar.gz
cd ansible-automation-dashboard-containerized-setup/
```

--------------------------------

### Extract Ansible Automation Platform Setup Bundle

Source: https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.5/html/rpm_installation/disconnected-installation

Extracts the Ansible Automation Platform setup bundle archive. This bundle contains RPMs and execution environment images for disconnected installations.

```bash
$ tar xvf \
   ansible-automation-platform-setup-bundle-2.5-1.tar.gz
$ cd ansible-automation-platform-setup-bundle-2.5-1
```
Tokens:
Raw