Skip to content

Commit 70897e3

Browse files
NathanChase22stgraber
NathanChase22
authored and
stgraber
committed
doc/network/bridge: Use gendoc
Signed-off-by: Nathan Chase <[email protected]>
1 parent 5568ad8 commit 70897e3

File tree

1 file changed

+5
-59
lines changed

1 file changed

+5
-59
lines changed

‎doc/reference/network_bridge.md

Lines changed: 5 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -52,65 +52,11 @@ The following configuration key namespaces are currently supported for the `brid
5252

5353
The following configuration options are available for the `bridge` network type:
5454

55-
Key | Type | Condition | Default | Description
56-
:-- | :-- | :-- | :-- | :--
57-
`bgp.peers.NAME.address` | string | BGP server | - | Peer address (IPv4 or IPv6)
58-
`bgp.peers.NAME.asn` | integer | BGP server | - | Peer AS number
59-
`bgp.peers.NAME.password` | string | BGP server | - (no password) | Peer session password (optional)
60-
`bgp.peers.NAME.holdtime` | integer | BGP server | `180` | Peer session hold time (in seconds; optional)
61-
`bgp.ipv4.nexthop` | string | BGP server | local address | Override the next-hop for advertised prefixes
62-
`bgp.ipv6.nexthop` | string | BGP server | local address | Override the next-hop for advertised prefixes
63-
`bridge.driver` | string | - | `native` | Bridge driver: `native` or `openvswitch`
64-
`bridge.external_interfaces` | string | - | - | Comma-separated list of unconfigured network interfaces to include in the bridge
65-
`bridge.hwaddr` | string | - | - | MAC address for the bridge
66-
`bridge.mtu` | integer | - | `1500` | Bridge MTU (default varies if tunnel in use)
67-
`dns.nameservers` | string | - | IPv4 and IPv6 address | DNS server IPs to advertise to DHCP clients and via Router Advertisements. Both IPv4 and IPv6 addresses get pushed via DHCP, and IPv6 addresses are also advertised as RDNSS via RA.
68-
`dns.domain` | string | - | `incus` | Domain to advertise to DHCP clients and use for DNS resolution
69-
`dns.mode` | string | - | `managed` | DNS registration mode: `none` for no DNS record, `managed` for Incus-generated static records or `dynamic` for client-generated records
70-
`dns.search` | string | - | - | Full comma-separated domain search list, defaulting to `dns.domain` value
71-
`dns.zone.forward` | string | - | `managed` | Comma-separated list of DNS zone names for forward DNS records
72-
`dns.zone.reverse.ipv4` | string | - | `managed` | DNS zone name for IPv4 reverse DNS records
73-
`dns.zone.reverse.ipv6` | string | - | `managed` | DNS zone name for IPv6 reverse DNS records
74-
`ipv4.address` | string | standard mode | - (initial value on creation: `auto`) | IPv4 address for the bridge (use `none` to turn off IPv4 or `auto` to generate a new random unused subnet) (CIDR)
75-
`ipv4.dhcp` | bool | IPv4 address | `true` | Whether to allocate addresses using DHCP
76-
`ipv4.dhcp.expiry` | string | IPv4 DHCP | `1h` | When to expire DHCP leases
77-
`ipv4.dhcp.gateway` | string | IPv4 DHCP | IPv4 address | Address of the gateway for the subnet
78-
`ipv4.dhcp.ranges` | string | IPv4 DHCP | all addresses | Comma-separated list of IP ranges to use for DHCP (FIRST-LAST format)
79-
`ipv4.dhcp.routes` | string | IPv4 DHCP | - | Static routes to provide via DHCP option 121, as a comma-separated list of alternating subnets (CIDR) and gateway addresses (same syntax as dnsmasq)
80-
`ipv4.firewall` | bool | IPv4 address | `true` | Whether to generate filtering firewall rules for this network
81-
`ipv4.nat` | bool | IPv4 address | `false` (initial value on creation if `ipv4.address` is set to `auto`: `true`) | Whether to NAT
82-
`ipv4.nat.address` | string | IPv4 address | - | The source address used for outbound traffic from the bridge
83-
`ipv4.nat.order` | string | IPv4 address | `before` | Whether to add the required NAT rules before or after any pre-existing rules
84-
`ipv4.ovn.ranges` | string | - | - | Comma-separated list of IPv4 ranges to use for child OVN network routers (FIRST-LAST format)
85-
`ipv4.routes` | string | IPv4 address | - | Comma-separated list of additional IPv4 CIDR subnets to route to the bridge
86-
`ipv4.routing` | bool | IPv4 address | `true` | Whether to route traffic in and out of the bridge
87-
`ipv6.address` | string | standard mode | - (initial value on creation: `auto`) | IPv6 address for the bridge (use `none` to turn off IPv6 or `auto` to generate a new random unused subnet) (CIDR)
88-
`ipv6.dhcp` | bool | IPv6 address | `true` | Whether to provide additional network configuration over DHCP
89-
`ipv6.dhcp.expiry` | string | IPv6 DHCP | `1h` | When to expire DHCP leases
90-
`ipv6.dhcp.ranges` | string | IPv6 stateful DHCP | all addresses | Comma-separated list of IPv6 ranges to use for DHCP (FIRST-LAST format)
91-
`ipv6.dhcp.stateful` | bool | IPv6 DHCP | `false` | Whether to allocate addresses using DHCP
92-
`ipv6.firewall` | bool | IPv6 address | `true` | Whether to generate filtering firewall rules for this network
93-
`ipv6.nat` | bool | IPv6 address | `false` (initial value on creation if `ipv6.address` is set to `auto`: `true`) | Whether to NAT
94-
`ipv6.nat.address` | string | IPv6 address | - | The source address used for outbound traffic from the bridge
95-
`ipv6.nat.order` | string | IPv6 address | `before` | Whether to add the required NAT rules before or after any pre-existing rules
96-
`ipv6.ovn.ranges` | string | - | - | Comma-separated list of IPv6 ranges to use for child OVN network routers (FIRST-LAST format)
97-
`ipv6.routes` | string | IPv6 address | - | Comma-separated list of additional IPv6 CIDR subnets to route to the bridge
98-
`ipv6.routing` | bool | IPv6 address | `true` | Whether to route traffic in and out of the bridge
99-
`raw.dnsmasq` | string | - | - | Additional `dnsmasq` configuration to append to the configuration file
100-
`security.acls` | string | - | - | Comma-separated list of Network ACLs to apply to NICs connected to this network (see {ref}`network-acls-bridge-limitations`)
101-
`security.acls.default.egress.action`| string | `security.acls` | `reject` | Action to use for egress traffic that doesn't match any ACL rule
102-
`security.acls.default.egress.logged`| bool | `security.acls` | `false` | Whether to log egress traffic that doesn't match any ACL rule
103-
`security.acls.default.ingress.action`| string | `security.acls` | `reject` | Action to use for ingress traffic that doesn't match any ACL rule
104-
`security.acls.default.ingress.logged`| bool | `security.acls` | `false` | Whether to log ingress traffic that doesn't match any ACL rule
105-
`tunnel.NAME.group` | string | `vxlan` | `239.0.0.1` | Multicast address for `vxlan` (used if local and remote aren't set)
106-
`tunnel.NAME.id` | integer | `vxlan` | `0` | Specific tunnel ID to use for the `vxlan` tunnel
107-
`tunnel.NAME.interface` | string | `vxlan` | - | Specific host interface to use for the tunnel
108-
`tunnel.NAME.local` | string | `gre` or `vxlan` | - | Local address for the tunnel (not necessary for multicast `vxlan`)
109-
`tunnel.NAME.port` | integer | `vxlan` | `0` | Specific port to use for the `vxlan` tunnel
110-
`tunnel.NAME.protocol` | string | standard mode | - | Tunneling protocol: `vxlan` or `gre`
111-
`tunnel.NAME.remote` | string | `gre` or `vxlan` | - | Remote address for the tunnel (not necessary for multicast `vxlan`)
112-
`tunnel.NAME.ttl` | integer | `vxlan` | `1` | Specific TTL to use for multicast routing topologies
113-
`user.*` | string | - | - | User-provided free-form key/value pairs
55+
% Include content from [config_options.txt](../config_options.txt)
56+
```{include} ../config_options.txt
57+
:start-after: <!-- config group network_bridge-common start -->
58+
:end-before: <!-- config group network_bridge-common end -->
59+
```
11460

11561
```{note}
11662
The `bridge.external_interfaces` option supports an extended format allowing the creation of missing VLAN interfaces.

0 commit comments

Comments
 (0)