- Configure Your Project
- Docker Configuration
- Start Tasks
- VS Code Extensions
- Exposing Ports
- Prebuilt Workspaces
- Environment Variables
- Workspace Location
- Editor Configuration
- Gitpod Self-Hosted
- Install on Google Cloud Platform
- Install on Amazon Web Services
- Install on self-managed Kubernetes
- Configure Ingress
- Configure OAuth
- Configure a Database
- Configure a Docker Registry
- Configure Storage
- Configure Nodes
- Configure Workspaces
- Languages & Frameworks
This section describes how to install Gitpod on any Kubernetes cluster using Helm. This is the most flexible and generic way of installing Gitpod. The chart for stable releases resides in Helm repository charts.gitpod.io, charts for branch-builds can be found here, and the source of the charts is in our public git repository.
For some cloud providers, we offer Terraform scripts packaged into an installer. The installer aims to use the managed services from your cloud provider (Kubernetes Cluster, database, storage, image registry) rather than installing them along with the chart. Also, the script configures the cluster for best performance and cost-efficiency. We recommend using the installer if your cloud provider is supported. Once the installer has created the cluster, it will pre-configure and install this Gitpod helm chart into it.
- A Kubernetes cluster in version 1.15 <= x <= 1.17.
kubectlwith connection to your cluster
helmin version >= 3.
Gitpod should work on small Kubernetes nodes out of the box (2vCPUs, 8GB RAM). For a better experience we recommend at least 4vCPUs and 16GB RAM for workspaces nodes. For cost efficiency, we recommend to enable cluster-autoscaling.
To install Gitpod in your Kubernetes cluster, follow these steps:
Run the following commands in your local terminal:
helm repo add gitpod.io https://charts.gitpod.io helm install gitpod gitpod.io/gitpod
kubectl get podsand verify that all pods are in state
RUNNING. If some are not, please see the Troubleshooting Guide.
- Configure domain and https.
- Go to https://<your-domain.com> and follow the steps to complete the installation.
By default, the Helm chart installs a working Gitpod installation in a lot of scenarios. Yet, there are certain things you might want to review when installing Gitpod for long term use and/or a bigger audience:
- Database: Configure where Gitpod stores all internal runtime data.
- Storage: Configure where Gitpod persists workspace content.
- Docker Registry: Configure where Gitpod stores workspace images.
- Kubernetes Nodes: Configure file system layout and the workspace’s node associativity.
- Workspaces: Configure workspace sizing.
To try the latest version of Gitpod, freshly build form the
master branch of our git repository or any other branch, follow these steps:
- Obtain the version name from werft.gitpod-dev.com. The version has the format
The Helm chart ships as part of our
installerdocker image. You can extract it by running:
docker run --entrypoint cp -v $PWD:/workspace gcr.io/gitpod-io/self-hosted/installer:<version> -R /dist/helm/ /workspace
Still Have Questions?
Please reach out. We’re happy to answer them.