.nh
.TH podman-pod-create 1
.SH NAME
.PP
podman-pod-create - Create a new pod

.SH SYNOPSIS
.PP
\fBpodman pod create\fP [\fIoptions\fP] [\fIname\fP]

.SH DESCRIPTION
.PP
Creates an empty pod, or unit of multiple containers, and prepares it to have
containers added to it. The pod can be created with a specific name. If a name
is not given a random name is generated. The pod ID is printed to STDOUT. You
can then use \fBpodman create --pod \fB\fC<pod_id|pod_name>\fR ...\fP to add containers
to the pod, and \fBpodman pod start \fB\fC<pod_id|pod_name>\fR\fP to start the pod.

.PP
The operator can identify a pod in three ways:
UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”)
UUID short identifier (“f78375b1c487”)
Name (“jonah”)

.PP
podman generates a UUID for each pod, and if a name is not assigned
to the container with \fB--name\fP then a random string name will be generated
for it. This name is useful to identify a pod.

.PP
Note: resource limit related flags work by setting the limits explicitly in the pod's cgroup parent
for all containers joining the pod. A container can override the resource limits when joining a pod.
For example, if a pod was created via \fBpodman pod create --cpus=5\fP, specifying \fBpodman container create --pod=\fB\fC<pod_id|pod_name>\fR --cpus=4\fP causes the container to use the smaller limit. Also, containers which specify their own cgroup, such as \fB--cgroupns=host\fP, do NOT get the assigned pod level cgroup resources.

.SH OPTIONS
.SS \fB--add-host\fP=\fIhost:ip\fP
.PP
Add a custom host-to-IP mapping (host:ip)

.PP
Add a line to /etc/hosts. The format is hostname:ip. The \fB--add-host\fP
option can be set multiple times. Conflicts with the \fB--no-hosts\fP option.

.PP
The /etc/hosts file is shared between all containers in the pod.

.SS \fB--blkio-weight\fP=\fIweight\fP
.PP
Block IO relative weight. The \fIweight\fP is a value between \fB10\fP and \fB1000\fP\&.

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--blkio-weight-device\fP=\fIdevice:weight\fP
.PP
Block IO relative device weight.

.SS \fB--cgroup-parent\fP=\fIpath\fP
.PP
Path to cgroups under which the cgroup for the pod will be created. If the
path is not absolute, the path is considered to be relative to the cgroups path
of the init process. Cgroups will be created if they do not already exist.

.SS \fB--cpu-shares\fP, \fB-c\fP=\fIshares\fP
.PP
CPU shares (relative weight).

.PP
By default, all containers get the same proportion of CPU cycles. This
proportion can be modified by changing the container's CPU share weighting
relative to the combined weight of all the running containers.
Default weight is \fB1024\fP\&.

.PP
The proportion will only apply when CPU-intensive processes are running.
When tasks in one container are idle, other containers can use the
left-over CPU time. The actual amount of CPU time will vary depending on
the number of containers running on the system.

.PP
For example, consider three containers, one has a cpu-share of 1024 and
two others have a cpu-share setting of 512. When processes in all three
containers attempt to use 100% of CPU, the first container would receive
50% of the total CPU time. If a fourth container is added with a cpu-share
of 1024, the first container only gets 33% of the CPU. The remaining containers
receive 16.5%, 16.5% and 33% of the CPU.

.PP
On a multi-core system, the shares of CPU time are distributed over all CPU
cores. Even if a container is limited to less than 100% of CPU time, it can
use 100% of each individual CPU core.

.PP
For example, consider a system with more than three cores.
If the container \fIC0\fP is started with \fB--cpu-shares=512\fP running one process,
and another container \fIC1\fP with \fB--cpu-shares=1024\fP running two processes,
this can result in the following division of CPU shares:

.TS
allbox;
l l l l 
l l l l .
\fB\fCPID\fR	\fB\fCcontainer\fR	\fB\fCCPU\fR	\fB\fCCPU share\fR
100	C0	0	100% of CPU0
101	C1	1	100% of CPU1
102	C1	2	100% of CPU2
.TE

.PP
On some systems, changing the resource limits may not be allowed for non-root
users. For more details, see
https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--cpus\fP=\fIamount\fP
.PP
Set the total number of CPUs delegated to the pod. Default is 0.000 which indicates that there is no limit on computation power.

.SS \fB--cpuset-cpus\fP=\fInumber\fP
.PP
CPUs in which to allow execution. Can be specified as a comma-separated list
(e.g. \fB0,1\fP), as a range (e.g. \fB0-3\fP), or any combination thereof
(e.g. \fB0-3,7,11-15\fP).

.PP
On some systems, changing the resource limits may not be allowed for non-root
users. For more details, see
https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--cpuset-mems\fP=\fInodes\fP
.PP
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on
NUMA systems.

.PP
If there are four memory nodes on the system (0-3), use \fB--cpuset-mems=0,1\fP
then processes in the container will only use memory from the first
two memory nodes.

.PP
On some systems, changing the resource limits may not be allowed for non-root
users. For more details, see
https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--device\fP=\fIhost-device[:container-device][:permissions]\fP
.PP
Add a host device to the pod. Optional \fIpermissions\fP parameter
can be used to specify device permissions by combining
\fBr\fP for read, \fBw\fP for write, and \fBm\fP for \fBmknod\fP(2).

.PP
Example: \fB--device=/dev/sdc:/dev/xvdc:rwm\fP\&.

.PP
Note: if \fIhost-device\fP is a symbolic link then it will be resolved first.
The pod will only store the major and minor numbers of the host device.

.PP
Podman may load kernel modules required for using the specified
device. The devices that Podman will load modules for when necessary are:
/dev/fuse.

.PP
In rootless mode, the new device is bind mounted in the container from the host
rather than Podman creating it within the container space. Because the bind
mount retains its SELinux label on SELinux systems, the container can get
permission denied when accessing the mounted device. Modify SELinux settings to
allow containers to use all device labels via the following command:

.PP
$ sudo setsebool -P  container_use_devices=true

.PP
Note: the pod implements devices by storing the initial configuration passed by the user and recreating the device on each container added to the pod.

.SS \fB--device-read-bps\fP=\fIpath:rate\fP
.PP
Limit read rate (in bytes per second) from a device (e.g. \fB--device-read-bps=/dev/sda:1mb\fP).

.PP
On some systems, changing the resource limits may not be allowed for non-root
users. For more details, see
https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--device-write-bps\fP=\fIpath:rate\fP
.PP
Limit write rate (in bytes per second) to a device (e.g. \fB--device-write-bps=/dev/sda:1mb\fP).

.PP
On some systems, changing the resource limits may not be allowed for non-root
users. For more details, see
https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--dns\fP=\fIipaddr\fP
.PP
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.

.SS \fB--dns-option\fP=\fIoption\fP
.PP
Set custom DNS options in the /etc/resolv.conf file that will be shared between all containers in the pod.

.SS \fB--dns-search\fP=\fIdomain\fP
.PP
Set custom DNS search domains in the /etc/resolv.conf file that will be shared between all containers in the pod.

.SS \fB--exit-policy\fP=\fBcontinue\fP | \fIstop\fP
.PP
Set the exit policy of the pod when the last container exits.  Supported policies are:

.TS
allbox;
l l 
l l .
\fB\fCExit Policy\fR	\fB\fCDescription\fR
\fIcontinue\fP	T{
The pod continues running, by keeping its infra container alive, when the last container exits. Used by default.
T}
\fIstop\fP	T{
The pod (including its infra container) is stopped when the last container exits. Used in \fB\fCkube play\fR\&.
T}
.TE

.SS \fB--gidmap\fP=\fIpod_gid:host_gid:amount\fP
.PP
GID map for the user namespace. Using this flag will run all containers in the pod with user namespace enabled.
It conflicts with the \fB--userns\fP and \fB--subgidname\fP flags.

.SS \fB--help\fP, \fB-h\fP
.PP
Print usage statement.

.SS \fB--hostname\fP=\fIname\fP
.PP
Set a hostname to the pod.

.SS \fB--infra\fP
.PP
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: true.

.SS \fB--infra-command\fP=\fIcommand\fP
.PP
The command that will be run to start the infra container. Default: "/pause".

.SS \fB--infra-conmon-pidfile\fP=\fIfile\fP
.PP
Write the pid of the infra container's \fBconmon\fP process to a file. As \fBconmon\fP runs in a separate process than Podman, this is necessary when using systemd to manage Podman containers and pods.

.SS \fB--infra-image\fP=\fIimage\fP
.PP
The custom image that will be used for the infra container.  Unless specified, Podman builds a custom local image which does not require pulling down an image.

.SS \fB--infra-name\fP=\fIname\fP
.PP
The name that will be used for the pod's infra container.

.SS \fB--ip\fP=\fIipv4\fP
.PP
Specify a static IPv4 address for the pod, for example \fB10.88.64.128\fP\&.
This option can only be used if the pod is joined to only a single network - i.e., \fB--network=network-name\fP is used at most once -
and if the pod is not joining another container's network namespace via \fB--network=container:\fIid\fP\fP\&.
The address must be within the network's IP address pool (default \fB10.88.0.0/16\fP).

.PP
To specify multiple static IP addresses per pod, set multiple networks using the \fB--network\fP option with a static IP address specified for each using the \fB\fCip\fR mode for that option.

.SS \fB--ip6\fP=\fIipv6\fP
.PP
Specify a static IPv6 address for the pod, for example \fBfd46:db93:aa76:ac37::10\fP\&.
This option can only be used if the pod is joined to only a single network - i.e., \fB--network=network-name\fP is used at most once -
and if the pod is not joining another container's network namespace via \fB--network=container:\fIid\fP\fP\&.
The address must be within the network's IPv6 address pool.

.PP
To specify multiple static IPv6 addresses per pod, set multiple networks using the \fB--network\fP option with a static IPv6 address specified for each using the \fB\fCip6\fR mode for that option.

.SS \fB--label\fP, \fB-l\fP=\fIkey=value\fP
.PP
Add metadata to a pod.

.SS \fB--label-file\fP=\fIfile\fP
.PP
Read in a line-delimited file of labels.

.SS \fB--mac-address\fP=\fIaddress\fP
.PP
Pod network interface MAC address (e.g. 92:d0:c6:0a:29:33)
This option can only be used if the pod is joined to only a single network - i.e., \fB--network=\fInetwork-name\fP\fP is used at most once -
and if the pod is not joining another container's network namespace via \fB--network=container:\fIid\fP\fP\&.

.PP
Remember that the MAC address in an Ethernet network must be unique.
The IPv6 link-local address will be based on the device's MAC address
according to RFC4862.

.PP
To specify multiple static MAC addresses per pod, set multiple networks using the \fB--network\fP option with a static MAC address specified for each using the \fB\fCmac\fR mode for that option.

.SS \fB--memory\fP, \fB-m\fP=\fInumber[unit]\fP
.PP
Memory limit. A \fIunit\fP can be \fBb\fP (bytes), \fBk\fP (kibibytes), \fBm\fP (mebibytes), or \fBg\fP (gibibytes).

.PP
Allows the memory available to a container to be constrained. If the host
supports swap memory, then the \fB-m\fP memory setting can be larger than physical
RAM. If a limit of 0 is specified (not using \fB-m\fP), the container's memory is
not limited. The actual limit may be rounded up to a multiple of the operating
system's page size (the value would be very large, that's millions of trillions).

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--memory-swap\fP=\fInumber[unit]\fP
.PP
A limit value equal to memory plus swap.
A \fIunit\fP can be \fBb\fP (bytes), \fBk\fP (kibibytes), \fBm\fP (mebibytes), or \fBg\fP (gibibytes).

.PP
Must be used with the \fB-m\fP (\fB--memory\fP) flag.
The argument value should always be larger than that of
 \fB-m\fP (\fB--memory\fP) By default, it is set to double
the value of \fB--memory\fP\&.

.PP
Set \fInumber\fP to \fB-1\fP to enable unlimited swap.

.PP
This option is not supported on cgroups V1 rootless systems.

.SS \fB--name\fP, \fB-n\fP=\fIname\fP
.PP
Assign a name to the pod.

.SS \fB--network\fP=\fImode\fP, \fB--net\fP
.PP
Set the network mode for the pod.

.PP
Valid \fImode\fP values are:

.RS
.IP \(bu 2
\fBbridge[:OPTIONS,...]\fP: Create a network stack on the default bridge. This is the default for rootful containers. It is possible to specify these additional options:
.RS
.IP \(bu 2
\fBalias=name\fP: Add network-scoped alias for the container.
.IP \(bu 2
\fBip=IPv4\fP: Specify a static ipv4 address for this container.
.IP \(bu 2
\fBip=IPv6\fP: Specify a static ipv6 address for this container.
.IP \(bu 2
\fBmac=MAC\fP: Specify a static mac address for this container.
.IP \(bu 2
\fBinterface_name\fP: Specify a name for the created network interface inside the container.

.RE
For example to set a static ipv4 address and a static mac address, use \fB\fC--network bridge:ip=10.88.0.10,mac=44:33:22:11:00:99\fR\&.
.IP \(bu 2
<network name or ID>[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by \fBpodman network create\fP\&. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. Use the \fB--network\fP option multiple times to specify additional networks.
.IP \(bu 2
\fBnone\fP: Create a network namespace for the container but do not configure network interfaces for it, thus the container has no network connectivity.
.IP \(bu 2
\fBcontainer:\fP\fIid\fP: Reuse another container's network stack.
.IP \(bu 2
\fBhost\fP: Do not create a network namespace, the container will use the host's network. Note: The host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
.IP \(bu 2
\fBns:\fP\fIpath\fP: Path to a network namespace to join.
.IP \(bu 2
\fBprivate\fP: Create a new namespace for the container. This will use the \fBbridge\fP mode for rootful containers and \fBslirp4netns\fP for rootless ones.
.IP \(bu 2
\fBslirp4netns[:OPTIONS,...]\fP: use \fBslirp4netns\fP(1) to create a user network stack. This is the default for rootless containers. It is possible to specify these additional options, they can also be set with \fB\fCnetwork_cmd_options\fR in containers.conf:
.RS
.IP \(bu 2
\fBallow_host_loopback=true|false\fP: Allow slirp4netns to reach the host loopback IP (default is 10.0.2.2 or the second IP from slirp4netns cidr subnet when changed, see the cidr option below). The default is false.
.IP \(bu 2
\fBmtu=MTU\fP: Specify the MTU to use for this network. (Default is \fB\fC65520\fR).
.IP \(bu 2
\fBcidr=CIDR\fP: Specify ip range to use for this network. (Default is \fB\fC10.0.2.0/24\fR).
.IP \(bu 2
\fBenable_ipv6=true|false\fP: Enable IPv6. Default is true. (Required for \fB\fCoutbound_addr6\fR).
.IP \(bu 2
\fBoutbound_addr=INTERFACE\fP: Specify the outbound interface slirp should bind to (ipv4 traffic only).
.IP \(bu 2
\fBoutbound_addr=IPv4\fP: Specify the outbound ipv4 address slirp should bind to.
.IP \(bu 2
\fBoutbound_addr6=INTERFACE\fP: Specify the outbound interface slirp should bind to (ipv6 traffic only).
.IP \(bu 2
\fBoutbound_addr6=IPv6\fP: Specify the outbound ipv6 address slirp should bind to.
.IP \(bu 2
\fBport_handler=rootlesskit\fP: Use rootlesskit for port forwarding. Default.
Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually \fB\fC10.0.2.100\fR\&. If the application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks.
.IP \(bu 2
\fBport_handler=slirp4netns\fP: Use the slirp4netns port forwarding, it is slower than rootlesskit but preserves the correct source IP address. This port handler cannot be used for user-defined networks.

.RE

.IP \(bu 2
\fBpasta[:OPTIONS,...]\fP: use \fBpasta\fP(1) to create a user-mode networking
stack.
.br
This is only supported in rootless mode.
.br
By default, IPv4 and IPv6 addresses and routes, as well as the pod interface
name, are copied from the host. If port forwarding isn't configured, ports
will be forwarded dynamically as services are bound on either side (init
namespace or container namespace). Port forwarding preserves the original
source IP address. Options described in pasta(1) can be specified as
comma-separated arguments.
.br
In terms of pasta(1) options, \fB--config-net\fP is given by default, in
order to configure networking when the container is started, and
\fB--no-map-gw\fP is also assumed by default, to avoid direct access from
container to host using the gateway address. The latter can be overridden
by passing \fB--map-gw\fP in the pasta-specific options (despite not being an
actual pasta(1) option).
.br
Also, \fB-t none\fP and \fB-u none\fP are passed if, respectively, no TCP or
UDP port forwarding from host to container is configured, to disable
automatic port forwarding based on bound ports. Similarly, \fB-T none\fP and
\fB-U none\fP are given to disable the same functionality from container to
host.
.br
Some examples:
.RS
.IP \(bu 2
\fBpasta:--map-gw\fP: Allow the container to directly reach the host using the
gateway address.
.IP \(bu 2
\fBpasta:--mtu,1500\fP: Specify a 1500 bytes MTU for the \fItap\fP interface in
the container.
.IP \(bu 2
\fBpasta:--ipv4-only,-a,10.0.2.0,-n,24,-g,10.0.2.2,--dns-forward,10.0.2.3,-m,1500,--no-ndp,--no-dhcpv6,--no-dhcp\fP,
equivalent to default slirp4netns(1) options: disable IPv6, assign
\fB\fC10.0.2.0/24\fR to the \fB\fCtap0\fR interface in the container, with gateway
\fB\fC10.0.2.3\fR, enable DNS forwarder reachable at \fB\fC10.0.2.3\fR, set MTU to 1500
bytes, disable NDP, DHCPv6 and DHCP support.
.IP \(bu 2
\fBpasta:-I,tap0,--ipv4-only,-a,10.0.2.0,-n,24,-g,10.0.2.2,--dns-forward,10.0.2.3,--no-ndp,--no-dhcpv6,--no-dhcp\fP,
equivalent to default slirp4netns(1) options with Podman overrides: same as
above, but leave the MTU to 65520 bytes
.IP \(bu 2
\fBpasta:-t,auto,-u,auto,-T,auto,-U,auto\fP: enable automatic port forwarding
based on observed bound ports from both host and container sides
.IP \(bu 2
\fBpasta:-T,5201\fP: enable forwarding of TCP port 5201 from container to
host, using the loopback interface instead of the tap interface for improved
performance

.RE
NOTE: For backward compatibility reasons, if there is an existing network named \fB\fCpasta\fR, Podman will use it instead of the pasta mode."?

.RE

.PP
Invalid if using \fB--dns\fP, \fB--dns-option\fP, or \fB--dns-search\fP with \fB--network\fP set to \fBnone\fP or \fBcontainer:\fP\fIid\fP\&.

.SS \fB--network-alias\fP=\fIalias\fP
.PP
Add a network-scoped alias for the pod, setting the alias for all networks that the container joins. To set a
name only for a specific network, use the alias option as described under the \fB--network\fP option.
If the network has DNS enabled (\fB\fCpodman network inspect -f {{.DNSEnabled}} <name>\fR),
these aliases can be used for name resolution on the given network. This option can be specified multiple times.
NOTE: When using CNI a pod will only have access to aliases on the first network that it joins. This limitation does
not exist with netavark/aardvark-dns.

.SS \fB--no-hosts\fP
.PP
Do not create \fI/etc/hosts\fP for the pod.
By default, Podman will manage \fI/etc/hosts\fP, adding the container's own IP address and any hosts from \fB--add-host\fP\&.
\fB--no-hosts\fP disables this, and the image's \fI/etc/hosts\fP will be preserved unmodified.

.PP
This option conflicts with \fB--add-host\fP\&.

.SS \fB--pid\fP=\fIpid\fP
.PP
Set the PID mode for the pod. The default is to create a private PID namespace for the pod. Requires the PID namespace to be shared via --share.

.PP
.RS

.nf
host: use the host’s PID namespace for the pod
ns: join the specified PID namespace
private: create a new namespace for the pod (default)

.fi
.RE

.SS \fB--pod-id-file\fP=\fIpath\fP
.PP
Write the pod ID to the file.

.SS \fB--publish\fP, \fB-p\fP=\fI[[ip:][hostPort]:]containerPort[/protocol]\fP
.PP
Publish a container's port, or range of ports, within this pod to the host.

.PP
Both \fIhostPort\fP and \fIcontainerPort\fP can be specified as a range of ports.
When specifying ranges for both, the number of container ports in the
range must match the number of host ports in the range.

.PP
If host IP is set to 0.0.0.0 or not set at all, the port will be bound on all IPs on the host.

.PP
By default, Podman will publish TCP ports. To publish a UDP port instead, give
\fB\fCudp\fR as protocol. To publish both TCP and UDP ports, set \fB\fC--publish\fR twice,
with \fB\fCtcp\fR, and \fB\fCudp\fR as protocols respectively. Rootful containers can also
publish ports using the \fB\fCsctp\fR protocol.

.PP
Host port does not have to be specified (e.g. \fB\fCpodman run -p 127.0.0.1::80\fR).
If it is not, the container port will be randomly assigned a port on the host.

.PP
Use \fBpodman port\fP to see the actual mapping: \fB\fCpodman port $CONTAINER $CONTAINERPORT\fR\&.

.PP
\fBNote:\fP You must not publish ports of containers in the pod individually,
but only by the pod itself.

.PP
\fBNote:\fP This cannot be modified once the pod is created.

.SS \fB--replace\fP
.PP
If another pod with the same name already exists, replace and remove it. The default is \fBfalse\fP\&.

.SS \fB--security-opt\fP=\fIoption\fP
.PP
Security Options

.RS
.IP \(bu 2
\fBapparmor=unconfined\fP : Turn off apparmor confinement for the pod
.IP \(bu 2
\fBapparmor\fP=\fIalternate-profile\fP : Set the apparmor confinement profile for the pod
.IP \(bu 2
\fBlabel=user:\fP\fIUSER\fP: Set the label user for the pod processes
.IP \(bu 2
\fBlabel=role:\fP\fIROLE\fP: Set the label role for the pod processes
.IP \(bu 2
\fBlabel=type:\fP\fITYPE\fP: Set the label process type for the pod processes
.IP \(bu 2
\fBlabel=level:\fP\fILEVEL\fP: Set the label level for the pod processes
.IP \(bu 2
\fBlabel=filetype:\fP\fITYPE\fP: Set the label file type for the pod files
.IP \(bu 2
\fBlabel=disable\fP: Turn off label separation for the pod

.RE

.PP
Note: Labeling can be disabled for all pods/containers by setting label=false in the \fBcontainers.conf\fP (\fB\fC/etc/containers/containers.conf\fR or \fB\fC$HOME/.config/containers/containers.conf\fR) file.

.RS
.IP \(bu 2
\fBlabel=nested\fP: Allows SELinux modifications within the container. Containers are allowed to modify SELinux labels on files and processes, as long as SELinux policy allows. Without \fBnested\fP, containers view SELinux as disabled, even when it is enabled on the host. Containers are prevented from setting any labels.
.IP \(bu 2
\fBmask\fP=\fI/path/1:/path/2\fP: The paths to mask separated by a colon. A masked path cannot be accessed inside the containers within the pod.
.IP \(bu 2
\fBno-new-privileges\fP: Disable container processes from gaining additional privileges.
.IP \(bu 2
\fBseccomp=unconfined\fP: Turn off seccomp confinement for the pod.
.IP \(bu 2
\fBseccomp=profile.json\fP: JSON file to be used as a seccomp filter. Note that the \fB\fCio.podman.annotations.seccomp\fR annotation is set with the specified value as shown in \fB\fCpodman inspect\fR\&.
.IP \(bu 2
\fBproc-opts\fP=\fIOPTIONS\fP : Comma-separated list of options to use for the /proc mount. More details
for the possible mount options are specified in the \fBproc(5)\fP man page.
.IP \(bu 2
\fBunmask\fP=\fIALL\fP or \fI/path/1:/path/2\fP, or shell expanded paths (/proc/*): Paths to unmask separated by a colon. If set to \fBALL\fP, it will unmask all the paths that are masked or made read-only by default.
The default masked paths are \fB/proc/acpi, /proc/kcore, /proc/keys, /proc/latency_stats, /proc/sched_debug, /proc/scsi, /proc/timer_list, /proc/timer_stats, /sys/firmware, and /sys/fs/selinux\fP\&.  The default paths that are read-only are \fB/proc/asound\fP, \fB/proc/bus\fP, \fB/proc/fs\fP, \fB/proc/irq\fP, \fB/proc/sys\fP, \fB/proc/sysrq-trigger\fP, \fB/sys/fs/cgroup\fP\&.

.RE

.PP
Note: Labeling can be disabled for all containers by setting \fBlabel=false\fP in the \fBcontainers.conf\fP(5) file.

.SS \fB--share\fP=\fInamespace\fP
.PP
A comma-separated list of kernel namespaces to share. If none or "" is specified, no namespaces will be shared and the infra container will not be created unless expiclity specified via \fB--infra=true\fP\&. The namespaces to choose from are cgroup, ipc, net, pid, uts. If the option is prefixed with a "+" then the namespace is appended to the default list, otherwise it replaces the default list. Defaults matches Kubernetes default (ipc, net, uts)

.SS \fB--share-parent\fP
.PP
This boolean determines whether or not all containers entering the pod will use the pod as their cgroup parent. The default value of this flag is true. Use the \fB--share\fP option to share the cgroup namespace rather than a cgroup parent in a pod.

.PP
Note: This options conflict with \fB--share=cgroup\fP since that would set the pod as the cgroup parent but enter the container into the same cgroupNS as the infra container.

.SS \fB--shm-size\fP=\fInumber[unit]\fP
.PP
Size of \fI/dev/shm\fP\&. A \fIunit\fP can be \fBb\fP (bytes), \fBk\fP (kibibytes), \fBm\fP (mebibytes), or \fBg\fP (gibibytes).
If the unit is omitted, the system uses bytes. If the size is omitted, the default is \fB64m\fP\&.
When \fIsize\fP is \fB0\fP, there is no limit on the amount of memory used for IPC by the pod.
This option conflicts with \fB--ipc=host\fP\&.

.SS \fB--shm-size-systemd\fP=\fInumber[unit]\fP
.PP
Size of systemd-specific tmpfs mounts such as /run, /run/lock, /var/log/journal and /tmp.
A \fIunit\fP can be \fBb\fP (bytes), \fBk\fP (kibibytes), \fBm\fP (mebibytes), or \fBg\fP (gibibytes).
If the unit is omitted, the system uses bytes. If the size is omitted, the default is \fB64m\fP\&.
When \fIsize\fP is \fB0\fP, the usage is limited to 50% of the host's available memory.

.SS \fB--subgidname\fP=\fIname\fP
.PP
Run the container in a new user namespace using the map with \fIname\fP in the \fI/etc/subgid\fP file.
If running rootless, the user needs to have the right to use the mapping. See \fBsubgid\fP(5).
This flag conflicts with \fB--userns\fP and \fB--gidmap\fP\&.

.SS \fB--subuidname\fP=\fIname\fP
.PP
Run the container in a new user namespace using the map with \fIname\fP in the \fI/etc/subuid\fP file.
If running rootless, the user needs to have the right to use the mapping. See \fBsubuid\fP(5).
This flag conflicts with \fB--userns\fP and \fB--uidmap\fP\&.

.SS \fB--sysctl\fP=\fIname=value\fP
.PP
Configure namespaced kernel parameters for all containers in the pod.

.PP
For the IPC namespace, the following sysctls are allowed:

.RS
.IP \(bu 2
kernel.msgmax
.IP \(bu 2
kernel.msgmnb
.IP \(bu 2
kernel.msgmni
.IP \(bu 2
kernel.sem
.IP \(bu 2
kernel.shmall
.IP \(bu 2
kernel.shmmax
.IP \(bu 2
kernel.shmmni
.IP \(bu 2
kernel.shm_rmid_forced
.IP \(bu 2
Sysctls beginning with fs.mqueue.*

.RE

.PP
Note: if the ipc namespace is not shared within the pod, the above sysctls are not allowed.

.PP
For the network namespace, only sysctls beginning with net.* are allowed.

.PP
Note: if the network namespace is not shared within the pod, the above sysctls are not allowed.

.SS \fB--uidmap\fP=\fIcontainer_uid:from_uid:amount\fP
.PP
Run all containers in the pod in a new user namespace using the supplied mapping. This
option conflicts with the \fB--userns\fP and \fB--subuidname\fP options. This
option provides a way to map host UIDs to container UIDs. It can be passed
several times to map different ranges.

.SS \fB--userns\fP=\fImode\fP
.PP
Set the user namespace mode for all the containers in a pod. It defaults to the \fB\fCPODMAN_USERNS\fR environment variable. An empty value ("") means user namespaces are disabled.

.PP
Rootless user --userns=Key mappings:

.TS
allbox;
l l l 
l l l .
\fB\fCKey\fR	\fB\fCHost User\fR	\fB\fCContainer User\fR
""	$UID	T{
0 (Default User account mapped to root user in container.)
T}
keep-id	$UID	T{
$UID (Map user account to same UID within container.)
T}
auto	$UID	T{
nil (Host User UID is not mapped into container.)
T}
nomap	$UID	T{
nil (Host User UID is not mapped into container.)
T}
.TE

.PP
Valid \fImode\fP values are:

.RS
.IP \(bu 2
\fIauto[:\fP\fIOPTIONS,...\fP\fI]\fP: automatically create a namespace. It is possible to specify these options to \fB\fCauto\fR:
.IP \(bu 2
\fIgidmapping=\fP\fICONTAINER_GID:HOST_GID:SIZE\fP to force a GID mapping to be present in the user namespace.
.IP \(bu 2
\fIsize=\fP\fISIZE\fP: to specify an explicit size for the automatic user namespace. e.g. \fB\fC--userns=auto:size=8192\fR\&. If \fB\fCsize\fR is not specified, \fB\fCauto\fR will estimate a size for the user namespace.
.IP \(bu 2
\fIuidmapping=\fP\fICONTAINER_UID:HOST_UID:SIZE\fP to force a UID mapping to be present in the user namespace.
.IP \(bu 2
\fIhost\fP: run in the user namespace of the caller. The processes running in the container will have the same privileges on the host as any other process launched by the calling user (default).
.IP \(bu 2
\fIkeep-id\fP: creates a user namespace where the current rootless user's UID:GID are mapped to the same values in the container. This option is not allowed for containers created by the root user.
.IP \(bu 2
\fInomap\fP: creates a user namespace where the current rootless user's UID:GID are not mapped into the container. This option is not allowed for containers created by the root user.

.RE

.SS \fB--uts\fP=\fImode\fP
.PP
Set the UTS namespace mode for the pod. The following values are supported:

.RS
.IP \(bu 2
\fBhost\fP: use the host's UTS namespace inside the pod.
.IP \(bu 2
\fBprivate\fP: create a new namespace for the pod (default).
.IP \(bu 2
\fBns:[path]\fP: run the pod in the given existing UTS namespace.

.RE

.SS \fB--volume\fP, \fB-v\fP=\fI[[SOURCE-VOLUME|HOST-DIR:]CONTAINER-DIR[:OPTIONS]]\fP
.PP
Create a bind mount. If \fB\fC-v /HOST-DIR:/CONTAINER-DIR\fR is specified, Podman
bind mounts \fB\fC/HOST-DIR\fR from the host into \fB\fC/CONTAINER-DIR\fR in the Podman
container. Similarly, \fB\fC-v SOURCE-VOLUME:/CONTAINER-DIR\fR will mount the named
volume from the host into the container. If no such named volume exists,
Podman will create one. If no source is given, the volume will be created
as an anonymously named volume with a randomly generated name, and will be
removed when the pod is removed via the \fB\fC--rm\fR flag or
the \fB\fCpodman rm --volumes\fR command.

.PP
(Note when using the remote client, including Mac and Windows (excluding WSL2) machines, the volumes will be mounted from the remote server, not necessarily the client machine.)

.PP
The \fIOPTIONS\fP is a comma-separated list and can be: [1]
\[la]#Footnote1\[ra]

.RS
.IP \(bu 2
\fBrw\fP|\fBro\fP
.IP \(bu 2
\fBz\fP|\fBZ\fP
.IP \(bu 2
[\fBO\fP]
.IP \(bu 2
[\fBU\fP]
.IP \(bu 2
[\fBno\fP]\fBcopy\fP
.IP \(bu 2
[\fBno\fP]\fBdev\fP
.IP \(bu 2
[\fBno\fP]\fBexec\fP
.IP \(bu 2
[\fBno\fP]\fBsuid\fP
.IP \(bu 2
[\fBr\fP]\fBbind\fP
.IP \(bu 2
[\fBr\fP]\fBshared\fP|[\fBr\fP]\fBslave\fP|[\fBr\fP]\fBprivate\fP[\fBr\fP]\fBunbindable\fP
.IP \(bu 2
\fBidmap\fP[=\fBoptions\fP]

.RE

.PP
The \fB\fCCONTAINER-DIR\fR must be an absolute path such as \fB\fC/src/docs\fR\&. The volume
will be mounted into the container at this directory.

.PP
If a volume source is specified, it must be a path on the host or the name of a
named volume. Host paths are allowed to be absolute or relative; relative paths
are resolved relative to the directory Podman is run in. If the source does not
exist, Podman will return an error. Users must pre-create the source files or
directories.

.PP
Any source that does not begin with a \fB\fC\&.\fR or \fB\fC/\fR will be treated as the name of
a named volume. If a volume with that name does not exist, it will be created.
Volumes created with names are not anonymous, and they are not removed by the \fB\fC--rm\fR
option and the \fB\fCpodman rm --volumes\fR command.

.PP
Specify multiple \fB-v\fP options to mount one or more volumes into a
pod.

.PP
\fB\fCWrite Protected Volume Mounts\fR

.PP
Add \fB:ro\fP or \fB:rw\fP option to mount a volume in read-only or
read-write mode, respectively. By default, the volumes are mounted read-write.
See examples.

.PP
\fB\fCChowning Volume Mounts\fR

.PP
By default, Podman does not change the owner and group of source volume
directories mounted into containers. If a pod is created in a new
user namespace, the UID and GID in the container may correspond to another UID
and GID on the host.

.PP
The \fB\fC:U\fR suffix tells Podman to use the correct host UID and GID based on the
UID and GID within the pod, to change recursively the owner and
group of the source volume. Chowning walks the file system under the volume and
changes the UID/GID on each file, it the volume has thousands of inodes, this
process will take a long time, delaying the start of the pod.

.PP
\fBWarning\fP use with caution since this will modify the host filesystem.

.PP
\fB\fCLabeling Volume Mounts\fR

.PP
Labeling systems like SELinux require that proper labels are placed on volume
content mounted into a pod. Without a label, the security system
might prevent the processes running inside the pod from using the
content. By default, Podman does not change the labels set by the OS.

.PP
To change a label in the pod context, add either of two suffixes
\fB:z\fP or \fB:Z\fP to the volume mount. These suffixes tell Podman to relabel file
objects on the shared volumes. The \fBz\fP option tells Podman that two or more
pods share the volume content. As a result, Podman labels the
content with a shared content label. Shared volume labels allow all containers
to read/write content. The \fBZ\fP option tells Podman to label the content with
a private unshared label Only the current pod can use a private
volume. Relabeling walks the file system under the volume and changes the label
on each file, if the volume has thousands of inodes, this process will take a
long time, delaying the start of the pod. If the volume
was previously relabeled with the \fB\fCz\fR option, Podman is optimized to not relabel
a second time. If files are moved into the volume, then the labels can be
manually change with the \fB\fCchcon -R container_file_t PATH\fR command.

.PP
Note: Do not relabel system files and directories. Relabeling system content
might cause other confined services on the machine to fail.  For these types
of containers we recommend disabling SELinux separation.  The option
\fB--security-opt label=disable\fP disables SELinux separation for the pod.
For example if a user wanted to volume mount their entire home directory into a
pod, they need to disable SELinux separation.

.PP
.RS

.nf
   $ podman pod create --security-opt label=disable -v $HOME:/home/user fedora touch /home/user/file

.fi
.RE

.PP
\fB\fCOverlay Volume Mounts\fR

.PP
The \fB\fC:O\fR flag tells Podman to mount the directory from the host as a
temporary storage using the \fB\fCoverlay file system\fR\&. The pod processes
can modify content within the mountpoint which is stored in the
container storage in a separate directory. In overlay terms, the source
directory will be the lower, and the container storage directory will be the
upper. Modifications to the mount point are destroyed when the pod
finishes executing, similar to a tmpfs mount point being unmounted.

.PP
For advanced users, the \fBoverlay\fP option also supports custom non-volatile
\fBupperdir\fP and \fBworkdir\fP for the overlay mount. Custom \fBupperdir\fP and
\fBworkdir\fP can be fully managed by the users themselves, and Podman will not
remove it on lifecycle completion.
Example \fB:O,upperdir=/some/upper,workdir=/some/work\fP

.PP
Subsequent executions of the container will see the original source directory
content, any changes from previous pod executions no longer exist.

.PP
One use case of the overlay mount is sharing the package cache from the
host into the container to allow speeding up builds.

.PP
Note:

.PP
.RS

.nf
 - The `O` flag conflicts with other options listed above.

.fi
.RE

.PP
Content mounted into the container is labeled with the private label.
       On SELinux systems, labels in the source directory must be readable
by the pod infra container label. Usually containers can read/execute \fB\fCcontainer_share_t\fR
and can read/write \fB\fCcontainer_file_t\fR\&. If unable to change the labels on a
source volume, SELinux container separation must be disabled for the pod or infra container
to work.
     - The source directory mounted into the pod with an overlay mount
should not be modified, it can cause unexpected failures. It is recommended
to not modify the directory until the container finishes running.

.PP
\fB\fCMounts propagation\fR

.PP
By default bind mounted volumes are \fB\fCprivate\fR\&. That means any mounts done
inside the pod will not be visible on host and vice versa. One can change
this behavior by specifying a volume mount propagation property. Making a
volume shared mounts done under that volume inside the pod will be
visible on host and vice versa. Making a volume \fBslave\fP enables only one
way mount propagation and that is mounts done on host under that volume
will be visible inside container but not the other way around. [1]
\[la]#Footnote1\[ra]

.PP
To control mount propagation property of a volume one can use the [\fBr\fP]\fBshared\fP,
[\fBr\fP]\fBslave\fP, [\fBr\fP]\fBprivate\fP or the [\fBr\fP]\fBunbindable\fP propagation flag.
Propagation property can be specified only for bind mounted volumes and not for
internal volumes or named volumes. For mount propagation to work the source mount
point (the mount point where source dir is mounted on) has to have the right propagation
properties. For shared volumes, the source mount point has to be shared. And for
slave volumes, the source mount point has to be either shared or slave.
[1]
\[la]#Footnote1\[ra]

.PP
To recursively mount a volume and all of its submounts into a
pod, use the \fBrbind\fP option. By default the bind option is
used, and submounts of the source directory will not be mounted into the
pod.

.PP
Mounting the volume with a \fBcopy\fP option tells podman to copy content from
the underlying destination directory onto newly created internal volumes. The
\fBcopy\fP only happens on the initial creation of the volume. Content is not
copied up when the volume is subsequently used on different containers. The
\fBcopy\fP option is ignored on bind mounts and has no effect.

.PP
Mounting the volume with the \fBnosuid\fP options means that SUID applications on
the volume will not be able to change their privilege. By default volumes
are mounted with \fBnosuid\fP\&.

.PP
Mounting the volume with the \fBnoexec\fP option means that no executables on the
volume will be able to be executed within the pod.

.PP
Mounting the volume with the \fBnodev\fP option means that no devices on the volume
will be able to be used by processes within the pod. By default volumes
are mounted with \fBnodev\fP\&.

.PP
If the \fIHOST-DIR\fP is a mount point, then \fBdev\fP, \fBsuid\fP, and \fBexec\fP options are
ignored by the kernel.

.PP
Use \fBdf HOST-DIR\fP to figure out the source mount, then use
\fBfindmnt -o TARGET,PROPAGATION \fIsource-mount-dir\fP\fP to figure out propagation
properties of source mount. If \fBfindmnt\fP(1) utility is not available, then one
can look at the mount entry for the source mount point in \fI/proc/self/mountinfo\fP\&. Look
at the "optional fields" and see if any propagation properties are specified.
In there, \fBshared:N\fP means the mount is shared, \fBmaster:N\fP means mount
is slave, and if nothing is there, the mount is private. [1]
\[la]#Footnote1\[ra]

.PP
To change propagation properties of a mount point, use \fBmount\fP(8) command. For
example, if one wants to bind mount source directory \fI/foo\fP, one can do
\fBmount --bind /foo /foo\fP and \fBmount --make-private --make-shared /foo\fP\&. This
will convert /foo into a shared mount point. Alternatively, one can directly
change propagation properties of source mount. Say \fI/\fP is source mount for
\fI/foo\fP, then use \fBmount --make-shared /\fP to convert \fI/\fP into a shared mount.

.PP
Note: if the user only has access rights via a group, accessing the volume
from inside a rootless pod will fail.

.PP
\fB\fCIdmapped mount\fR

.PP
If \fB\fCidmap\fR is specified, create an idmapped mount to the target user
namespace in the container. The idmap option supports a custom mapping
that can be different than the user namespace used by the
container. The mapping can be specified after the idmap option like:
\fB\fCidmap=uids=0-1-10#10-11-10;gids=0-100-10\fR\&.
For each triplet, the first value is the start of the backing file
system IDs that are mapped to the second value on the host.  The
length of this mapping is given in the third value.
Multiple ranges are separated with #.

.SS \fB--volumes-from\fP=\fICONTAINER[:OPTIONS]\fP
.PP
Mount volumes from the specified container(s). Used to share volumes between
containers and pods. The \fIoptions\fP is a comma-separated list with the following available elements:

.RS
.IP \(bu 2
\fBrw\fP|\fBro\fP
.IP \(bu 2
\fBz\fP

.RE

.PP
Mounts already mounted volumes from a source container onto another
pod. \fICONTAINER\fP may be a name or ID.
To share a volume, use the --volumes-from option when running
the target container. Volumes can be shared even if the source container
is not running.

.PP
By default, Podman mounts the volumes in the same mode (read-write or
read-only) as it is mounted in the source container.
This can be changed by adding a \fB\fCro\fR or \fB\fCrw\fR \fIoption\fP\&.

.PP
Labeling systems like SELinux require that proper labels are placed on volume
content mounted into a pod. Without a label, the security system might
prevent the processes running inside the container from using the content. By
default, Podman does not change the labels set by the OS.

.PP
To change a label in the pod context, add \fB\fCz\fR to the volume mount.
This suffix tells Podman to relabel file objects on the shared volumes. The \fB\fCz\fR
option tells Podman that two entities share the volume content. As a result,
Podman labels the content with a shared content label. Shared volume labels allow
all containers to read/write content.

.PP
If the location of the volume from the source container overlaps with
data residing on a target pod, then the volume hides
that data on the target.

.SH EXAMPLES
.PP
.RS

.nf
$ podman pod create --name test

$ podman pod create mypod

$ podman pod create --infra=false

$ podman pod create --infra-command /top toppod

$ podman pod create --publish 8443:443

$ podman pod create --network slirp4netns:outbound_addr=127.0.0.1,allow_host_loopback=true

$ podman pod create --network slirp4netns:cidr=192.168.0.0/24

$ podman pod create --network pasta

$ podman pod create --network net1:ip=10.89.1.5 --network net2:ip=10.89.10.10

.fi
.RE

.SH SEE ALSO
.PP
\fBpodman(1)\fP, \fBpodman-pod(1)\fP, \fBpodman-kube-play(1)\fP, \fBcontainers.conf(1)\fP, \fBcgroups(7)\fP

.SH HISTORY
.PP
July 2018, Originally compiled by Peter Hunt pehunt@redhat.com
\[la]mailto:pehunt@redhat.com\[ra]

.SH FOOTNOTES
.PP
1: The Podman project is committed to inclusivity, a core value of open source. The \fB\fCmaster\fR and \fB\fCslave\fR mount propagation terminology used here is problematic and divisive, and should be changed. However, these terms are currently used within the Linux kernel and must be used as-is at this time. When the kernel maintainers rectify this usage, Podman will follow suit immediately.
