Installation

Requirements

  • To build images, you must install a containerization tool - either podman or docker - as well as the ansible-builder Python package.

  • The --container-runtime option must correspond to the containerization tool you use.

  • ansible-builder version 3.x requires Python 3.9 or higher.

Base Image Requirements

Ansible Builder requires RPM-based container images (those using dnf or microdnf package management) as the base for execution environments. Non-RPM-based distributions such as Debian, Ubuntu, or Alpine are not supported.

For detailed information about choosing an appropriate base image and a list of images that should work, see the Choosing a base image section.

Install from PyPI

$ pip3 install ansible-builder

Note

An alternative approach to installing ansible-builder is using the ansible-dev-tools package. Ansible Development Tools (ADT) is a single Python package that includes all necessary tools to set up a development environment, generate new collections, build and test the content.

# This also installs ansible-core if it is not already installed
$ pip3 install ansible-dev-tools

Install from Source

To install from the mainline development branch:

$ pip3 install https://github.com/ansible/ansible-builder/archive/devel.zip

To install from a specific tag or branch, replace <ref> in the following example:

$ pip3 install https://github.com/ansible/ansible-builder/archive/<ref>.zip