alt-orchestra/talos
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix kubespan name inconsistency

Browse Source 
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 e46227ab95a6d06132e82315f55b5ced533ddabb)
This commit is contained in:
Tim Jones 2024-09-21 09:04:03 +01:00 committed by Andrey Smirnov
parent f136c031c5
commit 882582a8ea
No known key found for this signature in database
GPG Key ID: FE042E3D4085A811
7 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/machinery/config/schemas/config.schema.json
View File

@ -240,7 +240,7 @@
}, },
"kind": { "kind": {
"enum": [ "enum": [
"KubespanEndpoints" "KubeSpanEndpoints"
], ],
"title": "kind", "title": "kind",
"description": "kind is the kind of the resource.\n", "description": "kind is the kind of the resource.\n",

6
pkg/machinery/config/types/network/kubespan_endpoints.go
View File

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

6
pkg/machinery/config/types/network/network_doc.go
View File

@ -39,9 +39,9 @@ func (DefaultActionConfigV1Alpha1) Doc() *encoder.Doc {
func (KubespanEndpointsConfigV1Alpha1) Doc() *encoder.Doc { func (KubespanEndpointsConfigV1Alpha1) Doc() *encoder.Doc {
doc := &encoder.Doc{ doc := &encoder.Doc{
Type: "KubespanEndpoints", Type: "KubeSpanEndpointsConfig",
Comments: [3]string{"" /* encoder.HeadComment */, "KubespanEndpoints is a config document to configure KubeSpan endpoints." /* encoder.LineComment */, "" /* encoder.FootComment */}, Comments: [3]string{"" /* encoder.HeadComment */, "KubeSpanEndpointsConfig is a config document to configure KubeSpan endpoints." /* encoder.LineComment */, "" /* encoder.FootComment */},
Description: "KubespanEndpoints is a config document to configure KubeSpan endpoints.", Description: "KubeSpanEndpointsConfig is a config document to configure KubeSpan endpoints.",
Fields: []encoder.Doc{ Fields: []encoder.Doc{
{}, { {}, {
Name: "extraAnnouncedEndpoints", Name: "extraAnnouncedEndpoints",

2
pkg/machinery/config/types/network/testdata/kubespanendpointsconfig.yaml vendored
View File

@ -1,5 +1,5 @@
apiVersion: v1alpha1 apiVersion: v1alpha1
kind: KubespanEndpointsConfig kind: KubeSpanEndpointsConfig
extraAnnouncedEndpoints: extraAnnouncedEndpoints:
- 3.4.5.6:123 - 3.4.5.6:123
- 10.11.12.13:456 - 10.11.12.13:456

6
website/content/v1.8/reference/configuration/network/kubespanendpoints.md → website/content/v1.8/reference/configuration/network/kubespanendpointsconfig.md
View File

@ -1,6 +1,6 @@
--- ---
description: KubespanEndpoints is a config document to configure KubeSpan endpoints. description: KubeSpanEndpointsConfig is a config document to configure KubeSpan endpoints.
title: KubespanEndpoints title: KubeSpanEndpointsConfig
--- ---
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
@ -15,7 +15,7 @@ title: KubespanEndpoints
{{< highlight yaml >}} {{< highlight yaml >}}
apiVersion: v1alpha1 apiVersion: v1alpha1
kind: KubespanEndpointsConfig kind: KubeSpanEndpointsConfig
# A list of extra Wireguard endpoints to announce from this machine. # A list of extra Wireguard endpoints to announce from this machine.
extraAnnouncedEndpoints: extraAnnouncedEndpoints:
- 192.168.13.46:52000 - 192.168.13.46:52000

2
website/content/v1.8/schemas/config.schema.json
View File

@ -240,7 +240,7 @@
}, },
"kind": { "kind": {
"enum": [ "enum": [
"KubespanEndpoints" "KubeSpanEndpoints"
], ],
"title": "kind", "title": "kind",
"description": "kind is the kind of the resource.\n", "description": "kind is the kind of the resource.\n",

2
website/content/v1.8/talos-guides/network/kubespan.md
View File

@ -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. 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. 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 ```yaml
apiVersion: v1alpha1 apiVersion: v1alpha1