Toggle navigation

.md .pdf

Contents

Changelog

Unreleased

2024.1.0

(full changelog)

Breaking Changes

• Drop support for k8s 1.24, test against 1.29 #794 (@consideRatio)

Bugs fixed

• Update dask-gateway-server’s setuptools for Python 3.12+ #778 (@consideRatio)

• Make dependency on async-timeout explicit and conditional to python 3.10 and older #772 (@consideRatio)

• No longer explicitly set imagePullPolicy to IfNotPresent by default #770 (@consideRatio, @TomAugspurger)

• k8s controller: round to worker cores to three digits, not one #766 (@consideRatio, @TomAugspurger)

Maintenance and upkeep improvements

• Fix docs build by pinning indirect dependencies #799 (@consideRatio)

• Drop support for k8s 1.24, test against 1.29 #794 (@consideRatio)

• Update traefik from 2.10.4 to 2.10.6 #773,#792 (@consideRatio)

• Reduce log level of k8s controller’s reconciling loop’s messages #771 (@consideRatio, @TomAugspurger)

Documentation improvements

• Fix list not displayed as such in install-kube.rst #795 (@Ph0tonic, @consideRatio)

• Fix command applying CRDs from bad release in changelog #748 (@brews, @consideRatio)

Continuous integration improvements

• ci: second iteration to fix artifact upload/download #791 (@consideRatio)

• ci: make upload/download artifact compatible with new action version #790 (@consideRatio)

• ci: add test for python 3.12 #776 (@consideRatio)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@brews (activity) | @consideRatio (activity) | @dask-bot (activity) | @jacobtomlinson (activity) | @JColl88 (activity) | @Ph0tonic (activity) | @sebastian-luna-valero (activity) | @TomAugspurger (activity) | @udeet27 (activity)

2023.9.0

(full changelog)

Breaking changes

• The Python packages dask-gateway and dask-gateway-server now require Python 3.9+, and dask-gateway-server now requires sqlalchemy 2.

• The Helm chart now requires k8s 1.24+, and the bundled CRDs for Traefik has been updated. To upgrade to 2023.9.0, first upgrade the registered CRDs like below:

  kubectl apply --server-side --force-conflicts -f https://raw.githubusercontent.com/dask/dask-gateway/2023.9.0/resources/helm/dask-gateway/crds/daskclusters.yaml
  kubectl apply --server-side --force-conflicts -f https://raw.githubusercontent.com/dask/dask-gateway/2023.9.0/resources/helm/dask-gateway/crds/traefik.yaml
  

New features added

• Adding envs key Helm values to gateway resources #688 (@JoeJasinski, @consideRatio)

Bugs fixed

• client: fix double display of Options in jupyter #677 (@Kirill888, @consideRatio)

Maintenance and upkeep improvements

• Require py39, k8s 1.24, use golang 1.21, update traefik from v2.9 to v2.10 #739 (@consideRatio)

• Relocate coverage config to pyproject.toml #742 (@consideRatio)

• Pin setuptools to v63 and fix failing tests #741 (@consideRatio)

• maint: monthly depedabot updates of github actions #700 (@consideRatio)

• Support and require sqlalchemy 2.0 #685 (@TomAugspurger, @consideRatio)

Documentation improvements

• Link to central deploying Dask page #690 (@scharlottej13, @jacobtomlinson, @consideRatio)

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review. See our definition of contributors.

(GitHub contributors page for this release)

@consideRatio (activity) | @dask-bot (activity) | @jacobtomlinson (activity) | @JColl88 (activity) | @JoeJasinski (activity) | @Kirill888 (activity) | @klucar (activity) | @scharlottej13 (activity) | @TomAugspurger (activity)

2023.1.1

(full changelog)

Bugs fixed

• client: fix failure to display widget with ipywidgets 8 #672 (@Kirill888)

Maintenance and upkeep improvements

• Update RELEASE.md to use tbump #673 (@consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@consideRatio | @Kirill888

2023.1.0

(full changelog)

Highlights

• The dask-gateway-server in the Helm chart is now run with Python 3.11.

• Full compatibility with Python 3.11, where dask-gateway-server previously didn’t have it but the dask-gateway client had it.

New features added

• Add support for Python 3.11 #659 (@consideRatio)

Maintenance and upkeep improvements

• Use and fix support for Python 3.11 in Helm chart images #666 (@consideRatio)

• maint: increase test’s wait duration for shutdown of worker processes for distributed>=2022.11.0 #652 (@consideRatio)

• maint: increase test’s wait duration for shutdown of worker processes for distributed>=2022.11.0, for slurm #660 (@consideRatio)

Continuous integration improvements

• ci: test against python 3.11 (tests are failing) #656 (@consideRatio)

• ci: pre-commit.ci to update hooks monthly instead of weekly #655 (@consideRatio)

• ci: help hadoop/pbs tests become robuster by awaiting startup #647 (@consideRatio)

Other merged PRs

• Refreeze dask-gateway/Dockerfile.requirements.txt #669 (@dask-bot)

• Refreeze dask-gateway/Dockerfile.requirements.txt #668 (@dask-bot)

• Refreeze dask-gateway-server/Dockerfile.requirements.txt #667 (@dask-bot)

• Refreeze dask-gateway-server/Dockerfile.requirements.txt #663 (@dask-bot)

• Refreeze dask-gateway/Dockerfile.requirements.txt #664 (@dask-bot)

Contributors to this release

(GitHub contributors page for this release)

@consideRatio | @fjetter | @holzman

2022.11.0

(full changelog)

Breaking changes

This breaking change only impacts Helm chart installations. The Bundled CRDs for Traefik has been updated. To upgrade to 2022.11.0, also upgrade the registered CRDs like below.

kubectl apply --server-side --force-conflicts -f https://raw.githubusercontent.com/dask/dask-gateway/2022.11.0/resources/helm/dask-gateway/crds/daskclusters.yaml
kubectl apply --server-side --force-conflicts -f https://raw.githubusercontent.com/dask/dask-gateway/2022.11.0/resources/helm/dask-gateway/crds/traefik.yaml

Bugs fixed

• Fix invalid wheel name to PEP 600 #635 (@consideRatio)

• Fix failure to build and publish arm64 images #634 (@consideRatio)

Maintenance and upkeep improvements

• helm chart: update traefik to 2.9.4 (associated CRDs unchanged) #636 (@consideRatio)

• Extend integration tests to multi-namespace deployment #627 (@holzman)

• helm chart: update traefik to 2.9.1 and the associated CRDs #621 (@consideRatio)

Continuous integration improvements

• ci: use ubuntu-22.04 explicitly and constrain test duration #644 (@consideRatio)

• ci: test against golang 1.19, latest slurm, latest hadoop #637 (@consideRatio)

• ci: test against latest versions of k8s #620 (@consideRatio)

Other merged PRs

• Refreeze dask-gateway/Dockerfile.requirements.txt #644 (@dask-bot)

• Refreeze dask-gateway/Dockerfile.requirements.txt #640 (@dask-bot)

• Refreeze dask-gateway-server/Dockerfile.requirements.txt #639 (@dask-bot)

• Refreeze dask-gateway-server/Dockerfile.requirements.txt #631 (@dask-bot)

• Refreeze dask-gateway/Dockerfile.requirements.txt #630 (@dask-bot)

• [pre-commit.ci] pre-commit autoupdate #628 (@pre-commit-ci)

• [pre-commit.ci] pre-commit autoupdate #625 (@pre-commit-ci)

• build(deps): bump JamesIves/github-pages-deploy-action from 4.4.0 to 4.4.1 #623 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@consideRatio | @holzman | @martindurant

2022.10.0

This release includes no breaking changes.

(full changelog)

New features added

• Simplified integration with namespace local JupyterHub Helm charts #612 (@consideRatio)

• Helm chart: add gateway.backend.imagePullSecrets #606 (@maxime1907, @consideRatio)

Bugs fixed

• Fix typo in SLURM backend. #603 (@amanning9, @jcrist)

• Add public address to GatewayCluster when connecting to an existing cluster #601 (@giffels, @consideRatio)

• fix: add missing fields nameOverride and fullnameOverride #593 (@maxime1907, @consideRatio)

• Await close_rpc() in client #588 (@patrix58, @consideRatio)

Maintenance and upkeep improvements

• Refreeze dask-gateway-server/Dockerfile.requirements.txt #617 (@dask-bot)

• Refreeze dask-gateway/Dockerfile.requirements.txt #616 (@dask-bot)

• refactor: use traefik documented syntax for cli flags #611 (@consideRatio, @martindurant)

• Compatibility fix for ipywidgets 8+ #609 (@viniciusdc, @consideRatio)

Documentation improvements

• Reorder gateway config and update comment about gateway.nodeSelector #590 (@GeorgianaElena, @consideRatio)

Continuous integration improvements

• build(deps): bump pypa/gh-action-pypi-publish from 1.5.0 to 1.5.1 #602 (@dependabot, @consideRatio)

• build(deps): bump docker/setup-qemu-action from 1 to 2 #600 (@dependabot, @consideRatio)

• build(deps): bump actions/setup-python from 3 to 4 #599 (@dependabot, @consideRatio)

• build(deps): bump JamesIves/github-pages-deploy-action from 4.2.5 to 4.4.0 #598 (@dependabot, @consideRatio)

• build(deps): bump jupyterhub/action-k3s-helm from 2 to 3 #597 (@dependabot, @consideRatio)

• build(deps): bump docker/setup-buildx-action from 1 to 2 #596 (@dependabot, @consideRatio)

• ci: fix broken dependabot config #595 (@consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@amanning9 | @consideRatio | @dependabot | @GeorgianaElena | @giffels | @jcrist | @martindurant | @maxime1907 | @patrix58 | @pre-commit-ci | @viniciusdc

2022.6.1

Bugs fixed

• Update dask-gateway package’s requirements to what works #580 (@consideRatio)

Continuous integration improvements

• ci: avoid 429 too-many-requests issues from linkcheck #578 (@consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@consideRatio | @martindurant

2022.6.0

This release makes dask-gateway the client require dask>=2022, distributed>=2022, and click>=8.1.3, but includes no other breaking changes.

New features added

• Provide frozen requirements.txt files for images, and automation to update them #575 (@consideRatio)

Bugs fixed

• Fix compatibility with distributed >= 2022.5.1 and traitlets >= 5.2.0, and raise the lower bound of required versions #573 (@consideRatio)

• Let Traefik’s route traffic across namespaces via IngressRoute resources #569 (@olivier-lacroix)

Maintenance and upkeep improvements

• Install bokeh and numpy in the Helm chart’s scheduler and worker sample image #561 (@zonca)

• golang: refresh dask-gateway-proxy using modules and package directories #559 (@rigzba21)

• maint: unpin click again as issues seems resolved #558 (@consideRatio)

Documentation improvements

• Update Dask logo #572 (@jacobtomlinson)

• Update docs theme for rebranding #567 (@scharlottej13)

• Document setting display: False in hub services config #564 (@yuvipanda)

• docs: remove outdated comment about dev-environment.yaml #557 (@consideRatio)

Contributors to this release

(GitHub contributors page for this release)

@consideRatio | @jacobtomlinson | @jcrist | @martindurant | @menendes | @olivier-lacroix | @rigzba21 | @scharlottej13 | @TomAugspurger | @yuvipanda | @zonca

2022.4.0

This release is the first in a long time, and with it comes significant improvements in documentation and automation to make it easier to cut releases going onwards.

The project now adopts CalVer versioning with a YYYY.MM.MICRO format similar to other Dask organization projects using the slightly different YYYY.0M.MICRO format with a leading zero on the month.

Breaking changes

• dask-gateway and dask-gateway-server now requires Python 3.8+

• Breaking changes to the dask-gateway Helm chart:

  • ACTION REQUIRED: When upgrading to this version you must also update the Helm chart’s bundled CRD resources like this:

    kubectl apply -f https://raw.githubusercontent.com/dask/dask-gateway/2022.4.0/resources/helm/dask-gateway/crds/daskclusters.yaml
    kubectl apply -f https://raw.githubusercontent.com/dask/dask-gateway/2022.4.0/resources/helm/dask-gateway/crds/traefik.yaml
    

  • Now published to the Helm chart repository https://helm.dask.org.

  • Now require k8s 1.20+ and helm 3.5+.

  • Now bundles with a values.schema.json file that won’t tolerate most unrecognized configuration to help users avoid typos in their configs.

  • Now pushes the Helm chart’s images to ghcr.io/dask/dask-gateway-server and ghcr.io/dask/dask-gateway.

  • Now declares the purpose of ghcr.io/dask/dask-gateway to be a truly minimal image for Helm chart testing purposes and encourages users to maintain their own image for worker and scheduler pods. See the related documentation on using your own image.

New features added

• ci, maint: build/publish to PyPI, build linux/mac and amd64/arm64 wheels #538 (@consideRatio)

• Helm chart: add values.schema.yaml and associated maint. scripts #429 (@consideRatio)

• Add customizable worker_threads #353 (@AndreaGiardini)

Enhancements made

• Helm chart: add imagePullSecrets for traefik #445 (@consideRatio)

Bugs fixed

• Fix failure to start api/controller pods with tini as an entrypoint #540 (@consideRatio)

• Fixed worker_threads config #463 (@TomAugspurger)

• Avoid warning in Gateway.del #442 (@TomAugspurger)

• Fix for authenticating with JupyterHub service #410 (@aktech)

• helm chart: Add label to be allowed direct network access to the jupyterhub pod #352 (@consideRatio)

Maintenance and upkeep improvements

• Update traefik’s CRDs #554 (@consideRatio)

• Update dev-environment.yaml and remove test_helm.py #550 (@consideRatio)

• maint, docs: add myst-parser for occational markdown files and sphinx_copybutton #548 (@consideRatio)

• Disable arm64 for dask/dask-gateway image #545 (@consideRatio)

• Reference distributed’s actual TimeoutError used #534 (@consideRatio)

• Helm chart images: conda removed -> pip only, usage disclaimer added, minimized Dockerfile complexity #533 (@consideRatio)

• pre-commit: start using isort #532 (@consideRatio)

• Drop support for Python 3.7 #531 (@consideRatio)

• maint: avoid regression/breaking change in click and declare our dependency to the library explicitly #525 (@consideRatio)

• Cleanup no longer needed workarounds for Python 3.6 #510 (@consideRatio)

• ci, pre-commit: add whitespace fixing autoformatters #507 (@consideRatio)

• maint/ci: remove support for Python 3.6 and test against multiple versions of Python and Golang #501 (@consideRatio)

• Add boilerplate .gitignore from GitHub #499 (@consideRatio)

• Adding conda environment file for development dependencies #488 (@rigzba21)

• Helm chart: update traefik CRDs and Traefik version from 2.5 to 2.6 #479 (@consideRatio)

• Bump dask and distributed to 2022.02.0 #474 (@consideRatio)

• Bump base images #468 (@jcrist)

• Update docker images #464 (@TomAugspurger)

• Use new Dask docs theme #448 (@jacobtomlinson)

• Fix/update pre commit config #443 (@TomAugspurger)

• Register a kubernetes pytest mark #441 (@TomAugspurger)

• Helm chart: update to traefik v2.5.x #431 (@consideRatio)

• helm chart: refactor to use consistent modern syntax #425 (@consideRatio)

• helm chart: don’t package a README.rst file #424 (@consideRatio)

• images: some refactoring and version bumps for arm64 compatible Dockerfiles #423 (@consideRatio)

• Helm chart: update deprecated k8s resources no longer supported in k8s 1.22 #420 (@consideRatio)

• Use format_bytes from dask instead of distributed #416 (@TomAugspurger)

• Fix travis main tests #411 (@aktech)

• Change default branch from master to main #372 (@jsignell)

Documentation improvements

• docs: revert adding copybutton, doesn’t work well with dask theme #556 (@consideRatio)

• Add RELEASE.md #549 (@consideRatio)

• Document skaffold.yaml and update image references #513 (@consideRatio)

• Remove legacy purge flag from k8s uninstall docs #502 (@brews)

• ci/docs: updates related to building and testing documentation #500 (@consideRatio)

• Added release notes #467 (@TomAugspurger)

• point readme test & docs badges to destinations #460 (@delgadom)

• adding kubernetes networking notes from #360 #454 (@rigzba21)

• DOC: rm extra https #447 (@raybellwaves)

• Helm chart: add note about dummy schema #444 (@consideRatio)

• Update references from old to new Helm chart registry #438 (@consideRatio)

• Cleanup outdated travis references #426 (@consideRatio)

• Add GitHub Actions badges in README.md #415 (@aktech)

• Add warning about Go version to server installation instructions. #399 (@douglasdavis)

• added a missing comma in the profile options code chunk example #396 (@cdibble)

• Fixes broken link to z2jh helm setup instructions #374 (@arokem)

Other merged PRs

• ci: align with PEP600 about wheel platform names #555 (@consideRatio)

• ci: refactor three job definitions into one run three times #552 (@consideRatio)

• ci: add helm chart upgrade test #551 (@consideRatio)

• ci: avoid running tests in fork’s PR branches #541 (@consideRatio)

• ci: fix pbs image and tests, reduce threads and delay pip install to avoid memory peak causing process termination #536 (@consideRatio)

• ci: fix intermittent errors by sleeping a bit before running tests #530 (@consideRatio)

• [pre-commit.ci] pre-commit autoupdate #527 (@pre-commit-ci)

• [pre-commit.ci] pre-commit autoupdate #521 (@pre-commit-ci)

• ci: de-duplicate deps by docs/requirements.txt and tests/requirements.txt and update CI images #519 (@consideRatio)

• ci: use k3s instead of k3d to setup k8s, and test against k8s 1.20-1.23 #518 (@consideRatio)

• ci: add fixme notes, update python/go versions, make a script executable like others #517 (@consideRatio)

• ci: use chartpress to build/test/publish images and Helm chart #514 (@consideRatio)

• ci: add timeout to avoid 6h consequence of intermittent hang issue #512 (@consideRatio)

• ci, pre-commit: add python style modernizing autoformatter #508 (@consideRatio)

• ci: run go native tests against modern versions of go #505 (@consideRatio)

• ci: update black config for python 3.7-3.10 #503 (@consideRatio)

• ci: let flake8 be configured in a single place instead of three #497 (@consideRatio)

• ci: fix docs workflow triggers, update misc action versions, unpin some dependencies #495 (@consideRatio)

• ci: build/push python packages workflow, added #494 (@consideRatio)

• ci: build/push images workflow, added #493 (@consideRatio)

• ci: misc updates to test workflow and pytest-asyncio #492 (@consideRatio)

• ci: delete no longer used script before_install.sh (travis legacy) #491 (@consideRatio)

• ci: add dependabot config #490 (@consideRatio)

• ci: remove no longer used (?) github repo deploy key (to push to gh-pages branch?) #485 (@consideRatio)

• [pre-commit.ci] pre-commit autoupdate #481 (@pre-commit-ci)

• ci: fix ci failure, optimize workflow triggers, document use of pre-commit.ci #477 (@consideRatio)

• ci: add –color=yes to pytest as needed in github actions #430 (@consideRatio)

• ci: fix Kubernetes CI Tests #413 (@aktech)

• ci: move CI to GitHub Actions #408 (@aktech)

• ci: test GitHub Actions for auto-release #339 (@fanshi118)

Contributors to this release

(GitHub contributors page for this release)

@aktech | @AndreaGiardini | @aravindrp | @arokem | @bolliger32 | @brews | @cdibble | @choldgraf | @consideRatio | @cslovell | @delgadom | @dgerlanc | @dhirschfeld | @douglasdavis | @droctothorpe | @erl987 | @fanshi118 | @Id2ndR | @jacobtomlinson | @JColl88 | @jcrist | @jrbourbeau | @jsignell | @martindurant | @menendes | @mmccarty | @mukhery | @pre-commit-ci | @quasiben | @raybellwaves | @rigzba21 | @rileyhun | @rsignell-usgs | @TomAugspurger | @wdhowe | @yuvipanda

previous

Development