[PATCH pve-docs 13/13] sdn: add documentation for wireguard status reporting

[Stefan Hanreich <s.hanreich@proxmox.com>]

Explains the content of the returned fields and how to interpret them,
particularly how the status of an interface is determined.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 pve-gui.adoc |  1 +
 pvesdn.adoc  | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 65 insertions(+)

diff --git a/pve-gui.adoc b/pve-gui.adoc
index 3a99eaf..dce5e26 100644
--- a/pve-gui.adoc
+++ b/pve-gui.adoc
@@ -149,6 +149,7 @@ Line Height :: Specify the absolute height of a line.
 
 
 
+[[gui_resource_tree]]
 Resource Tree
 ~~~~~~~~~~~~~
 
diff --git a/pvesdn.adoc b/pvesdn.adoc
index a09a443..edcb539 100644
--- a/pvesdn.adoc
+++ b/pvesdn.adoc
@@ -957,6 +957,70 @@ Skip Route Generation:: The fabric will autogenerate routes in the kernel
 routing table for all allowed IPs of a peer. By setting this option, no routes
 will be inserted into the kernel routing table.
 
+
+[[pvesdn_fabric_status]]
+Status Reporting
+~~~~~~~~~~~~~~~~
+
+Fabrics report their current status for informational and debugging purposes. It
+can be accessed by clicking on the respective entry for the fabric in the
+xref:gui_resource_tree[Resource Tree]. Depending on the protocol, different
+metrics are reported.
+
+
+[[pvesdn_fabric_status_wireguard]]
+WireGuard
+^^^^^^^^^
+
+.Interfaces
+
+Provides information about the WireGuard interfaces of a specific node. The
+following properties are available:
+
+Name:: The name of the network interface on the host.
+
+Type:: Interfaces are always of type 'wireguard'.
+
+State:: The SDN stack performs several checks to determine the state of the
+interface. Possible states are: 'up', 'down', 'error'. An interface is up if the
+kernel interface exists and has the `UP` flag set. Otherwise, if the interface
+exists, but does not have the `UP` flag set, then it is considered 'down'. In
+all other cases (e.g. interface does not exist on the node or has the wrong
+type) the 'error' status is returned.
+
+Public Key:: The public key that can be used for communicating with the
+WireGuard instance on this interface.
+
+Listen Port:: The port that can be used to reach this WireGuard instance.
+
+.Neighbors
+
+Provides information about the peers of all WireGuard interfaces on a specific
+node. The following properties are available:
+
+Name:: The name of the node in the fabric configuration. Additionally contains
+the name of the referenced interface in parentheses, if the node is in an
+internal node.
+
+Neighbor:: The endpoint used to reach this peer (e.g. 192.0.2.0:51820).
+
+Interface:: The interface that has this neighbor configured.
+
+Public Key:: The public key of the neighbor.
+
+Allowed IPs:: A comma separated list of CIDRs. Those indicate the destination
+IPs that are allowed when sending traffic to this neighbor.
+
+Latest Handshake:: When the latest handshake with this neighbor occurred.
+Handshakes are exchanged every 180 seconds, *if* traffic is sent via this
+WireGuard interface. If no traffic is sent, then also no handshake is exchanged.
+
+Bytes transmitted:: The amount of traffic that has been sent to this neighbor.
+
+Bytes received:: The amount of traffic that has been received from this
+neighbor.
+
+
 [[pvesdn_config_route_filtering]]
 Prefix Lists and Route Maps
 ---------------------------
-- 
2.47.3