diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/podman-build.1.md | 2 | ||||
-rw-r--r-- | docs/podman-create.1.md | 10 | ||||
-rw-r--r-- | docs/podman-network-create.1.md | 70 | ||||
-rw-r--r-- | docs/podman-network-ls.1.md | 2 | ||||
-rw-r--r-- | docs/podman-network.1.md | 1 | ||||
-rw-r--r-- | docs/podman-run.1.md | 10 | ||||
-rw-r--r-- | docs/podman-volume-inspect.1.md | 1 | ||||
-rw-r--r-- | docs/podman-volume-rm.1.md | 8 |
8 files changed, 88 insertions, 16 deletions
diff --git a/docs/podman-build.1.md b/docs/podman-build.1.md index 142dc4827..1a04f8224 100644 --- a/docs/podman-build.1.md +++ b/docs/podman-build.1.md @@ -281,7 +281,7 @@ with 3 being roughly equivalent to using the global *--debug* option, and values below 0 omitting even error messages which accompany fatal errors. **--memory**, **-m**=*LIMIT* -Memory limit (format: <number>[<unit>], where unit = b, k, m or g) +Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Allows you to constrain the memory available to a container. If the host supports swap memory, then the **-m** memory setting can be larger than physical diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md index 3a3d5ef89..8a0334765 100644 --- a/docs/podman-create.1.md +++ b/docs/podman-create.1.md @@ -379,7 +379,7 @@ Default is to create a private IPC namespace (POSIX SysV IPC) for the container **--kernel-memory**=*number[unit]* -Kernel memory limit (format: `<number>[<unit>]`, where unit = b, k, m or g) +Kernel memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Constrains the kernel memory available to a container. If a limit of 0 is specified (not using `--kernel-memory`), the container's kernel memory @@ -421,7 +421,7 @@ Not currently supported **--memory**, **-m**=*limit* -Memory limit (format: <number>[<unit>], where unit = b, k, m or g) +Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Allows you to constrain the memory available to a container. If the host supports swap memory, then the **-m** memory setting can be larger than physical @@ -431,7 +431,7 @@ system's page size (the value would be very large, that's millions of trillions) **--memory-reservation**=*limit* -Memory soft limit (format: <number>[<unit>], where unit = b, k, m or g) +Memory soft limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) After setting memory reservation, when the system detects memory contention or low memory, containers are forced to restrict their consumption to their @@ -661,9 +661,9 @@ Note: Labeling can be disabled for all containers by setting label=false in the **--shm-size**=*size* -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). +Size of `/dev/shm` (format: <number>[<unit>], where unit = 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`. +When size is `0`, there is no limit on the amount of memory used for IPC by the container. **--stop-signal**=*SIGTERM* diff --git a/docs/podman-network-create.1.md b/docs/podman-network-create.1.md new file mode 100644 index 000000000..0679d8ee2 --- /dev/null +++ b/docs/podman-network-create.1.md @@ -0,0 +1,70 @@ +% podman-network-create(1) + +## NAME +podman\-network-create - Create a Podman CNI network + +## SYNOPSIS +**podman network create** [*options*] name + +## DESCRIPTION +Create a CNI-network configuration for use with Podman. At the time of this writing, the only network +type that can be created is a *bridge* network. + +If no options are provided, Podman will assign a free subnet and name for your network. + +Upon completion of creating the network, Podman will display the path to the newly added network file. + +## OPTIONS +**-d**, , **--driver** + +Driver to manage the network (default "bridge"). Currently on `bridge` is supported. + +**--gateway** + +Define a gateway for the subnet. If you want to provide a gateway address, you must also provide a +*subnet* option. + +**--internal** + +Restrict external access of this network + +**--ip-range** + +Allocate container IP from a range. The range must be a complete subnet and in CIDR notation. The *ip-range* option +must be used with a *subnet* option. + +**--subnet** + +The subnet in CIDR notation. + +## EXAMPLE + +Create a network with no options +``` +# podman network create +/etc/cni/net.d/cni-podman-4.conflist +``` + +Create a network named *newnet* that uses *192.5.0.0/16* for its subnet. +``` +# podman network create --subnet 192.5.0.0/16 newnet +/etc/cni/net.d/newnet.conflist +``` + +Create a network named *newnet* that uses *192.168.33.0/24* and defines a gateway as *192.168.133.3* +``` +# podman network create --subnet 192.168.33.0/24 --gateway 192.168.33.3 newnet +/etc/cni/net.d/newnet.conflist +``` + +Create a network that uses a *192.168.55.0/24** subnet and has an IP address range of *192.168.55.129 - 192.168.55.254*. +``` +# podman network create --subnet 192.168.55.0/24 --ip-range 192.168.55.128/25 +/etc/cni/net.d/cni-podman-5.conflist +``` + +## SEE ALSO +podman(1), podman-network(1), podman-network-inspect(1) + +## HISTORY +August 2019, Originally compiled by Brent Baude <bbaude@redhat.com> diff --git a/docs/podman-network-ls.1.md b/docs/podman-network-ls.1.md index 658b86c21..46e424593 100644 --- a/docs/podman-network-ls.1.md +++ b/docs/podman-network-ls.1.md @@ -12,7 +12,7 @@ Displays a list of existing podman networks. This command is not available for r ## OPTIONS **--quiet**, **-q** -The `quiet` options will restrict the output to only the network names +The `quiet` option will restrict the output to only the network names ## EXAMPLE diff --git a/docs/podman-network.1.md b/docs/podman-network.1.md index c9f6725a3..f05b2b78f 100644 --- a/docs/podman-network.1.md +++ b/docs/podman-network.1.md @@ -13,6 +13,7 @@ The network command manages CNI networks for Podman. It is not supported for roo | Command | Man Page | Description | | ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- | +| create | [podman-network-create(1)](podman-network-create.1.md)| Create a Podman CNI network| | inspect | [podman-network-inspect(1)](podman-network-inspect.1.md)| Displays the raw CNI network configuration for one or more networks| | ls | [podman-network-ls(1)](podman-network-ls.1.md)| Display a summary of CNI networks | | rm | [podman-network-rm(1)](podman-network-rm.1.md)| Remove one or more CNI networks | diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index fd9e40c23..8f46e8f22 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -390,7 +390,7 @@ Default is to create a private IPC namespace (POSIX SysV IPC) for the container **--kernel-memory**=*number[unit]* -Kernel memory limit (format: `<number>[<unit>]`, where unit = b, k, m or g) +Kernel memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Constrains the kernel memory available to a container. If a limit of 0 is specified (not using `--kernel-memory`), the container's kernel memory @@ -432,7 +432,7 @@ Not currently supported **--memory**, **-m**=*limit* -Memory limit (format: <number>[<unit>], where unit = b, k, m or g) +Memory limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) Allows you to constrain the memory available to a container. If the host supports swap memory, then the **-m** memory setting can be larger than physical @@ -442,7 +442,7 @@ system's page size (the value would be very large, that's millions of trillions) **--memory-reservation**=*limit* -Memory soft limit (format: <number>[<unit>], where unit = b, k, m or g) +Memory soft limit (format: <number>[<unit>], where unit = b (bytes), k (kilobytes), m (megabytes), or g (gigabytes)) After setting memory reservation, when the system detects memory contention or low memory, containers are forced to restrict their consumption to their @@ -685,9 +685,9 @@ Note: Labeling can be disabled for all containers by setting label=false in the **--shm-size**=*size* -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). +Size of `/dev/shm` (format: <number>[<unit>], where unit = 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`. +When size is `0`, there is no limit on the amount of memory used for IPC by the container. **--sig-proxy**=*true|false* diff --git a/docs/podman-volume-inspect.1.md b/docs/podman-volume-inspect.1.md index a6c99f6c8..ac5b6c977 100644 --- a/docs/podman-volume-inspect.1.md +++ b/docs/podman-volume-inspect.1.md @@ -11,6 +11,7 @@ podman\-volume\-inspect - Get detailed information on one or more volumes Display detailed information on one or more volumes. The output can be formatted using the **--format** flag and a Go template. To get detailed information about all the existing volumes, use the **--all** flag. +Volumes can be queried individually by providing their full name or a unique partial name. ## OPTIONS diff --git a/docs/podman-volume-rm.1.md b/docs/podman-volume-rm.1.md index fe047e7da..9a2fe8c99 100644 --- a/docs/podman-volume-rm.1.md +++ b/docs/podman-volume-rm.1.md @@ -4,14 +4,14 @@ podman\-volume\-rm - Remove one or more volumes ## SYNOPSIS -**podman volume rm** [*options*] +**podman volume rm** [*options*] *volume* [...] ## DESCRIPTION -Removes one ore more volumes. Only volumes that are not being used will be removed. +Removes one or more volumes. Only volumes that are not being used will be removed. If a volume is being used by a container, an error will be returned unless the **--force** -flag is being used. To remove all the volumes, use the **--all** flag. - +flag is being used. To remove all volumes, use the **--all** flag. +Volumes can be removed individually by providing their full name or a unique partial name. ## OPTIONS |