Creating and Consuming Execution Environments

1. Fetch base image
2. In the ephemeral copy of base image, collections are downloaded and the list of declared Python and system dependencies, if any, are collected for later.
3. In the ephemeral builder image, Python wheels for all Python dependencies listed in the definition file are downloaded and built (as needed), including all Python dependencies declared by collections listed in the definition file.
4. prepend for additional_build_steps from the definition file are run.
5. In the final automation execution environments image, system dependencies listed in the definition file are installed, including all system dependencies declared by collections listed in the definition file.
6. In the final automation execution environments image, the downloaded collections are copied and the previously fetched Python dependencies are installed.
7. append for additional_build_steps from the definition file are run.

Procedure

1. Log in to registry.redhat.io via Podman:

   $ podman login -u="[username]" -p="[token/hash]" registry.redhat.io

2. Ensure that you can pull the desired automation execution environment base image

   podman pull registry.redhat.io/ansible-automation-platform-22/ee-minimal-rhel8:latest

3. Configure your Ansible Builder files to specify the desired base image and any additional content to add to the new execution environment image.

   1. For example, to add the Kubernetes Core Collection from Galaxy to the image, fill out the requirements.yml file as follows:

      collections:
        - kubernetes.core

   2. For more information on definition files and their content, refer to to definition file breakdown section.

4. In the execution environment definition file, specify the original ee-minimal container’s URL and tag in the EE_BASE_IMAGE field. In doing so, your final execution-environment.yml file will look like the following:

   Example 3.1. A customized execution-environment.yml file

   version: 1
   
   build_arg_defaults:
     EE_BASE_IMAGE: 'registry.redhat.io/ansible-automation-platform-22/ee-minimal-rhel8:latest'
   
   dependencies:
     galaxy: requirements.yml

   Note

   Since this example uses the community version of kubernetes.core and not a certified collection from automation hub, we do not need to create an ansible.cfg file or reference that in our definition file.

5. Build the new execution environment image using the following command:

   $ ansible-builder build -t registry.redhat.io/[username]/new-ee

   where [username] specifies your username, and new-ee specifies the name of your new container image.

1. Use the podman images command to confirm that your new container image is in that list:

   Example 3.2. Output of a podman images command with the image new-ee

   REPOSITORY          TAG     IMAGE ID      CREATED        SIZE
   localhost/new-ee    latest  f5509587efbb  3 minutes ago  769 MB

   1. Verify that the collection is installed:

      $ podman run registry.redhat.io/[username]/new-ee ansible-doc -l kubernetes.core

   2. Tag the image for use in your automation hub:

      $ podman tag registry.redhat.io/[username]/new-ee [automation-hub-IP-address]/[username]/new-ee

   3. Log in to your automation hub using Podman:

      Note

      You must have admin or appropriate container repository permissions for automation hub to push a container. See Managing containers in private automation hub in the Red Hat Ansible Automation Platform documentation for more information.

      $ podman login -u="[username]" -p="[token/hash]" [automation-hub-IP-address]

   4. Push your image to the container registry in automation hub:

      $ podman push [automation-hub-IP-address]/[username]/new-ee

   5. Pull your new image into your automation controller instance:
2. Navigate to automation controller.
3. From the side-navigational bar, click Administration → Execution Environments.
4. Click Add.

5. Enter the appropriate information then click Save to pull in the new image.

   Note

   If your instance of automation hub is password or token protected, ensure that you have the appropriate container registry credential set up.

Procedure

1. Log in to Podman using your registry.redhat.io credentials:

   $ podman login registry.redhat.io

2. Enter your username and password at the prompts.

3. Pull a container image:

   $ podman pull registry.redhat.io/<container_image_name>:<tag>

Verification

1. List the images in local storage:

   $ podman images

2. Verify that the image you recently pulled is contained in the list.
3. Verify that the tag is correct.

Verification

1. List the images in local storage:

   $ podman images

2. Verify that the image you recently tagged with your automation hub information is contained in the list.

Procedure

1. Log in to Podman using your automation hub location and credentials:

   $ podman login -u=<username> -p=<password> <automation_hub_url>

2. Push your container image to your automation hub container registry:

   $ podman push <automation_hub_url>/<container_image_name>

   Note

   The --remove-signatures flag is required when signed images from registry.redhat.io are pushed to the automation hub container registry. The push operation re-compresses image layers during the upload, which is not guaranteed to be reproducible and is client implementation dependent. This may lead to image-layer digest changes and a failed push operation, resulting in Error: Copying this image requires changing layer representation, which is not possible (image is signed or the destination specifies a digest).

Verification

1. Log in to your automation hub.
2. Navigate to Container Registry.
3. Locate the container in the container repository list.

Procedure

1. Navigate to Execution Environments.
2. Select your container repository.
3. On the Detail tab, click Add.
4. In the Raw Markdown text field, enter your README text in Markdown.
5. Click Save when you are finished.

Procedure

1. Navigate to Execution Environments.
2. Select your container repository.
3. Click Edit at the top right of your window.

4. Under Groups with access, select a group or groups to grant access to.

   • Optional: Add or remove permissions for a specific group using the drop down under that group name.
5. Click Save.

Procedure

1. Navigate to Execution Environments.
2. Select your container repository.
3. Click the Images tab.
4. Click , then click Manage tags.

5. Add a new tag in the text field and click Add.

   • Optional: Remove current tags by clicking x on any of the tags for that image.
6. Click Save.

Procedure

1. Navigate to automation controller.
2. In the side-menu bar, click Resources → Credentials.
3. Click Add to create a new credential.
4. Enter an authorization Name, Description, and Organization.
5. Select the Credential Type.
6. Enter the Authentication URL. This is the container registry address.
7. Enter the Username and Password or Token required to log in to the container registry.
8. Optionally, select Verify SSL to enable SSL verification.
9. Click Save.

Procedure

1. Navigate to Execution Environments.
2. Select your container repository.
3. In the Pull this image entry, click Copy to clipboard.
4. Paste and run the command in your terminal.

1. Navigate to Execution Environments → Remote Registries.
2. Add https://registry.redhat.io to the registry.
3. Add any required credentials to authenticate.

1. Navigate to Execution Environments → Execution Environments.
2. Click Add execution environment in the page header.
3. Select the registry you wish to pull from. The "name" field displays the name of the image that will show up as on your local registry.