Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 3.52 KB

README.md

File metadata and controls

72 lines (53 loc) · 3.52 KB
Raw

A Helm chart for Jupyter on Fairspace

This helm chart will install and setup JupyterHub to be working with a Fairspace workspace.

The connection to the workspace should be configured in the values.yaml file.

Prerequisites

Install the Google Cloud SDK, ensure that your Google account has access to the fairspace-207108 GCP project, log in using gcloud auth login. Make sure you have access to the docker registry and Helm Chart repository.

A working instance of a fairspace workspace should be setup. Relevant parameters must be used for configuration of JupyterHub.

How to install

On GCP/GKE

First create a configuration file with settings for the workspace to install. For example:

ingress:
    domain: jupyter.mydomain.com
    
# Additional jupyter-specific variables

Then use the procedure at https://docs.fairway.app/#_installation_and_configuration for deploying the application.

On Minikube

By default, on minikube one would want to run the system without TLS and ingresses. An example configuration file would be something like:

ingress:
    enabled: false
    
# Additional jupyter-specific variables

We currently don't have a tested script for Minikube deployments. The steps should largely be the same as the ones for GCP, except for configuration of GCP-specific resources, and cert-manager installation.

Ingress parameters

Parameter Description Default
ingress.enabled Whether or not an ingress is setup for Jupyter. Should be set to false when running locally. true
ingress.domain Domain that is used for setting up the workspace. Is used as postfix for the hostname for the specific components. For example setting fairspace.app as domain will setup jupyterhub at jupyterhub.fairspace.app
ingress.tls.enabled Whether or not an TLS is enabled on the ingresses for workspace true
ingress.tls.secretNameOverride If set, this secret name is used for loading certificates for TLS. tls-<release name>
ingress.tls.certificate.obtain If set, a Certificate object will be created, such that cert-manager will request a certificate automatically. true

Keycloak parameters

Parameter Description Default
keycloak.baseUrl Base url of the keycloak installation, with scheme, without /auth. For example: https://keycloak.hyperspace.fairspace.app
keycloak.realm Keycloak realm that is used for this hyperspace.
keycloak.loginRealm By default the keycloak user logs in to the master realm. However, the script can also be run by a realm-admin of the realm that must be configured. Please note that the user needs the realm-management/realm-admin to configure the workspace.
keycloak.username Username to use for the keycloak admin user.
keycloak.password Password to use for the keycloak admin user
jupyterhub.hub.config.FairspaceOAuthenticator.client_id Client ID of the client to use for OpenID

Tool configuration

Configuration settings for specific applications should be put under a corresponding section in config.yaml:

  • Jupyterhub Settings for Jupyterhub should be in the section jupyterhub. See the Jupyterhub docs for more information on the specific settings