0
0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-08-24 20:38:34 +00:00

more docs

Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
This commit is contained in:
Pavel Boldyrev 2025-07-18 16:20:09 -04:00
parent 12cc3298e9
commit 520e7b4594
No known key found for this signature in database
GPG Key ID: 637146A2A6804C59
5 changed files with 137 additions and 0 deletions

View File

@ -0,0 +1,38 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_evpn
parent: Resources
subcategory: Virtual Environment
description: |-
EVPN Zone in Proxmox SDN. The EVPN zone creates a routable Layer 3 network, capable of spanning across multiple clusters.
---
# Resource: proxmox_virtual_environment_sdn_zone_evpn
EVPN Zone in Proxmox SDN. The EVPN zone creates a routable Layer 3 network, capable of spanning across multiple clusters.
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `id` (String) The unique identifier of the SDN zone.
### Optional
- `advertise_subnets` (Boolean) Enable subnet advertisement for EVPN.
- `controller` (String) EVPN controller address.
- `disable_arp_nd_suppression` (Boolean) Disable ARP/ND suppression for EVPN.
- `dns` (String) DNS API server address.
- `dns_zone` (String) DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server.
- `exit_nodes` (Set of String) List of exit nodes for EVPN.
- `exit_nodes_local_routing` (Boolean) Enable local routing for EVPN exit nodes.
- `ipam` (String) IP Address Management system.
- `mtu` (Number) MTU value for the zone.
- `nodes` (Set of String) Proxmox node names.
- `primary_exit_node` (String) Primary exit node for EVPN.
- `reverse_dns` (String) Reverse DNS API server address.
- `rt_import` (String) Route target import for EVPN.
- `vrf_vxlan` (Number) VRF VXLAN-ID used for dedicated routing interconnect between VNets. It must be different than the VXLAN-ID of the VNets.

View File

@ -0,0 +1,33 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_qinq
parent: Resources
subcategory: Virtual Environment
description: |-
QinQ Zone in Proxmox SDN. QinQ also known as VLAN stacking, that uses multiple layers of VLAN tags for isolation. The QinQ zone defines the outer VLAN tag (the Service VLAN) whereas the inner VLAN tag is defined by the VNet. Your physical network switches must support stacked VLANs for this configuration. Due to the double stacking of tags, you need 4 more bytes for QinQ VLANs. For example, you must reduce the MTU to 1496 if you physical interface MTU is 1500.
---
# Resource: proxmox_virtual_environment_sdn_zone_qinq
QinQ Zone in Proxmox SDN. QinQ also known as VLAN stacking, that uses multiple layers of VLAN tags for isolation. The QinQ zone defines the outer VLAN tag (the Service VLAN) whereas the inner VLAN tag is defined by the VNet. Your physical network switches must support stacked VLANs for this configuration. Due to the double stacking of tags, you need 4 more bytes for QinQ VLANs. For example, you must reduce the MTU to 1496 if you physical interface MTU is 1500.
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `id` (String) The unique identifier of the SDN zone.
### Optional
- `bridge` (String) A local, VLAN-aware bridge that is already configured on each local node
- `dns` (String) DNS API server address.
- `dns_zone` (String) DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server.
- `ipam` (String) IP Address Management system.
- `mtu` (Number) MTU value for the zone.
- `nodes` (Set of String) Proxmox node names.
- `reverse_dns` (String) Reverse DNS API server address.
- `service_vlan` (Number) Service VLAN tag for QinQ.
- `service_vlan_protocol` (String) Service VLAN protocol for QinQ.

View File

@ -0,0 +1,31 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_vlan
parent: Resources
subcategory: Virtual Environment
description: |-
VLAN Zone in Proxmox SDN. It uses an existing local Linux or OVS bridge to connect to the node's physical interface. It uses VLAN tagging defined in the VNet to isolate the network segments. This allows connectivity of VMs between different nodes.
---
# Resource: proxmox_virtual_environment_sdn_zone_vlan
VLAN Zone in Proxmox SDN. It uses an existing local Linux or OVS bridge to connect to the node's physical interface. It uses VLAN tagging defined in the VNet to isolate the network segments. This allows connectivity of VMs between different nodes.
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `id` (String) The unique identifier of the SDN zone.
### Optional
- `bridge` (String) The local bridge or OVS switch, already configured on _each_ node that allows node-to-node connection.
- `dns` (String) DNS API server address.
- `dns_zone` (String) DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server.
- `ipam` (String) IP Address Management system.
- `mtu` (Number) MTU value for the zone.
- `nodes` (Set of String) Proxmox node names.
- `reverse_dns` (String) Reverse DNS API server address.

View File

@ -0,0 +1,31 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_vxlan
parent: Resources
subcategory: Virtual Environment
description: |-
VXLAN Zone in Proxmox SDN. It establishes a tunnel (overlay) on top of an existing network (underlay). This encapsulates layer 2 Ethernet frames within layer 4 UDP datagrams using the default destination port 4789. You have to configure the underlay network yourself to enable UDP connectivity between all peers. Because VXLAN encapsulation uses 50 bytes, the MTU needs to be 50 bytes lower than the outgoing physical interface.
---
# Resource: proxmox_virtual_environment_sdn_zone_vxlan
VXLAN Zone in Proxmox SDN. It establishes a tunnel (overlay) on top of an existing network (underlay). This encapsulates layer 2 Ethernet frames within layer 4 UDP datagrams using the default destination port 4789. You have to configure the underlay network yourself to enable UDP connectivity between all peers. Because VXLAN encapsulation uses 50 bytes, the MTU needs to be 50 bytes lower than the outgoing physical interface.
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `id` (String) The unique identifier of the SDN zone.
### Optional
- `dns` (String) DNS API server address.
- `dns_zone` (String) DNS domain name. Used to register hostnames, such as `<hostname>.<domain>`. The DNS zone must already exist on the DNS server.
- `ipam` (String) IP Address Management system.
- `mtu` (Number) MTU value for the zone.
- `nodes` (Set of String) Proxmox node names.
- `peers` (Set of String) A list of IP addresses of each node in the VXLAN zone. This can be external nodes reachable at this IP address. All nodes in the cluster need to be mentioned here
- `reverse_dns` (String) Reverse DNS API server address.

View File

@ -66,6 +66,10 @@ import (
//go:generate cp ./build/docs-gen/resources/virtual_environment_network_linux_bridge.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_network_linux_vlan.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_sdn_zone_simple.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_sdn_zone_vlan.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_sdn_zone_qinq.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_sdn_zone_vxlan.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_sdn_zone_evpn.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_user_token.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_vm2.md ./docs/resources/
//go:generate cp ./build/docs-gen/resources/virtual_environment_metrics_server.md ./docs/resources/