Chapter 2. Configuring Red Hat automation hub as the primary source for content

Configure Red Hat automation hub as your primary source of content to access Ansible Certified Content Collections. You can configure automation hub in the command-line interface (CLI) or the web console.

2.1. Configuring Red Hat automation hub as the primary source for content using the CLI

Configure Red Hat automation hub as your primary source of content by using the CLI. To configure automation hub, you must modify the ansible.cfg configuration file. With automation hub, you have access to certified, supported collections.

Prerequisites

Creating a new token revokes any previous tokens
generated for {PrivateHubName}. Ensure that you update any Controller or scripts that you created with the previous token.

Procedure

  1. Add the server_list option under the [galaxy] section and provide one or more server names.

  2. Create a new section for each server name: 

    [galaxy_server._<server_name>_]

  3. Set the url option for each server name. You must include the api/galaxy/ subdirectory in the server URL: 

    https://<server_fully_qualified_domain_name>/api/galaxy/
  4. Optional: Set the auth_url option. The community Ansible Galaxy does not require an auth_url.
  5. Set the API token for the automation hub server.

The following ansible.cfg configuration file example shows how to configure multiple servers in prioritized order, with automation hub configured as your primary source and an Ansible Galaxy server as a secondary source:

ansible.cfg

[galaxy]
server_list = automation_hub, my_org_hub

[galaxy_server.automation_hub]
url=https://cloud.redhat.com/api/automation-hub/api/galaxy/ 1 2
auth_url=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

token=my_ah_token

[galaxy_server.my_org_hub]
url=https://automation.my_org/api/galaxy/ 3
username=my_user
password=my_pass

1
Include a trailing slash / after the server URL.
2
Include the /api/galaxy/ subdirectory in the Ansible Galaxy server URL.
3
Include the /api/galaxy/ subdirectory in the automation hub server URL.
Note

All API URLs must end with a trailing slash / to prevent receiving a 301 redirect.

You have now configured automation hub as your primary server using CLI, and can proceed to download and install supported collections.

Additional resources

For more information about server list configuration options and using Ansible Galaxy as an Ansible content source, see the Ansible Galaxy User Guide.

2.2. Configuring Red Hat automation hub as the primary source for content using the web console

Configure Red Hat automation hub as your primary source of content by using the web console. To configure automation hub, you must create a credential and add it to the Organization’s Galaxy Credentials field. With automation hub, you have access to certified, supported collections.

Prerequisites

Creating a new token revokes any previous tokens
generated for {PrivateHubName}. Ensure that you update any Controller or scripts that you created with the previous token.

Procedure

  1. Go to your automation controller.

  2. Create a new credential.

    1. Click Add from the Credentials screen.
    2. Enter the name for your new credential in the Name field.
    3. Optional: Enter a description and enter or select the name of the organization with which the credential is associated.
    4. Under Organization, select the organization that you would like to use the credential for.
    5. Select Ansible Galaxy/Automation Hub API Token as the credential type.
    6. Under Type Details, enter the Galaxy Server URL, Authentication Server URL, and API Token created in the Prerequisite.
    7. Click Save.

  3. Select the credential you created from the Organization’s Galaxy Credentials field.

    1. Navigate to Access → Organizations.
    2. Select the organization where you’d like to add your Galaxy credentials.
    3. Click Edit.
    4. Under Galaxy Credentials, click the Search icon.
    5. Select the credential you created for automation hub, and place it at the beginning of the list.
    6. Optional: If you have a secondary source of content, such as Ansible Galaxy, place this credential after the credential you created for automation hub.
    7. Click Select.
    8. Click Save.

Verification

To validate the credential, update an existing source control management (SCM)-based project by selecting the project and clicking the Refresh icon.

  1. Navigate to your project repository.
  2. Select a project that uses a collections/requirements.yml file.
  3. Update the project by clicking the refresh icon [refresh icon].

If the status of the project is Successful, then the credential is valid.

You have now configured automation hub as your primary server using the web console, and you can proceed to download and install supported collections.

Additional resources

  1. For more information about server list configuration options and using Ansible Galaxy as an Ansible content source, see the Ansible Galaxy User Guide.
  2. For more information about creating and using credentials, see the Credentials section of automation controller User Guide v4.2.1.