This section describes how to install Gitpod on a vanilla Kubernetes cluster. Gitpod also provides more optimized installations offering better performance for particular cloud providers:
- Google Cloud Platform: Install Gitpod in a blank GCP project, either using a script that automates the procedure or manually step-by-step.
- Ensure you have the general installation prerequisites available.
kubectlwith access to that cluster.
helm. We recommend version 3.x. Any version >= 2.11 will also work, but requires you to have tiller configured.
The Gitpod self-hosted repository contains the configuration files this guide is refering to. Throughout this guide you will be modifying the files found in this repo. We recommend you fork this repository so that you can easily rebase your changes on the latest version.
git clone https://github.com/gitpod-io/self-hosted cd self-hosted git remote rename origin upstream
For the rest of this guide we will assume that you are located in the root of a working copy of this repository.
Gitpod requires a domain name which resolves to the IP of your Kubernetes cluster. In this document we’ll use
your-domain.com as example. Set your real domain in the
By default Gitpod deploys a
LoadBalancer service as means of ingress.
If you have a fixed IP address that you want to use, set the
gitpod.components.proxy.loadBalancerIP field to the external IP of your cluster/load balancer.
If this field is not set, Kubernetes will assign you a load balancer IP during deployment.
Once you know your IP address, configure your three domain names to resolve to that IP address:
Gitpod delegates authentication to a configurable OAuth provider.
Follow the steps to set up GitHub or GitLab as OAuth provider.
Gitpod builds docker images on demand and runs them in Kubernetes pods as workspaces. Since Kubernetes by default only pulls images from secure Docker registries, you will either need to have HTTPS certificates configured if you want to use the internal docker registry, or use an external docker registry.
To get Gitpod running quickly, you may skip this chapter. For production scenarios, however, we highly recomend this configuration.
- Docker Registry: Use your own Docker registry instead of the built-in one.
- HTTPS certificates: Configure HTTPS certificates for secure access to Gitpod.
- Database: Use your own MySQL database instead of the built-in one.
helm repo add charts.gitpod.io https://charts.gitpod.io helm dep update helm upgrade --install $(for i in $(cat configuration.txt); do echo -e "-f $i"; done) gitpod .
https://<your-domain.com>/ and check that you can login and start workspaces just like on gitpod.io.
Launch a workpace. Launching the first workspace can take significantly longer (up to 15min), this is because Docker images are being pulled.