Upgrades and Updates

How to upgrade ZenML Pro components.

This section covers upgrading ZenML Pro components for all deployment types. Each component has its own upgrade procedures and considerations.

Always upgrade the Control Plane first, then upgrade Workspace Servers. This ensures compatibility and prevents potential issues.

Control Plane

Upgrade procedures for the Control Plane across SaaS, Hybrid, and Self-hosted deployments.

Workspace Server

Upgrade procedures for Workspace Servers across all deployment scenarios (includes Workload Manager updates).

Before You Upgrade

Check Release Notes

• For ZenML Pro Control Plane: Check available versions in the ZenML Pro ArtifactHub repository

• For ZenML Pro Workspace Servers: Check available versions in the ZenML OSS ArtifactHub repository and review the ZenML GitHub releases page for release notes and breaking changes

Backup Checklist

Before any upgrade:

1. Database backup - Export your database

2. Values.yaml files - Save copies of your Helm values

3. TLS certificates - Ensure certificates are backed up

Database Migrations

Some updates may require database migrations:

1. Review migration related changes in release notes

2. Monitor logs for any migration-related errors

3. Verify data integrity after upgrade

4. Test key features (workspace access, pipeline runs, etc.)

Post-Upgrade Verification

After upgrading any component:

1. Health Checks - Verify all pods are running

2. Test Connectivity - Confirm SDK can connect

3. Validate Functionality - Test pipeline execution

4. Review Logs - Check for errors or warnings

Related Documentation

• Configuration Details - Component configuration reference

• System Architecture - Understand component interactions

• Scenarios - Deployment scenarios and guides