Live notes towards a test deployment and demo

[consideRatio]

Development

For a test deployment and demo we need a few things to come into place.

Software preparation

• Testable opt-in feature of c.BinderHub.require_build_only
  Allow building the image without needing to launch it jupyterhub/binderhub#1647

Chart preparation

• Published Helm chart etc, installable from everywhere
• Ability to configure BinderHub
  Allow binderhub to be configured via config and extraConfig #18
• Add a daemonset to setup a docker-api on the host node as a socket to be mounted by the build pods created by BinderHub

Testing

Testing deployment

We can test things locally or in a CI system, but we have setup a k8s cluster to test things in a production similar environment for now to also enable easier demoing of the results.

• Write notes about the k8s cluster we have for testing things

  • The GCP project binderhub-service-development has a GKE cluster setup.

  gcloud auth login --update-adc
  gcloud container clusters get-credentials binderhub-service --zone=europe-west1-d --project=binderhub-service-development
  

• Write notes about the helm commands to install / upgrade, and with what config

  tools/generate-json-schema.py
  tools/validate-against-schema.py
  chartpress --no-build
  
  helm upgrade --install binderhub-service binderhub-service
  

  Once installed, we can access the binderhub REST API. @GeorgianaElena and I have done this in a not convenient way of first opening a network connection to binderhub's UI:

  kubectl port-forward deploy/binderhub-service 8585
  

  Then we were able to make a build from curl like this:

  curl http://localhost:8585/build/gh/binderhub-ci-repos/cached-minimal-dockerfile/HEAD?build_only=true
  

• Setup a GCP based container registry we can work against

  • Create a key to access it, and put it in a k8s secret, and make use of it via binderhub config KubernetesBuildExecutor.push_secret

Testing procedure

• Trial how to test this in a minimalistic way
  I think straight up curl to for example http://localhost:8585/build/gh/binderhub-ci-repos/cached-minimal-dockerfile/HEAD?build_only=true is sufficient.
• Verify ability to start build of images
• Verify ability to push images to some registry
  We have tested against a GKE Artifact registry (includes docker container registry)

[consideRatio]

Status update

The demo to deploy and use a binderhub in a "build only" mode through its REST API is now demonstrated, and the checkboxes for this issue is resolved. Future work is planned in #27, and below is a gif animation of using the CLI curl to access the REST API in the deployment to a k8s cluster on GCP.

binderhub the software accepts "build_only=true"

@GeorgianaElena has made jupyterhub/binderhub#1647 functional, and we have also worked to make a Helm chart deploy binderhub using that not yet merged feature-branch.

binderhub-service running, and REST API functional

When the image is built and pushed, we don't directly launch. BinderHub has started without coupling to JupyterHub, built an image, and pushed it to a container registry.

Images pushed to container registry