Skip to content

Commit 5b62065

Browse files
authored
Merge pull request #1460 from stgraber/ovn
2 parents 2203d80 + ed387a2 commit 5b62065

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

doc/howto/network_forwards.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,21 +38,32 @@ Property | Type | Required | Description
3838
:-- | :-- | :-- | :--
3939
`listen_address` | string | yes | IP address to listen on
4040
`description` | string | no | Description of the network forward
41-
`config` | string set | no | Configuration options as key/value pairs (only `target_address` and `user.*` custom keys supported)
41+
`config` | string set | no | See table below
4242
`ports` | port list | no | List of {ref}`port specifications <network-forwards-port-specifications>`
4343

44+
### Forward configuration
45+
46+
Network forwards have the following configuration options:
47+
48+
Key | Type | Default | Description
49+
:-- | :--- | :------ | :----------
50+
`user.*` | string | - | User defined key/value configuration
51+
`target_address` | string | - | Default target address for anything not covered through a port definition
52+
4453
(network-forwards-listen-addresses)=
4554
### Requirements for listen addresses
4655

4756
The requirements for valid listen addresses vary depending on which network type the forward is associated to.
4857

49-
Bridge network
50-
: - Any non-conflicting listen address is allowed.
51-
- The listen address must not overlap with a subnet that is in use with another network.
58+
#### Bridge network
59+
60+
- Any non-conflicting listen address is allowed.
61+
- The listen address must not overlap with a subnet that is in use with another network.
62+
63+
#### OVN network
5264

53-
OVN network
54-
: - Allowed listen addresses must be defined in the uplink network's `ipv{n}.routes` settings or the project's {config:option}`project-restricted:restricted.networks.subnets` setting (if set).
55-
- The listen address must not overlap with a subnet that is in use with another network.
65+
- Allowed listen addresses must be defined in the uplink network's `ipv{n}.routes` settings or the project's {config:option}`project-restricted:restricted.networks.subnets` setting (if set).
66+
- The listen address must not overlap with a subnet that is in use with another network.
5667

5768
(network-forwards-port-specifications)=
5869
## Configure ports

0 commit comments

Comments
 (0)