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

Conversation

corneliusludmann
Copy link
Contributor

Description

This pull request adds docs on how to configure the Gitpod installer to enable the SSH gateway.

Related Issue(s)

Fixes #8493

Release Notes

NONE

Meta

/werft no-preview

@corneliusludmann corneliusludmann requested a review from a team March 11, 2022 14:54
@github-actions github-actions bot added the team: delivery Issue belongs to the self-hosted team label Mar 11, 2022
@corneliusludmann corneliusludmann requested a review from iQQBot March 11, 2022 14:55
@codecov
Copy link

codecov bot commented Mar 11, 2022

Codecov Report

Merging #8761 (2d84f8e) into main (5e3897d) will decrease coverage by 1.13%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #8761      +/-   ##
==========================================
- Coverage   12.31%   11.17%   -1.14%     
==========================================
  Files          20       18       -2     
  Lines        1161      993     -168     
==========================================
- Hits          143      111      -32     
+ Misses       1014      880     -134     
+ Partials        4        2       -2     
Flag Coverage Δ
components-gitpod-cli-app 11.17% <ø> (ø)
components-local-app-app-darwin-amd64 ?
components-local-app-app-darwin-arm64 ?
components-local-app-app-linux-amd64 ?
components-local-app-app-linux-arm64 ?
components-local-app-app-windows-386 ?
components-local-app-app-windows-amd64 ?
components-local-app-app-windows-arm64 ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
components/local-app/pkg/auth/pkce.go
components/local-app/pkg/auth/auth.go

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

mrsimonemms
mrsimonemms previously approved these changes Mar 11, 2022
Copy link
Contributor

@mrsimonemms mrsimonemms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/hold

I've put a nit in there. Happy for you to merge as-is though if you want

mrsimonemms
mrsimonemms previously approved these changes Mar 11, 2022
Copy link
Contributor

@mrsimonemms mrsimonemms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

# Installing Gitpod with SSH access to workspaces with the Gitpod Installer
**_Needed by some desktop IDEs to connect to a workspace._**

> **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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, only the use of hostPort (pod) and nodePort (services) will affect the SSH port of the host

iQQBot
iQQBot previously approved these changes Mar 11, 2022
Copy link
Contributor

@iQQBot iQQBot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is enough for GKE/AKS/EKS which use loadbalancer, users who use loadbalancer do not need to modify the node ssh port

@iQQBot iQQBot dismissed stale reviews from mrsimonemms and themself via 5ec8992 March 14, 2022 08:33
@stale
Copy link

stale bot commented Mar 25, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added meta: stale This issue/PR is stale and will be closed soon and removed meta: stale This issue/PR is stale and will be closed soon labels Mar 25, 2022
@iQQBot iQQBot force-pushed the clu/installer-ssh-docs branch from 57fac6a to 2d84f8e Compare March 30, 2022 08:16
@mrsimonemms mrsimonemms self-requested a review March 30, 2022 08:51
@mrsimonemms
Copy link
Contributor

/unhold

@iQQBot
Copy link
Contributor

iQQBot commented Mar 30, 2022

/unhold

@roboquat roboquat merged commit b2788a5 into main Mar 30, 2022
@roboquat roboquat deleted the clu/installer-ssh-docs branch March 30, 2022 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note-none size/S team: delivery Issue belongs to the self-hosted team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document SSH Gateway in the installer
4 participants