Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ linters:
gosec:
excludes:
- G115
lll:
line-length: 150
revive:
rules:
- name: "package-comments"
Expand Down
64 changes: 64 additions & 0 deletions docs/data-sources/virtual_environment_sdn_zone_evpn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_evpn
parent: Data Sources
subcategory: Virtual Environment
description: |-
Retrieves information about an EVPN Zone in Proxmox SDN. The EVPN zone creates a routable Layer 3 network, capable of spanning across multiple clusters.
---

# Data Source: proxmox_virtual_environment_sdn_zone_evpn

Retrieves information about an EVPN Zone in Proxmox SDN. The EVPN zone creates a routable Layer 3 network, capable of spanning across multiple clusters.

## Example Usage

```terraform
data "proxmox_virtual_environment_sdn_zone_evpn" "example" {
id = "evpn1"
}

output "data_proxmox_virtual_environment_sdn_zone_evpn" {
value = {
id = data.proxmox_virtual_environment_sdn_zone_evpn.example.id
nodes = data.proxmox_virtual_environment_sdn_zone_evpn.example.nodes
controller = data.proxmox_virtual_environment_sdn_zone_evpn.example.controller
vrf_vxlan = data.proxmox_virtual_environment_sdn_zone_evpn.example.vrf_vxlan
advertise_subnets = data.proxmox_virtual_environment_sdn_zone_evpn.example.advertise_subnets
disable_arp_nd_suppression = data.proxmox_virtual_environment_sdn_zone_evpn.example.disable_arp_nd_suppression
exit_nodes = data.proxmox_virtual_environment_sdn_zone_evpn.example.exit_nodes
exit_nodes_local_routing = data.proxmox_virtual_environment_sdn_zone_evpn.example.exit_nodes_local_routing
primary_exit_node = data.proxmox_virtual_environment_sdn_zone_evpn.example.primary_exit_node
rt_import = data.proxmox_virtual_environment_sdn_zone_evpn.example.rt_import
mtu = data.proxmox_virtual_environment_sdn_zone_evpn.example.mtu
dns = data.proxmox_virtual_environment_sdn_zone_evpn.example.dns
dns_zone = data.proxmox_virtual_environment_sdn_zone_evpn.example.dns_zone
ipam = data.proxmox_virtual_environment_sdn_zone_evpn.example.ipam
reverse_dns = data.proxmox_virtual_environment_sdn_zone_evpn.example.reverse_dns
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier of the SDN zone.

### Read-Only

- `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) The Proxmox nodes which the zone and associated VNets are deployed on
- `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. Must be in the format '<ASN>:<number>' (e.g., '65000:65000').
- `vrf_vxlan` (Number) VRF VXLAN-ID used for dedicated routing interconnect between VNets. It must be different than the VXLAN-ID of the VNets.
54 changes: 54 additions & 0 deletions docs/data-sources/virtual_environment_sdn_zone_qinq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_qinq
parent: Data Sources
subcategory: Virtual Environment
description: |-
Retrieves information about a 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.
---

# Data Source: proxmox_virtual_environment_sdn_zone_qinq

Retrieves information about a 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.

## Example Usage

```terraform
data "proxmox_virtual_environment_sdn_zone_qinq" "example" {
id = "qinq1"
}

output "data_proxmox_virtual_environment_sdn_zone_qinq" {
value = {
id = data.proxmox_virtual_environment_sdn_zone_qinq.example.id
nodes = data.proxmox_virtual_environment_sdn_zone_qinq.example.nodes
bridge = data.proxmox_virtual_environment_sdn_zone_qinq.example.bridge
service_vlan = data.proxmox_virtual_environment_sdn_zone_qinq.example.service_vlan
service_vlan_protocol = data.proxmox_virtual_environment_sdn_zone_qinq.example.service_vlan_protocol
mtu = data.proxmox_virtual_environment_sdn_zone_qinq.example.mtu
dns = data.proxmox_virtual_environment_sdn_zone_qinq.example.dns
dns_zone = data.proxmox_virtual_environment_sdn_zone_qinq.example.dns_zone
ipam = data.proxmox_virtual_environment_sdn_zone_qinq.example.ipam
reverse_dns = data.proxmox_virtual_environment_sdn_zone_qinq.example.reverse_dns
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier of the SDN zone.

### Read-Only

- `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) The Proxmox nodes which the zone and associated VNets are deployed on
- `reverse_dns` (String) Reverse DNS API server address.
- `service_vlan` (Number) Service VLAN tag for QinQ. The tag must be between `1` and `4094`.
- `service_vlan_protocol` (String) Service VLAN protocol for QinQ. The protocol must be `802.1ad` or `802.1q`.
48 changes: 48 additions & 0 deletions docs/data-sources/virtual_environment_sdn_zone_simple.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_simple
parent: Data Sources
subcategory: Virtual Environment
description: |-
Retrieves information about a Simple Zone in Proxmox SDN. It will create an isolated VNet bridge. This bridge is not linked to a physical interface, and VM traffic is only local on each the node. It can be used in NAT or routed setups.
---

# Data Source: proxmox_virtual_environment_sdn_zone_simple

Retrieves information about a Simple Zone in Proxmox SDN. It will create an isolated VNet bridge. This bridge is not linked to a physical interface, and VM traffic is only local on each the node. It can be used in NAT or routed setups.

## Example Usage

```terraform
data "proxmox_virtual_environment_sdn_zone_simple" "example" {
id = "simple1"
}

output "data_proxmox_virtual_environment_sdn_zone_simple" {
value = {
id = data.proxmox_virtual_environment_sdn_zone_simple.example.id
nodes = data.proxmox_virtual_environment_sdn_zone_simple.example.nodes
mtu = data.proxmox_virtual_environment_sdn_zone_simple.example.mtu
dns = data.proxmox_virtual_environment_sdn_zone_simple.example.dns
dns_zone = data.proxmox_virtual_environment_sdn_zone_simple.example.dns_zone
ipam = data.proxmox_virtual_environment_sdn_zone_simple.example.ipam
reverse_dns = data.proxmox_virtual_environment_sdn_zone_simple.example.reverse_dns
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier of the SDN zone.

### Read-Only

- `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) The Proxmox nodes which the zone and associated VNets are deployed on
- `reverse_dns` (String) Reverse DNS API server address.
50 changes: 50 additions & 0 deletions docs/data-sources/virtual_environment_sdn_zone_vlan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_vlan
parent: Data Sources
subcategory: Virtual Environment
description: |-
Retrieves information about a 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.
---

# Data Source: proxmox_virtual_environment_sdn_zone_vlan

Retrieves information about a 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.

## Example Usage

```terraform
data "proxmox_virtual_environment_sdn_zone_vlan" "example" {
id = "vlan1"
}

output "data_proxmox_virtual_environment_sdn_zone_vlan" {
value = {
id = data.proxmox_virtual_environment_sdn_zone_vlan.example.id
nodes = data.proxmox_virtual_environment_sdn_zone_vlan.example.nodes
bridge = data.proxmox_virtual_environment_sdn_zone_vlan.example.bridge
mtu = data.proxmox_virtual_environment_sdn_zone_vlan.example.mtu
dns = data.proxmox_virtual_environment_sdn_zone_vlan.example.dns
dns_zone = data.proxmox_virtual_environment_sdn_zone_vlan.example.dns_zone
ipam = data.proxmox_virtual_environment_sdn_zone_vlan.example.ipam
reverse_dns = data.proxmox_virtual_environment_sdn_zone_vlan.example.reverse_dns
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier of the SDN zone.

### Read-Only

- `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) The Proxmox nodes which the zone and associated VNets are deployed on
- `reverse_dns` (String) Reverse DNS API server address.
50 changes: 50 additions & 0 deletions docs/data-sources/virtual_environment_sdn_zone_vxlan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zone_vxlan
parent: Data Sources
subcategory: Virtual Environment
description: |-
Retrieves information about a 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.
---

# Data Source: proxmox_virtual_environment_sdn_zone_vxlan

Retrieves information about a 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.

## Example Usage

```terraform
data "proxmox_virtual_environment_sdn_zone_vxlan" "example" {
id = "vxlan1"
}

output "data_proxmox_virtual_environment_sdn_zone_vxlan" {
value = {
id = data.proxmox_virtual_environment_sdn_zone_vxlan.example.id
nodes = data.proxmox_virtual_environment_sdn_zone_vxlan.example.nodes
peers = data.proxmox_virtual_environment_sdn_zone_vxlan.example.peers
mtu = data.proxmox_virtual_environment_sdn_zone_vxlan.example.mtu
dns = data.proxmox_virtual_environment_sdn_zone_vxlan.example.dns
dns_zone = data.proxmox_virtual_environment_sdn_zone_vxlan.example.dns_zone
ipam = data.proxmox_virtual_environment_sdn_zone_vxlan.example.ipam
reverse_dns = data.proxmox_virtual_environment_sdn_zone_vxlan.example.reverse_dns
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier of the SDN zone.

### Read-Only

- `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) The Proxmox nodes which the zone and associated VNets are deployed on
- `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.
79 changes: 79 additions & 0 deletions docs/data-sources/virtual_environment_sdn_zones.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
layout: page
title: proxmox_virtual_environment_sdn_zones
parent: Data Sources
subcategory: Virtual Environment
description: |-
Retrieves information about all SDN Zones in Proxmox. This data source can optionally filter zones by type.
---

# Data Source: proxmox_virtual_environment_sdn_zones

Retrieves information about all SDN Zones in Proxmox. This data source can optionally filter zones by type.

## Example Usage

```terraform
# List all SDN zones
data "proxmox_virtual_environment_sdn_zones" "all" {}

# List only EVPN zones
data "proxmox_virtual_environment_sdn_zones" "evpn_only" {
type = "evpn"
}

# List only Simple zones
data "proxmox_virtual_environment_sdn_zones" "simple_only" {
type = "simple"
}

output "data_proxmox_virtual_environment_sdn_zones_all" {
value = {
zones = data.proxmox_virtual_environment_sdn_zones.all.zones
}
}

output "data_proxmox_virtual_environment_sdn_zones_filtered" {
value = {
evpn_zones = data.proxmox_virtual_environment_sdn_zones.evpn_only.zones
simple_zones = data.proxmox_virtual_environment_sdn_zones.simple_only.zones
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `type` (String) Filter zones by type (simple, vlan, qinq, vxlan, evpn).

### Read-Only

- `zones` (List of Object) List of SDN zones. (see [below for nested schema](#nestedatt--zones))

<a id="nestedatt--zones"></a>
### Nested Schema for `zones`

Read-Only:

- `advertise_subnets` (Boolean)
- `bridge` (String)
- `controller` (String)
- `disable_arp_nd_suppression` (Boolean)
- `dns` (String)
- `dns_zone` (String)
- `exit_nodes` (Set of String)
- `exit_nodes_local_routing` (Boolean)
- `id` (String)
- `ipam` (String)
- `mtu` (Number)
- `nodes` (Set of String)
- `peers` (Set of String)
- `primary_exit_node` (String)
- `reverse_dns` (String)
- `rt_import` (String)
- `service_vlan` (Number)
- `service_vlan_protocol` (String)
- `type` (String)
- `vrf_vxlan` (Number)
Loading