One Click Deployment using CLI
Deploying ZenML on cloud using the CLI
This is an older version of the ZenML documentation. To read and view the latest version please visit this up-to-date URL.
The easiest and fastest way to get running on the cloud is by using the deploy
CLI command. It currently only supports deploying to Kubernetes on managed cloud services. You can check the overview page to learn other options that you have.
Before we begin, it will help to understand the architecture around the ZenML server and the database that it uses. Now, depending on your setup, you may find one of the following scenarios relevant.
Option 1: Starting from scratch
If you don't have an existing Kubernetes cluster, you have the following two options to set it up:
Using a stack recipe that sets up a cluster along with other tools that you might need in your cloud stack like artifact stores, and secret managers. Take a look at all available stack recipes to see if there's something that works for you.
Note Once you have created your cluster, make sure that you configure your kubectl client to talk to it. If you have used stack recipes, this step is already done for you!
You're now ready to deploy ZenML! Run the following command:
You will be prompted to provide a name for your deployment and details like what cloud provider you want to deploy to, in addition to the username, password and email you want to set for the default user — and that's it! It creates the database and any VPCs, permissions and more that is needed.
Note To be able to run the deploy command, you should have your cloud provider's CLI configured locally with permissions to create resources like MySQL databases and networks.
Reasonable defaults are in place for you already and if you wish to configure more settings, take a look at the next scenario that uses a config file.
Option 2: Using existing cloud resources
Existing Kubernetes Cluster
If you already have an existing cluster without an ingress controller, you can jump straight to the deploy
command above to get going with the defaults. Please make sure you have your local kubectl
configured to talk to your cluster.
Having an existing NGINX Ingress Controller
The deploy
command, by default, tries to create an NGINX ingress controller on your cluster. If you already have an existing controller, you can tell ZenML to not re-deploy it through the use of a config file. This file can be found in the Configuration File Templates towards the end of this guide. It offers a host of configuration options that you can leverage for advanced use cases.
Check if an ingress controller is running on your cluster by running the following command. You should see an entry in the output with the hostname populated.
Set
create_ingress_controller
tofalse
.Supply your controller's hostname to the
ingress_controller_hostname
variable.Note If you're on GCP, the ingress host could be an IP address of the form
https://xx.xx.xx.xx
. Append.nip.io
to this address before supplying the value to theingress_controller_hostname
variable. Learn more here.You can now run the
deploy
command and pass the config file above, to it.Note To be able to run the deploy command, you should have your cloud provider's CLI configured locally with permissions to create resources like MySQL databases and networks.
Existing Hosted SQL Database
If you also already have a database that you would want to use with the deployment, you can choose to configure it with the use of the config file. Here we will demonstrate setting the database.
Note Only MySQL version 5.7.x are supported by ZenML, currently.
Fill the fields below from the config file with values from your database.
Run the
deploy
command and pass the config file above to it.Note To be able to run the deploy command, you should have your cloud provider's CLI configured locally with permissions to create resources like MySQL databases and networks.
Configuration File Templates
Base Config File
This is the general structure of a config file. Use this as a base and then add any cloud-specific parameters from the sections below.
Note Feel free to include only those variables that you want to customize, in your file. For all other variables, the defaults (specified in square brackets) would be used.
Cloud specific settings
The database_username
and database_password
from the general config is used to set those variables for the AWS RDS instance as well.
Last updated