community.general.atomic_container module – Manage the containers 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_container
.
Synopsis
Manage the containers on the atomic host platform.
Allows to manage the lifecycle of a container on the atomic host platform.
Aliases: cloud.atomic.atomic_container
Requirements
The below requirements are needed on the host that executes this module.
atomic
Parameters
Parameter |
Comments |
---|---|
Define the backend to use for the container. Choices:
|
|
The image to use to install the container. |
|
Define if it is an user or a system container. Choices:
|
|
Name of the container. |
|
Define the rootfs of the image. |
|
State of the container. Choices:
|
|
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. Default: |
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: 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 |
Description |
---|---|
The command standard output Returned: always Sample: |