add Name to Node

Signed-off-by: Seán C McCord <ulexus@gmail.com>
siderolabs · May 9, 2021 · d3fd1f3 · d3fd1f3
1 parent eb0e8ba
commit d3fd1f3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/types/types.go b/types/types.go
@@ -2,9 +2,18 @@ package types
 
 // Node describes a Wireguard Peer
 type Node struct {
+	// Name is the human-readable identifier of this Node.
+	// Usually, this is the kubernetes Node name.
+	// It *should* generally be unique, but it is not required to be so.
+	Name string
+
+	// ID is the unique identifier for this Node.
+	// Usually, this is the Wireguard Public Key of the Node.
    ID string
 
+	// IP is the Wireguard interface IP of this Node.
 	IP string
 
+	// KnownEndpoints is a list of known endpoints (host:port) for this Node.
    KnownEndpoints []string
 }