Upgrade the version of the ZenML server
Learn how to upgrade your server to a new version of ZenML for the different deployment options.
The way to upgrade your ZenML server depends a lot on how you deployed it.
To upgrade your ZenML server that was deployed with the
zenml deploycommand to a newer version, you can follow the steps below.
- In the config file, set
zenmlserver_image_tagto the version that you want your ZenML server to be running.
- Run the deploy command again with this config file:zenml deploy --config=/PATH/TO/FILE
Any database schema updates are automatically handled by ZenML and unless mentioned otherwise, all of your data is migrated to the new version, intact.
To upgrade to a new version with docker, you have to delete the existing container and then run the new version of the
Check that your data is persisted (either on persistent storage or on an external MySQL instance) before doing this.
Optionally also perform a backup before the upgrade.
- Delete the existing ZenML container, for example like this:# find your container IDdocker ps# stop the containerdocker stop <CONTAINER_ID># remove the containerdocker rm <CONTAINER_ID>
- Deploy the version of the
zenml-serverimage that you want to use. Find all versions here.docker run -it -d -p 8080:8080 --name <CONTAINER_NAME> zenmldocker/zenml-server:<VERSION>
To upgrade your ZenML server Helm release to a new version, follow the steps below:
- Pull the latest version of the Helm chart from the ZenML GitHub repository, or a version of your choice, e.g.:
# If you haven't cloned the ZenML repository yet
git clone https://github.com/zenml-io/zenml.git
# Optional: checkout an explicit release tag
# git checkout 0.21.1
# Switch to the directory that hosts the helm chart
- Simply reuse the
custom-values.yamlfile that you used during the previous installation or upgrade. If you don't have it handy, you can extract the values from the ZenML Helm deployment using the following command:helm -n <namespace> get values zenml-server > custom-values.yaml
- Upgrade the release using your modified values file. Make sure you are in the directory that hosts the helm chart:helm -n <namespace> upgrade zenml-server . -f custom-values.yaml
It is not recommended to change the container image tag in the Helm chart to custom values, since every Helm chart version is tested to work only with the default image tag. However, if you know what you're doing you can change the
zenml.image.tagvalue in your
custom-values.yamlfile to the desired ZenML version (e.g.
Downgrading the server to an older version is not supported and can lead to unexpected behavior.
The version of the Python client that connects to the server should be kept at the same version as the server.