+
quadlet_options
list / elements=string
|
Options for the quadlet file. Provide missing in usual container args options as a list of lines to add.
|
-
+ |
Rdt-class sets the class of service (CLOS or COS) for the container to run in. Requires root.
|
-
+ |
@@ -1262,7 +1273,7 @@ see
+ |
@@ -1274,7 +1285,7 @@ see
+ |
@@ -1286,42 +1297,42 @@ see
+
requires
list / elements=string
|
Specify one or more requirements. A requirement is a dependency container that will be started before this container. Containers can be specified by name or ID.
|
-
+ |
Restart policy to follow when containers exit. Restart policy will not take effect if a container is stopped via the podman kill or podman stop commands. Valid values are * no - Do not restart containers on exit * on-failure[:max_retries] - Restart containers when they exit with a non-0 exit code, retrying indefinitely or until the optional max_retries count is hit * always - Restart containers when they exit, regardless of status, retrying indefinitely
|
-
+ |
Seconds to wait before forcibly stopping the container when restarting. Use -1 for infinite wait. Applies to “restarted” status.
|
-
+ |
Number of times to retry pulling or pushing images between the registry and local storage in case of failure. Default is 3.
|
-
+ |
Duration of delay between retry attempts when pulling or pushing images between the registry and local storage in case of failure.
|
-
+
rm
@@ -1336,7 +1347,7 @@ see
+ |
@@ -1348,7 +1359,7 @@ see
+ |
@@ -1360,49 +1371,49 @@ see
+ |
Determines how to use the NOTIFY_SOCKET, as passed with systemd and Type=notify. Can be container, conmon, ignore.
|
-
+ |
Specify the policy to select the seccomp profile.
|
-
+
secrets
list / elements=string
|
Add the named secrets into the container. The format is secret[,opt=opt...], see documentation for more details.
|
-
+
security_opt
list / elements=string
|
Security Options. For example security_opt “seccomp=unconfined”
|
-
+ |
Size of /dev/shm. The format is <number><unit>. number must be greater than 0. Unit is optional and can be b (bytes), k (kilobytes), m(megabytes), or g (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses 64m
|
-
+ |
Size of systemd-specific tmpfs mounts such as /run, /run/lock, /var/log/journal and /tmp.
|
-
+ |
@@ -1414,7 +1425,7 @@ see
+ |
@@ -1435,70 +1446,70 @@ see
+ |
Signal to stop a container. Default is SIGTERM.
|
-
+ |
Seconds to wait before forcibly stopping the container. Use -1 for infinite wait. Applies to “stopped” status.
|
-
+ |
Timeout (in seconds) to stop a container. Default is 10.
|
-
+ |
Run the container in a new user namespace using the map with ‘name’ in the /etc/subgid file.
|
-
+ |
Run the container in a new user namespace using the map with ‘name’ in the /etc/subuid file.
|
-
+ |
Configure namespaced kernel parameters at runtime
|
-
+ |
Run container in systemd mode. The default is true.
|
-
+ |
Maximum time (in seconds) a container is allowed to run before conmon sends it the kill signal. By default containers run until they exit or are stopped by “podman stop”.
|
-
+ |
Set timezone in container. This flag takes area-based timezones, GMT time, as well as local, which sets the timezone in the container to match the host machine. See /usr/share/zoneinfo/ for valid timezones. Remote connections use local containers.conf for defaults.
|
-
+ |
@@ -1510,14 +1521,14 @@ see
+ |
Create a tmpfs mount. For example tmpfs “/tmp” “rw,size=787448k,mode=1777”
|
-
+ |
@@ -1529,14 +1540,14 @@ see
+
uidmap
list / elements=string
|
Run the container in a new user namespace using the supplied mapping.
|
-
+ |
-
+ |
Set the umask inside the container. Defaults to 0022. Remote connections use local containers.conf for defaults.
|
-
+
unsetenv
list / elements=string
|
Unset default environment variables for the container.
|
-
+ |
@@ -1571,14 +1582,14 @@ see
+ |
Sets the username or UID used and optionally the groupname or GID for the specified command.
|
-
+ |
-
+ |
Set the UTS mode for the container
|
-
+ |
Use VARIANT instead of the default architecture variant of the container image.
|
-
+ |
-
+
volumes_from
list / elements=string
|
Mount volumes from the specified container(s).
|
-
+ |
+ |
Name of quadlet file to write. By default it takes image name without prefixes and tags.
|
-
+
quadlet_options
list / elements=string
|
Options for the quadlet file. Provide missing in usual network args options as a list of lines to add.
|
-
+ |
@@ -402,7 +413,7 @@ To check whether it is installed, run
+ |
@@ -410,14 +421,14 @@ To check whether it is installed, run Default: "latest"
-
+ |
username to use when authenticating to remote registries.
|
-
+
validate_certs
@@ -555,6 +566,7 @@ To check whether it is installed, run state: quadlet
quadlet_dir: /etc/containers/systemd
quadlet_filename: alpine-latest
+ quadlet_file_mode: '0640'
quadlet_options:
- Variant=arm/v7
- |
diff --git a/docs/podman_import_module.html b/docs/podman_import_module.html
index 6408bf0..af5b2ee 100644
--- a/docs/podman_import_module.html
+++ b/docs/podman_import_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_import module – Import Podman container from a tar file.
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
diff --git a/docs/podman_load_module.html b/docs/podman_load_module.html
index cef2322..3d66441 100644
--- a/docs/podman_load_module.html
+++ b/docs/podman_load_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_load module – Load image from a tar file.
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
diff --git a/docs/podman_login_info_module.html b/docs/podman_login_info_module.html
index 042f2b3..7f1460e 100644
--- a/docs/podman_login_info_module.html
+++ b/docs/podman_login_info_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_login_info module – Return the logged-in user if any for a given registry
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
diff --git a/docs/podman_login_module.html b/docs/podman_login_module.html
index 925c14e..ae4224a 100644
--- a/docs/podman_login_module.html
+++ b/docs/podman_login_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_login module – Login to a container registry using podman
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
@@ -99,7 +99,7 @@ see
password
- string / required
+ string
|
Password for the registry server.
|
@@ -112,6 +112,13 @@ see |
+ Name of an existing podman secret to use for authentication to target registry
+ |
+ |
+ |
@@ -123,9 +130,9 @@ see
+
username
- string / required
+ string
|
Username for the registry server.
|
@@ -145,6 +152,12 @@ see username: user
password: 'p4ssw0rd'
registry: quay.io
+
+- name: Login to quay.io using existing secret called password
+ containers.podman.podman_login:
+ username: user
+ secret: password
+ registry: quay.io
diff --git a/docs/podman_logout_module.html b/docs/podman_logout_module.html
index c1b92ea..859da98 100644
--- a/docs/podman_logout_module.html
+++ b/docs/podman_logout_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_logout module – Log out of a container registry using podman
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
diff --git a/docs/podman_network_info_module.html b/docs/podman_network_info_module.html
index a0c97c3..cbe5648 100644
--- a/docs/podman_network_info_module.html
+++ b/docs/podman_network_info_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_network_info module – Gather info about podman networks
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
diff --git a/docs/podman_network_module.html b/docs/podman_network_module.html
index 97078ca..a188925 100644
--- a/docs/podman_network_module.html
+++ b/docs/podman_network_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_network module – Manage podman networks
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
@@ -243,6 +243,27 @@ see |
+ Set the threshold for broadcast queueing. Must be a 32 bit integer. Setting this value to -1 disables broadcast queueing altogether.
+ |
+
+ |
+This option assigns the given name to the created Linux Bridge. Sets ‘com.docker.network.bridge.name’ option.
+ |
+
+ |
+Sets the Maximum Transmission Unit (MTU) and takes an integer value. Sets ‘com.docker.network.driver.mtu’ option.
+ |
+
+ |
@@ -254,27 +275,34 @@ see
+ |
Sets the Route Metric for the default route created in every container joined to this network. Can only be used with the Netavark network backend.
|
-
+ |
This option sets the specified ip/macvlan mode on the interface.
|
-
+ |
MTU size for bridge network interface.
|
+
+ no_default_route
+ string
+ |
+If set to 1, Podman will NOT automatically add a default route to subnets.
+ |
+
parent
string
@@ -289,13 +317,31 @@ see VLAN tag for bridge which enables vlan_filtering.
|
-
+ |
+This option assigns a VRF to the bridge interface. It accepts the name of the VRF and defaults to none. Can only be used with the Netavark network backend.
+ |
+
+ |
Path to the directory to write quadlet file in. By default, it will be set as /etc/containers/systemd/ for root user, ~/.config/containers/systemd/ for non-root users.
|
+
+ quadlet_file_mode
+ any
+ |
+The permissions of the quadlet file.
+ The quadlet_file_mode can be specied as octal numbers or as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r). For octal numbers format, you must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like 0644 or 01777) or quote it (like '644' or '1777') so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.
+ If quadlet_file_mode is not specified and the quadlet file does not exist, the default '0640' mask will be used when setting the mode for the newly created file.
+ If quadlet_file_mode is not specified and the quadlet file does exist, the mode of the existing file will be used.
+ Specifying quadlet_file_mode is the best way to ensure files are created with the correct permissions.
+ |
+
quadlet_filename
string
diff --git a/docs/podman_play_module.html b/docs/podman_play_module.html
index fb43be0..70fd827 100644
--- a/docs/podman_play_module.html
+++ b/docs/podman_play_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_play module – Play kubernetes YAML file using podman
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
@@ -147,19 +147,26 @@ see
kube_file
- path / required
+ path
|
Path to file with YAML configuration for a Pod.
|
|
+ kube_file_content
+ string
+ |
+Content of the kube file.
+ |
+
+ |
Set logging driver for all created containers.
|
-
+ |
@@ -175,7 +182,7 @@ see
+ |
-
+
max_size
string
@@ -192,7 +199,7 @@ see Specify a max size of the log file (e.g 10mb).
|
-
+
path
string
@@ -200,7 +207,7 @@ see specify a path to the log file (e.g. /var/log/container/mycontainer.json).
|
-
+
tag
string
@@ -208,27 +215,38 @@ see Specify a custom log tag for the container. This option is currently supported only by the journald log driver in Podman.
|
-
+
network
list / elements=string
|
List of the names of CNI networks the pod should join.
|
-
+ |
The username and password to use to authenticate with the registry if required.
|
-
+ |
Path to the directory to write quadlet file in. By default, it will be set as /etc/containers/systemd/ for root user, ~/.config/containers/systemd/ for non-root users.
|
+
+ quadlet_file_mode
+ any
+ |
+The permissions of the quadlet file.
+ The quadlet_file_mode can be specied as octal numbers or as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r). For octal numbers format, you must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like 0644 or 01777) or quote it (like '644' or '1777') so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.
+ If quadlet_file_mode is not specified and the quadlet file does not exist, the default '0640' mask will be used when setting the mode for the newly created file.
+ If quadlet_file_mode is not specified and the quadlet file does exist, the mode of the existing file will be used.
+ Specifying quadlet_file_mode is the best way to ensure files are created with the correct permissions.
+ |
+
quadlet_filename
string
@@ -346,6 +364,7 @@ see greet_to: world
userns: host
quadlet_filename: kube-pod
+ quadlet_file_mode: '0640'
quadlet_options:
- "SetWorkingDirectory=yaml"
- "ExitCodePropagation=any"
diff --git a/docs/podman_pod_info_module.html b/docs/podman_pod_info_module.html
index df146b5..5d5e824 100644
--- a/docs/podman_pod_info_module.html
+++ b/docs/podman_pod_info_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_pod_info module – Gather info about podman pods
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
diff --git a/docs/podman_pod_module.html b/docs/podman_pod_module.html
index 0a77c0d..fc05d25 100644
--- a/docs/podman_pod_module.html
+++ b/docs/podman_pod_module.html
@@ -37,7 +37,7 @@
containers.podman.podman_pod module – Manage Podman pods
Note
- This module is part of the containers.podman collection (version 1.16.1).
+ This module is part of the containers.podman collection (version 1.16.2).
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 containers.podman.
@@ -521,20 +521,31 @@ see
+ quadlet_file_mode
+ any
+ |
+ The permissions of the quadlet file.
+ The quadlet_file_mode can be specied as octal numbers or as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r). For octal numbers format, you must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like 0644 or 01777) or quote it (like '644' or '1777') so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results.
+ If quadlet_file_mode is not specified and the quadlet file does not exist, the default umask on the system will be used when setting the mode for the newly created file.
+ If quadlet_file_mode is not specified and the quadlet file does exist, the mode of the existing file will be used.
+ Specifying quadlet_file_mode is the best way to ensure files are created with the correct permissions.
+ |
+ |
+ |
Name of quadlet file to write. By default it takes name value.
|
-
+
quadlet_options
list / elements=string
|
Options for the quadlet file. Provide missing in usual container args options as a list of lines to add.
|
-
+ |
@@ -546,28 +557,28 @@ see
+ |
Restart policy to follow when containers exit.
|
-
+
security_opt
list / elements=string
|
Security options for the pod.
|
-
+ |
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.
|
-
+ |
@@ -579,21 +590,21 @@ see
+ |
Set the size of the /dev/shm shared memory space. A unit can be b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes). If the unit is omitted, the system uses bytes. If the size is omitted, the default is 64m. When size is 0, there is no limit on the amount of memory used for IPC by the pod.
|
-
+ |
Size of systemd-specific tmpfs mounts such as /run, /run/lock, /var/log/journal and /tmp. A unit can be b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes). If the unit is omitted, the system uses bytes. If the size is omitted, the default is 64m. When size is 0, the usage is limited to 50 percents of the host’s available memory.
|
-
+ |
@@ -612,49 +623,49 @@ see
+ |
Name for GID map from the /etc/subgid file. Using this flag will run the container with user namespace enabled. This flag conflicts with `userns` and `gidmap`.
|
-
+ |
Name for UID map from the /etc/subuid file. Using this flag will run the container with user namespace enabled. This flag conflicts with `userns` and `uidmap`.
|
-
+ |
Set kernel parameters for the pod.
|
-
+
uidmap
list / elements=string
|
Run the container in a new user namespace using the supplied mapping. This option conflicts with the `userns` and `subuidname` options. This option provides a way to map host UIDs to container UIDs. It can be passed several times to map different ranges.
|
-
+ |
Set the user namespace mode for all the containers in a pod. It defaults to the PODMAN_USERNS environment variable. An empty value (“”) means user namespaces are disabled.
|
-
+ |
Set the UTS namespace mode for the pod.
|
- | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |