Chapter 3. Publishing an automation execution environment
3.1. Customizing an existing automation execution environments image
Ansible Controller includes three default execution environments:
-
Ansible 2.9
- no collections are installed other than Controller modules -
Minimal
- contains the latest Ansible 2.13 release along with Ansible Runner, but contains no collections or other additional content -
EE Supported
- Minimal, plus all Red Hat-supported collections and dependencies
While these environments cover many automation use cases, you can add additional items to customize these containers for your specific needs. The following procedure adds the kubernetes.core
collection to the ee-minimal
default image:
Procedure
Log in to
registry.redhat.io
via Podman:$ podman login -u="[username]" -p="[token/hash]" registry.redhat.io
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
Configure your Ansible Builder files to specify the desired base image and any additional content to add to the new execution environment image.
For example, to add the Kubernetes Core Collection from Galaxy to the image, fill out the
requirements.yml
file as follows:collections: - kubernetes.core
- For more information on definition files and their content, refer to to definition file breakdown section.
In the execution environment definition file, specify the original
ee-minimal
container’s URL and tag in theEE_BASE_IMAGE
field. In doing so, your finalexecution-environment.yml
file will look like the following:Example 3.1. A customized
execution-environment.yml
fileversion: 1 build_arg_defaults: EE_BASE_IMAGE: 'registry.redhat.io/ansible-automation-platform-22/ee-minimal-rhel8:latest' dependencies: galaxy: requirements.yml
NoteSince this example uses the community version of
kubernetes.core
and not a certified collection from automation hub, we do not need to create anansible.cfg
file or reference that in our definition file.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, andnew-ee
specifies the name of your new container image.
If you do not use -t
with build
, an image called ansible-execution-env
is created and loaded into the local container registry.
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 imagenew-ee
REPOSITORY TAG IMAGE ID CREATED SIZE localhost/new-ee latest f5509587efbb 3 minutes ago 769 MB
Verify that the collection is installed:
$ podman run registry.redhat.io/[username]/new-ee ansible-doc -l kubernetes.core
Tag the image for use in your automation hub:
$ podman tag registry.redhat.io/[username]/new-ee [automation-hub-IP-address]/[username]/new-ee
Log in to your automation hub using Podman:
NoteYou 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]
Push your image to the container registry in automation hub:
$ podman push [automation-hub-IP-address]/[username]/new-ee
- Pull your new image into your automation controller instance:
- Navigate to automation controller.
-
From the side-navigational bar, click
. - Click .
Enter the appropriate information then click
to pull in the new image.NoteIf your instance of automation hub is password or token protected, ensure that you have the appropriate container registry credential set up.