gian/incus-mirror
1
0
Fork 0
mirror of https://github.com/lxc/incus synced 2026-08-02 05:26:46 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

doc/reference/network_physical: Convert to gendoc

Browse Source 
Signed-off-by: Janet Kimmm <janet.halo21@gmail.com>
This commit is contained in:
Janet Kimmm 2025-04-29 01:20:58 -04:00 committed by Stéphane Graber
parent e981222d2a
commit 2768dde564
No known key found for this signature in database
GPG Key ID: C638974D64792D67
1 changed files with 59 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
doc/reference/network_physical.md
View File

@ -26,27 +26,65 @@ The following configuration key namespaces are currently supported for the `phys
The following configuration options are available for the `physical` network type:
Key | Type | Condition | Default | Description
:-- | :-- | :-- | :-- | :--
`gvrp` | bool | - | `false` | Register VLAN using GARP VLAN Registration Protocol
`mtu` | integer | - | - | The MTU of the new interface
`parent` | string | - | - | Existing interface to use for network
`vlan` | integer | - | - | The VLAN ID to attach to
`bgp.peers.NAME.address` | string | BGP server | - | Peer address (IPv4 or IPv6) for use by `ovn` downstream networks
`bgp.peers.NAME.asn` | integer | BGP server | - | Peer AS number for use by `ovn` downstream networks
`bgp.peers.NAME.password` | string | BGP server | - (no password) | Peer session password (optional) for use by `ovn` downstream networks
`bgp.peers.NAME.holdtime` | integer | BGP server | `180` | Peer session hold time (in seconds; optional)
`dns.nameservers` | string | standard mode | - | List of DNS server IPs on `physical` network
`ipv4.gateway` | string | standard mode | - | IPv4 address for the gateway and network (CIDR)
`ipv4.ovn.ranges` | string | - | - | Comma-separated list of IPv4 ranges to use for child OVN network routers (FIRST-LAST format)
`ipv4.routes` | string | IPv4 address | - | Comma-separated list of additional IPv4 CIDR subnets that can be used with child OVN networks `ipv4.routes.external` setting
`ipv4.routes.anycast` | bool | IPv4 address | `false` | Allow the overlapping routes to be used on multiple networks/NIC at the same time
`ipv6.gateway` | string | standard mode | - | IPv6 address for the gateway and network (CIDR)
`ipv6.ovn.ranges` | string | - | - | Comma-separated list of IPv6 ranges to use for child OVN network routers (FIRST-LAST format)
`ipv6.routes` | string | IPv6 address | - | Comma-separated list of additional IPv6 CIDR subnets that can be used with child OVN networks `ipv6.routes.external` setting
`ipv6.routes.anycast` | bool | IPv6 address | `false` | Allow the overlapping routes to be used on multiple networks/NIC at the same time
`ovn.ingress_mode` | string | standard mode | `l2proxy` | Sets the method how OVN NIC external IPs will be advertised on uplink network: `l2proxy` (proxy ARP/NDP) or `routed`
`user.*` | string | - | - | User-provided free-form key/value pairs
## BGP options
These options configure BGP peering for OVN downstream networks:
% Include content from [config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group network_physical-bgp start -->
:end-before: <!-- config group network_physical-bgp end -->
```
## DNS options
These keys control the DNS servers and search domains used by the physical network:
% Include content from [config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group network_physical-dns start -->
:end-before: <!-- config group network_physical-dns end -->
```
## IPV4 options
These options define the IPv4 configuration for the physical network:
% Include content from [config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group network_physical-ipv4 start -->
:end-before: <!-- config group network_physical-ipv4 end -->
```
## IPV6 options
These options define the IPv6 configuration for the physical network:
% Include content from [config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group network_physical-ipv6 start -->
:end-before: <!-- config group network_physical-ipv6 end -->
```
## OVN options
These options apply when using a physical network as an OVN uplink:
% Include content from [config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group network_physical-ovn start -->
:end-before: <!-- config group network_physical-ovn end -->
```
## Common options
These apply to all physical networks regardless of other features:
% Include content from [config_options.txt](../config_options.txt)
```{include} ../config_options.txt
:start-after: <!-- config group network_physical-common start -->
:end-before: <!-- config group network_physical-common end -->
```
(network-physical-features)=
## Supported features