Changes in KubeSpawner

[0.12]

[0.12.0] - 2020-07-XX

Security

• Security fix: CVE-2020-15110 / GHSA-v7m9-9497-p9gr. When named-servers are enabled, certain username patterns, depending on authenticator, could allow collisions. The default named-server template is changed to prevent collisions, meaning that upgrading will lose associations of named-servers with their PVCs if the default templates are used. Data should not be lost (old PVCs will be ignored, not deleted), but will need manual migration to new PVCs prior to deletion of old PVCs.

New features

• Add slugs field for selecting profiles in API, instead of indices. #401 (@stv0g)
• Expose __version__ in kubespawner module #383 (@consideRatio)
• log a warning if unrecognized user_options are provided #389 (@minrk)

Fixes

• Fix ingress compatibility with kubernetes >= 0.10. kubernetes >= 0.10 is now required. #402 (@BertR)
• Fix progress serialization #381 (@consideRatio)
• Typos in storage capacity #384 (@TkTech)
• Typos in profile_list help #411 (@mriedem)

Maintenance

• Fix CI builds #394 (@consideRatio)
• use bump2version and add release documentation #376 (@consideRatio)
• improve development documentation #377 (@consideRatio)
• test with JupyterHub master #380 (@consideRatio)
• update contributing guide #391 (@betatim)

[0.11]

[0.11.1] - 2019-11-29

0.11.1 consists of a small bugfix that made the progress reporting break.

Fixes

• Fix spawn progress events now showing up due to failure to serialize #381 (@consideRatio)

Maintenance

• Don’t require deploy job to also run tests #379 (@consideRatio)

[0.11.0] - 2019-11-28

0.11.0 features minor feature additions, compatebility measures, and fixes. KubeSpawner now require Python 3.5 and is no longer actively tested against Kubernetes clusters versioned 1.10 as before, but is now being tested against version 1.12-1.16 with the python kubernetes client library version 8-11 that is compatible with k8s 1.11-1.15.

New

• Add KubeSpawner.storage_selector for matching persistent volume using storage selector. #338 (@GrahamDumpleton)
• Provide raw_event in spawner progress #361 (@clkao)
• Add {username} expansion to extra_pod_config #321 (@cgiraldo)
• Configurable delete_grace_period #310 (@arturozv)

Fixes

• Scope security context to container from pod where it is possible #334 (@shoelsch)
• Permit storage class to be empty string. #337 (@GrahamDumpleton)
• Fix pod name prefix escaping for named servers #309 (@dmarth)
• Always load user_options #301 (@minrk)
• using user_options in kubespawner #285 (@hhuuggoo)
• Allow None on UID and GID #286 (@dtaniwaki)

Compatibility

• CI reworked, support modern k8s high resolution timestamps, event monitoring is made more reliable, kubernetes=>8 required, python>=3.6 required, inline docs added #368 (@consideRatio)
• Fix for Kubernetes 1.16 regarding datetime comparison #362 (@consideRatio)
• More idiomatic python syntax #356 (@AnotherCodeArtist)
• Compatibility with kubernetes, jupyterhub prereleases #314 (@minrk)
• compatibility with kubernetes 9.0 #294 (@minrk)
• Pin kubernetes version to 8.0 #292 (@yuvipanda)

Maintenance

• Iteration of local development instructions #377 (@consideRatio)
• Add RELEASE.md and utilize bump2version #376 (@consideRatio)
• Fix docs build #371 (@consideRatio)
• [MRG]: Travis pypi: only use pre for nightly #369 (@manics)
• Add relevant badges to README.md #365 (@consideRatio)
• Update SETUP.md instructions to match current state of JupyterHub #353 (@yuvipanda)
• codecov badge #312 (@choldgraf)
• Update documentation regarding run_as_gid behavior #297 (@kevin-bates)
• build docs with python 3.6 #295 (@minrk)
• making kubespawner docs links more discoverable #287 (@choldgraf)

[0.10]

[0.10.1] 2018-12-11

0.10.1 is a tiny bugfix release, fixing regressions in 0.10.0.

• Fix deprecation of KubeSpawner.hub_connect_ip, which caused errors in 0.10 when the deprecated config was used.

[0.10.1] 2018-12-05

0.10.0 is a small release, with minor changes and fixes.

• Deprecate KubeSpawner.image_spec configuration in favor of standard KubeSpawner.image. image_spec continues to work with deprecation warnings
• Stop pinning an exact kubernetes client version; instead, require kubernetes client >= 7. If desired, pinning should be done in images/installations
• Expand username template variables in extra_containers
• Set pod restart policy to OnFailure, so that notebook servers that terminate themselves cleanly do not restart automatically
• Formally deprecate KubeSpawner.hub_connect_ip and KubeSpawner.hub_connect_ip in favor of JupyterHub.hub_connect_ip, available in jupyterhub >= 0.8

[0.9]

[0.9.0] 2018-09-03

KubeSpawner 0.9.0 is a big release of KubeSpawner.

Change highlights:

• Require Kubernetes >= 1.6
• Require JupyterHub >= 0.8
• Require Python >= 3.5
• Expose lots more Kubernetes options
• Support configuration profiles via :attr:.KubeSpawner.profile_list
• Support Kubernetes events for the progress API in JupyterHub 0.9.
• Update Kubernetes Python client to 6.0 (supporting Kubernetes 1.10 APIs)
• Numerous bugfixes