diff --git a/README.md b/README.md index 7deb5c73..d39d708e 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,10 @@ This will update the README.md file, make a commit, tag it, and then push both t To create a _special_ release, simply tag it with a tag name of your choice with the exception that it cannot start with the character `v`. +### Deploy AiiDAlab on Kubernetes + +Please see [here](k8s/README.md) for instructions on how to deploy AiiDAlab on Kubernetes. + ## Deploy AiiDAlab with AiiDAlab Launch The `aiidalab-launch` tool provides a convenient and robust method of both launching and managing one or multiple AiiDAlab instances on your computer. diff --git a/k8s/README.md b/k8s/README.md new file mode 100644 index 00000000..fb9979a2 --- /dev/null +++ b/k8s/README.md @@ -0,0 +1,38 @@ +# AiiDAlab on Kubernetes + +## Deploy on a local Minikube (Kubernetes) cluster for testing + +Here we provide instructions on how to run the stack on a local [Minikube Kubernetes cluster](https://minikube.sigs.k8s.io) for testing. + +Using Minikube is one approach to deploy a small local Kubernetes cluster, however alternatives exist (e.g. [kind](https://kind.sigs.k8s.io/), k3s, colima). +If you are not using Minikube you may have to adjust the instructions provided here slightly. + +First, [install Minikube](https://k8s-docs.netlify.app/en/docs/tasks/tools/install-minikube/) in your test environment and then start it, e.g., with `minikube start`. + +If you want to test locally built images, make sure to build them within your test environment, with +```console +eval $(minikube docker-env) +doit build +``` + +Before installing the deployment for the first time, execute: + +```console +helm repo add jupyterhub https://jupyterhub.github.io/helm-chart/ +helm repo update +``` + +Then execute `./k8s/helm-install.sh` to install AiiDAlab on the cluster. + +To expose the web server, you need to create a tunnel with +```console +minikube tunnel +``` + +You should then be able to access the server at the address shown by +```console +kubectl get svc proxy-public +``` + +Tip: Use ngrok to forward the server to the internet and access it from a different machine. +**Please be advised that this approach carries significant security risk and should only be used for testing!** diff --git a/k8s/helm-install.sh b/k8s/helm-install.sh new file mode 100755 index 00000000..5b18d202 --- /dev/null +++ b/k8s/helm-install.sh @@ -0,0 +1,13 @@ +#!/bin/bash +set -e +set -u + +VERSION=$(dunamai from git --dirty | sed 's/+/_/g') + +helm upgrade aiidalab \ + jupyterhub/jupyterhub \ + --version=1.1.4 \ + --values k8s/values.dev.yml \ + --set singleuser.image.tag="${VERSION}" \ + --cleanup-on-fail \ + --install $@ diff --git a/k8s/values.dev.yml b/k8s/values.dev.yml new file mode 100644 index 00000000..51c34766 --- /dev/null +++ b/k8s/values.dev.yml @@ -0,0 +1,7 @@ +--- +singleuser: + image: + name: "aiidalab/full-stack" + tag: "latest" + pullPolicy: Never # To use locally built images + cmd: start-singleuser.sh