Skip to content

Commit 6756eb3

Browse files
committed
Deduplicate more options.
Signed-off-by: Jan Kaluza <[email protected]>
1 parent 9de737b commit 6756eb3

38 files changed

+523
-545
lines changed

docs/source/markdown/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ podman-manifest-create.1.md
3434
podman-manifest-inspect.1.md
3535
podman-manifest-push.1.md
3636
podman-mount.1.md
37+
podman-network-create.1.md
3738
podman-network-ls.1.md
3839
podman-network-reload.1.md
3940
podman-pause.1.md
@@ -73,6 +74,7 @@ podman-build.unit.5.md
7374
podman-container.unit.5.md
7475
podman-image.unit.5.md
7576
podman-kube.unit.5.md
77+
podman-kube-down.1.md
7678
podman-network.unit.5.md
7779
podman-pod.unit.5.md
7880
podman-volume.unit.5.md
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
####> This option file is used in:
2+
####> podman podman-image.unit.5.md.in, pull
3+
####> If file is edited, make sure the changes
4+
####> are applicable to all of those.
5+
<< if is_quadlet >>
6+
### `AllTags=true`
7+
<< else >>
8+
#### **--all-tags**, **-a**
9+
<< endif >>
10+
11+
All tagged images in the repository are pulled.
12+
13+
*IMPORTANT: When using the all-tags flag, Podman does not iterate over the search registries in the **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)** but always uses docker.io for unqualified image names.*

docs/source/markdown/options/annotation.image.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
####> This option file is used in:
2-
####> podman build, farm build
2+
####> podman build, podman-build.unit.5.md.in, farm build
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
55
<< if is_quadlet >>
6-
### `Annotation=annotation=value`
6+
### `Annotation=annotation=value [annotation=value ...]`
77
<< else >>
88
#### **--annotation**=*annotation=value*
99
<< endif >>
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
####> This option file is used in:
2+
####> podman podman-container.unit.5.md.in
3+
####> If file is edited, make sure the changes
4+
####> are applicable to all of those.
5+
### `AutoUpdate=registry`
6+
7+
Indicates whether the container will be auto-updated ([podman-auto-update(1)](podman-auto-update.1.md)). The following values are supported:
8+
9+
* `registry`: Requires a fully-qualified image reference (e.g., quay.io/podman/stable:latest) to be used to create the container. This enforcement is necessary to know which image to actually check and pull. If an image ID was used, Podman does not know which image to check/pull anymore.
10+
11+
* `local`: Tells Podman to compare the image a container is using to the image with its raw name in local storage. If an image is updated locally, Podman simply restarts the systemd unit executing the container.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
####> This option file is used in:
2+
####> podman kube play, podman-kube.unit.5.md.in
3+
####> If file is edited, make sure the changes
4+
####> are applicable to all of those.
5+
<< if is_quadlet >>
6+
### `ConfigMap=path`
7+
<< else >>
8+
#### **--configmap**=*path*
9+
<< endif >>
10+
11+
Use Kubernetes configmap YAML at path to provide a source for environment variable values within the containers of the pod. (This option is not available with the remote Podman client)
12+
13+
<< if is_quadlet >>
14+
The value may contain only one path but it may be absolute or relative to the location of the unit file.
15+
<< else >>
16+
Note: The **--configmap** option can be used multiple times or a comma-separated list of paths can be used to pass multiple Kubernetes configmap YAMLs.
17+
The YAML file may be in a multi-doc YAML format. But, it must contain only configmaps.
18+
<< endif >>
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
####> This option file is used in:
2+
####> podman network create, podman-network.unit.5.md.in
3+
####> If file is edited, make sure the changes
4+
####> are applicable to all of those.
5+
<< if is_quadlet >>
6+
### `DisableDNS=true`
7+
<< else >>
8+
#### **--disable-dns**
9+
<< endif >>
10+
11+
Disables the DNS plugin for this network which if enabled, can perform container to container name
12+
resolution. It is only supported with the `bridge` driver, for other drivers it is always disabled.

docs/source/markdown/options/dns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
####> This option file is used in:
2-
####> podman build, podman-build.unit.5.md.in, podman-container.unit.5.md.in, create, farm build, podman-network.unit.5.md.in, podman-pod.unit.5.md.in, run
2+
####> podman build, podman-build.unit.5.md.in, podman-container.unit.5.md.in, create, farm build, network create, podman-network.unit.5.md.in, podman-pod.unit.5.md.in, run
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
55
<< if is_quadlet >>
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
####> This option file is used in:
2+
####> podman network create, podman-network.unit.5.md.in
3+
####> If file is edited, make sure the changes
4+
####> are applicable to all of those.
5+
<< if is_quadlet >>
6+
### `Driver=driver`
7+
<< else >>
8+
#### **--driver**, **-d**=*driver*
9+
<< endif >>
10+
11+
Driver to manage the network. Currently `bridge`, `macvlan` and `ipvlan` are supported. Defaults to `bridge`.
12+
As rootless the `macvlan` and `ipvlan` driver have no access to the host network interfaces because rootless networking requires a separate network namespace.
13+
14+
The netavark backend allows the use of so called *netavark plugins*, see the
15+
[plugin-API.md](https://github.com/containers/netavark/blob/main/plugin-API.md)
16+
documentation in netavark. The binary must be placed in a specified directory
17+
so podman can discover it, this list is set in `netavark_plugin_dirs` in
18+
**[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**
19+
under the `[network]` section.
20+
21+
The name of the plugin can then be used as driver to create a network for your plugin.
22+
The list of all supported drivers and plugins can be seen with `podman info --format {{.Plugins.Network}}`.
23+
24+
Note that the `macvlan` and `ipvlan` drivers do not support port forwarding. Support for port forwarding
25+
with a plugin depends on the implementation of the plugin.

docs/source/markdown/options/env.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
####> If file is edited, make sure the changes
44
####> are applicable to all of those.
55
<< if is_quadlet >>
6-
### `Environment=env`
6+
### `Environment=env=value [env=value ...]`
77
<< else >>
88
#### **--env**, **-e**=*env*
99
<< endif >>
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
####> This option file is used in:
2+
####> podman podman-container.unit.5.md.in
3+
####> If file is edited, make sure the changes
4+
####> are applicable to all of those.
5+
### `Exec=command`
6+
7+
Additional arguments for the container; this has exactly the same effect as passing
8+
more arguments after a `podman run <image> <arguments>` invocation.
9+
10+
The format is the same as for [systemd command lines](https://www.freedesktop.org/software/systemd/man/systemd.service.html#Command%20lines),
11+
However, unlike the usage scenario for similarly-named systemd `ExecStart=` verb
12+
which operates on the ambient root filesystem, it is very common for container
13+
images to have their own `ENTRYPOINT` or `CMD` metadata which this interacts with.
14+
15+
The default expectation for many images is that the image will include an `ENTRYPOINT`
16+
with a default binary, and this field will add arguments to that entrypoint.
17+
18+
Another way to describe this is that it works the same way as the [args field in a Kubernetes pod](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell).

0 commit comments

Comments
 (0)