Merge pull request #121 from mathbunnyru/asalikhov/more_cleanup

Cleanup some code and improve REAMDE

Author: manics

.github/workflows/test.yml

@@ -1,5 +1,5 @@
 # This is a GitHub workflow defining a set of jobs with a set of steps.
-# ref: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
+# ref: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
 #
 name: Tests
 
@@ -15,14 +15,15 @@ jobs:
   # https://github.com/pre-commit/action
   pre-commit:
     name: Lint
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
       - uses: pre-commit/action@v3.0.0
 
   # Run tests
   test:
+    name: Test
     runs-on: ubuntu-22.04
     timeout-minutes: 10
     strategy:
@@ -47,11 +48,9 @@ jobs:
         run: cat ci/config_token.py >> ${{ matrix.example }}/jupyterhub_config.py
 
       - name: Run JupyterHub
-        run: |
-          cd ${{ matrix.example }}
-          docker-compose up -d
+        working-directory: ${{ matrix.example }}
+        run: docker-compose up --detach
 
       - name: Test
-        run: |
-          cd ${{ matrix.example }}
-          pytest -vs
+        working-directory: ${{ matrix.example }}
+        run: pytest --verbose --capture=no

README.md

@@ -1,16 +1,16 @@
 # jupyterhub-deploy-docker
 
 **jupyterhub-deploy-docker** provides a reference
-deployment of [JupyterHub](https://github.com/jupyter/jupyterhub), a
-multi-user [Jupyter Notebook](http://jupyter.org/) environment, on a
+deployment of [JupyterHub](https://github.com/jupyterhub/jupyterhub), a
+multi-user [Jupyter Notebook](https://jupyter.org) environment, on a
 **single host** using [Docker](https://docs.docker.com).
 
 Possible **use cases** include:
 
 - Creating a JupyterHub demo environment that you can spin up relatively
   quickly.
 - Providing a multi-user Jupyter Notebook environment for small classes,
-  teams, or departments.
+  teams or departments.
 
 ## Disclaimer
 
@@ -27,13 +27,13 @@ project.
 
 Key components of this reference deployment are:
 
-- **Host**: Runs the [JupyterHub components](https://jupyterhub.readthedocs.org/en/latest/getting-started.html#overview)
+- **Host**: Runs the [JupyterHub components](https://jupyterhub.readthedocs.io/en/stable/reference/technical-overview.html)
   in a Docker container on the host.
 
 - **Authenticator**: Uses [Native Authenticator](https://github.com/jupyterhub/nativeauthenticator) to authenticate users.
-  Any user will be allowed to sign-up
+  Any user will be allowed to sign up.
 
-- **Spawner**:Uses [DockerSpawner](https://github.com/jupyter/dockerspawner)
+- **Spawner**:Uses [DockerSpawner](https://github.com/jupyterhub/dockerspawner)
   to spawn single-user Jupyter Notebook servers in separate Docker
   containers on the same host.
 
@@ -49,14 +49,14 @@ Key components of this reference deployment are:
 
 This deployment uses Docker, via [Docker Compose](https://docs.docker.com/compose/), for all the things.
 
-1. Use [Docker's installation instructions](https://docs.docker.com/engine/installation/)
+1. Use [Docker's installation instructions](https://docs.docker.com/engine/install/)
    to set up Docker for your environment.
 
 ## Authenticator setup
 
 This deployment uses [JupyterHub Native Authenticator](https://native-authenticator.readthedocs.io/en/latest/) to authenticate users.
 
-1. An single `admin` user will be enabled be default. Any user will be allowed to signup.
+1. An single `admin` user will be enabled by default. Any user will be allowed to sign up.
 
 ## Build the JupyterHub Docker image
 
@@ -79,20 +79,20 @@ To specify which Notebook image to spawn for users, you set the value of the
 Whether you build a custom Notebook image or pull an image from a public or
 private Docker registry, the image must reside on the host.
 
-If the Notebook image does not exist on host, Docker will attempt to pull the
+If the Notebook image does not exist on the host, Docker will attempt to pull the
 image the first time a user attempts to start his or her server. In such cases,
 JupyterHub may timeout if the image being pulled is large, so it is better to
 pull the image to the host before running JupyterHub.
 
 This deployment defaults to the
-[jupyter/minimal-notebook](https://hub.docker.com/r/jupyter/minimal-notebook/)
-Notebook image, which is built from the `minimal-notebook`
+[jupyter/base-notebook](https://hub.docker.com/r/jupyter/base-notebook/)
+Notebook image, which is built from the `base-notebook`
 [Docker stacks](https://github.com/jupyter/docker-stacks).
 
 You can pull the image using the following command:
 
 ```bash
-docker pull jupyter/minimal-notebook:latest
+docker pull jupyter/base-notebook:latest
 ```
 
 ## Run JupyterHub
@@ -142,7 +142,7 @@ c.DockerSpawner.image = os.environ['DOCKER_NOTEBOOK_IMAGE']
 
 ### If I change the name of the Notebook server image to spawn, do I need to restart JupyterHub?
 
-Yes. JupyterHub reads its configuration which includes the container image
+Yes. JupyterHub reads its configuration, which includes the container image
 name for DockerSpawner. JupyterHub uses this configuration to determine the
 Notebook server image to spawn during startup.
 
@@ -156,9 +156,9 @@ again to their individual notebook servers. However, users may need to
 refresh their browser to re-establish connections to the running Notebook
 kernels.
 
-### How can I backup a user's notebook directory?
+### How can I back up a user's notebook directory?
 
-There are multiple ways to [backup and restore](https://docs.docker.com/engine/userguide/containers/dockervolumes/#backup-restore-or-migrate-data-volumes) data in Docker containers.
+There are multiple ways to [Back up and restore data](https://docs.docker.com/desktop/backup-and-restore/) in Docker containers.
 
 Suppose you have the following running containers:
 
@@ -178,7 +178,7 @@ In this deployment, the user's notebook directories (`/home/jovyan/work`) are ba
     [{jtyberg /var/lib/docker/volumes/jtyberg/_data /home/jovyan/work local rw true rprivate}]
 ```
 
-We can backup the user's notebook directory by running a separate container that mounts the user's volume and creates a tarball of the directory.
+We can back up the user's notebook directory by running a separate container that mounts the user's volume and creates a tarball of the directory.
 
 ```bash
 docker run --rm \

basic-example/Dockerfile.jupyterhub

@@ -4,9 +4,9 @@ ARG JUPYTERHUB_VERSION
 FROM jupyterhub/jupyterhub:$JUPYTERHUB_VERSION
 
 # Install dockerspawner, nativeauthenticator
+# hadolint ignore=DL3013
 RUN python3 -m pip install --no-cache-dir \
-        dockerspawner==12.* \
-        jupyterhub-nativeauthenticator==1.*
+    dockerspawner \
+    jupyterhub-nativeauthenticator
 
-COPY ./jupyterhub_config.py /srv/jupyterhub/jupyterhub_config.py
 CMD ["jupyterhub", "-f", "/srv/jupyterhub/jupyterhub_config.py"]

basic-example/docker-compose.yml

@@ -32,13 +32,11 @@ services:
       # All containers will join this network
       DOCKER_NETWORK_NAME: jupyterhub-network
       # JupyterHub will spawn this Notebook image for users
-      DOCKER_NOTEBOOK_IMAGE: jupyter/minimal-notebook:latest
+      DOCKER_NOTEBOOK_IMAGE: jupyter/base-notebook:latest
       # Notebook directory inside user image
       DOCKER_NOTEBOOK_DIR: /home/jovyan/work
       # Using this run command
       DOCKER_SPAWN_CMD: start-singleuser.sh
-    command: >
-      jupyterhub -f /srv/jupyterhub/jupyterhub_config.py
 
 volumes:
   jupyterhub-data:

basic-example/jupyterhub_config.py

@@ -30,10 +30,10 @@
 c.DockerSpawner.network_name = network_name
 
 # Explicitly set notebook directory because we'll be mounting a volume to it.
-# Most jupyter/docker-stacks *-notebook images run the Notebook server as
+# Most `jupyter/docker-stacks` *-notebook images run the Notebook server as
 # user `jovyan`, and set the notebook directory to `/home/jovyan/work`.
 # We follow the same convention.
-notebook_dir = os.environ.get("DOCKER_NOTEBOOK_DIR") or "/home/jovyan/work"
+notebook_dir = os.environ.get("DOCKER_NOTEBOOK_DIR", "/home/jovyan/work")
 c.DockerSpawner.notebook_dir = notebook_dir
 
 # Mount the real user's Docker volume on the host to the notebook user's

ci/check_hub.sh

@@ -13,6 +13,7 @@ while [ $count -lt 60 ]; do
     printf .
     count=$((count+1))
 done
+
 if [ $started -eq 0 ]; then
     echo "*****"
     echo "JupyterHub did not start"