docs: fix kubespan name inconsistency

Fix the inconsistent use of KubeSpan in docs and Config suffix for the yaml config doc kind. Signed-off-by: Tim Jones <tim.jones@siderolabs.com> (cherry picked from commit e46227a)
siderolabs · Sep 23, 2024 · 882582a · 882582a
1 parent f136c03
commit 882582a
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json
@@ -240,7 +240,7 @@
         },
         "kind": {
           "enum": [
-            "KubespanEndpoints"
+            "KubeSpanEndpoints"
           ],
           "title": "kind",
           "description": "kind is the kind of the resource.\n",

diff --git a/pkg/machinery/config/types/network/kubespan_endpoints.go b/pkg/machinery/config/types/network/kubespan_endpoints.go
@@ -16,7 +16,7 @@ import (
 )
 
 // KubespanEndpointsKind is a KubeSpan endpoints document kind.
-const KubespanEndpointsKind = "KubespanEndpointsConfig"
+const KubespanEndpointsKind = "KubeSpanEndpointsConfig"
 
 func init() {
 	registry.Register(KubespanEndpointsKind, func(version string) config.Document {
@@ -38,9 +38,9 @@ var (
 //
 //	examples:
 //	  - value: exampleKubespanEndpointsV1Alpha1()
-//	alias: KubespanEndpoints
+//	alias: KubeSpanEndpointsConfig
 //	schemaRoot: true
-//	schemaMeta: v1alpha1/KubespanEndpoints
+//	schemaMeta: v1alpha1/KubeSpanEndpoints
 type KubespanEndpointsConfigV1Alpha1 struct {
 	meta.Meta `yaml:",inline"`
 	//   description: |

diff --git a/pkg/machinery/config/types/network/network_doc.go b/pkg/machinery/config/types/network/network_doc.go
diff --git a/pkg/machinery/config/types/network/testdata/kubespanendpointsconfig.yaml b/pkg/machinery/config/types/network/testdata/kubespanendpointsconfig.yaml
@@ -1,5 +1,5 @@
 apiVersion: v1alpha1
-kind: KubespanEndpointsConfig
+kind: KubeSpanEndpointsConfig
 extraAnnouncedEndpoints:
     - 3.4.5.6:123
     - 10.11.12.13:456
diff --git a/...onfiguration/network/kubespanendpoints.md → ...ration/network/kubespanendpointsconfig.md b/...onfiguration/network/kubespanendpoints.md → ...ration/network/kubespanendpointsconfig.md
@@ -1,6 +1,6 @@
 ---
-description: KubespanEndpoints is a config document to configure KubeSpan endpoints.
-title: KubespanEndpoints
+description: KubeSpanEndpointsConfig is a config document to configure KubeSpan endpoints.
+title: KubeSpanEndpointsConfig
 ---
 
 <!-- markdownlint-disable -->
@@ -15,7 +15,7 @@ title: KubespanEndpoints
 
 {{< highlight yaml >}}
 apiVersion: v1alpha1
-kind: KubespanEndpointsConfig
+kind: KubeSpanEndpointsConfig
 # A list of extra Wireguard endpoints to announce from this machine.
 extraAnnouncedEndpoints:
     - 192.168.13.46:52000

diff --git a/website/content/v1.8/schemas/config.schema.json b/website/content/v1.8/schemas/config.schema.json
@@ -240,7 +240,7 @@
         },
         "kind": {
           "enum": [
-            "KubespanEndpoints"
+            "KubeSpanEndpoints"
           ],
           "title": "kind",
           "description": "kind is the kind of the resource.\n",

diff --git a/website/content/v1.8/talos-guides/network/kubespan.md b/website/content/v1.8/talos-guides/network/kubespan.md
@@ -134,7 +134,7 @@ The `filters` setting allows hiding some endpoints from being advertised over Ku
 This is useful when some endpoints are known to be unreachable between the nodes, so that KubeSpan doesn't try to establish a connection to them.
 Another use-case is hiding some endpoints if nodes can connect on multiple networks, and some of the networks are more preferable than others.
 
-To include additional announced endpoints, such as inbound NAT mappings, you can add the [machine config document]({{< relref "../../reference/configuration/network/kubespanendpoints" >}}).
+To include additional announced endpoints, such as inbound NAT mappings, you can add the [machine config document]({{< relref "../../reference/configuration/network/kubespanendpointsconfig" >}}).
 
 ```yaml
 apiVersion: v1alpha1