Skip to content

Latest commit

 

History

History
262 lines (196 loc) · 30.5 KB

CHANGES.md

File metadata and controls

262 lines (196 loc) · 30.5 KB
Raw

Changes in BinderHub

Note: the BinderHub repository does not follow a traditional "semver" release schedule. Updates to this repository are deployed to production at mybinder.org quickly after they are merged (see this blogpost on the henchbot for more information). As such, this changelog is broken up by dates, not versions, and is just to make it easier to track what has changed over time

0.2.0...HEAD

(full changelog)

Breaking changes

binderhub_config.py is mounted at runtime

The binderhub_config.py file is now mounted at runtime instead of being built into the BinderHub image #1165. If you have custom configuration you should add it using the extraConfig Helm chart property.

cors configuration properties have been moved to BinderHub and BinderSpawner

cors chart parameters have been moved into Traitlets configurable properties #1351:

  • cors.allowedOrigin ➡️ config.BinderHub.cors_allow_origin
  • jupyterhub.custom.cors.allowedOrigin ➡️ jupyterhub.hub.config.BinderSpawner.cors_allow_origin

Kubernetes 1.23+ is required

Older versions of Kubernetes are no longer supported #1493 #1609 #1714.

dind.enabled replaced by imageBuilderType: dind

The BinderHub builder has been generalised to support non-docker implementations #1531. If you are using Docker-in-Docker replace:

  • dind.enabled: true ➡️ imageBuilderType: dind

The component: dind pod builder label is changed to component: image-builder #1543

imageCleaner.host.enabled replaced byimageCleaner.enabled

When Docker-in-Docker (dind) is enabled the image cleaner used to be run in Docker-in-Docker and on the host Docker. This is no longer the case, the image cleaner is only run in one place #1588. If you were previously disabling the image cleaner replace:

  • imageCleaner.host.enabled: false ➡️ imageCleaner.enabled: false

binderhub.build.Build class replaced by binderhub.build.KubernetesBuildExecutor

The binderhub.build.Build class is replaced by the Traitlets based binderhub.build.KubernetesBuildExecutor class #1518, #1521.

The following build configuration properties should be set using Traitlets in the BinderHub configuration:

  • c.BinderHub.appendix ➡️ c.BuildExecutor.appendix
  • c.BinderHub.sticky_builds ➡️ c.KubernetesBuildExecutor.sticky_builds
  • c.BinderHub.log_tail_lines ➡️ c.KubernetesBuildExecutor.log_tail_lines
  • c.BinderHub.push_secret ➡️ c.BuildExecutor.push_secret
  • c.BinderHub.build_memory_request ➡️ c.KubernetesBuildExecutor.memory_request
  • c.BinderHub.build_memory_limit ➡️ c.BuildExecutor.memory_limit
  • c.BinderHub.build_docker_host ➡️ c.KubernetesBuildExecutor.docker_host
  • c.BinderHub.build_namespace ➡️ c.KubernetesBuildExecutor.namespace
  • c.BinderHub.build_image ➡️ c.KubernetesBuildExecutor.build_image
  • c.BinderHub.build_node_selector ➡️ c.KubernetesBuildExecutor.node_selector

If you have subclassed binderhub.build.Build you must update your subclass (including __init__() if defined) to inherit from binderhub.build.KubernetesBuildExecutor. The behaviour of the class is otherwise unchanged.

Z2JH 3 and JupyterHub 4

The Z2JH dependency has been updated from 1.2.0 to 3.0.0 which includes JupyterHub 4 #1544 #1714.

See Z2JH's upgrade notes and changelog for breaking changes in the upgrade from 1.2.0 to 2.0.0, and then from 2.0.0 to 3.0.0.

Python versions have been increased

The minimum Python version is 3.8, and the Helm Chart BinderHub image has been upgraded to 3.11 #1610 #1611.

Default image registry changed to Quay.io

We now publish the chart's docker images to both Quay.io and Docker Hub and the chart is from now configured to use the images at Quay.io by default.

The change is to ensure that images can be pulled without a Docker Hub rate limit even if the JupyterHub organization on Docker Hub wouldn't be sponsored by Docker Hub in the future, something we need to apply for each year.

0.2.0

master@{2019-07-01}...master@{2019-10-01}

(full changelog)

Enhancements made

Bugs fixed

Other merged PRs

Contributors for this release (commentors + issue/PR authors)

(GitHub contributors page for this release)

@akhmerov | @bdrian | @betatim | @bitnik | @chicocvenancio | @choldgraf | @consideRatio | @enolfc | @fm75 | @hugokerstens | @ingodahn | @jhamman | @jpivarski | @kaseyhackspace | @koldLight | @lesteve | @manics | @meeseeksmachine | @minrk | @nuest | @pdurbin | @sgibson91 | @stklik | @Xarthisius | @zchef2k

master@{2019-04-01}...master@{2019-07-01}

(full changelog)

Enhancements made

  • adding whitelisted specs #883 (@choldgraf)
  • Add basic news header to the HTML templates #881 (@betatim)
  • Manually list BinderHub dependencies in docs requirements #879 (@betatim)
  • Add instructions for setting up an Azure Container Registry #878 (@sgibson91)
  • document launch schema version 3 #876 (@bitnik)
  • Add Zenodo provider #870 (@betatim)
  • Add extraEnv to the BinderHub deployment #867 (@betatim)
  • Make base badge URL available in the loading screen as well #865 (@betatim)
  • rename variable and restructure API docs #860 (@nuest)
  • Make the URL used to generate launch badges configurable #859 (@betatim)
  • Discuss indentation of configuration files in debugging docs #847 (@sgibson91)
  • Update to Docs: Clarify where in secret.yaml GitHub Personal Access Token should be added #835 (@sgibson91)
  • Write an estimate how long it takes to load #830 (@certik)
  • Update the contributer guide #824 (@betatim)
  • Allow git_credentials to be configurable #823 (@katylava)
  • Add a handler to expose what versions this hub uses #821 (@betatim)
  • Support basic (htpasswd) authentication for registry #818 (@dylex)

Bugs fixed

  • Revert "Update to Docs: Clarify where in secret.yaml GitHub Personal Access Token should be added" #841 (@sgibson91)
  • removing extra docs buttons #829 (@choldgraf)

Other merged PRs

Contributors for this release (commentors + issue/PR authors)

(GitHub contributors page for this release)

@ageorgou | @alexmorley | @arnim | @banesullivan | @betatim | @bitnik | @certik | @choldgraf | @consideRatio | @dylex | @jhamman | @katylava | @kteich-oreilly | @lukasheinrich | @meeseeksmachine | @memeplex | @minrk | @nuest | @sg-s | @sgibson91 | @shibbas | @yuvipanda | @zaembraal

master@{2019-01-01}...master@{2019-04-01}

(full changelog)

Enhancements made

Bugs fixed

Other merged PRs

Contributors for this release (commentors + issue/PR authors)

(GitHub contributors page for this release)

@ageorgou | @alexmorley | @andrewjohnlowe | @banesullivan | @betatim | @bitnik | @captainsafia | @Carreau | @chenyg0911 | @choldgraf | @consideRatio | @drj11 | @fm75 | @ggorman | @jhamman | @jzf2101 | @lesteve | @ltetrel | @meeseeksmachine | @minrk | @mrocklin | @psychemedia | @rgaiacs | @rgbkrk | @sgibson91 | @shibbas | @stklik | @taylorreiter | @williamfgc | @willingc | @yuvipanda