mirror of
https://github.com/containers/podman.git
synced 2026-07-10 15:25:00 -04:00
7612af4c0e
This commit does the following: - Splits the podman-systemd.unit.5.md into multiple files - one for each quadlet file type. - Adds the podman-quadlet-basic-usage.7.md for quadlet examples. - Majority of the text in the new files is copied from the podman-systemd.unit.5.md - Adds support for very simple condditional in the markdown_preprocess. - Uses new logic in markdown_preprocess in options/*.md to use a single .md file for both podman subcommands man-pages and quadlet man-pages. This deduplicates the Quadlet man-pages a lot. - Adds new `@@option quadlet:source.md`` preprocess command to import such .md files from options directory. Signed-off-by: Jan Kaluza <jkaluza@redhat.com>
63 lines
3.6 KiB
Markdown
63 lines
3.6 KiB
Markdown
####> This option file is used in:
|
|
####> podman build, podman-build.unit.5.md.in, farm build
|
|
####> If file is edited, make sure the changes
|
|
####> are applicable to all of those.
|
|
<< if is_quadlet >>
|
|
### `Network=mode`
|
|
<< else >>
|
|
#### **--network**=*mode*, **--net**
|
|
<< endif >>
|
|
|
|
Sets the configuration for network namespaces when handling `RUN` instructions.
|
|
|
|
<< if is_quadlet >>
|
|
Special case:
|
|
|
|
* If the `name` of the network ends with `.network`, Quadlet will look for the corresponding `.network` Quadlet unit. If found, Quadlet will use the name of the Network set in the Unit, otherwise, `systemd-$name` is used. The generated systemd service contains a dependency on the service unit generated for that `.network` unit, or on `$name-network.service` if the `.network` unit is not found. Note: the corresponding `.network` file must exist.
|
|
<< endif >>
|
|
|
|
Valid _mode_ values are:
|
|
|
|
- **none**: no networking.
|
|
- **host**: use the Podman host network stack. 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 (default)
|
|
- **\<network name|ID\>**: Join the network with the given name or ID, e.g. use `--network mynet` to join the network with the name mynet. Only supported for rootful users.
|
|
- **pasta[:OPTIONS,...]**: use **pasta**(1) to create a user-mode networking
|
|
stack. \
|
|
This is the default for rootless containers and only supported in rootless mode. \
|
|
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
|
|
are 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. \
|
|
In terms of pasta(1) options, **--config-net** is given by default, in
|
|
order to configure networking when the container is started, and
|
|
**--no-map-gw** is also assumed by default, to avoid direct access from
|
|
container to host using the gateway address. The latter can be overridden
|
|
by passing **--map-gw** in the pasta-specific options (despite not being an
|
|
actual pasta(1) option). \
|
|
Also, **-t none** and **-u none** are passed to disable
|
|
automatic port forwarding based on bound ports. Similarly, **-T none** and
|
|
**-U none** are given to disable the same functionality from container to
|
|
host. \
|
|
Some examples:
|
|
- **pasta:--map-gw**: Allow the container to directly reach the host using the
|
|
gateway address.
|
|
- **pasta:--mtu,1500**: Specify a 1500 bytes MTU for the _tap_ interface in
|
|
the container.
|
|
- **pasta:--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**:
|
|
disable IPv6, assign `10.0.2.0/24` to the `tap0` interface in the container,
|
|
with gateway `10.0.2.3`, enable DNS forwarder reachable at `10.0.2.3`,
|
|
set MTU to 1500 bytes, disable NDP, DHCPv6 and DHCP support.
|
|
- **pasta:-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**:
|
|
same as above, but leave the MTU to 65520 bytes
|
|
- **pasta:-t,auto,-u,auto,-T,auto,-U,auto**: enable automatic port forwarding
|
|
based on observed bound ports from both host and container sides
|
|
- **pasta:-T,5201**: enable forwarding of TCP port 5201 from container to
|
|
host, using the loopback interface instead of the tap interface for improved
|
|
performance
|