Skip to content

Deploying JupyterHub

Warning

Deploying Jupyterhub requires an existing Kubernetes cluster.

Introduction

JupyterHub allows users to interact with a computing environment through a webpage. As most devices have access to a web browser, JupyterHub makes it is easy to provide and standardize the computing environment for a group of people (e.g., for a class of students or an analytics team). JupyterHub is a web-interface through which many "singleuser" Jupyter notebooks (one per user) may be launched.

The JupyterHub Kubernetes application is provided as part of the Azimuth science platforms collection. It is installed using the Applications dashboard of an Kubernetes cluster, which is powered by Kubeapps. The Applications dashboard is available from the Services list of your Kubernetes cluster.

The Applications dashboard shows both installed Applications and a Catalog of applications available for installation. The applications in the catalog are determined by your cloud operator. To learn more about the Applications dashboard, visit the Kubeapps documentation.

Launch process

Warning

Before deploying Jupyterhub, ensure that you are working in the correct Kubernetes namespace, which is likely to be "default" unless you are an advanced user. View and change your current namespace using the "Current Context" dialog in the top-right of the Applications dashboard.

  1. Follow the Kubeapps documentation to deploy an application, selecting jupyterhub-azimuth as the application that you wish to deploy.

  2. When prompted, use the form to customise your deployment:

    Option Explanation
    Name A name for your JupyterHub deployment. Names must be unique per-namespace.
    JupyterHub identifier The name that your JupyterHub service will have in the Services list of your Kubernetes cluster.
    CPU guarantee for each single user notebook Singleuser notebooks will only launch on a Kubernetes worker node with this many free CPUs.
    CPU limit for each single user notebook Singleuser notebooks will be limited to using this amount of CPU.
    Memory guarantee for each single user notebook Singleuser notebooks will only launch on a Kubernetes worker node with this much free memory.
    Memory limit for each single user notebook Singleuser notebooks will be limited to using this amount of memory.
    Local storage capacity for each user notebook Singleuser notebooks will have cloud volumes (virtual disks) of this size attached to them.

  3. When you have completed the form, start the deployment.

  4. After the deployment has completed, your JupyterHub instance is available from the Services menu of your Kubernetes cluster.

Last update: December 14, 2023
Created: December 14, 2023