Chapter 1. Red Hat Certified, validated, and Ansible Galaxy content in automation hub

Procedure

1. Log in to console.redhat.com.
2. Navigate to Automation Hub Collections.
3. Set the toggle switch on each collection to exclude or include it on your synclist.
4. To initiate the remote repository synchronization, navigate to automation hub and select Collection Repositories.
5. Click the More Actions icon ⋮ and select Sync to initiate the remote repository synchronization to your private automation hub.
6. Optional: If your remote repository is already configured, update the collections content that you made available to local users by manually synchronizing Red Hat Ansible Certified Content Collections to your private automation hub.

Procedure

1. Log in to console.redhat.com as an organization administrator.
2. Navigate to Automation Hub Connect to Hub.
3. Under Offline token, click Load token.
4. Click Copy to clipboard to copy the API token.
5. Paste the API token into a file and store in a secure location.

Procedure

1. Log in to your private automation hub.
2. From the navigation panel, select Collections Remotes.
3. In the rh-certified remote repository, click the More Actions icon ⋮ and click Edit.
4. In the URL field, paste the Sync URL.
5. In the Token field, paste the token you acquired from console.redhat.com.

6. Click Save.

   You can now synchronize collections between your organization synclist on console.redhat.com and your private automation hub.

7. Click the More Actions icon ⋮ and select Sync.

Procedure

1. Log in to automation hub.
2. From the navigation panel, select Collections Remotes.
3. In the Community remote, click the More Actions icon ⋮ and select Edit.
4. In the YAML requirements field, click Browse and locate the requirements.yml file on your local machine.

5. Click Save.

   You can now synchronize collections identified in your requirements.yml file from Ansible Galaxy to your private automation hub.

6. Click the More Actions icon ⋮ and select Sync to sync collections from Ansible Galaxy and Ansible automation hub.

Procedure

1. Log in to private automation hub.
2. From the navigation panel, select Collections Remotes.
3. In either the rh-certified or Community remote, click the More Actions icon ⋮ and select Edit.
4. Expand the Show advanced options drop-down menu.
5. Enter your proxy URL, proxy username, and proxy password in the appropriate fields.
6. Click Save.

Procedure

1. Create a signing script that accepts only a filename.

   Note

   This script acts as the signing service and must generate an ascii-armored detached gpg signature for that file using the key specified through the PULP_SIGNING_KEY_FINGERPRINT environment variable.

   The script prints out a JSON structure with the following format.

   {"file": "filename", "signature": "filename.asc"}

   All the file names are relative paths inside the current working directory. The file name must remain the same for the detached signature.

   Example:

   The following script produces signatures for content:

   #!/usr/bin/env bash
   
   FILE_PATH=$1
   SIGNATURE_PATH="$1.asc"
   
   ADMIN_ID="$PULP_SIGNING_KEY_FINGERPRINT"
   PASSWORD="password"
   
   # Create a detached signature
   gpg --quiet --batch --pinentry-mode loopback --yes --passphrase \
      $PASSWORD --homedir ~/.gnupg/ --detach-sign --default-key $ADMIN_ID \
      --armor --output $SIGNATURE_PATH $FILE_PATH
   
   # Check the exit status
   STATUS=$?
   if [ $STATUS -eq 0 ]; then
      echo {\"file\": \"$FILE_PATH\", \"signature\": \"$SIGNATURE_PATH\"}
   else
      exit $STATUS
   fi

   After you deploy a private automation hub with signing enabled to your Ansible Automation Platform cluster, new UI additions are displayed in collections.

2. Review the Ansible Automation Platform installer inventory file for options that begin with automationhub_*.

   [all:vars]
   .
   .
   .
   automationhub_create_default_collection_signing_service = True
   automationhub_auto_sign_collections = True
   automationhub_require_content_approval = True
   automationhub_collection_signing_service_key = /abs/path/to/galaxy_signing_service.gpg
   automationhub_collection_signing_service_script = /abs/path/to/collection_signing.sh

   The two new keys (automationhub_auto_sign_collections and automationhub_require_content_approval) indicate that the collections must be signed and approved after they are uploaded to private automation hub.

Procedure

1. Log in to your Ansible Automation Platform.
2. From the navigation panel, select Collections Approval. The Approval dashboard opens and displays a list of collections.
3. Click Sign and approve for each collection that you want to sign.

Procedure

1. Log in to your automation hub.

2. From the navigation panel, select Signature Keys. The Signature Keys dashboard displays a list of multiple keys: collections and container images.

   • To verify collections, download the key prefixed with collections-.
   • To verify container images, download the key prefixed with container-.

3. Choose one of the following methods to download your public key:

   • Select the menu icon and click Download Key to download the public key.
   • Select the public key from the list and click the Copy to clipboard icon.
   • Click the drop-down menu under the Public Key tab and copy the entire public key block.

Procedure

1. To import a public key into a non-default keyring for use with ansible-galaxy, run the following command.

   gpg --import --no-default-keyring --keyring ~/.ansible/pubring.kbx my-public-key.asc

   Note

   In addition to any signatures provided by the automation hub, signature sources can also be provided in the requirements file and on the command line. Signature sources should be URIs.

2. To verify the collection name provided on the CLI with an additional signature, run the following command:

   ansible-galaxy collection install namespace.collection
   --signature https://examplehost.com/detached_signature.asc
   --signature file:///path/to/local/detached_signature.asc --keyring ~/.ansible/pubring.kbx

   You can use this option multiple times to provide multiple signatures.

3. Confirm that the collections in a requirements file list any additional signature sources following the collection’s signatures key, as in the following example.

   # requirements.yml
   collections:
     - name: ns.coll
       version: 1.0.0
       signatures:
         - https://examplehost.com/detached_signature.asc
         - file:///path/to/local/detached_signature.asc
   
   ansible-galaxy collection verify -r requirements.yml --keyring ~/.ansible/pubring.kbx

   When you install a collection from automation hub, the signatures provided by the server are saved along with the installed collections to verify the collection’s authenticity.

4. (Optional) If you need to verify the internal consistency of your collection again without querying the Ansible Galaxy server, run the same command you used previously using the --offline option.

Procedure

1. To obtain the tarball, navigate to the Red Hat Ansible Automation Platform download page and select Ansible Validated Content.

2. Upload the content and define the variables (this example uses automationhub_api_token):

   ansible-playbook collection_seed.yml
   -e automationhub_api_token=<api_token>
   -e automationhub_main_url=https://automationhub.example.com
   -e automationhub_require_content_approval=true

   Note

   Use either automationhub_admin_password or automationhub_api_token, not both.