Merge pull request #176 from minrk/rel-v2

changelog for 1.0

Author: minrk

docs/source/changelog.md

@@ -4,6 +4,94 @@ 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.
 
+## 1.0.0 (prerelease)
+
+1.0.0 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...HEAD))
+
+### 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))
+- reduce requirements of KV store implementations and custom methods [#185](https://github.com/jupyterhub/traefik-proxy/pull/185) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
+
+### 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
+
+- set providersThrottleDuration=0s in tests [#190](https://github.com/jupyterhub/traefik-proxy/pull/190) ([@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio))
+- fix heading level in 0.3 changelog [#188](https://github.com/jupyterhub/traefik-proxy/pull/188) ([@minrk](https://github.com/minrk))
+- run rst2md on remaining rst files [#187](https://github.com/jupyterhub/traefik-proxy/pull/187) ([@minrk](https://github.com/minrk))
+- use editable install to get test coverage [#186](https://github.com/jupyterhub/traefik-proxy/pull/186) ([@minrk](https://github.com/minrk))
+- Make traefik_entrypoint name explicit [#184](https://github.com/jupyterhub/traefik-proxy/pull/184) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
+- test: fix consul auth port [#183](https://github.com/jupyterhub/traefik-proxy/pull/183) ([@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio), [@GeorgianaElena](https://github.com/GeorgianaElena))
+- deprecate consul due to unhealthy API clients [#182](https://github.com/jupyterhub/traefik-proxy/pull/182) ([@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio))
+- add dependabot config for github actions [#178](https://github.com/jupyterhub/traefik-proxy/pull/178) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
+- 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))
+
+### Documentation improvements
+
+- doc: update sample configuration for v2 [#189](https://github.com/jupyterhub/traefik-proxy/pull/189) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena))
+- Fix CI README badges [#177](https://github.com/jupyterhub/traefik-proxy/pull/177) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio))
+- docs: update link to traefik API [#175](https://github.com/jupyterhub/traefik-proxy/pull/175) ([@minrk](https://github.com/minrk), [@manics](https://github.com/manics))
+- Update performance benchmarks for v2 [#163](https://github.com/jupyterhub/traefik-proxy/pull/163) ([@minrk](https://github.com/minrk), [@GeorgianaElena](https://github.com/GeorgianaElena), [@manics](https://github.com/manics))
+
+### 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-17&type=c))
+
+@alexleach ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Aalexleach+updated%3A2021-10-18..2023-03-17&type=Issues)) | @consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3AconsideRatio+updated%3A2021-10-18..2023-03-17&type=Issues)) | @dependabot ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Adependabot+updated%3A2021-10-18..2023-03-17&type=Issues)) | @devnull-mr ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Adevnull-mr+updated%3A2021-10-18..2023-03-17&type=Issues)) | @dolfinus ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Adolfinus+updated%3A2021-10-18..2023-03-17&type=Issues)) | @GeorgianaElena ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3AGeorgianaElena+updated%3A2021-10-18..2023-03-17&type=Issues)) | @manics ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Amanics+updated%3A2021-10-18..2023-03-17&type=Issues)) | @maulikjs ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Amaulikjs+updated%3A2021-10-18..2023-03-17&type=Issues)) | @minrk ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Aminrk+updated%3A2021-10-18..2023-03-17&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-17&type=Issues)) | @twalcari ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Ftraefik-proxy+involves%3Atwalcari+updated%3A2021-10-18..2023-03-17&type=Issues))
+
 ## [0.3.0](https://github.com/jupyterhub/traefik-proxy/compare/0.2.0...0.3.0) 2021-10-18
 
 ### Enhancements made

jupyterhub_traefik_proxy/consul.py

@@ -59,15 +59,15 @@ class TraefikConsulProxy(TKvProxy):
     )
 
     kv_url = Unicode("DEPRECATED", config=True).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="consul_url",
     )
     kv_username = Unicode("DEPRECATED", config=True).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="consul_username",
     )
     kv_password = Unicode("DEPRECATED", config=True).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="consul_password",
     )
 

jupyterhub_traefik_proxy/etcd.py

@@ -94,15 +94,15 @@ def _default_executor(self):
     )
 
     kv_url = Unicode("DEPRECATED", config=True).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="etcd_url",
     )
     kv_username = Unicode("DEPRECATED", config=True).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="etcd_username",
     )
     kv_password = Unicode("DEPRECATED", config=True).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="etcd_password",
     )
 

jupyterhub_traefik_proxy/proxy.py

@@ -69,7 +69,7 @@ def _concurrency_changed(self, change):
         config=True,
         help="Deprecated. Use static_config_file",
     ).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="static_config_file",
     )
 

jupyterhub_traefik_proxy/toml.py

@@ -9,12 +9,12 @@ class TraefikTomlProxy(TraefikFileProviderProxy):
     toml_dynamic_config_file = Unicode(
         config=True,
     ).tag(
-        deprecated_in="0.4",
+        deprecated_in="1.0",
         deprecated_for="TraefikFileProvider.dynamic_config_file",
     )
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.log.warning(
-            "TraefikTomlProxy is deprecated in jupyterhub-traefik-proxy 0.4. Use `c.JupyterHub.proxy_class = 'traefik_file'"
+            "TraefikTomlProxy is deprecated in jupyterhub-traefik-proxy 1.0. Use `c.JupyterHub.proxy_class = 'traefik_file'"
         )