Merge pull request #668 from dolfinus/ingress_class_name

[KubeIngressProxy] Add KubeIngressProxy.ingress_class_name
jupyterhub · Nov 8, 2022 · 4960fcf · 4960fcf
2 parents 49f4109 + 9027036
commit 4960fcf
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/kubespawner/objects.py b/kubespawner/objects.py
@@ -737,6 +737,7 @@ def make_ingress(
     common_labels: Optional[dict] = None,
     ingress_extra_labels: Optional[dict] = None,
     ingress_extra_annotations: Optional[dict] = None,
+    ingress_class_name: Optional[str] = None,
 ):
     """
     Returns an ingress, service, endpoint object that'll work for this service
@@ -833,6 +834,7 @@ def make_ingress(
         kind='Ingress',
         metadata=ingress_meta,
         spec=V1IngressSpec(
+            ingress_class_name=ingress_class_name,
             rules=[
                 V1IngressRule(
                     host=host,
@@ -853,7 +855,7 @@ def make_ingress(
                         ]
                     ),
                 )
-            ]
+            ],
         ),
     )
 

diff --git a/kubespawner/proxy.py b/kubespawner/proxy.py
@@ -225,6 +225,13 @@ def _namespace_default(self):
         """,
     )
 
+    ingress_class_name = Unicode(
+        config=True,
+        help="""
+        Default value for 'ingressClassName' field in Ingress specification
+        """,
+    )
+
     k8s_api_ssl_ca_cert = Unicode(
         "",
         config=True,
@@ -375,6 +382,7 @@ async def add_route(self, routespec, target, data):
             common_labels=common_labels,
             ingress_extra_labels=ingress_extra_labels,
             ingress_extra_annotations=ingress_extra_annotations,
+            ingress_class_name=self.ingress_class_name,
         )
 
         async def ensure_object(create_func, patch_func, body, kind):

diff --git a/tests/test_objects.py b/tests/test_objects.py
@@ -2004,6 +2004,7 @@ def test_make_ingress(target, ip):
             common_labels=common_labels,
             ingress_extra_labels=ingress_extra_labels,
             ingress_extra_annotations=ingress_extra_annotations,
+            ingress_class_name='nginx',
         )
     )
 
@@ -2067,6 +2068,7 @@ def test_make_ingress(target, ip):
             'name': 'jupyter-test',
         },
         'spec': {
+            'ingressClassName': 'nginx',
             'rules': [
                 {
                     'http': {
@@ -2086,7 +2088,7 @@ def test_make_ingress(target, ip):
                         ]
                     }
                 }
-            ]
+            ],
         },
     }