Ansible Builder Guide
Execution environment builder to create consistent and reproducible automation execution environments for your Red Hat Ansible Automation Platform.
Abstract
Preface
Use Ansible Builder to create consistent and reproducible automation execution environments for your Red Hat Ansible Automation Platform needs.
Chapter 1. Introduction to Ansible Builder
1.1. About Ansible Builder
Ansible Builder is a command line tool that automates the process of building automation execution environments by using the metadata defined in various Ansible Collections, as well as by the user.
1.1.1. Why use Ansible Builder?
Before Ansible Builder was developed, Automation Platform users would potentially run against dependency issues and multiple error messages as they attempted to create a custom virtual environment or container that had all of their required dependencies installed.
Through the use of an easily customizable definition file, Ansible Builder installs Ansible, specified Collections and any of its dependencies so that all of the necessary requirements to get jobs running are fulfilled behind the scenes.
Chapter 2. Using Ansible Builder
2.1. Installing Ansible Builder
You can install Ansible Builder using Red Hat Subscription Management to register and attach to your Red Hat Ansible Automation Platform subscription. In your terminal, run the following command:
$ dnf install ansible-builder
You can also install Ansible Builder from the Python Package Index (PyPI). To install with this setup, run:
$ pip install ansible-builder
2.2. Building a definition file
Once you have Ansible Builder installed, we will need to create a definition file which Ansible Builder will use to create your automation execution environment image. The high level process to build an automation execution environment image is for Ansible Builder to read and validate your definition file, then create a Continerfile, and finally pass the Containerfile to Podman which then packages and creates your automation execution environment image. The definition file we will create for Ansible Builder is in yaml format and contains different sections which we will discuss in further detail.
The following is an example of a definition file:
Example 2.1. A definition file
version: 1 build_arg_defaults: 1 ANSIBLE_GALAXY_CLI_COLLECTION_OPTS: "-v" ansible_config: 'ansible.cfg' 2 dependencies: 3 galaxy: requirements.yml python: requirements.txt system: bindep.txt additional_build_steps: 4 prepend: | RUN whoami RUN cat /etc/os-release append: - RUN echo This is a post-install command! - RUN ls -la /etc
For more information about these definition file parameters, please see this section.
2.3. Executing the build and creating commands
Prerequisites
- You have created a definition file
Procedure
To build an automation execution environment image, run:
$ ansible-builder build
By default, Ansible Builder will look for a definition file named execution-environment.yml but a different file path can be specified as an argument via the -f flag:
$ ansible-builder build -f definition-file-name.ymlwhere definition-file-name specifies the name of your definition file.
2.4. Breakdown of definition file content
A definition file is necessary for building automation execution environments with Ansible Builder, as it specifies the content which will be included in the automation execution environment container image.
The following sections breaks down the different parts of a definition file.
2.4.1. Build args and base image
The build_arg_defaults section of the definition file is a dictionary whose keys can provide default values for arguments to Ansible Builder. See the following table for a list of values that can be used in default_build_args:
| Value | Description |
|---|---|
|
|
|
|
| Specifies the parent image for the automation execution environment, enabling a new image to be built that is based off of an already-existing image |
|
| Specifies the image used for compiling-type tasks |
The values given inside build_arg_defaults will be hard-coded into the Containerfile, so these values will persist if podman build is called manually.
If the same variable is specified in the CLI --build-arg flag, the CLI value will take higher precedence.
2.4.2. Ansible config file path
When using an ansible.cfg file to pass a token and other settings for a private account to an automation hub server, list the config file path (relative to where the definition file is located) as a string to enable it as a build argument in the initial phase of the build.
The ansible.cfg file should be formatted like the following example:
Example 2.2. An ansible.cfg file
[galaxy] server_list = automation_hub [galaxy_server.automation_hub] url=https://cloud.redhat.com/api/automation-hub/ auth_url=https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token token=my_ah_token
For more information on how to download a collection from automation hub, please see the related Ansible documentation page.
2.4.3. Dependencies
2.4.3.1. Galaxy
The galaxy entry points to a valid requirements file for the ansible-galaxy collection install -r … command.
The entry requirements.yml may be a relative path from the directory of the automation execution environment definition’s folder, or an absolute path.
The content of a requirements.yml file may look like the following:
Example 2.3. A requirements.yml file for Galaxy
--- collections: - geerlingguy.java - kubernetes.core
2.4.3.2. Python
The python entry in the definition file points to a valid requirements file for the pip install -r … command.
The entry requirements.txt is a file that installs extra Python requirements on top of what the Collections already list as their Python dependencies. It may be listed as a relative path from the directory of the automation execution environment definition’s folder, or an absolute path. The contents of a requirements.txt file should be formatted like the following example, similar to the standard output from a pip freeze command:
Example 2.4. A requirements.yml file for Python
boto>=2.49.0 botocore>=1.12.249 pytz python-dateutil>=2.7.0 awxkit packaging requests>=2.4.2 xmltodict azure-cli-core==2.11.1 python_version >= '2.7' collection community.vmware google-auth openshift>=0.6.2 requests-oauthlib openstacksdk>=0.13 ovirt-engine-sdk-python>=4.4.10
2.4.3.3. System
The system entry in the definition points to a bindep requirements file, which will install system-level dependencies that are outside of what the collections already include as their dependencies. It may be listed as a relative path from the directory of the automation execution environment definition’s folder, or an absolute path.
To demonstrate this, the following is an example bindep.txt file that adds the libxml2 and subversion packages to a container:
Example 2.5. A bindep.txt file
libxml2-devel [platform:rpm] subversion [platform:rpm]
2.4.4. Additional custom build steps
The prepend and append commands may be specified in the additional_build_steps section. These will add commands to the Containerfile which will run either before or after the main build steps are executed.
The syntax for additional_build_steps must be one of the following:
a multi-line string
Example 2.6. A multi-line string entry
RUN whoami RUN cat /etc/os-release
a list
Example 2.7. A list entry
- RUN echo This is a post-install command! - RUN ls -la /etc
2.5. Optional build command arguments
The -t flag will give your automation execution environment image a specific name. For example, the following command will build an image named my_first_ee_image:
$ ansible-builder build -t my_first_ee_image
If you have multiple definition files, you can specify which one to use by utilizing the -f flag:
$ ansible-builder build -f another-definition-file.yml -t another_ee_image
In the example above, Ansible Builder will use the specifications provided in the file another-definition-file.yml instead of the default execution-environment.yml to build an automation execution environment image named another_ee_image.
For other specifications and flags that are possible to use with the build command, enter ansible-builder build --help to see a list of additional options.
2.6. Creating a Containerfile without building an image
To create a shareable Containerfile without building an image from it, run:
$ ansible-builder create
Chapter 3. Publishing an automation execution environment
3.1. Pushing an execution environment container image to automation hub
Prerequisite
- You have execution environment permissions in automation hub allowing you to create new containers or push to an existing container.
A container registry is a repository for storing container images. Once you have built an automation execution environment image, you’ll be ready to push that container image to the registry portion of your instance of automation hub.
With your automation hub URL on hand, run the following command to log in to Podman, substituting your username, password, and automation hub URL:
$ podman login -u=username -p=password automation-hub-url
Once you’re logged in to Podman, run the following command to push your container image to the container registry on automation hub:
$ podman push automation-hub-url/ee-image-name
The automation execution environment image name is specified by the -t argument to the ansible-builder build command. If you did not specify a custom image name using the -t flag, the default image tag is ansible-execution-env:latest.
3.2. Pulling from a protected registry
To pull container images from a password or token-protected registry, create a credential in automation controller:
Procedure
- Navigate to automation controller
- In the side-menu bar, click Resources > Credentials.
- Click Add to create a new credential.
- Supply an authorization URL, username, and password. Click Save.
For more information, please reference the Pulling from Protected Registries section of the Execution Environment documentation.
Chapter 4. Building off of existing base EEs provided by Red Hat Ansible Automation Platform
4.1. Gathering system-level dependencies
The bindep format provides a way of specifying cross-platform requirements. A minimum expectation is that the collection(s) specify necessary requirements for [platform:rpm].
Below is an example of content from a valid bindep.txt file:
Example 4.1. A bindep.txt file
python38-devel [platform:rpm compile] subversion [platform:rpm] git-lfs [platform:rpm]
Entries from multiple collections will be combined into a single file. This will be processed by bindep and then passed to dnf. Only requirements with no profiles or no runtime requirements will be installed to the image.
4.2. Note for pip-based requirements
Python requirements files are combined into a single file using the requirements-parser library in order to support complex syntax. Entries from separate collections that give the same package name will be combined into the same entry, with the constraints combined.
There are several package names which are specifically ignored by ansible-builder; if a collection lists these, they will not be included in the combined file. These include test packages and packages that provide Ansible itself.
The full list can be found in EXCLUDE_REQUIREMENTS in the ansible_builder.requirements.py module.
4.3. Customizing an existing execution environment image
Ansible Controller ships with three default execution environments:
-
Ansible 2.9- no collections are installed other than Controller modules -
Minimal- contains the latest Ansible 2.11 release along with Ansible Runner, but contains no collections or other additional content -
EE Supported- contains all Red Hat-supported content
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
quay.iovia Podman:$ podman login -u="[username]" -p="[token/hash]" quay.io
Verify that you have access to pull the base image that you want to use.
-
For example, to pull a
ee-minimalimage, check that you have access to this repository.
-
For example, to pull a
Configure your Ansible Builder files to specify any additional content to add to the new execution environment image which is based off of
ee-minimal.For example, to add the Kubernetes Core Collection from Galaxy to the image, fill out the
requirements.ymlfile as such:--- 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 filepath to the original
ee-minimalcontainer via theEE_BASE_IMAGEfield. In doing so, your finalexecution-environment.ymlfile will look like the following:Example 4.2. A customized
execution-environment.ymlfile--- version: 1 build_arg_defaults: EE_BASE_IMAGE: 'example.registry.com/my-base-ee' dependencies: galaxy: requirements.yml
NoteSince this example uses the community version of
kubernetes.coreand not a certified collection from automation hub, we do not need to create anansible.cfgnor reference that in our definition file.Build the new execution environment image using the following command:
$ ansible-builder build -t quay.io/[username]/new-ee
where
[username]specifies your username, andnew-eespecifies the name of your new container image.Use the
podman imagescommand to confirm that your new container image is indeed in that list:Example 4.3. Output of a
podman imagescommand with the imagenew-eeREPOSITORY TAG IMAGE ID CREATED SIZE localhost/new-ee latest f5509587efbb 3 minutes ago 769 MB
- Verify your newly-created execution environment image via Ansible Navigator
Push your image to the container registry automation hub:
$ podman push quay.io/[username]/new-ee
Pull your new image in your automation controller instance:
- Navigate to automation controller
- From the side-navigational bar, click Administration > Execution Environments.
- Click Add.
Enter the appropriate information then hit Save 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.
