Course Leader Role
If you have the teacher role, you are allowed to create JupyterHub requests. If a JupyterHub request is approved, you may invite your course participants to join your JupyterHub.
JHaaS will deploy the JupyterHub for the time period you requested. When the period expires, the JupyterHub will be deleted.
Requesting a JupyterHub
To request a JupyterHub, login as teacher. Select the "Leadership" tab in the top navigation, then click on "Create new Request". Fill in the data accordingly:
| Key | Effect |
|---|---|
| Project Name | This name will be displayed on the JHaaS Portal and in Authentik |
| Slug | Unique identifier for your JupyterHub and part of the deployment URL |
| Description | Additional information, displayed on the JHaaS Portal and in Authentik |
| Usage period | Defines the start and end date for your JupyterHub Lifecycle |
| Notebook Type | Define the Jupyter Notebook to be used (see Notebooks section) |
| Expected Usage | This affects reservation and limits for resources |
After creating your JupyterHub Request you have to wait for the governance to apply or decline your request.
If you want to make any changes to your JupyterHub, you can create a JupyterHub change request. These JupyterHub Change Requests have also to be confirmed by the governance.
You may create JupyterHub Change Requests or cancel JupyterHub Requests at any time before the JupyterHub gets deployed. After the beginning of the deployment process, no more changes are allowed. If you want to destroy your JupyterHub before the end of your requested usage period, you may mark it for degration.
Updating of a deployed JupyterHub is planned for a later release of JHaaS.
Managing access to a JupyterHub
As soon as your JupyterHub Request is accepted by the governance, you can invite your course participants. On your JupyterHub Requestss overview and details page appears a link, that you can provide to your participants.
As soon as a participant applies for participation, you can accept or reject the participation on the JupyterHub Request details page.
About Jupyter Notebook Types
Predefined Notebook Types
We predefine some common used notebook types. These are:
| Image | Description |
|---|---|
| Minimal | Basic command-line tools useful when working in Jupyter applications |
| Spicy | Popular packages from the scientific Python ecosystem |
| R | Popular packages from the R ecosystem |
| Datascience | Libraries for data analysis from the Julia, Python, and R communities |
| Spark | Python and R support for Apache Spark |
| RStudio | Run RStudio in a jupyter notebook |
Custom Notebook Type
In addition to the predefined notebook types, you are free to use a third party notebook image (e.g. from the community) or to create your own custom jupyter notebook image. To do so, select Custom as Notebook Type and enter a notebook image and default url to use.
The easiest way to find a suitable image is to look at the official jupyter docker stacks documentation.
If there is not the perfect fit image there, you can take the image that is most likely to fit and build on that. You find the sources on Github. That's the easiest starting point to build your first custom notebook image.
Note: Beware that GPU accelerated notebooks only make sense if your JHaaS provider provides graphics cards for your JupyterHub.