mirror/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2026-07-09 06:44:58 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #29114 from Luap99/network-doc

Browse Source 
docs: fix network create
This commit is contained in:
Danish Prakash
2026-07-06 21:20:01 +05:30
committed by GitHub
parent d5213284f4 4b5c1b67bf
commit 451b71f6b2
2 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/markdown/options/opt.md
View File

@@ -14,7 +14,7 @@ All drivers accept the `mtu`, `metric`, `no_default_route` and options.
- `mtu`: Sets the Maximum Transmission Unit (MTU) and takes an integer value.
- `metric` Sets the Route Metric for the default route created in every container joined to this network. Accepts a positive integer value. Can only be used with the Netavark network backend.
- `no_default_route`: If set to 1, Podman will not automatically add a default route to subnets. Routes can still be added
- `no_default_route`: If set to `true`, Podman will not automatically add a default route to subnets. Routes can still be added
manually by creating a custom route using `--route`.
Additionally the `bridge` driver supports the following options:

15
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
@@ -96,7 +102,12 @@ $ podman network create --subnet 192.168.33.0/24 --route 10.1.0.0/24,192.168.33.
Create a network with a static subnet and a static route without a default
route.
```
$ podman network create --subnet 192.168.33.0/24 --route 10.1.0.0/24,192.168.33.10 --opt no_default_route=1 newnet
$ 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.