jupyterhub-chameleon

Chameleon extensions for JupyterHub


Keywords
chameleon, jupyterhub, jupyterhub-authenticator, jupyterhub-spawner, openstack
License
MIT
Install
pip install jupyterhub-chameleon==2.0.6

Documentation

jupyterhub-chameleon

Chameleon customizations for JupyterHub, all in one module.

This module contains several extensions and congurations relevant for Chameleon:

  • A custom authenticator that handles authenticating users against Chameleon's OpenID-Connect IdP.
  • A Docker-based spawner preconfigured with volumes backed by RBD and special handling of user scratch directories vs. experimental (ephemeral) mounts
  • An experiment import handler, which is used to craft a special spawn request that pulls code either from an external location to create an ephemeral experimental environment
  • A managed service that can refresh a user's access tokens

Installation

pip install jupyterhub-chameleon

Usage

The install_extension function is the easiest way to ensure everything is configured properly, as it will make most of the adjustments to the stock configuration for you.

import jupyterhub_chameleon

c = get_config()
jupyterhub_chameleon.install_extension(c)

# Configure JupyterHub further as needed

Configuration options

Environment variables are the easiest way to control the default behavior of this module:

DEBUG:

(bool) whether to enable debug logging.

JUPYTERHUB_PUBLIC_URL:

(str) the full (public) base URL of the JupyterHub server. JupyterHub should really provide this to managed services, but it doesn't, so we have to. The issue is that we are behind a reverse proxy, so we need to inform JupyterHub of this.

DOCKER_VOLUME_DRIVER:

(str) the name of the Docker volume driver to use when creating user work directories.

DOCKER_VOLUME_DRIVER_OPTS:

(str) options, comma-separated "key=value" pairs, passed to the volume create command.

DOCKER_NOTEBOOK_IMAGE:

(str) the name of the Docker image to spawn for users.

DOCKER_NETWORK_NAME:

(str) the Docker network name.

KEYCLOAK_SERVER_URL:

(str) the full base URL of the Keycloak server.

KEYCLOAK_REALM_NAME:

(str) the Keycloak realm name to authenticate against.

KEYCLOAK_CLIENT_ID:

(str) the Keycloak client ID.

KEYCLOAK_CLIENT_SECRET:

(str) the Keycloak client secret.

OS_AUTH_URL:

(str) the full base URL of the Keystone public endpoint. This auth URL is used for the Keystone authenticator, is pre-populated inside spawned user environments, and is by default used for any OpenStack integrations internal to the JupyterHub.

OS_REGION_NAME:

(str) an optional default Keystone region; if not set, the first detected region is used when looking up services.

OS_IDENTITY_PROVIDER:

(str) the Keystone identity provider to use when logging in via federated authentication.

OS_PROTOCOL:

(str) the Keystone federation protocol to use (openid, saml).

ARTIFACT_SHARING_SWIFT_ACCOUNT:
(str) the Swift account ID to upload artifacts as. This should match either

the account owner for the container, or some account that has read access.

ARTIFACT_SHARING_SWIFT_CONTAINER:

(str) the Swift container to store uploaded artifacts. Defaults to "trovi"

ARTIFACT_SHARING_SWIFT_TEMP_URL_KEY:

(str) the Swift secret key for signing temporary URLs.

ARTIFACT_SHARING_TRUST_PROJECT_NAME:

(str) the Keystone project to bind publish trusts to. Paired with Swift ACLs, this allows for a container to be write-only from any authenticated user. Defaults to "trovi".

ARTIFACT_SHARING_OS_*:

(str) OpenStack RC parameter overrides to use when authenticating to Keystone to generate upload trusts and tokens.