This repository contains a Makefile, Ansible inventory and playbook for building container images running an init system for use in Ansible Molecule tests.
This is the successor of the buildah scripts from buildah-molecule-images.
sudo dnf -y install git make python3 python3-pip python3-virtualenv
mkdir -p ~/src/ansible && cd ~/src/ansible
git clone https://github.com/jomrr/ansible-molecule-images
cd ansible-molecule-images
pip install --user --upgrade pip
pip install --user keyring
# set docker registry user and secret, add to ~/.bashrc or ~/.bashrc.d/env
keyring set docker user
keyring set docker secret
# nvim ~/.bashrc.d/env
export DOCKER_USER=$(keyring get docker user)
export DOCKER_SECRET=$(keyring get docker secret)
# optionally edit containers.yml and add more registries and credentials under key push_registries.
# nvim containers.yml
make install
make all
# or:
make <almalinux|alpine|amazonlinux|archlinux|debian|fedora|opensuse|oraclelinux|ubuntu>
# to upgrade the virtualenv packages and ansible-galaxy dependencies run:
make upgradeThe playbook playbooks/build.yml uses the ansible.builtin.template
module to render Dockerfiles to build/{{ inventory_hostname }}/Dockerfile and then uses
the containers.podman.podman_image module to build and push the images to the registries
configured in containers.yml.
In this file, registries and their credentials are defined as a list of dictionaries under
the key push_registries. The name of the built image is configured via the host variable
build_image, and the tags are configured via the host variable build_tags.
Inventory variables in containers.yml
Any of these variables can be set at all, group or host level, where host level has the highest precedence.
| variable | type | default | example | description |
|---|---|---|---|---|
| ansible_connection | str | local | <= | ansible_connection=local for inventory hosts |
| build_dir | str | "../build" | <= | transient build directory in repository root |
| build_maintainer | str | Jonas Mauer <[email protected]> | <= | build maintainer metadata used in OCI labels in generated Dockerfile |
| display_name | str | - | AlmaLinux |
display name of the distribution the image is based on |
| pull_image | str | - | opensuse/tumbleweed |
name of the image to use in FROM statement in generated Dockerfile |
| pull_registry | str | docker.io | <= | the container registry from where an image is pulled from |
| push_image | str | - | opensuse-leap |
name/slug of the built image |
| push_repo | str | - | molecule-alpine |
repo name of the built image, e.g. molecule-fedora |
| push_tags | list=str | - | ["42", "adams"] |
tags for the built images |
| push_registries | list=dict | [ { name: docker.io, username: "{{ lookup('ansible.builtin.env', 'DOCKER_USER') }}", password: "{{ lookup('ansible.builtin.env', 'DOCKER_SECRET') }}" } ] | <= | list of registry definitions as dictionaries to which the built images are pushed |
This provides an overview of the prerequisites and ansible dependencies, as well as some usage examples.
The following prerequisites must be installed before using this playbook.
The following packages need to be installed manually, adapt to your distribution as package names may vary:
gitmake>= 4.3python3>= 3.12python3-pippython3-virtualenvyq>= 4.47 (https://github.com/mikefarah/yq)
The python prerequisites are installed in a virtualenv .venv via the Makefile with make install.
- ansible >= 2.18
To install it manually in the user environment without a virtualenv run:
pip install --user --upgrade pip
pip install --user --upgrade 'ansible>=2.18'For development the following are also installed by make install:
- commitizen
- pre-commit
- python-semantic-release
The containers.podman collection will be installed in the virtualenv during make install.
To install it manually for your regular user without virtualenv run:
ansible-galaxy collection install containers.podmanAs a requirements.yml file
---
# name: ansible-molecule-images
# file: requirements.yml
collections:
- containers.podman
roles: []
it can be installed with:
ansible-galaxy install -r requirements.ymlAll Fedora images are created in parallel, after completion the Debian images are created.
make fedora debianThis will make make run 2 jobs simultaneously, but mind the resource consumption:
make -j 2 fedora debianThis basically translates to the two commands:
ansible-playbook playbooks/build.yml --limit=fedora &
ansible-playbook playbooks/build.yml --limit=debian &The inventory containers.yml is configured as static yaml inventory in ansible.cfg and therefore implicitly used by ansible-playbook.
This content is published under the MIT License.
This content was created in 2024 by Jonas Mauer (@jomrr).
Thanks to @fgoebel for his contributions to buildah-molecule-images. They are included here. Looking forward to collaborating again.