CyVerse-Ansible.ansible-jupyterhub

ansible jupyterhub

このロールは、zero-to-jupyterhubをインストールします。

現在、Ubuntu 20および18がテストされており、動作しています。 Red Hatシステムでは現在正しく動作していませんが、作業中です。

要件

このロールはDockerとk3sを必要とします。

ロールの変数

  • JH_AUTH_CLASS: githubdummy、または空白に設定できます。空白の場合はPAM認証が使用されます。

  • JH_DUMMY_PASS: ダミークラスに使用するパスワード。設定しないと、ダミー認証を使用できません。

  • 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: 単一ユーザコンテナとハブの通信を待つタイムアウト設定; デフォルトは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: 設定すると、ハブコンテナのCPU設定; 0m - 1000m

  • JH_RESOURCES_REQUEST_MEMORY: 設定すると、ハブコンテナのメモリ設定; 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: 設定すると、ハブは使用可能になる前にすべてのノードにイメージをプルします。イメージが大きすぎたり、ノードが多すぎる場合は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
ダウンロード
21