community.general.atomic_container – Manage the containers on the atomic host platform

Note

This plugin is part of the community.general collection (version 4.2.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 community.general.

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

Synopsis

  • Manage the containers on the atomic host platform.

  • Allows to manage the lifecycle of a container on the atomic host platform.

Requirements

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

  • atomic

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
backend
string / required
    Choices:
  • docker
  • ostree
Define the backend to use for the container.
image
string / required
The image to use to install the container.
mode
string
    Choices:
  • user
  • system
Define if it is an user or a system container.
name
string / required
Name of the container.
rootfs
string
Define the rootfs of the image.
state
string
    Choices:
  • absent
  • latest ←
  • present
  • rollback
State of the container.
values
list / elements=string
Values for the installation of the container.
This option is permitted only with mode 'user' or 'system'.
The values specified here will be used at installation time as --set arguments for atomic install.

Notes

Note

  • Host should support atomic command

Examples

- name: Install the etcd system container
  community.general.atomic_container:
    name: etcd
    image: rhel/etcd
    backend: ostree
    state: latest
    mode: system
    values:
        - ETCD_NAME=etcd.server

- name: Uninstall the etcd system container
  community.general.atomic_container:
    name: etcd
    image: rhel/etcd
    backend: ostree
    state: absent
    mode: system

Return Values

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

Key Returned Description
msg
string
always
The command standard output

Sample:
[{"u'Using default tag": "latest ...'"}]


Authors

  • Giuseppe Scrivano (@giuseppe)