CHANGES.md

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.21+ is required

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

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 2 and JupyterHub 3

The Z2JH dependency has been updated to 2.0.0 which includes JupyterHub 3 #1544. See https://z2jh.jupyter.org/en/stable/administrator/upgrading/upgrade-1-to-2.html for breaking changes.

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.

0.2.0

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

(full changelog)

Enhancements made

• added Authorization header if access_token provided #954 (@kaseyhackspace)
• Add Figshare to UI #951 (@nuest)
• add "sticky builds" functionality #949 (@betatim)
• A small docs update #945 (@nuest)
• Make git_credentials configurable #940 (@chicocvenancio)
• Fix up description of helm chart contents #935 (@betatim)
• adding jupyterlab file paths for preview #925 (@choldgraf)
• Add more loading messages #924 (@betatim)
• adding help text loop to loading page #917 (@choldgraf)
• Add extraArgs to dind #916 (@enolfc)
• Serve pod usage information in /health handler #912 (@betatim)
• Make docker registry check smarter #911 (@betatim)
• disable continuous-image-puller #909 (@bitnik)
• adding social meta tags to binder pages #906 (@choldgraf)
• update documentation for "GitHub API limit" #905 (@bitnik)
• Add a /health endpoint to BinderHub #904 (@betatim)
• Per spec configuration #888 (@choldgraf)
• adding federation page #868 (@choldgraf)
• DinD documentation #838 (@jhamman)

Bugs fixed

• Fix node affinity selector #963 (@betatim)
• Fix node affinity label name #962 (@betatim)
• Check if nbviewer URL would show an error #934 (@betatim)
• Fix docker registry health check #932 (@betatim)
• Fixes and tests for git unresolved ref support #921 (@hugokerstens)

Other merged PRs

• Update repo2docker to 0.10.0 #958 (@enolfc)
• GitLab CE repository was moved to GitLab Foss #956 (@betatim)
• install jupyterhub 1.0.0 in binderhub image #944 (@bitnik)
• Update Z2JH helm chart #936 (@betatim)
• fixing binder social logo design #931 (@choldgraf)
• Try to resolve an image name to determine registry health #929 (@betatim)
• determine chart version with last change in project root #927 (@bitnik)
• Automatically open the log while building a repository #923 (@betatim)
• tweaks to social link #915 (@choldgraf)
• updating social tweaks #913 (@choldgraf)
• tweaks to social images #910 (@choldgraf)
• absolute URL for social image #907 (@choldgraf)
• Bump JupyterHub chart #901 (@chicocvenancio)
• Use git ls-remote to resolve refs for git provider #895 (@hugokerstens)

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

• Fix typo in OVH link #873 (@betatim)
• Add 'origin' field to launch events #872 (@yuvipanda)
• Add OVH BinderHub to list of known deployments #866 (@betatim)
• Tweak loading messages #858 (@betatim)
• fix tolerations in dind daemonset and add tolerations to image-cleaner #857 (@jhamman)
• add user tolerations to dind daemonset #856 (@jhamman)
• add default toleration to build pods #853 (@jhamman)
• Removing note about breaking changes #837 (@choldgraf)
• Add pod anti-affinity rule to build pods #834 (@betatim)
• Stop always pulling the repo2docker image #828 (@betatim)
• No more beta for BinderHub #826 (@betatim)
• bump jupyterhub chart c83896f...03215dd #822 (@minrk)
• Generate coverage while running tests #820 (@betatim)
• use chartpress 0.3 #784 (@minrk)

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

• Docs Improvement | Setup BinderHub #804 (@sgibson91)
• updating instructions and adding badges #791 (@choldgraf)
• docs for private repo access #783 (@minrk)
• adding link to gcloud install #782 (@choldgraf)
• Docs link in building page #781 (@choldgraf)
• Add liveness probe to binderhub helm chart #773 (@betatim)
• document template customization #767 (@bitnik)
• documentation for authentication #707 (@bitnik)

Bugs fixed

• Docs update: Change | symbol in DockerHub config to 'OR' #813 (@sgibson91)
• enable registry to use oauth 2.0 as well. #797 (@shibbas)
• badge typo #792 (@choldgraf)
• Prevent scroll to top on dropdown click #779 (@captainsafia)
• set HubOAuth.hub_host correctly #771 (@bitnik)
• fix for when extra_static_url_prefix is absolute #766 (@bitnik)
• some fixes in documentation #765 (@bitnik)

Other merged PRs

• update gist repoprovider #802 (@bitnik)
• Use different command name in Windows setup #801 (@captainsafia)
• bump default repo2docker to 0.8 #796 (@minrk)
• bump dind image to 18.09.2 #795 (@minrk)
• relax default liveness probe to 10s #790 (@minrk)
• Add badges to README #780 (@consideRatio)
• Move badge and path functions out of megafile #778 (@captainsafia)
• Move Image class to separate file #776 (@captainsafia)
• add base_url into livenessProbe.httpGet.path #775 (@bitnik)
• Update authentication tests #770 (@bitnik)
• upgrade pip, setuptools, requirements on travis; switch to pytest-asyncio #768 (@minrk)

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