aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-run.1.md.in
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/markdown/podman-run.1.md.in')
-rw-r--r--docs/source/markdown/podman-run.1.md.in63
1 files changed, 8 insertions, 55 deletions
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 95ee595d9..d596ee902 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -249,22 +249,7 @@ Print usage statement
@@option log-driver
-#### **--log-opt**=*name=value*
-
-Logging driver specific options.
-
-Set custom logging configuration. The following *name*s are supported:
-
-**path**: specify a path to the log file
- (e.g. **--log-opt path=/var/log/container/mycontainer.json**);
-
-**max-size**: specify a max size of the log file
- (e.g. **--log-opt max-size=10mb**);
-
-**tag**: specify a custom log tag for the container
- (e.g. **--log-opt tag="{{.ImageName}}"**.
-
-This option is currently supported only by the **journald** log driver.
+@@option log-opt
@@option mac-address
@@ -280,38 +265,11 @@ This option is currently supported only by the **journald** log driver.
@@option name.container
-#### **--network**=*mode*, **--net**
-
-Set the network mode for the container. Invalid if using **--dns**, **--dns-option**, or **--dns-search** with **--network** set to **none** or **container:**_id_. If used together with **--pod**, the container will not join the pod's network namespace.
-
-Valid _mode_ values are:
-
-- **bridge[:OPTIONS,...]**: Create a network stack on the default bridge. This is the default for rootful containers. It is possible to specify these additional options:
- - **alias=name**: Add network-scoped alias for the container.
- - **ip=IPv4**: Specify a static ipv4 address for this container.
- - **ip=IPv6**: Specify a static ipv6 address for this container.
- - **mac=MAC**: Specify a static mac address for this container.
- - **interface_name**: Specify a name for the created network interface inside the container.
-
- For example to set a static ipv4 address and a static mac address, use `--network bridge:ip=10.88.0.10,mac=44:33:22:11:00:99`.
-- \<network name or ID\>[:OPTIONS,...]: Connect to a user-defined network; this is the network name or ID from a network created by **[podman network create](podman-network-create.1.md)**. Using the network name implies the bridge network mode. It is possible to specify the same options described under the bridge mode above. You can use the **--network** option multiple times to specify additional networks.
-- **none**: Create a network namespace for the container but do not configure network interfaces for it, thus the container has no network connectivity.
-- **container:**_id_: Reuse another container's network stack.
-- **host**: 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.
-- **ns:**_path_: Path to a network namespace to join.
-- **private**: Create a new namespace for the container. This will use the **bridge** mode for rootful containers and **slirp4netns** for rootless ones.
-- **slirp4netns[:OPTIONS,...]**: use **slirp4netns**(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 `network_cmd_options` in containers.conf:
- - **allow_host_loopback=true|false**: 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.
- - **mtu=MTU**: Specify the MTU to use for this network. (Default is `65520`).
- - **cidr=CIDR**: Specify ip range to use for this network. (Default is `10.0.2.0/24`).
- - **enable_ipv6=true|false**: Enable IPv6. Default is true. (Required for `outbound_addr6`).
- - **outbound_addr=INTERFACE**: Specify the outbound interface slirp should bind to (ipv4 traffic only).
- - **outbound_addr=IPv4**: Specify the outbound ipv4 address slirp should bind to.
- - **outbound_addr6=INTERFACE**: Specify the outbound interface slirp should bind to (ipv6 traffic only).
- - **outbound_addr6=IPv6**: Specify the outbound ipv6 address slirp should bind to.
- - **port_handler=rootlesskit**: 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 `10.0.2.100`. If your 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.
- - **port_handler=slirp4netns**: 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.
+@@option network
+
+Invalid if using **--dns**, **--dns-option**, or **--dns-search** with **--network** set to **none** or **container:**_id_.
+
+If used together with **--pod**, the container will not join the pod's network namespace.
@@option network-alias
@@ -344,11 +302,7 @@ This is used to override the Podman provided user setup in favor of entrypoint c
@@option platform
-#### **--pod**=*name*
-
-Run container in an existing pod. If you want Podman to make the pod for you, prefix the pod name with **new:**.
-To make a pod with more granular options, use the **podman pod create** command before creating a container.
-If a container is run with a pod, and the pod has an infra-container, the infra-container will be started before the container is.
+@@option pod.run
@@option pod-id-file.container
@@ -481,8 +435,7 @@ echo "asdf" | podman run --rm -i someimage /bin/cat
@@option uts.container
-#### **--variant**=*VARIANT*
-Use _VARIANT_ instead of the default architecture variant of the container image. Some images can use multiple variants of the arm architectures, such as arm/v5 and arm/v7.
+@@option variant.container
@@option volume