From ed387a224c9954f9c7c773d7698ce85841577e54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Graber?= Date: Wed, 27 Nov 2024 19:31:51 -0500 Subject: [PATCH] doc/network_forwards: Split configuration into own table MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stéphane Graber Sponsored-by: ActivePort (https://www.activeport.com.au) --- doc/howto/network_forwards.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/doc/howto/network_forwards.md b/doc/howto/network_forwards.md index 9fb9cbaa616..330615b4b7f 100644 --- a/doc/howto/network_forwards.md +++ b/doc/howto/network_forwards.md @@ -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 ` +### 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