containers.podman.podman_pod – Manage Podman pods

Note

This plugin is part of the containers.podman collection (version 1.4.1).

To install it use: ansible-galaxy collection install containers.podman.

To use it in a playbook, specify: containers.podman.podman_pod.

New in version 1.0.0: of containers.podman

Synopsis
Requirements
Parameters
Examples
Return Values

Synopsis

Manage podman pods.

Requirements

The below requirements are needed on the host that executes this module.

podman

Parameters

Parameter	Choices/Defaults	Comments
add_host list / elements=string		Add a host to the /etc/hosts file shared between all containers in the pod.
cgroup_parent string		Path to cgroups under which the cgroup for the pod will be created. If the path is not absolute, he path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.
debug boolean	no ← yes	Return additional information which can be helpful for investigations.
dns list / elements=string		Set custom DNS servers in the /etc/resolv.conf file that will be shared between all containers in the pod. A special option, "none" is allowed which disables creation of /etc/resolv.conf for the pod.
dns_opt list / elements=string		Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod.
dns_search list / elements=string		Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod.
executable string	Default: "podman"	Path to `podman` executable if it is not in the `$PATH` on the machine running `podman`
hostname string		Set a hostname to the pod
infra boolean	no yes	Create an infra container and associate it with the pod. An infra container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default is true.
infra_command string		The command that will be run to start the infra container. Default is "/pause".
infra_conmon_pidfile string		Write the pid of the infra container's conmon process to a file. As conmon runs in a separate process than Podman, this is necessary when using systemd to manage Podman containers and pods.
infra_image string		The image that will be created for the infra container. Default is "k8s.gcr.io/pause:3.1".
ip string		Set a static IP for the pod's shared network.
label dictionary		Add metadata to a pod, pass dictionary of label keys and values.
label_file string		Read in a line delimited file of labels.
mac_address string		Set a static MAC address for the pod's shared network.
name string / required		Assign a name to the pod.
network string		Set network mode for the pod. Supported values are bridge (the default), host (do not create a network namespace, all containers in the pod will use the host's network), or a comma-separated list of the names of CNI networks the pod should join.
no_hosts boolean	no yes	Disable creation of /etc/hosts for the pod.
pod_id_file string		Write the pod ID to the file.
publish list / elements=string		Publish a port or range of ports from the pod to the host. aliases: ports
recreate boolean	no ← yes	Use with present and started states to force the re-creation of an existing pod.
share string		A comma delimited list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared. The namespaces to choose from are ipc, net, pid, user, uts.
state string	created ← killed restarted absent started stopped paused unpaused	This variable is set for state

Examples

# What modules does for example
- podman_pod:
    name: pod1
    state: started
    ports:
      - 4444:5555

Return Values

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

Key	Returned	Description
pod dictionary	always	Pod inspection results for the given pod built. Sample: {'Config': {'cgroupParent': '/libpod_parent', 'created': '2020-06-14T15:16:12.230818767+03:00', 'hostname': 'newpod', 'id': 'a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58', 'infraConfig': {'infraPortBindings': None, 'makeInfraContainer': True}, 'labels': {}, 'lockID': 515, 'name': 'newpod', 'sharesCgroup': True, 'sharesIpc': True, 'sharesNet': True, 'sharesUts': True}, 'Containers': [{'id': 'dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2', 'state': 'configured'}], 'State': {'cgroupPath': '/libpod_parent/a5a5c6cdf8c72272fc5c33f787e8d7501e2fa0c1e92b2b602860defdafeeec58', 'infraContainerID': 'dc70a947c7ae15198ec38b3c817587584085dee3919cbeb9969e3ab77ba10fd2', 'status': 'Created'}}

Authors

Sagi Shnaidman (@sshnaidm)

© 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/containers/podman/podman_pod_module.html