Skip to content

Commit 290294e

Browse files
[installer] Add docs for workspace SSH access
1 parent 5e3897d commit 290294e

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Installing Gitpod with SSH access to workspaces with the Gitpod Installer
2+
**_Needed by some desktop IDEs to connect to a workspace._**
3+
4+
> **IMPORTANT:** This uses port 22 on your Kubernetes nodes. When enabled, this will prevent login to the cluster via SSH. If you wish to maintain SSH access to your cluster, please configure another SSH port on your nodes.
5+
6+
To enable the SSH gateway you need to generate a host key, need to add it as secret to your Kubernetes cluster, and need to configure the Gitpod Installer to use this secret.
7+
8+
You can use `ssh-keygen` to generate a host key like this:
9+
10+
```shell
11+
$ ssh-keygen -t rsa -q -N "" -f host.key
12+
```
13+
14+
Add it to your Kubernetes cluster like this:
15+
```shell
16+
$ kubectl create secret generic ssh-gateway-host-key --from-file=host.key
17+
```
18+
19+
Add the following to your Gitpod config `gitpod.config.yaml`:
20+
```yaml
21+
sshGatewayHostKey:
22+
kind: secret
23+
name: ssh-gateway-host-key
24+
```
25+
26+
That's it. Install Gitpod as usual, consider adding firewall rules that allow the connection on port 22 to your workspace nodes, and you can use desktop IDEs that need SSH access to connect to your workspace.

0 commit comments

Comments
 (0)