community.general.atomic_image module – Manage the container images on the atomic host platform

Note

This module is part of the community.general collection (version 10.0.1).

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 community.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.atomic_image.

Synopsis

  • Manage the container images on the atomic host platform.

  • Allows to execute the commands specified by the RUN label in the container image when present.

Requirements

The below requirements are needed on the host that executes this module.

  • atomic

Parameters

Parameter

Comments

backend

string

Define the backend where the image is pulled.

Choices:

  • "docker"

  • "ostree"

name

string / required

Name of the container image.

started

boolean

Start or Stop the container.

Choices:

  • false

  • true ← (default)

state

string

The state of the container image.

The state latest will ensure container image is upgraded to the latest version and forcefully restart container, if running.

Choices:

  • "absent"

  • "latest" ← (default)

  • "present"

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • Host should support atomic command.

Examples

- name: Execute the run command on rsyslog container image (atomic run rhel7/rsyslog)
  community.general.atomic_image:
    name: rhel7/rsyslog
    state: latest

- name: Pull busybox to the OSTree backend
  community.general.atomic_image:
    name: busybox
    state: latest
    backend: ostree

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

The command standard output

Returned: always

Sample: "Using default tag: latest ..."

Authors

  • Saravanan KR (@krsacme)