Docs4dev
Docs
ansible / 2.4 / atomic_container_module.html

atomic_container - Manage the containers on the atomic host platform

New in version 2.4.

Synopsis

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

Requirements (on host that executes module)

  • atomic
  • python >= 2.6

Options

parameter required default choices comments
backend
 yes None
  • docker
  • ostree
Define the backend to use for the container
image
 yes
The image to use to install the container
mode
 yes None
  • user
  • system
Define if it is an user or a system container
name
 yes
Name of the container
rootfs
 no
Define the rootfs of the image
state
 yes latest
  • latest
  • absent
  • latest
  • rollback
State of the container
values
 no None
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.

Examples

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

# Uninstall the etcd system container
- atomic_container:
    name: etcd
    image: rhel/etcd
    backend: ostree
    state: absent
    system: True

Return Values

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

name description returned type sample
msg
The command standard output
always string [{"u'Using default tag": "latest ...'"}]

Notes

Note

  • Host should support atomic command

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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