Skip to content

[installer] Add docs for workspace SSH access #8761

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.

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

Merged
merged 1 commit into from
Mar 30, 2022
Merged
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions install/installer/docs/workspace-ssh-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Installing Gitpod with SSH access to workspaces with the Gitpod Installer
**_Needed by some desktop IDEs to connect to a workspace._**

> **IMPORTANT:** When you use k3s, this will open port 22 on your Kubernetes nodes for accessing the workspaces. 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.

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.

You can use `ssh-keygen` to generate a host key like this:

```
ssh-keygen -t rsa -q -N "" -f host.key
```

Add it to your Kubernetes cluster like this:
```
kubectl create secret generic ssh-gateway-host-key --from-file=host.key
```

Add the following to your Gitpod config `gitpod.config.yaml`:
```yaml
sshGatewayHostKey:
kind: secret
name: ssh-gateway-host-key
```

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.