mm/jupyterhub-deploy-docker
1
0
Fork 0
Code Pull Requests Releases Activity

Merge pull request #3 from willingc/faq-edit

Browse Source 
Edit FAQ
This commit is contained in:
Justin Tyberg 2016-04-19 08:24:12 -04:00
commit d1d5fc4213
1 changed files with 34 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -177,7 +177,11 @@ Note that the Docker stacks `*-notebook` images tagged `2d878db5cbff` include th
docker pull jupyter/scipy-notebook:2d878db5cbff
```
Note: If you choose to use a different container image, you must set the `DOCKER_CONTAINER_IMAGE` environment variable in the `.env` file, or override it in the environment where you launch JupyterHub.
Note: If you choose to use a container image other than
``jupyter/scipy-notebook``, you must change the `DOCKER_CONTAINER_IMAGE` value
of the `.env` file to the desired container image. Alternatively, you can
override the value by setting the `DOCKER_CONTAINER_IMAGE` variable to a
different Notebook image in the environment where you launch JupyterHub.
## Run the JupyterHub container
@ -213,20 +217,33 @@ docker logs jupyterhub
### How do I specify the Notebook server image to spawn for users?
In this deployment, JupyterHub uses DockerSpawner to spawn single-user Notebook servers. The `jupyterhub_config.py` reads the image name from the `DOCKER_CONTAINER_IMAGE` environment variable.
In this deployment, JupyterHub uses DockerSpawner to spawn single-user
Notebook servers. You set the desired Notebook server image in a
`DOCKER_CONTAINER_IMAGE` environment variable.
When spawning single-user notebooks, JupyterHub reads the DockerSpawner's
image name from `jupyterhub_config.py` file. This file includes the
DockerSpawner's image name which refers to desired image in the
`DOCKER_CONTAINER_IMAGE` environment variable:
```
# DockerSpawner setting in jupyterhub_config.py
c.DockerSpawner.container_image = os.environ['DOCKER_CONTAINER_IMAGE']
```
By default, this variable is set in the `.env` file.
By default, the`DOCKER_CONTAINER_IMAGE` environment variable is set in the
`.env` file.
```
# Setting in the .env file
DOCKER_CONTAINER_IMAGE=jupyter/scipy-notebook:2d878db5cbff
```
You can either change this value in the `.env` file, or you can override it by setting the `DOCKER_CONTAINER_IMAGE` variable to a different Notebook image in the environment where you launch JupyterHub.
To use a different notebook server image, you can either change the desired
container image value in the `.env` file, or you can override it
by setting the `DOCKER_CONTAINER_IMAGE` variable to a different Notebook
image in the environment where you launch JupyterHub. For example, the
following setting would be used to spawn single-user pyspark notebook servers:
```
DOCKER_CONTAINER_IMAGE=jupyterhub/pyspark-notebook:2d878db5cbff \
@ -235,9 +252,19 @@ DOCKER_CONTAINER_IMAGE=jupyterhub/pyspark-notebook:2d878db5cbff \
### If I change the name of the Notebook server image to spawn, do I need to restart JupyterHub?
Yes. JupyterHub reads its configuration and sets the name of the Notebook server image to spawn during startup. It you change the name of the Docker image to spawn, then you will need to restart the JupyterHub container.
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.
In this deployment, cookies are persisted to a Docker volume on the host, so restarting JupyterHub might cause a blip in service as the JupyterHub container restarts, but users will not have to login again; however, users may need to refresh their browsers to re-establish connections to active Notebook kernels.
If you change DockerSpawner's name of the Docker image to spawn, you will
need to restart the JupyterHub container for changes to occur.
In this reference deployment, cookies are persisted to a Docker volume on the
Hub's host. Restarting JupyterHub might cause a temporary blip in user
service as the JupyterHub container restarts. Users will not have to login
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?