Skip to content

Commit d01f3d6

Browse files
consideRatiomanics
authored andcommitted
docs: add changelog for 2.0.0
Iterative improvements on the changelog 2.0.0 entry Co-authored-by: Simon Li <[email protected]> docs: use sphinx references instead of hardcoded links docs: small changelog updates [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci docs: added descriptions of breaking changes Co-authored-by: Simon Li <[email protected]> [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Port fixes from changelog to new upgrade guide Remove breaking/upgrade guide from changelog, link to new guide Add 2.0.0 notable deps anchor to changelog Co-authored-by: Min RK <[email protected]> [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Include example of args in singleuser.cmd Add description of changes to changelog Co-authored-by: Simon Li <[email protected]> 2.0.0-beta.1, with warnings Update 2.0.0 changelog with more PRs Update 2.0.0 dependencies table Remove some backticks which somehow crept in
1 parent 58d7d67 commit d01f3d6

File tree

2 files changed

+246
-8
lines changed

2 files changed

+246
-8
lines changed

docs/source/administrator/upgrading/upgrade-1-to-2.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Z2JH 2 contains several breaking changes, including some that affect the security of your deployment.
44
This guide will help you upgrade from 1.\* to 2.\*.
55

6+
(upgrade-1-2-security-breaking-change)=
7+
68
## Security: breaking change to `*.networkPolicy.egress`
79

810
NetworkPolicy egress rules have been extended with a new property.
@@ -49,18 +51,24 @@ and the configuration reference entries under
4951

5052
Z2JH 2.0.0 upgrades JupyterHub to the 2.\* series, and also upgrades all hub components.
5153
If you are using any custom JupyterHub services, addons, API integrations, or extra configuration, you should review the breaking changes in the
52-
[JupyterHub 2.0.0 changelog](https://github.com/jupyterhub/jupyterhub/blob/2.3.1/docs/source/changelog.md#200).
54+
[JupyterHub 2.x changelog](https://jupyterhub.readthedocs.io/en/2.3.1/changelog.html).
5355

54-
JupyterHub 2 uses an updated database schema.
55-
Z2JH 2.0.0 automatically handles the upgrade for SQLite databases (the default), but if you use an external database you need to configure [`hub.db.upgrade`](schema_hub.db.upgrade) to true when upgrading. It will not be possible to downgrade to older releases after this without also using a backup or resetting the database.
56+
JupyterHub 2 updates the database schema, which means a migration takes place when you upgrade JupyterHub.
57+
Z2JH automatically handles the upgrade if you are using sqlite (`hub.db.type = 'sqlite-pvc'`, the default), but it may not be possible to downgrade to older releases after this.
58+
When using sqlite, JupyterHub automatically creates a backup in the `hub-db` volume,
59+
which can be restored manually if you need to downgrade.
60+
If you use an external database you need to configure [`hub.db.upgrade`](schema_hub.db.upgrade) to `true` when upgrading.
5661

5762
JupyterHub 2 adds RBAC for managing permissions in JupyterHub.
58-
The old permissions model of admin/non-admin still works but you should use
59-
[RBAC to assign the required privileges to users or services in future](https://jupyterhub.readthedocs.io/en/stable/rbac/index.html)
63+
The old permissions model of admin/non-admin still works, but we recommend using [RBAC to assign only the required privileges to users or services in future](https://jupyterhub.readthedocs.io/en/stable/rbac/index.html).
64+
Default permissions are mostly unchanged, but a few have:
65+
66+
- Servers' own API tokens have limited permissions by default, which can be expanded by defining the `server` role. The previous behavior was the maximum permission of `inherit`.
67+
- `admin_access` as a concept is removed, so disabling it has no effect. In 2.0, admins by definition can do everything, including access servers. To limit user permissions, assign them to roles which have only the needed permissions.
6068

6169
See
62-
`TODO: link to Notable dependencies updated`
63-
in the changelog for more information on other upgraded hub components.
70+
[Notable dependencies updated](notable-dependencies-200)
71+
for more information on other upgraded hub components.
6472

6573
## JupyterLab and Jupyter Server
6674

@@ -69,7 +77,7 @@ To switch back to Jupyter Notebook either configure/rebuild your singleuser imag
6977

7078
## Default to using the container image's command instead of `jupyterhub-singleuser` [#2449](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/2449)
7179

72-
Z2JH now launches the container's default command (equivalent to setting `CMD` in a `Dockerfile`) instead of overriding it.
80+
Z2JH now launches the container's default command (as set e.g. by `CMD` in a `Dockerfile`) instead of overriding it.
7381
This ensures that containers that use a custom start command to configure their environment, such as some
7482
[Jupyter Docker Stacks](https://jupyter-docker-stacks.readthedocs.io/en/latest/)
7583
images, will work without any changes.
@@ -80,6 +88,16 @@ singleuser:
8088
cmd: jupyterhub-singleuser
8189
```
8290

91+
If you want to add custom arguments to the command, you must specify the full command and any arguments in `singleuser.cmd`, for example:
92+
93+
```yaml
94+
singleuser:
95+
cmd:
96+
- jupyterhub-singleuser
97+
- "--collaborative"
98+
- "--debug"
99+
```
100+
83101
## Configuration in `jupyterhub_config.d` has a higher priority than `hub.config` [#2457](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/2457)
84102

85103
Previously if `hub.config` was used to configure some JupyterHub traitlets it would override any custom configuration files mounted into `jupyterhub_config.d` in the hub container.

0 commit comments

Comments
 (0)