From 882582a8ea830427ac96e5bd4d4434e0e3211d39 Mon Sep 17 00:00:00 2001 From: Tim Jones Date: Sat, 21 Sep 2024 09:04:03 +0100 Subject: [PATCH] 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 (cherry picked from commit e46227ab95a6d06132e82315f55b5ced533ddabb) --- pkg/machinery/config/schemas/config.schema.json | 2 +- pkg/machinery/config/types/network/kubespan_endpoints.go | 6 +++--- pkg/machinery/config/types/network/network_doc.go | 6 +++--- .../types/network/testdata/kubespanendpointsconfig.yaml | 2 +- .../{kubespanendpoints.md => kubespanendpointsconfig.md} | 6 +++--- website/content/v1.8/schemas/config.schema.json | 2 +- website/content/v1.8/talos-guides/network/kubespan.md | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) rename website/content/v1.8/reference/configuration/network/{kubespanendpoints.md => kubespanendpointsconfig.md} (81%) diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json index 1fb4f1f267..388dc91ed9 100644 --- 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 index 1a6eb85362..8023ab898d 100644 --- 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 index b95565e64f..95df265544 100644 --- a/pkg/machinery/config/types/network/network_doc.go +++ b/pkg/machinery/config/types/network/network_doc.go @@ -39,9 +39,9 @@ func (DefaultActionConfigV1Alpha1) Doc() *encoder.Doc { func (KubespanEndpointsConfigV1Alpha1) Doc() *encoder.Doc { doc := &encoder.Doc{ - Type: "KubespanEndpoints", - Comments: [3]string{"" /* encoder.HeadComment */, "KubespanEndpoints is a config document to configure KubeSpan endpoints." /* encoder.LineComment */, "" /* encoder.FootComment */}, - Description: "KubespanEndpoints is a config document to configure KubeSpan endpoints.", + Type: "KubeSpanEndpointsConfig", + Comments: [3]string{"" /* encoder.HeadComment */, "KubeSpanEndpointsConfig is a config document to configure KubeSpan endpoints." /* encoder.LineComment */, "" /* encoder.FootComment */}, + Description: "KubeSpanEndpointsConfig is a config document to configure KubeSpan endpoints.", Fields: []encoder.Doc{ {}, { Name: "extraAnnouncedEndpoints", diff --git a/pkg/machinery/config/types/network/testdata/kubespanendpointsconfig.yaml b/pkg/machinery/config/types/network/testdata/kubespanendpointsconfig.yaml index 50bccf710d..b547519cf0 100644 --- 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/website/content/v1.8/reference/configuration/network/kubespanendpoints.md b/website/content/v1.8/reference/configuration/network/kubespanendpointsconfig.md similarity index 81% rename from website/content/v1.8/reference/configuration/network/kubespanendpoints.md rename to website/content/v1.8/reference/configuration/network/kubespanendpointsconfig.md index 9313a2de02..52ce35dd08 100644 --- a/website/content/v1.8/reference/configuration/network/kubespanendpoints.md +++ b/website/content/v1.8/reference/configuration/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 --- @@ -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 index 1fb4f1f267..388dc91ed9 100644 --- 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 index 7b22450d8d..b56a3c33e6 100644 --- 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