containers.podman.buildah connection – Interact with an existing buildah container

Note

This connection plugin is part of the containers.podman collection (version 1.19.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.buildah.

Synopsis

  • Run commands or put/fetch files to an existing container using buildah tool.

  • Supports container building workflows with enhanced error handling and performance.

Parameters

Parameter

Comments

auto_commit

boolean

Automatically commit changes after successful operations.

Choices:

  • false ← (default)

  • true

Configuration:

  • Variable: ansible_buildah_auto_commit

buildah_executable

string

Executable for buildah command.

Default: "buildah"

Configuration:

  • INI entry:

    [defaults]
buildah_executable = buildah

  • Environment variable: ANSIBLE_BUILDAH_EXECUTABLE

  • Variable: ansible_buildah_executable

buildah_extra_args

string

Extra arguments to pass to the buildah command line.

Default: ""

Configuration:

  • INI entry:

    [defaults]
buildah_extra_args = ""

  • Environment variable: ANSIBLE_BUILDAH_EXTRA_ARGS

  • Variable: ansible_buildah_extra_args

container_timeout

integer

Timeout in seconds for container operations. 0 means no timeout.

Default: 0

Configuration:

  • INI entry:

    [defaults]
buildah_timeout = 0

  • Environment variable: ANSIBLE_BUILDAH_TIMEOUT

  • Variable: ansible_buildah_timeout

extra_env_vars

dictionary

Additional environment variables to set in the container.

Default: {}

Configuration:

  • Variable: ansible_buildah_extra_env

ignore_mount_errors

boolean

Continue with copy operations even if container mounting fails.

Choices:

  • false

  • true ← (default)

Configuration:

  • Variable: ansible_buildah_ignore_mount_errors

mount_detection

boolean

Enable automatic detection and use of container mount points for file operations.

Choices:

  • false

  • true ← (default)

Configuration:

remote_addr

string

The ID or name of the buildah working container you want to access.

Default: "inventory_hostname"

Configuration:

  • INI entry:

    [defaults]
remote_addr = inventory_hostname

  • Environment variable: ANSIBLE_BUILDAH_HOST

  • Variable: inventory_hostname

  • Variable: ansible_host

  • Variable: ansible_buildah_host

remote_user

string

User specified via name or UID which is used to execute commands inside the container.

For buildah, this affects both run commands and copy operations.

Configuration:

  • INI entry:

    [defaults]
remote_user = VALUE

  • Environment variable: ANSIBLE_REMOTE_USER

  • Variable: ansible_user

working_directory

string

Set working directory for commands executed in the container.

Configuration:

Authors

  • Tomas Tomecek (@TomasTomecek)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.