Skip to content

Files

Latest commit

 

History

History
 
 

chart

README.md

Gitpod Self-Hosted

gitpod.io is a service that provides developers with ready-to-code dev environments in the cloud.

This Helm chart allows you to deploy and operate an instance of Gitpod on your own infrastructure.

Prerequisites

  • Kubernetes 1.13+
  • Helm 3+

Get Repo Info

git clone https://github.com/gitpod-io/gitpod
cd gitpod/chart

helm repo add charts.gitpod.io https://charts.gitpod.io
helm repo add stable https://charts.helm.sh/stable
helm repo add stable https://helm.min.io/
helm repo update
helm dep up

See helm repo for command documentation.

Install Chart

$ helm install gitpod .

See configuration below.

See helm install for command documentation.

Dependencies

By default this chart installs additional, dependent charts:

See configuration for options to replace those dependencies.

See helm dependency for command documentation.

Uninstall Chart

$ helm uninstall gitpod

This removes all the Kubernetes components associated with the chart and deletes the release.

See helm uninstall for command documentation.

Upgrading Chart

$ helm upgrade --install gitpod .

See helm upgrade for command documentation.

Recommended Configuration

The default installation of this Chart works out-of-the box in the majority of scenarios. The following section introduces the most important options you likely want to review and tune for your particular use case.

Ingress, Domain and HTTPS

Parameter Description Default
ingressMode One of hosts, pathAndHost and noDomain. Governs how workspaces are accessible. See values.yaml for details. noDomain
hostname The Hostname your installation is available at localhost
certificatesSecret Configures certificates for your domain {}

There are several options how to enable ingress into your Gitpod installation. They mostly hinge on the fact which kind of certificate are available:

  • noDomain requires no domain nor certificate but offers HTTP only
  • hosts enables all features and full HTTPS support but requires wilcard HTTPS certificates
  • pathAndHost is a tradeoff that works with non-wildcard HTTPS certificates Compare values.yaml for details.

For more details and a complete example using hosts see here.

OAuth

See here on how to pre-configure OAuth providers.

Database

The default installation comes with a MySQL that runs inside the same cluster.

See here on how to configure a custom database.

Storage

See here on how to configure a custom storage provider.

Docker Registry

See here on how to configure a custom docker registry.

Advanced Configuration Reference

Note: This is not complete yet and very much work-in-progress. Please open an issue if you have a particular question!

Node Filesystem Layout

See here on how to configure custom node paths.

Workspace sizing

See here on how to configure different workspace sizings.