jupyterhub-container

Jupyter HubサービスをあなたのAnsible Containerプロジェクトに追加します。サービスをインストールするには、次のコマンドを実行してください。

# 作業ディレクトリをAnsible Containerプロジェクトのルートに設定
$ cd myproject

# サービスをインストール
$ ansible-container install marcusianlevine.jupyterhub-container

必要条件

• Ansible Container
• 既存のAnsible Containerプロジェクト。プロジェクトを作成するには、次のコマンドを実行してください：

  # 空のプロジェクトディレクトリを作成
  $ mkdir myproject
  
  # 作業ディレクトリを新しいディレクトリに設定
  $ cd myproject
  
  # プロジェクトを初期化
  $ ansible-container init
  

役割変数

• vars_files
  • 追加の変数YAMLファイルのパスのオプションリスト（/srcに対する相対パス）
• extra_pip_packages: [dockerspawner]
  • JupyterHubと一緒にインストールする追加のpipパッケージのリスト

ファイルとディレクトリ

• jupyterhub_config_dir: /etc/jupyterhub/
  • JupyterHubの設定ファイルが置かれるディレクトリの絶対パス
• jupyterhub_config_path: "{{ jupyterhub_config_dir }}/jupyterhub_config.py"
  • JupyterHubの設定ファイルの絶対パス
• jupyterhub_srv_dir: /srv/jupyterhub
• jupyterhub_pip_version: 0.8.1
• jupyter_config_dir: /etc/jupyter
  • Jupyterノートブック設定ファイルが置かれるディレクトリの絶対パス
• jupyter_share_dir: /usr/local/share/jupyter
• jupyter_templates_dir: "{{ jupyter_config_dir }}/templates"
• ipython_config_dir: /etc/ipython

スポーナー設定

• use_helm: no
  • Zero-to-JupyterHub Helm Chart経由でkubespawnerをターゲット
• allow_sudo: no
  • sudo権限を持つシングルユーザーノートブックを生成
  • 警告：このオプションをコンテナ化されたスポーナーで使用するとセキュリティリスクがあります
• mem_limit: yes
  • デフォルトでは制限なし。10Gなどの有効なDockerまたはKubernetesのmem_limitを設定

ユーザー認証

• use_oauth: no
  • GitHub OAuthを使ってユーザー認証を行う
• use_ldap: no
  • ldapauthenticatorを使ってユーザー認証を行う
  • 以下の設定の詳細についてはドキュメントを参照
• ldap_domain
• ldap_bind_dn_template
• ldap_allowed_group
• ldap_user_search_base
• ldap_search_user
• ldap_user_attribute
• user_list: []
  • 許可されたユーザーのホワイトリスト
• admin_users: []
  • 管理者権限を与えるユーザーのリスト

Miniconda設定

• miniconda_version
  • インストールする特定のMinicondaのバージョンを指定
• conda_checksum
  • miniconda_versionがデフォルトと異なる場合は必須！
• conda_installer: Miniconda3-{{miniconda_version}}-Linux-x86_64.sh
  • インストーラースクリプトのテンプレート名。非標準アーキテクチャでビルドする場合のみ変更が必要。
• conda_prefix: /opt/conda
  • Minicondaがインストールされるディレクトリの絶対パス
• conda_config
  • 任意のconda設定を指定（例えば、検索するデフォルトのcondaチャネル）
  • 例はvars/main.ymlを参照

依存関係

デフォルトのdockerspawnerをターゲットにする場合、ホストにはDockerがインストールされている必要があります。例えば、mongrelion.dockerロールを使用します。

ライセンス

BSD

作成者情報

CKM AdvisorsのためにMarcus Levineが作成しました。