Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

changelog for 1.0 #176

Merged
merged 5 commits into from
Mar 17, 2023
Merged

changelog for 1.0 #176

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9921644
changelog for 0.4
minrk Mar 10, 2023
ece1700
improve changelog
minrk Mar 13, 2023
168d247
call it 1.0
minrk Mar 13, 2023
c46a2bb
Merge remote-tracking branch 'origin/main' into rel-v2
minrk Mar 17, 2023
224837c
changelog with latest changes
minrk Mar 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions docs/source/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,78 @@ For detailed changes from the prior release, click on the version number
and its link will bring up a GitHub listing of changes. Use `git log` on
the command line for details.

### 0.4.0 (prerelease)

0.4 is a big release for jupyterhub-traefik-proxy!
It updates support for traefik to version 2.x (current: 2.9.8).
Traefik versions < 2.0 are no longer supported.
If you have custom traefik configuration,
make sure to checkout [traefik's v1 to v2 migration guide](https://doc.traefik.io/traefik/migration/v1-to-v2/),
since your configuration may need updating.

A major consequence of the v2 updates is that the performance of adding and removing routes when there are a large number already defined is now greatly improved,
and no longer grows significantly with the number of routes.

Major changes:

- Traefik v2 is required. Traefik v1 is not supported.
- `TraefikTomlProxy` is deprecated in favor of `TraefikFileProviderProxy`,
which supports both toml and yaml.
Replace `traefik_toml` with `traefik_file` in your configuration.
- `python3 -m jupyterhub_traefik_proxy.install` will now only install traefik, not any key-value-store providers.
You can follow your KV store's own installation instructions.
- `python3 -m jupyterhub_traefik_proxy.install` now supports fetching any published traefik version on any architecture,
instead of a few preset versions.

Performance and responsiveness is also greatly improved.

([full changelog](https://github.com/jupyterhub/traefik-proxy/compare/0.3.0...ec8eadcc7d274911d8e5bdcbed9082c02edd642f))

#### API and Breaking Changes

- remove kv stores from install.py [#156](https://github.com/jupyterhub/traefik-proxy/pull/156) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena), [@consideRatio](https://github.com/consideRatio))
- Traefik v2 support [#145](https://github.com/jupyterhub/traefik-proxy/pull/145) ([@GeorgianaElena](https://github.com/GeorgianaElena), [@minrk](https://github.com/minrk), [@alexleach](https://github.com/alexleach))

#### New features added

- Traefik v2 support [#145](https://github.com/jupyterhub/traefik-proxy/pull/145) ([@GeorgianaElena](https://github.com/GeorgianaElena), [@minrk](https://github.com/minrk), [@alexleach](https://github.com/alexleach))

#### Enhancements made

- Improve performance, scaling [#165](https://github.com/jupyterhub/traefik-proxy/pull/165) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
- Improve error message on traefik api access error [#140](https://github.com/jupyterhub/traefik-proxy/pull/140) ([@twalcari](https://github.com/twalcari), [@minrk](https://github.com/minrk))

#### Bugs fixed

- Fix handling of empty dicts in traefik config [#173](https://github.com/jupyterhub/traefik-proxy/pull/173) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))

#### Maintenance and upkeep improvements

- reuse backends across tests [#174](https://github.com/jupyterhub/traefik-proxy/pull/174) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
- simplify some test fixtures [#169](https://github.com/jupyterhub/traefik-proxy/pull/169) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
- avoid deprecation warning in `--slow-last` sorting [#168](https://github.com/jupyterhub/traefik-proxy/pull/168) ([@minrk](https://github.com/minrk))
- restore proxy tests [#167](https://github.com/jupyterhub/traefik-proxy/pull/167) ([@minrk](https://github.com/minrk), [@manics](https://github.com/manics))
- Minor cleanup of start/stop methods and logging [#166](https://github.com/jupyterhub/traefik-proxy/pull/166) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
- Respect ip address config in urls, don't serve dashboard by default [#162](https://github.com/jupyterhub/traefik-proxy/pull/162) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena), [@consideRatio](https://github.com/consideRatio))
- minor logging tweaks [#161](https://github.com/jupyterhub/traefik-proxy/pull/161) ([@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio))
- Use checksums from traefik releases [#160](https://github.com/jupyterhub/traefik-proxy/pull/160) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
- Add pre-commit config and configure autoformating tools and pytest from pyproject.toml [#157](https://github.com/jupyterhub/traefik-proxy/pull/157) ([@GeorgianaElena](https://github.com/GeorgianaElena), [@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio))
- Deprecations for v2 upgrades [#154](https://github.com/jupyterhub/traefik-proxy/pull/154) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena), [@alexleach](https://github.com/alexleach), [@consideRatio](https://github.com/consideRatio))
- switch etcd3 client for Python 3.11 support [#153](https://github.com/jupyterhub/traefik-proxy/pull/153) ([@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio))
- Support External Traefik Certificate Resolver and update grpc [#152](https://github.com/jupyterhub/traefik-proxy/pull/152) ([@alexleach](https://github.com/alexleach), [@minrk](https://github.com/minrk))
- improve test time [#150](https://github.com/jupyterhub/traefik-proxy/pull/150) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
- Get the repo back running [#144](https://github.com/jupyterhub/traefik-proxy/pull/144) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena), [@consideRatio](https://github.com/consideRatio))
- prepare to rename default branch to main [#143](https://github.com/jupyterhub/traefik-proxy/pull/143) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))

#### Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).

([GitHub contributors page for this release](https://github.com/jupyterhub/traefik-proxy/graphs/contributors?from=2021-10-18&to=2023-03-10&type=c))

@alexleach ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Aalexleach+updated%3A2021-10-18..2023-03-10&type=Issues)) | @consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3AconsideRatio+updated%3A2021-10-18..2023-03-10&type=Issues)) | @devnull-mr ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Adevnull-mr+updated%3A2021-10-18..2023-03-10&type=Issues)) | @dolfinus ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Adolfinus+updated%3A2021-10-18..2023-03-10&type=Issues)) | @GeorgianaElena ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3AGeorgianaElena+updated%3A2021-10-18..2023-03-10&type=Issues)) | @manics ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Amanics+updated%3A2021-10-18..2023-03-10&type=Issues)) | @maulikjs ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Amaulikjs+updated%3A2021-10-18..2023-03-10&type=Issues)) | @minrk ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Aminrk+updated%3A2021-10-18..2023-03-10&type=Issues)) | @pre-commit-ci ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Apre-commit-ci+updated%3A2021-10-18..2023-03-10&type=Issues)) | @twalcari ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Atwalcari+updated%3A2021-10-18..2023-03-10&type=Issues))

### [0.3.0](https://github.com/jupyterhub/traefik-proxy/compare/0.2.0...0.3.0) 2021-10-18

#### Enhancements made
Expand Down