Handle deployment url for ingress, gateway etc.. #4234

safoinme · 2025-11-21T01:35:19Z

Describe changes

I implemented improved URL discovery and preference handling for Kubernetes deployments to achieve better control over which URL is returned when multiple endpoint types are available (Gateway API, Ingress, LoadBalancer, NodePort, ClusterIP).

Key changes:

Added url_preference setting to explicitly select URL type
Refactored URL discovery into focused helper methods
Added comprehensive test coverage for URL selection logic
Updated documentation with URL preference guidance
All discovered URLs are stored in deployment metadata

This allows users to explicitly request specific URL types (e.g., url_preference="ingress") and raises clear errors if the requested type is unavailable, preventing accidental fallback to unexpected endpoints.

Pre-requisites

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop.
Documentation has been updated in the Kubernetes deployer guide

Types of changes

New feature (non-breaking change which adds functionality)

htahir1 · 2025-11-21T08:08:57Z

@claude full-review

safoinme · 2025-11-24T12:37:51Z

@claude full-review

github-actions · 2025-12-03T10:33:30Z

Classification template updates in examples/mlops_starter have been pushed.

htahir1 · 2025-12-04T12:23:55Z

@claude full-review

github-actions · 2025-12-04T12:39:18Z

Documentation Link Check Results

❌ Absolute links check failed
There are broken absolute links in the documentation. See workflow logs for details
✅ Relative links check passed
_{Last checked: 2025-12-11 10:38:00 UTC}

stefannica

I love this idea of collecting all possible URLs and leaving it to the user to decide which one to use.

I like it so much in fact, that I think we should formalize it and allow ALL deployments to have one or more URLs in the main DeploymentResponse model, one default and some alternative ones.

stefannica · 2025-12-08T10:02:39Z

src/zenml/enums.py

+class KubernetesUrlPreference(StrEnum):
+    """URL preference for Kubernetes deployer when multiple URL types are available."""
+
+    GATEWAY_API = "gateway_api"
+    INGRESS = "ingress"
+    LOAD_BALANCER = "load_balancer"
+    NODE_PORT = "node_port"
+    CLUSTER_IP = "cluster_ip"
+    AUTO = "auto"
+
+


I think this belongs in a file somewhere under the kubernetes integration, not here.

stefannica · 2025-12-08T10:03:17Z

docs/book/component-guide/deployers/kubernetes.md

+
+Tip: When using Ingress or Gateway API, combine `service_type="ClusterIP"` with the matching `url_preference` so the returned URL matches the routing layer you manage (and you avoid paying for an extra LoadBalancer).
+
+- Strict preference behavior: If you set `url_preference` to a specific type and that URL can't be discovered (for example, LoadBalancer is still pending), the deployer raises an error instead of returning another URL type. This helps avoid accidental exposure paths.


Love this neat little insight!

stefannica · 2025-12-08T10:10:04Z

src/zenml/integrations/kubernetes/kube_utils.py

+    gateway: Union[Dict[str, Any], Any],
+    httproute: Union[Dict[str, Any], Any],


I know there are no typed objects in the kubernetes client library for things like gateway and httproute, but using dictionaries is really error prone and difficult to read/understand. I suggest you define some simple pydantic objects that map to the attributes that you're using from these objects instead of using these unpredictable .get calls. Generally speaking, when it feels like you're using a lot of .get, hasattr and getattr calls, this is a sign that you're not using Python typing features correctly.

stefannica · 2025-12-08T10:12:43Z

src/zenml/integrations/kubernetes/deployers/kubernetes_deployer.py

+                name=httproute_item.name,
+                namespace=httproute_namespace,
+                kind="HTTPRoute",
+                api_version="gateway.networking.k8s.io/v1beta1",


how likely is it that these versions will change or have changed ? shouldn't you try to cover all the relevant versions, past and future ?

This is a great insight, this is probably changing sometime soon once this get's more stable, hmmm but what would be the right way to handle this? let user pass the api version?

stefannica · 2025-12-08T10:13:56Z

src/zenml/integrations/kubernetes/deployers/kubernetes_deployer.py

+                        name=gateway_item.name,
+                        namespace=gateway_item_namespace,
+                        kind="Gateway",
+                        api_version="gateway.networking.k8s.io/v1beta1",


Same here: how likely is it that these versions will change or have changed ? shouldn't you try to cover all the relevant versions, past and future ?

same as above

stefannica · 2025-12-08T10:15:18Z

src/zenml/integrations/kubernetes/deployers/kubernetes_deployer.py

+            inventory, "Gateway", "gateway.networking.k8s.io/v1beta1"
+        )
+        httproute_items = _filter_inventory(
+            inventory, "HTTPRoute", "gateway.networking.k8s.io/v1beta1"
+        )


what about previous/future versions of these resources? can you check and make sure that this code is also valid on other kubernetes versions, past and (preferably) future?

stefannica · 2025-12-08T10:16:14Z

src/zenml/integrations/kubernetes/deployers/kubernetes_deployer.py

+            httproute_spec = httproute_dict.get("spec", {})
+            httproute_rules = httproute_spec.get("rules", [])
+
+            routes_to_service = False
+            for rule in httproute_rules:
+                backend_refs = rule.get("backendRefs", [])
+                for backend_ref in backend_refs:
+                    backend_service_name = backend_ref.get("name")
+                    backend_namespace = (
+                        backend_ref.get("namespace") or httproute_namespace
+                    )
+
+                    if (
+                        backend_service_name == service_item.name
+                        and backend_namespace == service_namespace
+                    ):
+                        routes_to_service = True
+                        break


Same comment here: prefer typed objects to these interminable and opaque .get calls.

github-actions · 2025-12-26T02:15:58Z

⚠️ This PR has been inactive for 2 weeks and has been marked as stale.
Timeline:

Week 2 (now): First reminder - PR marked as stale
Week 4: PR will be automatically closed if no activity
Please update this PR or leave a comment to keep it active. Any activity will reset the timer and remove the stale label.

init

4d1c5a0

github-actions bot added the internal To filter out internal PRs and issues label Nov 21, 2025

This comment was marked as outdated.

Sign in to view

safoinme and others added 2 commits November 21, 2025 10:24

apply claude review

a71c6db

Merge branch 'develop' into fix/improve-deployment-url-in-k8s-deployer

d72523a

zenml-io deleted a comment from claude bot Nov 24, 2025

This comment was marked as outdated.

Sign in to view

safoinme and others added 3 commits November 24, 2025 23:50

Merge branch 'develop' into fix/improve-deployment-url-in-k8s-deployer

a854c3d

fixes

2181088

Merge branch 'develop' into fix/improve-deployment-url-in-k8s-deployer

525b6a9

safoinme requested a review from stefannica December 3, 2025 10:30

safoinme marked this pull request as ready for review December 3, 2025 10:30

Auto-update of Starter template

b35c79b

Merge branch 'develop' into fix/improve-deployment-url-in-k8s-deployer

f969d27

This comment was marked as resolved.

Sign in to view

safoinme linked an issue Dec 4, 2025 that may be closed by this pull request

Kubernetes Deployer URL extraction #4299

Open

1 task

fix based on claude review

6774a9f

stefannica requested changes Dec 8, 2025

View reviewed changes

safoinme added 5 commits December 9, 2025 15:16

Merge branch 'develop' into fix/improve-deployment-url-in-k8s-deployer

5b2c576

url review fixes

ede0ef3

Merge branch 'develop' into fix/improve-deployment-url-in-k8s-deployer

f21f82e

fix utils

32ef6c5

mypy issues

2001b4a

github-actions bot added the stale label Dec 26, 2025


		Tip: When using Ingress or Gateway API, combine `service_type="ClusterIP"` with the matching `url_preference` so the returned URL matches the routing layer you manage (and you avoid paying for an extra LoadBalancer).

		- Strict preference behavior: If you set `url_preference` to a specific type and that URL can't be discovered (for example, LoadBalancer is still pending), the deployer raises an error instead of returning another URL type. This helps avoid accidental exposure paths.

		gateway: Union[Dict[str, Any], Any],
		httproute: Union[Dict[str, Any], Any],

Handle deployment url for ingress, gateway etc.. #4234

Are you sure you want to change the base?

Handle deployment url for ingress, gateway etc.. #4234

Conversation

safoinme commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe changes

Pre-requisites

Types of changes

Uh oh!

htahir1 commented Nov 21, 2025

Uh oh!

This comment was marked as outdated.

safoinme commented Nov 24, 2025

Uh oh!

This comment was marked as outdated.

github-actions bot commented Dec 3, 2025

Uh oh!

htahir1 commented Dec 4, 2025

Uh oh!

This comment was marked as resolved.

github-actions bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

stefannica left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

safoinme commented Nov 21, 2025 •

edited

Loading

github-actions bot commented Dec 4, 2025 •

edited

Loading