You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: public/omni/cluster-management/create-a-hybrid-cluster.mdx
+46-4Lines changed: 46 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,59 @@ title: Create a Hybrid Cluster
3
3
description: Create a hybrid Talos cluster across networks using KubeSpan.
4
4
---
5
5
6
-
This guide shows you how to create a cluster consisting of any combination of bare metal, cloud virtual machines, on-premise virtual machines, or SBCs, using KubeSpan. KubeSpan is a feature of Talos Linux that provides full node-to-node network encryption with WireGuard, and enables Kubernetes to operate securely even when machines in the cluster are on different networks.
6
+
import { version } from'/snippets/custom-variables.mdx';
7
7
8
-
Refer to the general guide on creating a cluster to get started. To create a hybrid cluster, navigate to the cluster, then apply the following cluster patch by clicking on "Config Patches", and create a new patch with the target of "Cluster":
8
+
A hybrid cluster is a Kubernetes cluster whose nodes span multiple networks or infrastructure types, for example, a mix of bare metal machines, cloud virtual machines, on-premises virtual machines, or single-board computers (SBCs).
By default, Kubernetes assumes all nodes can reach each other directly on the same network. When nodes are spread across different networks, this assumption breaks down. <ahref={`../../talos/${version}/networking/kubespan`}>Kubespan</a> addresses this by establishing an encrypted WireGuard tunnel between every node in the cluster, so that all nodes can communicate securely regardless of where they are hosted.
11
+
12
+
## Prerequisites
13
+
14
+
Before proceeding, create a cluster with nodes across your intended infrastructure. To learn how to create a cluster, follow the [Getting Started with Omni guide](../getting-started/getting-started).
15
+
16
+
## Enable KubeSpan
17
+
18
+
Once your cluster is created with nodes spanning multiple networks, enable KubeSpan to allow those nodes to communicate.
19
+
20
+
KubeSpan can be enabled via a config patch, applied either through the Omni UI or a cluster template.
21
+
22
+
<Tabs>
23
+
<Tabtitle="Cluster Templates">
24
+
25
+
To enable KubeSpan using a cluster template, add the following patch to your cluster template definition:
11
26
27
+
```yaml
28
+
patches:
29
+
- name: kubespan-enabled
30
+
inline:
31
+
machine:
32
+
network:
33
+
kubespan:
34
+
enabled: true
35
+
```
36
+
37
+
For more information on patching Omni clusters inline or with patch files, see the [Cluster Template reference documentation](../reference/cluster-templates#patches).
38
+
39
+
</Tab>
40
+
<Tab title="UI">
41
+
42
+
To enable KubeSpan using the UI:
43
+
44
+
1. Navigate to your cluster in Omni.
45
+
2. Click the **...** button next to the cluster you want to patch.
46
+
3. Select **Config Patches** from the dropdown.
47
+
4. Click **Create Patch** to open the **Create Patch** page.
48
+
5. Apply the following patch:
12
49
```yaml
13
50
machine:
14
51
network:
15
52
kubespan:
16
53
enabled: true
17
54
```
18
55
19
-
All machines in this cluster will have this patch applied to them, and use WireGuard encryption for all node-to-node traffic.
56
+
<img src="./images/create-a-hybrid-cluster-create-patch-kubescan-enabled.png" alt="Create a new cluster-scoped config patch" />
57
+
58
+
</Tab>
59
+
</Tabs>
60
+
61
+
Once this patch is applied, all node-to-node traffic in the cluster will be encrypted using WireGuard, allowing nodes to communicate with each other securely regardless of which network they are on.
0 commit comments