Kubernetes Deployer #4114

safoinme · 2025-10-30T22:01:00Z

Describe changes

I implemented/fixed _ to achieve _.

Pre-requisites

Please ensure you have done the following:

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. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs
- Dashboard: Needs to be communicated to the frontend team.
- Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
- Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

github-actions · 2025-10-30T22:01:24Z

🔍 Broken Links Report

Summary

📁 Files with broken links: 1
🔗 Total broken links: 2
📄 Broken markdown links: 2
🖼️ Broken image links: 0
⚠️ Broken reference placeholders: 0

Details

File	Link Type	Link Text	Broken Path
`deployers/kubernetes.md`	📄	"Kubernetes service connector"	`../../service-connectors/connector-types/kubernetes-cluster.md`
`deployers/kubernetes.md`	📄	"deployment user guide"	`../../user-guide/production-guide/deployment.md`

📂 Full file paths

/home/runner/work/zenml/zenml/scripts/../docs/book/component-guide/deployers/kubernetes.md
/home/runner/work/zenml/zenml/scripts/../docs/book/component-guide/deployers/kubernetes.md

github-actions · 2025-10-31T10:02:17Z

Documentation Link Check Results

✅ Absolute links check passed
❌ Relative links check failed
There are broken relative links in the documentation. See workflow logs for details
_{Last checked: 2025-10-31 20:52:59 UTC}

strickvl

Left some smaller comments / nits in there. Bigger-picture feedback:

feels like maybe there's room for tightening the kube_utils.py code?
I didn't check but is there any overlap between the K8S orchestrator and the extra kube_utils.py code? If so, we should reduce that duplication where possible.
probably needs tests wherever it makes sense. Feels like there's at least a bit of the logic which doesn't rely on the actual K8S infra which we should add unit tests for.

Might be more comments but these feel like the obvious ones. Mainly just about reducing duplication where it exists. A lot of those utils are just handling 404 errors and retries as far as I can see.

UPDATE: https://gist.github.com/strickvl/69f5d5e7ede6cf920b24d20ad3e83652 here are specific suggestions on that.

strickvl · 2025-10-31T12:39:53Z

examples/weather_agent/k8s_deploy_simple.yaml

+# Basic Kubernetes deployer configuration
+settings:
+  docker:
+    parent_image: safoinme/zenml:deployer-0.4


Probably to be removed?

strickvl · 2025-10-31T12:40:11Z

examples/weather_agent/k8s_deploy_advanced.yaml

+
+settings:
+  docker:
+    parent_image: safoinme/zenml:deployer-0.4


Same here. to be removed?

strickvl · 2025-10-31T12:41:24Z

examples/weather_agent/README.md

 zenml pipeline deploy pipelines.weather_agent.weather_agent
 ```

+For Kubernetes deployments, use the provided configuration files:


If people are going to do that then they need to set up a K8S deployer etc? So maybe link them to the docs page and tell them that they will first need to use that in their stack before this would work?

strickvl · 2025-10-31T12:44:04Z

src/zenml/integrations/kubernetes/kube_utils.py

+    )
+
+
+def wait_for_deployment_ready(


Feels like these 'wait for...' functions have a decent amount of duplicated code. Not sure if it would make sense to refactor them to remove that?

strickvl · 2025-10-31T12:46:56Z

src/zenml/integrations/kubernetes/kube_utils.py

+        if e.status == 404:
+            return None


Why do you do this here? (and above). Why wouldn't you want to raise the 404 as well?

strickvl · 2025-10-31T13:07:50Z

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

+If you only need local development or single-node deployments, consider the
+[local](local.md) or [docker](docker.md) deployer flavors instead.
+
+## How to deploy it


Is there also an 'easy' way to do this with our Terraform modules etc?

strickvl · 2025-10-31T13:09:32Z

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

+snapshots exactly like with other flavors:
+
+```bash
+zenml pipeline deploy my_module.my_pipeline --deployment k8s-example


Suggested change

zenml pipeline deploy my_module.my_pipeline --deployment k8s-example

zenml pipeline deploy my_module.my_pipeline --name k8s-example

--name I think and not --deployment

strickvl · 2025-10-31T13:16:32Z

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

+### Monitoring
+
+```bash
+kubectl get hpa -n zenml-deployments --watch
+kubectl describe hpa <name> -n zenml-deployments
+```


this section feels a bit sparse... either expand it a bit more, or delete it.

I guess people just want some guidance on how they can monitor usage etc.

strickvl · 2025-10-31T13:17:18Z

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

@@ -0,0 +1,1737 @@
+#  Copyright (c) ZenML GmbH 2021. All Rights Reserved.


Suggested change

# Copyright (c) ZenML GmbH 2021. All Rights Reserved.

# Copyright (c) ZenML GmbH 2025. All Rights Reserved.

strickvl · 2025-10-31T13:28:55Z

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

+            pod = self._get_pod_for_deployment(deployment)
+            pod_name = pod.metadata.name if pod else None
+
+            # Build metadata


Suggested change

# Build metadata

Michael ☠️

safoinme added 18 commits October 29, 2025 20:16

init k8s deployer

d99d2af

fixes

75f776f

Merge branch 'develop' into feature/k8s-deployer

1fc5236

updates

4b8ff65

update init

7fedc59

Remove unused config and name properties from KubernetesComponentMixin

ae07897

improvements

d5753ee

more improvements

ad216be

docstring

bb8d496

cleanup

498b582

mypy

7126b4a

fixes

5a9cc2d

mypy

559bc11

reeview-ready

51ac734

docstring

67e8edc

fix imports

f5e0b19

yaml for example

01041cc

update settings

07d41f8

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Oct 30, 2025

order and clean

e511820

safoinme requested a review from strickvl October 31, 2025 09:54

safoinme marked this pull request as ready for review October 31, 2025 09:54

Merge branch 'develop' into feature/k8s-deployer

3dcf9c5

formatt

13c909f

strickvl reviewed Oct 31, 2025

View reviewed changes

last update

85b82ee

	zenml pipeline deploy my_module.my_pipeline --deployment k8s-example
	zenml pipeline deploy my_module.my_pipeline --name k8s-example

		@@ -0,0 +1,1737 @@
		# Copyright (c) ZenML GmbH 2021. All Rights Reserved.

	# Copyright (c) ZenML GmbH 2021. All Rights Reserved.
	# Copyright (c) ZenML GmbH 2025. All Rights Reserved.

		)


		def wait_for_deployment_ready(

Kubernetes Deployer #4114

Are you sure you want to change the base?

Kubernetes Deployer #4114

Uh oh!

Conversation

safoinme commented Oct 30, 2025

Describe changes

Pre-requisites

Types of changes

Uh oh!

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

Uh oh!

🔍 Broken Links Report

Summary

Details

Uh oh!

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

Uh oh!

Documentation Link Check Results

Uh oh!

strickvl left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Oct 30, 2025 •

edited

Loading

github-actions bot commented Oct 31, 2025 •

edited

Loading

strickvl left a comment •

edited

Loading