Helm Charts

Get started by adding this Helm repo

helm repo add polus https://polusai.github.io/notebooks-hub/_static/charts

JupyterHub

Install the chart: helm install polus/polus-jupyterhub --generate-name

Notebooks Hub API

Install the chart: helm install polus/notebooks-hub-api --generate-name

Notebooks Hub UI

Install the chart: helm install polus/notebooks-hub-ui --generate-name

Notebooks-hub-ui

The Helm Chart for the UI Frontend for the Notebooks Hub Application

Configuration

The following table lists the configurable parameters of the Notebooks-hub-ui chart and their default values.

Parameter	Description	Default
`serviceType`		`"NodePort"`
`servicePort`		`4200`
`servicePortName`		`"4200"`
`targetPort`		`4200`
`nodePort`		`32000`
`ingressHost`		`"UI_HOST_URL"`
`replicas`		`2`
`tlsSecrets.enabled`	Using TLS certs via secrets at the Ingress level	`false`
`tlsSecrets.secret`	Name of Secret containing TLS private key and cert	`null`
`nodeAffinity.enabled`		`false`
`config.production`		`false`
`config.jupyterhub_url`		`"JUPYTERHUB_URL"`
`config.backend_url`		`"BACKEND_URL"`
`config.default_hardware_option`		`"DEFAULT_HARDWARE_OPTION"`
`imageName`		`"IMAGE_NAME"`
`appVersion`		`"APP_VERSION"`

Documentation generated by Frigate.

Minimal Test Deployment of JupyterHub

To test the basic functionality of the application (for example in Docker Desktop K8s cluster or a separate namespace in the cloud cluster) you can select the minimal viable configuration without auth, persistent database and any other integrations enabled.

Create local-values.yaml with the following content

hub:
  storage:
    storageClass: aws-efs
    storagePerUser: 1Gi
    sharedNotebooksStorage: 1Gi
    modulesStorage: 1Gi

  service:
    type: NodePort

postgresql:
  enabled: false

Install chart dependencies

helm repo add bitnami https://charts.bitnami.com/bitnami
helm dependency update
helm dependency build

Deploy the application

helm upgrade --install --generate-name deploy/Helm/jupyterhub --values local-values.yaml --namespace ${KUBERNETES_NAMESPACE}