CyVerse-Ansible.ansible-jupyterhub

ansible jupyterhub

这个角色将安装 zero-to-jupyterhub。

目前已经在 Ubuntu 20 和 18 上测试并正常工作。 在红帽系统上暂时无法正常工作,我们正在修复这个问题。

需求

需要安装 docker 和 k3s。

角色变量

  • JH_AUTH_CLASS,可以设置为 githubdummy,或者留空,这样将使用 pam 认证。

  • JH_DUMMY_PASS,使用 dummy 类所需的密码。如果未设置,则无法使用 dummy 认证。

  • JH_OAUTH2_CLIENT_ID,供如下认证使用的客户端 ID:github。

  • JH_OAUTH2_CLIENT_SECRET,供如下认证使用的客户端密钥:github。

  • JH_OAUTH2_CALLBACK_URL,供如下认证使用的回调 URL:github。

  • JH_SINGLEUSER_EXCLUDE_MASTER,如果设置为 true,将防止单用户笔记本在主节点上运行。

  • JH_SINGLEUSER_IMAGE,Jupyter 使用的镜像;默认是 jupyter/datascience-notebook

  • JH_SINGLEUSER_IMAGE_TAG,Jupyter 使用的镜像标签;默认是 latest

  • JH_SINGLEUSER_DEFAULT_URL,Jupyter 的默认 URL;默认是 "/lab"

  • JH_SINGLEUSER_GPU_ENABLE,默认是不启用 GPU

  • JH_SINGLEUSER_START_TIMEOUT,设置等待单用户容器启动的超时时间;默认是 600

  • JH_SINGLEUSER_HTTP_TIMEOUT,设置等待单用户容器与 Hub 通信的超时时间;默认是 600

  • JH_SINGLEUSER_MEMORY_GUARANTEE,为单用户容器设置的最小内存;默认是 1G

  • JH_SINGLEUSER_MEMORY_LIMIT,为单用户容器设置的最大内存;无默认值(无限制)

  • JH_SINGLEUSER_CPU_GUARANTEE,为单用户容器设置的最小 CPU;默认是 0.5

  • JH_SINGLEUSER_CPU_LIMIT,为单用户容器设置的最大 CPU;无默认值(1 CPU?)

  • JH_ALLOWED_USERS,允许登录应用的用户列表

  • JH_ADMINS,管理员用户列表

  • JH_SHARED_STORAGE_ENABLE,如果启用存储设置为 true

  • JH_SHARED_STORAGE_PV_NAME,设置为持久化存储卷名称

  • JH_SHARED_STORAGE_PVC_NAME,设置为持久化存储声明名称

  • JH_SHARED_STORAGE_MOUNT_DIR,设置为容器内的挂载目录,默认是 /home/jovyan/shared

  • JH_RESOURCES_REQUEST_CPU,如果设置,则为 Hub 容器的 CPU 设置,值范围为 0m - 1000m

  • JH_RESOURCES_REQUEST_MEMORY,如果设置,则为 Hub 容器的内存设置,值范围为 200Mi - 4Gi

  • JH_INGRESS_ENABLED,如果设置,将启用 Ingress

  • JH_INGRESS_CLASS,默认是 nginx

  • JH_INGRESS_BODY_SIZE,将设置最大代理体积。默认是 "4096m"

  • JH_INGRESS_HOSTNAME,如果设置,将为 Ingress 设置主机名

  • JH_DB_PVC_STORAGE_CLASS_NAME,如果设置,将为存储类名称

  • JH_PREPULL_IMAGES,如果设置,Hub 将在镜像可用之前提前拉取到所有节点。如果镜像过大或节点过多,请设置为 false。默认是 true。

依赖项

  • 此角色需要 Kubernetes,通常与 k3s 一起安装。如果未安装 helm,它将自动安装。

示例剧本

提供一个如何使用此角色的示例(例如,把变量作为参数传入),对用户来说总是很有帮助:

  • name: 此剧本将安装 jupyterhub hosts: jupyterhub roles:
    • ansible-docker
    • ansible-jupyterhub

许可证

BSD

作者信息

如需更多信息,请联系 Edwin Skidmore (edwin@cyverse.org)

关于项目

This role will install jupyterhub with CyVerse auth integration. Jupyterhub is configured to use dockerspawner

安装
ansible-galaxy install CyVerse-Ansible.ansible-jupyterhub
许可证
other
下载
22