Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Client connection tunneling docs #276

Merged
merged 1 commit into from
Sep 26, 2023
Merged

Client connection tunneling docs #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/capi-controlplane-bootstrap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,30 @@ spec:
```

**Note:** Controller nodes running with `--enable-worker` are assigned `node-role.kubernetes.io/master:NoExecute` taint automatically. You can disable default taints using `--no-taints` parameter.

## Client connection tunneling

k0smotron supports client connection tunneling to the child cluster's control plane nodes. This is useful when you want to access the control plane nodes from a remote location.
To enable tunneling, you need to set `spec.k0sConfigSpec.tunneling.enabled` to `true` in the `K0sControlPlane` object.

```yaml
apiVersion: controlplane.cluster.x-k8s.io/v1beta1
kind: K0sControlPlane
metadata:
name: docker-test
spec:
replicas: 1
k0sConfigSpec:
tunneling:
enabled: true
mode: tunnel # Tunneling mode: tunnel or proxy (default: tunnel)
```

K0smotron supports two tunneling modes: `tunnel` and `proxy`. You can set the tunneling mode using `spec.k0sConfigSpec.tunneling.mode` field. The default mode is `tunnel`.

K0smotron will create a kubeconfig file for the tunneling client in the `K0sControlPlane` object's namespace. You can find the kubeconfig file in the `<cluster-name>-<mode>-kubeconfig` secret.
You can use this kubeconfig file to access the control plane nodes from a remote location.

**Note:** Parent cluster's worker nodes must be accessible from the child cluster's nodes. You can use `spec.k0sConfigSpec.tunneling.serverAddress` to set the address of the parent cluster's node or load balancer. If you don't set this field, k0smotron will use the random worker node's address as the default address.

Currently, k0smotron supports only NodePort service type for tunneling. You can set the tunneling service port using `spec.k0sConfigSpec.tunneling.tunnelingNodePort` field. The default port is `31443`.
146 changes: 146 additions & 0 deletions docs/resource-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,13 @@ Resource Types:
PreStartCommands specifies commands to be run before starting k0s worker.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#k0scontrollerconfigspectunneling">tunneling</a></b></td>
<td>object</td>
<td>
Tunneling defines the tunneling configuration for the cluster.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>version</b></td>
<td>string</td>
Expand Down Expand Up @@ -190,6 +197,72 @@ Resource Types:
</table>


### K0sControllerConfig.spec.tunneling
<sup><sup>[↩ Parent](#k0scontrollerconfigspec)</sup></sup>



Tunneling defines the tunneling configuration for the cluster.

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>enabled</b></td>
<td>boolean</td>
<td>
Enabled specifies whether tunneling is enabled.<br/>
<br/>
<i>Default</i>: false<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>mode</b></td>
<td>enum</td>
<td>
Mode describes tunneling mode. If empty, k0smotron will use the default one.<br/>
<br/>
<i>Enum</i>: tunnel, proxy<br/>
<i>Default</i>: tunnel<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>serverAddress</b></td>
<td>string</td>
<td>
Server address of the tunneling server. If empty, k0smotron will try to detect worker node address for.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>serverNodePort</b></td>
<td>integer</td>
<td>
NodePort to publish for server port of the tunneling server. If empty, k0smotron will use the default one.<br/>
<br/>
<i>Format</i>: int32<br/>
<i>Default</i>: 31700<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>tunnelingNodePort</b></td>
<td>integer</td>
<td>
NodePort to publish for tunneling port. If empty, k0smotron will use the default one.<br/>
<br/>
<i>Format</i>: int32<br/>
<i>Default</i>: 31443<br/>
</td>
<td>false</td>
</tr></tbody>
</table>


### K0sControllerConfig.status
<sup><sup>[↩ Parent](#k0scontrollerconfig)</sup></sup>

Expand Down Expand Up @@ -1099,6 +1172,13 @@ Resource Types:
PreStartCommands specifies commands to be run before starting k0s worker.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#k0scontrolplanespeck0sconfigspectunneling">tunneling</a></b></td>
<td>object</td>
<td>
Tunneling defines the tunneling configuration for the cluster.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>version</b></td>
<td>string</td>
Expand Down Expand Up @@ -1151,6 +1231,72 @@ Resource Types:
</table>


### K0sControlPlane.spec.k0sConfigSpec.tunneling
<sup><sup>[↩ Parent](#k0scontrolplanespeck0sconfigspec)</sup></sup>



Tunneling defines the tunneling configuration for the cluster.

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>enabled</b></td>
<td>boolean</td>
<td>
Enabled specifies whether tunneling is enabled.<br/>
<br/>
<i>Default</i>: false<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>mode</b></td>
<td>enum</td>
<td>
Mode describes tunneling mode. If empty, k0smotron will use the default one.<br/>
<br/>
<i>Enum</i>: tunnel, proxy<br/>
<i>Default</i>: tunnel<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>serverAddress</b></td>
<td>string</td>
<td>
Server address of the tunneling server. If empty, k0smotron will try to detect worker node address for.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>serverNodePort</b></td>
<td>integer</td>
<td>
NodePort to publish for server port of the tunneling server. If empty, k0smotron will use the default one.<br/>
<br/>
<i>Format</i>: int32<br/>
<i>Default</i>: 31700<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>tunnelingNodePort</b></td>
<td>integer</td>
<td>
NodePort to publish for tunneling port. If empty, k0smotron will use the default one.<br/>
<br/>
<i>Format</i>: int32<br/>
<i>Default</i>: 31443<br/>
</td>
<td>false</td>
</tr></tbody>
</table>


### K0sControlPlane.spec.machineTemplate
<sup><sup>[↩ Parent](#k0scontrolplanespec)</sup></sup>

Expand Down