jupyterhubあれこれ

2018年04月11日 · 1 min read · Jupyter NoteBook  ·
Share on:

はじめに

jupyterをLDAP認証と組み合わせて複数人で使えるようにしたいなと前から思ってたのをテストしたのでメモ
jupyterを複数人で利用するにはjupyterhubを利用すれば良いらしい
ただjupyterhubはjupyter notebookを複数人で利用できるようにするものでjupyterlabを複数人で利用するにはjupyterlab hubを利用しないといけないらしい
正直ドキュメント読んでも？？？状態になってしまったのでそれぞれ環境を作る

以下の2つの組み合わせでテストしました

  • jupyter notebook + jupyterhub （+ ldapauthenticator）
  • jupyter lab + jupyterhub （+ ldapauthenticator）

環境はUbuntu16.04です
Docker上でイメージ作った際のコマンドを普通の環境用の書き直してるので素直に動かないかもしれないのでその時はrootで作業して下さい…

jupyterhub

環境構築

必要なパッケージをそれぞれ揃えます．

1$ sudo apt-get install -y curl python3 npm nodejs-legacy
2$ curl -kL https://bootstrap.pypa.io/get-pip.py | sudo python3
3$ sudo npm install -g configurable-http-proxy

pipでjupyter notebookとhubをインストールします

1$ sudo pip3 install jupyterhub
2$ sudo pip3 install --upgrade notebook

デフォルトの認証ではシステムにいるユーザーが利用されます
説明用にデモユーザーを作ります

1$ sudo useradd testuser
2$ sudo passwd testuser
3Enter new UNIX password:[適当に入力]
4Retype new UNIX password:[適当に入力]
5$ sudo mkdir /home/testuser
6$ sudo chown testuser /home/testuser

実行

ここまで来たら実行します

1$ sudo jupyterhub --port 8888

上手く行っていればアクセスしてログイン画面が出てくるのでログインして動作チェックします
問題なくnotebookが起動できればおっけーです

詳細設定

次に設定を生成します．

1$ sudo jupyterhub --generate-config
2Writing default config to: jupyterhub_config.py

/root辺りに生成されると思うので

1c.JupyterHub.port = 8888

とかにしてみて再度動作テストします

jupyterlab hub

環境構築

だいたい同じですがnpmの要求が5以上とかになってる関係で新しいnodejs入れたりします

1$ curl -sL https://deb.nodesource.com/setup_9.x | sudo bash
2$ curl -kL https://bootstrap.pypa.io/get-pip.py | sudo python3
3$ sudo apt-get update
4$ sudo apt-get install nodejs
5$ npm install -g configurable-http-proxy

pip3で必要なライブラリを揃えます．

1$ sudo pip3 install jupyterlab jupyterhub
2$ jupyter labextension install @jupyterlab/hub-extension

先程の方法でconfigを生成します

1$ sudo jupyterhub --generate-config
2Writing default config to: jupyterhub_config.py

生成したファイルに以下の設定を追記します

1c.Spawner.default_url = '/lab'

実行

同じように

1$ sudo jupyterlab

してみて同じようにWebからアクセスしてみてテストする
システムにいるユーザーでログインしてjupyterlabが起動すればおっけー

ldapauthenticator

jupyterhubでもjupyterlab hubでも同じ

環境構築

追加で以下をインストール

1$ sudo pip3 jupyterhub-ldapauthenticator

先程生成したconfigファイルに以下を追記する
環境に合わせて適宜変更する

1c.JupyterHub.authenticator_class = "ldapauthenticator.LDAPAuthenticator"
2c.LDAPAuthenticator.server_address = "LDAP認証サーバーのDNSまたはIP"
3c.LDAPAuthenticator.server_port = 389
4c.LDAPAuthenticator.use_ssl = False ※デフォルトがTrueなのでハマります
5c.LDAPAuthenticator.bind_dn_template = "uid={username},ou=people,dc=example,dc=jp"

起動テストして問題なくログインできればおっけーです
ダメな時は立ち上げた時のログを見ると結構詳細に出ててわかります
SSLがデフォで有効だったのでハマったけどすぐ気付けました