Jupyter Notebook deprecation -> default to JupyterLab #1575

romainx · 2022-01-19T11:23:34Z

Hello,

This PR intends to close #1217.

The idea is to

switch to JupyterLab by default i.e. running the jupyter lab command
permit to run different commands in order to switch back for example to the classic Jupyter Notebook.

Instead of defining a closed option, I think it's more flexible to define a new option JUPYTER_CMD that can be used to launch different jupyter commands.

Command	Backend	Frontend
`lab` (def)	Jupyter Server	JupyterLab
`notebook`	Jupyter Notebook	Jupyter Notebook
`nbclassic`	Jupyter Server	Jupyter Notebook
`server`	Jupyter Server	None?
`retro`*	Jupyter Server	RetroLab

*Not installed at this time, but it could be the case in the future or it could be customized by end users.
Thanks 🙏 @krassowski, your answer on SO helped me a lot to better understand the Jupyter landscape.

For example to switching back to classic notebook backend and frontend.

docker run -it --rm -p 8888:8888 -e JUPYTER_CMD=notebook jupyter/base-notebook
# Executing the command: jupyter notebook

At this time I've not checked if the value is in a list, if not it will be managed by the jupyter command.

docker run -it --rm -p 8888:8888 -e JUPYTER_CMD=foo jupyter/base-notebook
# Jupyter command `jupyter-foo` not found.

Warning and deprecation

I've left a warning that is intended to tell that JUPYTER_ENABLE_LAB is no more used and has no effect.
I'm not sure we have to manage here Jupyter Notebook deprecation since we do not launch it anymore by default.
If the user decides to run it intentionally, it's not necessary to raise a warning it should be done by Jupyter Notebook.

Todo

Decide if we want to use this solution -> 👍
Decide if we want to perform additional control to check if JUPYTER_CMD holds a proper value -> 👎
Decide if we want to keep a deprecation notice about the JUPYTER_ENABLE_LAB flag -> 👍 but it has to be changed
Update or remove the deprecation notice
Update the documentation
Improve test coverage

@mathbunnyru and @consideRatio I would like to have your opinion. Once decided I will take care of the remaining tasks.

Many thanks 😄

Introduce a new `JUPYTER_CMD` option

manics · 2022-01-19T11:47:34Z

It's there any sort of standard variable across the Jupyter ecosystem for defining the Jupyter app/command?

This has kind of come up in JupyterHub before, so it'd be nice if everyone in Jupyter could use a common variable!

romainx · 2022-01-19T11:51:52Z

@manics Agree, however I don't know. I've only seen JUPYTERHUB_SINGLEUSER_APP from here but I don't think it can be reused here. If someone has the answer I will be happy to use it instead.

benz0li · 2022-01-19T11:58:11Z

What about jupyterhub-sigleuser in

docker-stacks/base-notebook/start-singleuser.sh

Line 13 in d805612

. /usr/local/bin/start.sh jupyterhub-singleuser ${NOTEBOOK_ARGS} "$@"

Should this be changed to jupyter-labhub?

romainx · 2022-01-19T12:07:27Z

@benz0li good point! I will have a look 👀.

mathbunnyru

I do like this solution - it's quite clear what's gonna be launched.

One thing to add about this solution - we should probably parametrize more tests based on what we launch, it will make our test suite work in more situations.

base-notebook/test/test_start_container.py

benz0li · 2022-01-19T14:13:39Z

Should this be changed to jupyter-labhub?

Does not seem to be necessary:

JupyterHub < v2.0 (JupyterLab ≥ v3.0)

Opens Jupyter Notebook by default.
ℹ️ Setting c.Spawner.default_url = '/lab' in jupyterhub_config.py will open JupyterLab by default [when using the NotebookApp backend].

--

By default, the single-user notebook server uses the (old) NotebookApp from the notebook package.

— Configuring user environments — JupyterHub 1.4.2 documentation > Switching to Jupyter Server

ℹ️ Setting c.Spawner.environment = { 'JUPYTERHUB_SINGLEUSER_APP': 'jupyter_server.serverapp.ServerApp' } in jupyterhub_config.py will use Jupyter Server’s ServerApp backend.
👉 Setting c.Spawner.default_url = '/lab' or c.Spawner.default_url = '/tree' in jupyterhub_config.py is required.

JupyterHub ≥ v2.0 (JupyterLab ≥ v3.0)

By default the single-user server launches JupyterLab, which is based on Jupyter Server.

— Configuring user environments — JupyterHub 2.0.0 documentation > Switching back to classic notebook

ℹ️ Setting c.Spawner.default_url in jupyterhub_config.py has no effect.

--

The ServerApp is the default backend when running JupyterHub ≥ 2.0.

ℹ️ Setting c.Spawner.environment = { 'JUPYTERHUB_SINGLEUSER_APP': 'notebook.notebookapp.NotebookApp' } in jupyterhub_config.py will use the (old) NotebookApp backend.
👉 Opens Jupyter Notebook by default. Setting c.Spawner.default_url = '/lab' in jupyterhub_config.py will open JupyterLab by default.

romainx · 2022-01-19T17:04:06Z

@benz0li thank you and I confirm about jupyterhub-singleuser vs. jupyter-labhub.

As per the doc the app launched can be controlled through JUPYTERHUB_SINGLEUSER_APP.

Default -> SingleUserLabApp is launched
JUPYTERHUB_SINGLEUSER_APP=notebook.notebookapp.NotebookApp -> SingleUserNotebookApp is launched

Naming of environment variables

One thing that I think is a bit problematic is the naming of our environment variables in general. They aren't named to indicate they influence this project's scripts.

I'm considering if we could try to do something about that to help people find their way to this projects documentation to learn more about the environment variable that they otherwise may not be sure what it does.

Overall I'd love to see that this project would prefix its environment variables, but, we would need to deprecate many old variables if we wanted to do that anyhow.

Example situation

Someone configures their installation of a JupyterHub Helm chart in a k8s cluster to start the servers differently, which works, because they use a jupyter/docker-stacks based image.

singleuser:
  extraEnv:
    JUPYTER_CMD: notebook

After this, someone copies configuration to a situation when they are not using an image derived from a docker-stacks based image, and voila - they are confused what's going on etc.

Naming of environment variables - conclusion

I'm okay with merging this as it is. I wanted though to raise the question on what you think about prefixing the new environment variable with DOCKER_STACKS_ as an initial step towards making our environment variables be prefixed like that in general.

romainx · 2022-01-20T18:35:33Z

@consideRatio thanks a lot 😄! and this is a very good remark.
If @mathbunnyru is OK with that, I think it's better to change it now, it's not a problem for me.
If we stick with this prefix, it's better to do it before releasing a new variable that we will have to deprecate.
So let's go for?

JUPYTER_CMD -> DOCKER_STACKS_JUPYTER_CMD 🤔 not too long?

mathbunnyru

I'm ok with whatever env variable you choose :)

docs/index.rst

romainx · 2022-01-20T22:38:09Z

@mathbunnyru and @consideRatio I think I'm done with this PR 😌.
I've renamed the variable.
I let you merge it!
Thanks for your thoughtful reviews 🙏

I will just update the issue to reflect what has been done and it will be 👌.

mathbunnyru · 2022-01-20T22:48:16Z

Done. Welcome back, @romainx :)

The new jupyter/minimal-notebook image uses lab CMD to run the jupyter server, which was introduced by jupyter/docker-stacks#1575. It provides DOCKER_STACKS_JUPYTER_CMD to set how to run it. The lab (full-stack) is for AiiDAlab only and should start with notebook mode. I pin it as an environment variable to start the jupyter backend. Since we have the new jupyterhub, the `NOTEBOOK_ARGS` can be used to set the notebook arguments.

Default to JupyterLab

1d8d7df

Introduce a new `JUPYTER_CMD` option

romainx marked this pull request as draft January 19, 2022 11:24

romainx requested review from mathbunnyru and consideRatio January 19, 2022 11:24

mathbunnyru reviewed Jan 19, 2022

View reviewed changes

base-notebook/test/test_start_container.py Outdated Show resolved Hide resolved

romainx and others added 2 commits January 19, 2022 18:12

Test improved (review)

de087bb

Fix typing

39ae7d2

mathbunnyru reviewed Jan 19, 2022

View reviewed changes

base-notebook/start-notebook.sh Outdated Show resolved Hide resolved

romainx added 3 commits January 20, 2022 09:12

Fix comand and improve tests

1178c33

Update documentation

554ab11

Merge branch 'fix-1217-1' of https://github.com/romainx/docker-stacks …

7e04937

…into fix-1217-1

romainx marked this pull request as ready for review January 20, 2022 08:42

mathbunnyru reviewed Jan 20, 2022

View reviewed changes

base-notebook/test/test_start_container.py Show resolved Hide resolved

mathbunnyru requested changes Jan 20, 2022

View reviewed changes

docs/using/common.md Outdated Show resolved Hide resolved

mathbunnyru reviewed Jan 20, 2022

View reviewed changes

base-notebook/test/test_start_container.py Show resolved Hide resolved

Fix / improve docs (review)

c6f7d46

mathbunnyru approved these changes Jan 20, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

consideRatio approved these changes Jan 20, 2022

View reviewed changes

Wording in the examples (review)

88d83c9

mathbunnyru requested changes Jan 20, 2022

View reviewed changes

docs/index.rst Show resolved Hide resolved

romainx added 2 commits January 20, 2022 23:23

Align examples in both docs (review)

74bc6b3

JUPYTER_CMD -> DOCKER_STACKS_JUPYTER_CMD (review)

c954633

romainx mentioned this pull request Jan 20, 2022

Jupyter Notebook deprecation #1217

Closed

3 tasks

mathbunnyru merged commit b418b67 into jupyter:master Jan 20, 2022

romainx deleted the fix-1217-1 branch January 21, 2022 05:49

This was referenced Feb 5, 2022

Add documentation for JUPYTER_ENABLE_NB romainx/docker-stacks#3

Closed

Switch the default to Jupyter Server configuration file #1619

Merged

This was referenced Nov 25, 2022

New image from jupyter/minimal-notebook:python-3.9.13 will install jupyterhub > 2 aiidalab/aiidalab-docker-stack#329

Closed

Using notebook CMD to run the jupyter stack aiidalab/aiidalab-docker-stack#331

Merged

unkcpz mentioned this pull request Feb 28, 2023

Compatibility with ServerApp backend oschuett/appmode#65

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jupyter Notebook deprecation -> default to JupyterLab #1575

Jupyter Notebook deprecation -> default to JupyterLab #1575

romainx commented Jan 19, 2022 •

edited

Loading

manics commented Jan 19, 2022

romainx commented Jan 19, 2022 •

edited

Loading

benz0li commented Jan 19, 2022

romainx commented Jan 19, 2022

mathbunnyru left a comment

benz0li commented Jan 19, 2022

romainx commented Jan 19, 2022

mathbunnyru commented Jan 19, 2022

romainx commented Jan 20, 2022 •

edited

Loading

mathbunnyru left a comment

mathbunnyru commented Jan 20, 2022

romainx commented Jan 20, 2022

mathbunnyru left a comment

consideRatio left a comment

romainx commented Jan 20, 2022 •

edited

Loading

mathbunnyru left a comment •

edited

Loading

romainx commented Jan 20, 2022 •

edited

Loading

mathbunnyru commented Jan 20, 2022

Jupyter Notebook deprecation -> default to JupyterLab #1575

Jupyter Notebook deprecation -> default to JupyterLab #1575

Conversation

romainx commented Jan 19, 2022 • edited Loading

Warning and deprecation

Todo

manics commented Jan 19, 2022

romainx commented Jan 19, 2022 • edited Loading

benz0li commented Jan 19, 2022

romainx commented Jan 19, 2022

mathbunnyru left a comment

Choose a reason for hiding this comment

benz0li commented Jan 19, 2022

JupyterHub < v2.0 (JupyterLab ≥ v3.0)

JupyterHub ≥ v2.0 (JupyterLab ≥ v3.0)

romainx commented Jan 19, 2022

mathbunnyru commented Jan 19, 2022

romainx commented Jan 20, 2022 • edited Loading

mathbunnyru left a comment

Choose a reason for hiding this comment

mathbunnyru commented Jan 20, 2022

romainx commented Jan 20, 2022

mathbunnyru left a comment

Choose a reason for hiding this comment

consideRatio left a comment

Choose a reason for hiding this comment

Naming of environment variables

Example situation

Naming of environment variables - conclusion

romainx commented Jan 20, 2022 • edited Loading

mathbunnyru left a comment • edited Loading

Choose a reason for hiding this comment

romainx commented Jan 20, 2022 • edited Loading

mathbunnyru commented Jan 20, 2022

romainx commented Jan 19, 2022 •

edited

Loading

romainx commented Jan 19, 2022 •

edited

Loading

romainx commented Jan 20, 2022 •

edited

Loading

romainx commented Jan 20, 2022 •

edited

Loading

mathbunnyru left a comment •

edited

Loading

romainx commented Jan 20, 2022 •

edited

Loading