Simple vscode project for development python and jupyter notebook in docker. This repositry uses Jupyter Docker Stacks.
Install Extensino for Visual Studio Code. Remote - Containers - Visual Studio Marketplace
clone this repository
- Press Ctrl+Shift+p to open Command Palette in Visual Studo Code.
- Exec
Remote-Containers: rebuild and Reopen in Container - wait until docker-compose build and VSCode open work space
新しいモジュールをインストールしたり、ファイル操作やapt-getなどbashを操作したい場合があると思う。その場合はdocker exec -it コンテナID /bin/bashなどすれば、bashを起動できる。またはVS codeでRemote - containerしている場合は新しくターミナルを開けばいい。
jupyter/minimal-notebookやjupyter/scipy-notebookなど Jupyter Docker StacksのシリーズのDockerは立ち上がると同時にデフォルトでstart-notebook.shが走り、各種設定を行う。(GRAT_SUDOの有効化など)。start-notebook.shが必要な設定を行うのでデフォルトコマンドは変更しないほうがいい。
Jupyter Docker Stacksは2022年1月ごろ、デフォルトのサーバーバックエンドをjupyter notebookからjupyter serverに切り替えました。これに伴いデフォルトのエディタがjupyter notebookからjupyter Labに切り替わりました。
バックエンドがjupyter serverのままでも、jupyter notebookは引き続き使えます。loacalhost:8888にアクセスすると、jupyter labに、loacalhost:8888/treeにアクセスすると、従来のjupyter notebookにアクセスします。
しかし、様々な拡張機能があるjupyter_contrib_nbextensionsはjupyter notebookでしか使えず、しかもバックエンドがjupyter serverだと/treeのnotebookからもnbextensionは使えなくなってしまいます。私は選択中の文字を強調するHighlit Selected Wordを使いたいため、jupyter notebook+jupyter_contrib_nbextensionsを使い続けています。いまのところ同じ機能はjupyter labは対応していないようです。
なのでバックエンドをjupyter notebookに切り替える必要があります。
Common Features — Docker Stacks documentationによるとコンテナ内の環境変数DOCKER_STACKS_JUPYTER_CMDをnotebookに設定することで、立ち上がったサーバのバックエンドjupyter notebookに切り替えることができます。なので、docker-compose.yml中で次のように設定しています。
environment:
- DOCKER_STACKS_JUPYTER_CMD=notebookユーザーは管理者であるrootと、jovyanがいる。jupyter notebookを管理者権限で実行するのはセキュリティ的にまずいので、jupyter notebookはjovyanで起動するようになっている。
普通に立ち上げるとユーザーはjovyanになる。権限がないのでapt-get updateやapt-get installはできない。
しかしDockerfile中で
USER rootとrootに切り替えた場合、bashはrootで起動し、apt-getなどが使えるようになる。
この状態で、su jovyanなどとすれば、jovyanに切り替わる。このjovyanでは/opt/conda/bin/のパスが通っていないため、pipコマンドやcondaコマンドが使えない。export PATH=$PATH:/opt/conda/binなどとして、環境変数のPATHに/opt/conda/bin/を加えれば、pipコマンドやcondaコマンドが使えるようになる。
またDockerfile中でrootに切り替え、bashはrootで起動するようにした上で、docker-compose.ymlで、
- GRANT_SUDO=yesとしていれば、jovyanもsudoが使えるようになる。
つまりGRANT_SUDO=yes かつUSER rootならjovyanはsudoを使えるということ
https://jupyter-docker-stacks.readthedocs.io/en/latest/using/recipes.html
参照
conda installやpip installはrootとjovyanどちらのユーザーで実行しても、Pythonのプログラミングには問題ないように思える。
しかし唯一jupyter_contrib_nbextensionsのインストールはjovyanで行ったほうがいい。
rootでconda install -y jupyter_contrib_nbextensionsとしてしまうと、nbextensions関連のファイルがroot権限になってしまい、jupyter起動ユーザーがjovyanなため、jupyter上にnbextensionsのタブが現れても、どのエクステンションを有効にして書き換えても実際は権限の問題で書き換わらずに、F5で更新すると無効になってしまう。
だからjupyter_contrib_nbextensionsのインストールはDockerfile内jovyanユーザーで予めやっておく。
RUN conda install -y jupyter_contrib_nbextensions詳しくは jupyter notebookが使えるdockerにnbextensionsが導入できない
参照