Merge pull request #38 from udzuki/fix-29-jhub-permission-error

fix: JupyterHubの起動失敗(PermissionError: [Errno 13] Permission denied: '/home/jupyter/.local')

Author: savvan0h

README.adoc

@@ -2,7 +2,7 @@
 :lang: ja
 :source-highlighter: rouge
 :author: 国立情報学研究所
-:revdate: 2022年7月27日
+:revdate: 2022年8月17日
 :revnumber: 3.1-SNAPSHOT版
 :doctype: book
 :version-label:
@@ -18,6 +18,13 @@
 :sectnums:
 :imagesdir: images
 :icons: font
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
 
 = ラーニングアナリティクス基盤システム Docker 環境構築手順書
 
@@ -480,6 +487,27 @@ image::jupyterhub/signin.png[align=center, scaledwidth=50%]
 
 image::jupyterhub/notebooks.png[align=center]
 
+[WARNING]
+====
+Linux環境において、マウントしたホームディレクトリ（ `/home/jupyter` ）の所有者が適切に設定されず、権限エラーが発生する場合がある。
+
+----
+PermissionError: [Errno 13] Permission denied: '/home/jupyter/.local'
+----
+
+本問題が生じた場合には、実行ユーザのUID/GIDを以下の環境変数で指定し、コンテナを再起動すること。
+
+.docker-compose.yml
+[source, diff]
+----
+  jupyterhub:
+    ...
+    environment:
+      - LOCAL_UID=<uid> # id -u
+      - LOCAL_GID=<gid> # id -g
+----
+====
+
 <<<
 ==== Learning Lockerからステートメントを取得
 ノートブック「link:jupyterhub/notebooks/get_statements_from_learninglocker.ipynb[get_statements_from_learninglocker]」を活用し、Learning LockerのAPIを使用したステートメント取得が可能であることを確認する。 +

docker-compose.yml

@@ -128,6 +128,9 @@ services:
   jupyterhub:
     build: jupyterhub
     container_name: jupyterhub
+    #environment:
+    #  - LOCAL_UID=9001
+    #  - LOCAL_GID=9001
     ports:
       - "8001:8000"
     volumes:

jupyterhub/Dockerfile

@@ -1,17 +1,15 @@
 # See https://docs.anaconda.com/anaconda/reference/release-notes/#anaconda-2019-10-october-15-2019
 FROM continuumio/anaconda3:2019.10
 
-LABEL version="2.2.0"
+LABEL version="2.2.1"
 
 RUN conda install -y -c conda-forge jupyterhub=0.9.6
 RUN conda install -y -c r r-irkernel=0.8.15  # Install R
 RUN conda install -y psycopg2=2.8.4
-RUN useradd -m -p $(echo "jupyter" | openssl passwd -1 -stdin) -s /bin/bash jupyter
 
-# Copy sample notebooks
-COPY notebooks/*.ipynb /home/jupyter/
-RUN chown jupyter:jupyter /home/jupyter/*.ipynb
+COPY entrypoint.sh /usr/local/bin/entrypoint.sh
+RUN chmod +x /usr/local/bin/entrypoint.sh
 
 EXPOSE 8000
 
-CMD jupyterhub --no-ssl --Spawner.args="['--NotebookApp.iopub_data_rate_limit=1.0e10']"
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]

jupyterhub/entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+USER_ID=${LOCAL_UID:-9001}
+GROUP_ID=${LOCAL_GID:-9001}
+
+useradd -u $USER_ID -o -m -p $(echo "jupyter" | openssl passwd -1 -stdin) -s /bin/bash jupyter
+groupmod -g $GROUP_ID jupyter
+
+jupyterhub --no-ssl --Spawner.args="['--NotebookApp.iopub_data_rate_limit=1.0e10']"