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 8.6.4).
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.
Aliases: cloud.atomic.atomic_image
Requirements
The below requirements are needed on the host that executes this module.
atomic
Parameters
Parameter |
Comments |
---|---|
Define the backend where the image is pulled. Choices:
|
|
Name of the container image. |
|
Start or Stop the container. Choices:
|
|
The state of the container image. The state Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
The command standard output Returned: always Sample: |