Skip to content

Commit dfbece5

Browse files
committed
docs: update the kubespan docs
add info on kubespan's relationship with discovery service, when unavailable Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
1 parent 8b041a7 commit dfbece5

File tree

5 files changed

+18
-48
lines changed

5 files changed

+18
-48
lines changed

website/content/v1.10/talos-guides/network/kubespan.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,12 @@ cluster:
125125
enabled: true
126126
```
127127

128+
## Discovery Service Availability
129+
130+
KubeSpan depends on the Discovery Service for peer discovery and key exchange. Once all nodes in a cluster have established their KubeSpan connections, the cluster can continue operating normally even if the Discovery Service becomes temporarily unavailable. When the cluster is already running and all peers are connected, node-to-node communication remains seamless because the existing WireGuard sessions persist, allowing operations to continue uninterrupted.
131+
132+
However, if the Discovery Service is unavailable and you reboot a node or attempt to add new ones, those nodes will be unable to join or rejoin the mesh until the service becomes reachable again. This is because new key exchanges and peer discovery require an active connection to the Discovery Service.
133+
128134
## Configuration
129135

130136
KubeSpan will automatically discover all cluster members, exchange Wireguard public keys and establish a full mesh network.

website/content/v1.11/kubernetes-guides/upgrading-kubernetes.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -121,30 +121,6 @@ Version numbers for Talos, etcd, Kubernetes components, and add-ons change frequ
121121
122122
See the [Reproducible Machine Configuration]({{< relref "../talos-guides/configuration/reproducible-machine-config.md" >}}) guide for full instructions on handling machine configurations after version bumps.
123123
124-
#### Recommended Workflow
125-
126-
Instead of storing full machine configs, keep only the following:
127-
128-
* `secrets.yaml` (cluster secrets generated once at cluster creation)
129-
* Patch files (YAML/JSON patches that describe the differences you want from the defaults — e.g. custom networking, node labels, additional arguments)
130-
131-
When you need machine configs:
132-
133-
1. Generate fresh base machine configs with your `secrets.yaml`:
134-
135-
```bash
136-
talosctl gen config <cluster-name> <cluster-endpoint> \
137-
--with-secrets secrets.yaml
138-
```
139-
140-
1. [Apply your stored patches]({{< relref "../talos-guides/configuration/patching.md#configuration-patching-with-talosctl-cli" >}}) on top of the generated configs.
141-
142-
1. Use the patched configs when creating or updating nodes.
143-
144-
1. Discard the generated base configs.
145-
146-
This workflow ensures that upgrades via `talosctl upgrade-k8s` do not create drift between the live and declared state, since version bumps are handled automatically in regenerated configs.
147-
148124
## Manual Kubernetes Upgrade
149125
150126
Kubernetes can be upgraded manually by following the steps outlined below.

website/content/v1.11/talos-guides/network/kubespan.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,12 @@ cluster:
125125
enabled: true
126126
```
127127

128+
## Discovery Service Availability
129+
130+
KubeSpan depends on the Discovery Service for peer discovery and key exchange. Once all nodes in a cluster have established their KubeSpan connections, the cluster can continue operating normally even if the Discovery Service becomes temporarily unavailable. When the cluster is already running and all peers are connected, node-to-node communication remains seamless because the existing WireGuard sessions persist, allowing operations to continue uninterrupted.
131+
132+
However, if the Discovery Service is unavailable and you reboot a node or attempt to add new ones, those nodes will be unable to join or rejoin the mesh until the service becomes reachable again. This is because new key exchanges and peer discovery require an active connection to the Discovery Service.
133+
128134
## Configuration
129135

130136
KubeSpan will automatically discover all cluster members, exchange Wireguard public keys and establish a full mesh network.

website/content/v1.12/kubernetes-guides/upgrading-kubernetes.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -121,30 +121,6 @@ Version numbers for Talos, etcd, Kubernetes components, and add-ons change frequ
121121
122122
See the [Reproducible Machine Configuration]({{< relref "../talos-guides/configuration/reproducible-machine-config.md" >}}) guide for full instructions on handling machine configurations after version bumps.
123123
124-
#### Recommended Workflow
125-
126-
Instead of storing full machine configs, keep only the following:
127-
128-
* `secrets.yaml` (cluster secrets generated once at cluster creation)
129-
* Patch files (YAML/JSON patches that describe the differences you want from the defaults — e.g. custom networking, node labels, additional arguments)
130-
131-
When you need machine configs:
132-
133-
1. Generate fresh base machine configs with your `secrets.yaml`:
134-
135-
```bash
136-
talosctl gen config <cluster-name> <cluster-endpoint> \
137-
--with-secrets secrets.yaml
138-
```
139-
140-
1. [Apply your stored patches]({{< relref "../talos-guides/configuration/patching.md#configuration-patching-with-talosctl-cli" >}}) on top of the generated configs.
141-
142-
1. Use the patched configs when creating or updating nodes.
143-
144-
1. Discard the generated base configs.
145-
146-
This workflow ensures that upgrades via `talosctl upgrade-k8s` do not create drift between the live and declared state, since version bumps are handled automatically in regenerated configs.
147-
148124
## Manual Kubernetes Upgrade
149125
150126
Kubernetes can be upgraded manually by following the steps outlined below.

website/content/v1.12/talos-guides/network/kubespan.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,12 @@ cluster:
125125
enabled: true
126126
```
127127

128+
## Discovery Service Availability
129+
130+
KubeSpan depends on the Discovery Service for peer discovery and key exchange. Once all nodes in a cluster have established their KubeSpan connections, the cluster can continue operating normally even if the Discovery Service becomes temporarily unavailable. When the cluster is already running and all peers are connected, node-to-node communication remains seamless because the existing WireGuard sessions persist, allowing operations to continue uninterrupted.
131+
132+
However, if the Discovery Service is unavailable and you reboot a node or attempt to add new ones, those nodes will be unable to join or rejoin the mesh until the service becomes reachable again. This is because new key exchanges and peer discovery require an active connection to the Discovery Service.
133+
128134
## Configuration
129135

130136
KubeSpan will automatically discover all cluster members, exchange Wireguard public keys and establish a full mesh network.

0 commit comments

Comments
 (0)