Merge pull request #182 from minrk/deprecate-consul

deprecate consul due to unhealthy API clients

Author: consideRatio

docs/source/consul.md

@@ -1,5 +1,11 @@
 # Using TraefikConsulProxy
 
+```{warning}
+While it works today (2023), there does not appear to be a maintained Python client for the consul API.
+As such, using jupyterhub-traefik-proxy with consul is deprecated in jupyterhub-traefik-proxy 1.0.
+You can use etcd instead to achieve the same functionality (and slightly better performance).
+```
+
 [Consul](https://www.consul.io/)
 is a distributed key-value store.
 This and TraefikEtcdProxy is the choice to use when using jupyterhub-traefik-proxy

jupyterhub_traefik_proxy/consul.py

@@ -94,6 +94,12 @@ def _default_client(self):
             kwargs.update({"token": self.consul_password})
         return consul.aio.Consul(**kwargs)
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.log.warning(
+            "Using traefik with consul is deprecated in jupyterhub-traefik-proxy 1.0 due to lack of support for the python-consul2 API client. Use etcd instead."
+        )
+
     def _define_kv_specific_static_config(self):
         provider_config = {
             "consul": {