Prevent Workspace Starts

⚠️ Self-hosted as a product is no longer supported

The last official update of this product is the November 2022 self-hosted release. We no longer sell commercial self-hosted licenses. If you want to self-host Gitpod, you can still request our free community license. However, we no longer offer support or updates for it. If you are interested in an isolated, private installation of Gitpod, take a look at Gitpod Dedicated. Read our blog on Gitpod Dedicated to learn why we made the decision to discontinue self-hosted.

It may be necessary for you to prevent users from starting Gitpod workspaces (in a <namespace>). Please see the update guide for more information.

It is required to prevent workspace starts when updating Gitpod and using the Single Cluster Reference Architecture because it is not highly-available.

This can be done with kubectl, after which, users won’t be able to start workspaces until the ws-manager pod is running again.

Caution: You must stop running workspaces and wait for them to terminate before proceeding. Failure to do so can result in user data loss, because the workspaces will not be able to reliably back-up.

To scale-down the ws-manager component and prevent workspace starts:

language icon language: 
kubectl scale --replicas=0 deployment/ws-manager -n <namespace>

After which, users will receive an error when trying to start workspaces. Once Gitpod is redeployed, this change will be reset automatically and workspaces will be allowed to start again.

Was this helpful?