Skip to content

Commit 9921644

Browse files
committed
changelog for 0.4
1 parent 5137c74 commit 9921644

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

docs/source/changelog.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,78 @@ For detailed changes from the prior release, click on the version number
44
and its link will bring up a GitHub listing of changes. Use `git log` on
55
the command line for details.
66

7+
### 0.4.0 (prerelease)
8+
9+
0.4 is a big release for jupyterhub-traefik-proxy!
10+
It updates support for traefik to version 2.x (current: 2.9.8).
11+
Treafik versions < 2.0 is no longer supported.
12+
If you have custom traefik configuration,
13+
make sure to checkout [traefik's v1 to v2 migration guide](https://doc.traefik.io/traefik/migration/v1-to-v2/),
14+
since your configuration may need updating.
15+
16+
A major consequence if the v2 updates is that the performance of adding and removing routes when there are a large number already defined is now greatly improved,
17+
and no longer grows significantly with the number of routes.
18+
19+
Major changes:
20+
21+
- Traefik v2 is required. Traefik v1 is not supported.
22+
- `TraefikTomlProxy` is deprecated in favor of `TraefikFileProviderProxy`,
23+
which supports both toml and yaml.
24+
Replace `traefik_toml` with `traefik_file` in your configuration.
25+
- `python3 -m jupyterhub_traefik_proxy.install` will now only install traefik, not any key-value-store providers.
26+
You can follow your KV store's own installation instructions.
27+
- `python3 -m jupyterhub_traefik_proxy.install` now supports fetching any published traefik version on any architecture,
28+
instead of a few preset versions.
29+
30+
Performance and responsiveness is also greatly improved.
31+
32+
([full changelog](https://github.com/jupyterhub/traefik-proxy/compare/0.3.0...ec8eadcc7d274911d8e5bdcbed9082c02edd642f))
33+
34+
#### API and Breaking Changes
35+
36+
- 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))
37+
- 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))
38+
39+
#### New features added
40+
41+
- 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))
42+
43+
#### Enhancements made
44+
45+
- Improve performance, scaling [#165](https://github.com/jupyterhub/traefik-proxy/pull/165) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
46+
- 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))
47+
48+
#### Bugs fixed
49+
50+
- 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))
51+
52+
#### Maintenance and upkeep improvements
53+
54+
- reuse backends across tests [#174](https://github.com/jupyterhub/traefik-proxy/pull/174) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
55+
- simplify some test fixtures [#169](https://github.com/jupyterhub/traefik-proxy/pull/169) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
56+
- avod deprecation warning in `--slow-last` sorting [#168](https://github.com/jupyterhub/traefik-proxy/pull/168) ([@minrk](https://github.com/minrk))
57+
- restore proxy tests [#167](https://github.com/jupyterhub/traefik-proxy/pull/167) ([@minrk](https://github.com/minrk), [@manics](https://github.com/manics))
58+
- 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))
59+
- 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))
60+
- minor logging tweaks [#161](https://github.com/jupyterhub/traefik-proxy/pull/161) ([@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio))
61+
- Use checksums from traefik releases [#160](https://github.com/jupyterhub/traefik-proxy/pull/160) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
62+
- 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))
63+
- 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))
64+
- 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))
65+
- 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))
66+
- improve test time [#150](https://github.com/jupyterhub/traefik-proxy/pull/150) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
67+
- 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))
68+
- 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))
69+
70+
#### Contributors to this release
71+
72+
The following people contributed discussions, new ideas, code and documentation contributions, and review.
73+
See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).
74+
75+
([GitHub contributors page for this release](https://github.com/jupyterhub/traefik-proxy/graphs/contributors?from=2021-10-18&to=2023-03-10&type=c))
76+
77+
@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))
78+
779
### [0.3.0](https://github.com/jupyterhub/traefik-proxy/compare/0.2.0...0.3.0) 2021-10-18
880

981
#### Enhancements made

0 commit comments

Comments
 (0)