atomic_image – Manage the container images on the atomic host platform
atomic_image – Manage the container images on the atomic host platform
New in version 2.2.
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 - added in 2.4 |
|
Define the backend where the image is pulled. |
name - / required |
Name of the container image. | |
started boolean |
|
Start or Stop the container. |
state - |
|
The state of the container image. The state |
Notes
Note
- Host should support
atomic
command.
Examples
- name: Execute the run command on rsyslog container image (atomic run rhel7/rsyslog)
atomic_image:
name: rhel7/rsyslog
state: latest
- name: Pull busybox to the OSTree backend
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 ...'"}] |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
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.8/modules/atomic_image_module.html