erabo/spiegel_podman
1
0
Fork 0
mirror of https://github.com/podman-container-tools/podman.git synced 2026-08-05 00:15:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: update network create --route description

Browse source 
The netavark mention is not needed as we only support it now. Then
update it for the new route type syntax which was not documented in
commit daaf8b62ba.

Also add an example and a note that containers with CAP_NET_ADMIN can
alter routes still.

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
This commit is contained in:
Paul Holzinger 2026-07-03 16:27:26 +02:00
parent adb2307e18
commit 4b5c1b67bf
No known key found for this signature in database
GPG key ID: EB145DD938A3CAF2
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/source/markdown/podman-network-create.1.md.in
View file

@ -46,7 +46,13 @@ Ignore the create request if a network with the same name already exists instead
#### **--route**=*route*
A static route in the format `<destination in CIDR notation>,<gateway>,<route metric (optional)>`. This route will be added to every container in this network. Only available with the netavark backend. It can be specified multiple times if more than one static route is desired.
A static route in the format `<destination in CIDR notation>,<gateway|type>,<route metric (optional)>`.
The gateway must be a valid ip address or alternatively a type can be set instead which must be either
of `blackhole`, `unreachable` or `prohibit` and means the subnet will not be routed anywhere.
This route will be added to every container in this network. It can be specified multiple times if more than one static route is desired.
Note, routes are added into the container namespace, if a container is given the CAP_NET_ADMIN capability it is able to alter
the routes so this cannot be used for security relevant things in that case.
@@option subnet
@ -99,6 +105,11 @@ route.
$ podman network create --subnet 192.168.33.0/24 --route 10.1.0.0/24,192.168.33.10 --opt no_default_route=true newnet
```
Create a network with a route type blackhole. This means the traffic to the destination subnet will be dropped silently.
```
$ podman network create --route 10.1.0.0/24,blackhole --opt no_default_route=true newnet
```
Create a Macvlan based network using the host interface eth0. Macvlan networks can only be used as root.
```
$ sudo podman network create -d macvlan -o parent=eth0 --subnet 192.5.0.0/16 newnet