Changes in KubeSpawner


[0.14.0] - 2020-10-05

Enhancements made

  • Allow image_pull_secrets config to be specified the k8s native way #442 (@consideRatio)

Bugs fixed

Maintenance and upkeep improvements


[0.13.0] - 2020-09-XX

Noteworthy for this release are: performance improvements, Kubernetes native environment variable specification, the possibility to run multiple JupyterHub’s in the same namespace.

Breaking changes

The following changes probably won’t break typical usage of KubeSpawner, but could for example break logic to customized the progress page JupyerHub displays while spawning a Kubernetes pod for the user.

  • The Kubernetes EventsReflector, which is providing the KubeSpawner instances with information about Kubernetes Events describing events for other resources, is now exposing events as python dictionaries rather than V1Event objects. V1Event is defined in the kubernetes-client/python library as a representation of a Kubernetes Event.
  • KubeSpawner’s .progress method implementation ( which is generating a formatted message as well as a KubeSpawner specific raw_event entry now returns the raw_event as a Python dictionary with entries formatted in camelCase where the keys were formatted in snake_case.


  • Support EnvVar’s with ‘valueFrom’ as well as with ‘value’ #426 (@consideRatio)
  • Breaking change / performance: don’t make kubernetes-client deserialize k8s events into objects #424 (@rmoe)
  • Add component_label property to support multiple hub instances in the… #418 (@harsimranmaan)


  • Breaking change / performance: don’t make kubernetes-client deserialize k8s events into objects #424 (@rmoe)


  • Log thread pool worker count on init #420 (@mriedem)
  • CI: test k8s 1.18 and require success, publish without test, bump minikube #417 (@consideRatio)

Contributors to this release

@abinet | @chancez | @consideRatio | @harsimranmaan | @meeseeksmachine | @mriedem | @rmoe | @shenghu | @welcome | @yuvipanda | @zlanyi

This list of contributors were generated by github-activity according to these criteria.


[0.12.0] - 2020-07-17


  • 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)




[0.11.1] - 2019-11-29

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


  • Fix spawn progress events now showing up due to failure to serialize #381 (@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.




  • 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)



[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] 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