Jupyterhub on Kubernetes with Terraform

The goal is to create a Jupyterhub instance on Kubernetes

ARC-TS / Advanced Research Computing - Technology Services

[email protected]

• TODO: Document how to add starting data to notebooks
• TODO: Document how to change resource claim per notebook
• TODO: Add containers for addons eg. Julia
• TODO: Add hooks for Docker Hub

Basic Setup

Most options are documented in example.tfvars and config.tf

1. Copy example.tfvars
2. Create GCP Service Account create a key pair and download the secret
3. Assign Service account IAM roles:
   1. Viewer
   2. Compute Admin
   3. DNS Administrator (If using DNS Config)
   4. Kubernetes Engine Admin
   5. Service Account User
   6. Storage Admin (For remote backend recomended)
4. Create GCP bucket to hold Terraform state
5. Update backend.tf for bucket, prefix, and project name
6. Update custom.tfvars for creds
7. Setup Cloud DNS Zone if not already exists in your project or disable
8. Run: terraform init -var-file=custom.tfvars once
9. Validate plan: terraform plan -var-file=custom.tfvars
10. Apply plan: terraform apply -var-file=custom.tfvars
11. Tear it all down: terraform destory -var-file=custom.tfvars

Enable Globus OAuth

1. Generate SSL Keys and Cert (This takes time from the authority)
   1. openssl req -new -newkey rsa:2048 -keyout DNS.gcp.arc-ts.umich.edu.key -out dns.gcp.arc-ts.umich.edu.csr
   2. Remove password from key: openssl rsa -in DNS.gcp.arc-ts.umich.edu.key -out no-pass.key
   3. Use the password free key in your tfvars config file
2. Setup OAuth provider at Globus.org ["https://github.com/jupyterhub/oauthenticator"]
3. Validate plan: terraform plan -var-file=custom.tfvars
4. Apply plan: terraform apply -var-file=custom.tfvars
5. Tear it all down: terraform destory -var-file=custom.tfvars

Optional

• Edit config.tf to change what jupyterhub container starts on each login
• Force recreation of jupyterhub pod, commonly needed if config is changed terraform taint -module=jupyterhub kubernetes_pod.jupyterhub
• Connect to container with a shell:

gcloud container clusters get-credentials marcellus-wallace --zone us-central1-a --project brockp-terraform-admin \&& kubectl exec jupyter-notebook -c hub -i -t -- /bin/bash

Globus.org OAuth

• Instructions: ["https://github.com/jupyterhub/oauthenticator#globus-setup"]
• Scopes: openid profile urn:globus:auth:scope:transfer.api.globus.org:all
• Redirects: https://dns.gcp.arc-ts.umich.edu/hub/oauth_callback
• Select: Require a specific Identity Provider: University of Michigan
• Select: Pre-select Identity Provider: University of Michigan
• Leave rest as defaults
• Generate Secret: STORE SECURELY
• Set options in <config>.tfvars

Docker Container for Hub

• The images folder has a container deffinition for a jupyterhub with the needed addons
• Update to latest jupyterhub base container: docker pull jupyterhub/jupyterhub
• Build eg: docker build -t brockp/juputerhub-k8s:0.3 .
• Push to dockerhub: docker push brockp/jupyterhub-k8s:0.3
• Update juptyerhub/main.tf to point to the new version/container