Previous Next

Deployment Fundamentals

Basics - Staging and Production

This repo contains two branches: staging and prod. The staging branch corresponds to the config for staging.mybinder.org and the prod branch to mybinder.org. In general (except when performing a deployment), these branches should always be the same, and prod should not drift away from staging too much.

Pre-requisites

The following are tools and technologies that mybinder.org uses. You should have a working familiarity with them in order to make changes to the mybinder.org deployment.

Google Cloud Platform

MyBinder.org currently runs on Google Cloud. There are two Google Cloud projects that we use:

  1. binder-staging contains all resources for the staging deployment
  2. binder-prod contains all resources for the production deployment

We’ll hand out credentials to anyone who wants to play with the staging deployment, so please just ask!

While you only need merge access in this repository to deploy changes, ideally you should also have access to the two Google Cloud Projects so you can debug things when deployments fail.

Kubernetes Basics

We heavily use Kubernetes for the mybinder.org deployment, and it is important you have a working knowledge of how to use Kubernetes. Detailed explanations are out of the scope of this repository, but there is a good list of tutorials. Specifically, going through the interactive tutorial to get comfortable using kubectl is required.

Helm Basics

We use helm to manage our deployments, and it is important you have a working knowledge of how to use helm. Detailed explanations are out of the scope of this repository, but docs.helm.sh is an excellent source of information. At a minimum, you must at least understand:

This is a non-exhaustive list. Feel free to ask us questions on the gitter channel or here if something specific does not make sense!

Deployment policy Incident reporting