* [PATCH pve-docs 1/1] sdn: fabrics: wireguard: update endpoint documentation
@ 2026-05-21 13:08 Stefan Hanreich
2026-05-22 7:20 ` applied: " Thomas Lamprecht
0 siblings, 1 reply; 2+ messages in thread
From: Stefan Hanreich @ 2026-05-21 13:08 UTC (permalink / raw)
To: pve-devel
The split of the endpoint field into endpoint + port field has been
reverted. Update the documentation to reflect this change as well.
Since this has caused confusion while testing, add explicit examples
on the expected values for internal / external nodes respectively.
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
pvesdn.adoc | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/pvesdn.adoc b/pvesdn.adoc
index 8b72283..f584526 100644
--- a/pvesdn.adoc
+++ b/pvesdn.adoc
@@ -883,11 +883,12 @@ definitions that can be used across the whole cluster.
.Internal
Endpoint:: This is the IP or hostname that other Proxmox VE nodes should use for
-connecting to this Proxmox VE node. This is used together with the endpoint port
-when configuring this Proxmox VE node as a peer.
-
-Endpoint Port:: This is the UDP port that other Proxmox VE nodes should use for
-connecting to this Proxmox VE node. If unset, it defaults to `51820`.
+connecting to this Proxmox VE node (e.g. `192.0.2.1` / `2001:db8::1`). This is
+used together with the 'Listen Port' configured on the separate interfaces for
+constructing the actual endpoint. For instance, if a node has the IP `192.0.2.1`
+as an 'Endpoint' and an interface `wg0` with 'Listen Port' `51820` configured,
+then other nodes will use `192.0.2.1:51820` as endpoint for connecting to this
+node.
Allowed IPs:: A comma-separated list of CIDRs (for example `198.51.100.0/24`,
or `0.0.0.0/0` to tunnel all IPv4 traffic). When selecting this node as a peer
@@ -901,11 +902,10 @@ Name:: The name of the external node.
Public Key:: The public key used by the external node.
-Endpoint:: The IP or hostname that other nodes use to connect to this external
-peer.
-
-Endpoint Port:: The UDP port that other nodes use to connect to this external
-peer. If unset, it defaults to `51820`.
+Endpoint:: The IP or hostname together with the port that other nodes use to
+connect to this external peer (e.g. `192.0.2.1:51820`). If an endpoint uses an
+IPv6 address, then the address needs to be enclosed in square brackets (e.g.
+`[2001:db8::1]:51820`).
Allowed IPs:: A comma-separated list of CIDRs (for example `198.51.100.0/24`,
or `0.0.0.0/0` to tunnel all IPv4 traffic). When selecting this node as a peer
--
2.47.3
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-05-22 7:21 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-05-21 13:08 [PATCH pve-docs 1/1] sdn: fabrics: wireguard: update endpoint documentation Stefan Hanreich
2026-05-22 7:20 ` applied: " Thomas Lamprecht
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox