Ansible JupyterHub

==================

This role will set up JupyterHub with GitHub authentication and DockerSpawner for Jupyter notebooks.

Currently, it supports Ubuntu 20.

Requirements

• You need to have Docker installed.
• The community.docker collection should be installed by running: ansible-galaxy collection install community.docker.
• If you're using SwarmSpawner, make sure Docker and Docker Swarm are set up beforehand.

Role Variables

• jupyterhub_system_config: Directory for Jupyter configuration (default: /etc/jupyterhub).
• jupyterhub_log: Path to the JupyterHub log file (default: /var/log/jupyterhub.log).
• jupyterhub_dockerhost_ip: Default internal IP address of the Docker host (default: 172.17.0.1).
• jupyterhub_docker_image: Default Docker image for Jupyter notebooks (default: jupyter/datascience-notebook).
• jupyterhub_config_allowed_users: List of users allowed to log in.
• jupyterhub_config_admin_users: List of users with admin rights (default: empty).
• jupyterhub_systemd_after: Setting used for the systemd config file (this is specific to the distribution).
• jupyterhub_mod_auth_cas_config_path: Path for the Apache module configuration.
• jupyterhub_oauth2_callback_url: Callback URL for this JupyterHub.
• jupyterhub_oauth2_client_id: OAuth2 client ID.
• jupyterhub_oauth2_client_secret: OAuth2 client secret.
• jupyterhub_enable_swarmspawner: Default is false.

Dependencies

• Any role that installs Docker CE.

Example Playbook

Here’s an example of how to use this role with variable parameters:

- name: This playbook will install JupyterHub
  hosts: jupyterhub
  roles:
    - ansible-docker
    - ansible-jupyterhub-docker

License

This role is licensed under BSD.

Author Information

For more information, please contact Edwin Skidmore at edwin@cyverse.org.