Merge pull request #192 from minrk/main

make api endpoint configurable, restore previous entrypoint names

Author: GeorgianaElena

docs/source/consul.md

@@ -161,7 +161,7 @@ If TraefikConsulProxy is used as an externally managed service, then make sure y
     address = ":8000"
 
     # the port on localhost where the traefik api should be found
-    [entryPoints.enter_api]
+    [entryPoints.auth_api]
     address = "localhost:8099"
 
     [providers.consul]
@@ -237,7 +237,7 @@ This is an example setup for using JupyterHub and TraefikConsulProxy managed by
    address = ":8000"
 
    # the port on localhost where the traefik api should be found
-   [entryPoints.enter_api]
+   [entryPoints.auth_api]
    address = "localhost:8099"
 
    [providers.consul]

docs/source/etcd.md

@@ -233,7 +233,7 @@ This is an example setup for using JupyterHub and TraefikEtcdProxy managed by an
    address = ":8000"
 
    # the port on localhost where the traefik api should be found
-   [entryPoints.enter_api]
+   [entryPoints.auth_api]
    address = "localhost:8099"
 
    [providers.etcd]

docs/source/file.md

@@ -187,7 +187,7 @@ This is an example setup for using JupyterHub and TraefikFileProviderProxy manag
    address = ":8000"
 
    # the port on localhost where the traefik api should be found
-   [entryPoints.enter_api]
+   [entryPoints.auth_api]
    address = "localhost:8099"
 
    # the dynamic configuration directory

jupyterhub_traefik_proxy/proxy.py

@@ -198,7 +198,7 @@ def _add_port(self, proposal):
     traefik_entrypoint = Unicode(
         help="""The traefik entrypoint name to use.
 
-        By default, will be `web` if http or `websecure` if https.
+        By default, will be `http` if http or `https` if https.
 
         If running traefik externally with your own specified entrypoint name,
         set this value.
@@ -210,9 +210,19 @@ def _add_port(self, proposal):
     def _default_traefik_entrypoint(self):
         """Find the traefik entrypoint that matches our :attrib:`self.public_url`"""
         if self.is_https:
-            return "websecure"
+            return "https"
         else:
-            return "web"
+            return "http"
+
+    traefik_api_entrypoint = Unicode(
+        "auth_api",
+        help="""The traefik entrypoint name to use for API access.
+
+        Separate from traefik_entrypoint,
+        because this is usually only on localhost.
+        """,
+        config=True,
+    )
 
     @default("traefik_api_password")
     def _warn_empty_password(self):
@@ -415,7 +425,7 @@ async def _setup_traefik_static_config(self):
             self.traefik_entrypoint: {
                 "address": urlparse(self.public_url).netloc,
             },
-            "enter_api": {
+            self.traefik_api_entrypoint: {
                 "address": urlparse(self.traefik_api_url).netloc,
             },
         }
@@ -444,7 +454,7 @@ async def _setup_traefik_dynamic_config(self):
         routers = http.setdefault("routers", {})
         routers["route_api"] = {
             "rule": f"Host(`{api_url.hostname}`) && PathPrefix(`{api_path}`)",
-            "entryPoints": ["enter_api"],
+            "entryPoints": [self.traefik_api_entrypoint],
             "service": "api@internal",
             "middlewares": ["auth_api"],
         }

tests/config_files/traefik.toml

@@ -10,8 +10,8 @@ providersThrottleDuration = "0s"
 directory = "/tmp/jupyterhub-traefik-proxy-test"
 watch = true
 
-[entryPoints.websecure]
+[entryPoints.https]
 address = "127.0.0.1:8000"
 
-[entryPoints.enter_api]
+[entryPoints.auth_api]
 address = "127.0.0.1:8099"

tests/config_files/traefik_etcd_txns.txt

@@ -1,6 +1,6 @@
 
 put traefik/http/middlewares/auth_api/basicAuth/users/0 "api_admin:$apr1$eS/j3kum$q/X2khsIEG/bBGsteP.x./"
-put traefik/http/routers/route_api/entryPoints/0 "enter_api"
+put traefik/http/routers/route_api/entryPoints/0 "auth_api"
 put traefik/http/routers/route_api/middlewares/0 "auth_api"
 put traefik/http/routers/route_api/rule "Host(`localhost`) && PathPrefix(`/api`)"
 put traefik/http/routers/route_api/service "api@internal"

tests/conftest.py

@@ -379,9 +379,9 @@ def _launch_traefik_cli(*extra_args, env=None):
         "--api",
         "--log.level=debug",
         "--providers.providersThrottleDuration=0s",
-        # "--entrypoints.web.address=:8000",
-        "--entrypoints.websecure.address=:8000",
-        "--entrypoints.enter_api.address=:8099",
+        # "--entrypoints.http.address=:8000",
+        "--entrypoints.https.address=:8000",
+        "--entrypoints.auth_api.address=:8099",
     )
     args = default_args + extra_args
     return _launch_traefik(*args, env=env)