Skip to content

Commit

Permalink
Add documentation for breaking change
Browse files Browse the repository at this point in the history
  • Loading branch information
manics committed May 2, 2021
1 parent 0f1a798 commit 4a6eac7
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

Here you can find upgrade changes in between releases and upgrade instructions.

## [UNRELEASED]

#### Breaking changes

- **`singleuser.cmd` does not default to `jupyterhub-singleuser` - [#2138](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/2138)**

Previous versions of Z2JH ignored the command (`CMD`) configured in the singleuser image by default.
This is no longer the case, when a singleuser pod is started the `CMD` from the container image will be used.
If you want to revert to the previous behaviour set `singleuser.cmd=jupyterhub-singleuser`.

This change was made to make it easier to support custom startup scripts such as those used in [`docker-stacks`](https://github.com/jupyter/docker-stacks),
as well as alternatives to jupyter-notebook including [Jupyterlab](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html) and other applications based on [jupyter-server](https://jupyter-server.readthedocs.io/).

## [0.11]

### [0.11.1] - 2021-01-15
Expand Down
13 changes: 13 additions & 0 deletions doc/source/jupyterhub/customizing/user-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,19 @@ If you'd like users to select an environment from **multiple docker images**,
see {ref}`multiple-profiles`.
```

The Docker image will be started with the [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint) and [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd) defined in the image.
You can override `CMD`, by setting `singleuser.cmd`.

```{note}
In versions of Z2JH prior to 1.0.0 the images default was overridden.
To restore this behaviour:
```

```yaml
singleuser:
cmd: jupyterhub-singleuser
```
(jupyterlab-by-default)=
## Use JupyterLab by default
Expand Down
13 changes: 12 additions & 1 deletion jupyterhub/schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1681,7 +1681,18 @@ properties:
type: string
cmd:
type: [array, string, "null"]
description: *kubespawner-native-config-description
description: |
The command and arguments passed to the container.
This is the equivalent of the `CMD` Dockerfile instruction.
If not set the default from the container image will be used.
Note that in versions of Z2JH prior to 1.0.0 this was set to
`jupyterhub-singleuser` instead of using the image's default.
See the [KubeSpawner
documentation](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html)
for more information.
defaultUrl:
type: [string, "null"]
description: *kubespawner-native-config-description
Expand Down

0 comments on commit 4a6eac7

Please sign in to comment.