Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/network_forwards: Split configuration into own table #1460

Merged
merged 1 commit into from
Dec 4, 2024
Merged

doc/network_forwards: Split configuration into own table #1460

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions doc/howto/network_forwards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,32 @@ Property | Type | Required | Description
:-- | :-- | :-- | :--
`listen_address` | string | yes | IP address to listen on
`description` | string | no | Description of the network forward
`config` | string set | no | Configuration options as key/value pairs (only `target_address` and `user.*` custom keys supported)
`config` | string set | no | See table below
`ports` | port list | no | List of {ref}`port specifications <network-forwards-port-specifications>`

### Forward configuration

Network forwards have the following configuration options:

Key | Type | Default | Description
:-- | :--- | :------ | :----------
`user.*` | string | - | User defined key/value configuration
`target_address` | string | - | Default target address for anything not covered through a port definition

(network-forwards-listen-addresses)=
### Requirements for listen addresses

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

Bridge network
: - Any non-conflicting listen address is allowed.
- The listen address must not overlap with a subnet that is in use with another network.
#### Bridge network

- Any non-conflicting listen address is allowed.
- The listen address must not overlap with a subnet that is in use with another network.

#### OVN network

OVN network
: - 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).
- The listen address must not overlap with a subnet that is in use with another network.
- 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).
- The listen address must not overlap with a subnet that is in use with another network.

(network-forwards-port-specifications)=
## Configure ports
Expand Down
Loading