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

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

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

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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
python >= 2.6

Parameters

Parameter	Choices/Defaults	Comments
backend string	docker ostree	Define the backend where the image is pulled.
name string / required		Name of the container image.
started boolean	no yes ←	Start or Stop the container.
state string	absent latest ← present	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.

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	Returned	Description
msg string	always	The command standard output Sample: [{"u'Using default tag": "latest ...'"}]

Authors

Saravanan KR (@krsacme)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/atomic_image_module.html