Deploy a cloud stack with Terraform

Deploy a cloud stack using Terraform

ZenML maintains a collection of Terraform modules designed to streamline the provisioning of cloud resources and seamlessly integrate them with ZenML Stacks. These modules simplify the setup process, allowing users to quickly provision cloud resources as well as configure and authorize ZenML to utilize them for running pipelines and other AI/ML operations.

By leveraging these Terraform modules, users can ensure a more efficient and scalable deployment of their machine learning infrastructure, ultimately enhancing their development and operational workflows. The modules' implementation can also be used as a reference for creating custom Terraform configurations tailored to specific cloud environments and requirements.

Terraform requires you to manage your infrastructure as code yourself. Among other things, this means that you will need to have Terraform installed on your machine and you will need to manually manage the state of your infrastructure.

If you prefer a more automated approach, you can use the 1-click stack deployment feature to deploy a cloud stack with ZenML with minimal knowledge of Terraform or cloud infrastructure for that matter.

If you have the required infrastructure pieces already deployed on your cloud, you can also use the stack wizard to seamlessly register your stack.

Pre-requisites

To use this feature, you need a deployed ZenML server instance that is reachable from the cloud provider where you wish to have the stack provisioned (this can't be a local server started via zenml up). If you do not already have one set up, you can register for a free ZenML Pro account or you can learn about self-hosting a ZenML server here.

Once you are connected to your deployed ZenML server, you need to create a service account and an API key for it. You will use the API key to give the Terraform module programmatic access to your ZenML server. You can find more about service accounts and API keys here. but the process is as simple as running the following CLI command while connected to your ZenML server:

zenml service-account create <account-name>

Example output:

$ zenml service-account create terraform-account
Created service account 'terraform-account'.
Successfully created API key `default`.
The API key value is: 'ZENKEY_...'
Please store it safely as it will not be shown again.
To configure a ZenML client to use this API key, run:

zenml connect --url https://842ed6a9-zenml.staging.cloudinfra.zenml.io --api-key \
    'ZENKEY_...'

Finally, you will need the following on the machine where you will be running Terraform:

• Terraform installed on your machine (version at least 1.9).

• the ZenML Terraform stack modules assume you are already locally authenticated with your cloud provider through the provider's CLI or SDK tool and have permissions to create the resources that the modules will provision. This is different depending on the cloud provider you are using and is covered in the following sections.

How to use the Terraform stack deployment modules

If you are already knowledgeable with using Terraform and the cloud provider where you want to deploy the stack, this process will be straightforward. In a nutshell, you will need to:

1. create a new Terraform configuration file (e.g., main.tf), preferably in a new directory, with the content that looks like this (<cloud provider> can be aws, gcp, or azure):

module "zenml_stack" {
  source = "zenml-io/zenml-stack/<cloud-provider>"
  version = "x.y.z"

  # Required inputs
  zenml_server_url = "https://<zenml-server-url>"
  zenml_api_key = "<your-api-key>"
  # Optional inputs
  zenml_stack_name = "<your-stack-name>"
  orchestrator = "<your-orchestrator-type>" # e.g., "local", "sagemaker", "vertex", "azureml", "skypilot"
}
output "zenml_stack_id" {
  value = module.zenml_stack.zenml_stack_id
}
output "zenml_stack_name" {
  value = module.zenml_stack.zenml_stack_name
}

There might be a few additional required or optional inputs depending on the cloud provider you are using. You can find the full list of inputs for each module in the Terraform Registry documentation for the relevant module or you can read on in the following sections.

2. Run the following commands in the directory where you have your Terraform configuration file:

terraform init
terraform apply

The directory where you keep the Terraform configuration file and where you run the terraform commands is important. This is where Terraform will store the state of your infrastructure. Make sure you do not delete this directory or the state file it contains unless you are sure you no longer need to manage these resources with Terraform or after you have deprovisioned them up with terraform destroy.

3. Terraform will prompt you to confirm the changes it will make to your cloud infrastructure. If you are happy with the changes, type yes and hit enter.

4. Terraform will then provision the resources you have specified in your configuration file. Once the process is complete, you will see a message indicating that the resources have been successfully created and printing out the ZenML stack ID and name:

...
Apply complete! Resources: 15 added, 0 changed, 0 destroyed.

Outputs:

zenml_stack_id = "04c65b96-b435-4a39-8484-8cc18f89b991"
zenml_stack_name = "terraform-gcp-588339e64d06"

At this point, a ZenML stack has also been created and registered with your ZenML server and you can start using it to run your pipelines:

zenml integration install <list-of-required-integrations>
zenml stack set <zenml_stack_id>

You can find more details specific to the cloud provider of your choice in the next section:

AWS

The original documentation for the ZenML AWS Terraform module contains extensive information about required permissions, inputs, outputs and provisioned resources. This is a summary of the key points from that documentation.

Authentication

To authenticate with AWS, you need to have the AWS CLI installed on your machine and you need to have run aws configure to set up your credentials.

Example Terraform Configuration

Here is an example Terraform configuration file for deploying a ZenML stack on AWS:

module "zenml_stack" {
  source = "zenml-io/zenml-stack/aws"

  # Required inputs
  zenml_server_url = "https://<zenml-server-url>"
  zenml_api_key = "<your-api-key>"

  # Optional inputs
  region = "<your-aws-region>"
  orchestrator = "<your-orchestrator-type>" # e.g., "local", "sagemaker", "skypilot"
}
output "zenml_stack_id" {
  value = module.zenml_stack.zenml_stack_id
}
output "zenml_stack_name" {
  value = module.zenml_stack.zenml_stack_name
}

Stack Components

The Terraform module will create a ZenML stack configuration with the following components:

1. an S3 Artifact Store linked to a S3 bucket

2. an ECR Container Registry linked to a ECR repository

3. depending on the orchestrator input variable:

4. a local Orchestrator, if orchestrator is set to local. This can be used in combination with the SageMaker Step Operator to selectively run some steps locally and some on SageMaker.

5. a SageMaker Orchestrator linked to the AWS account, if orchestrator is set to sagemaker (default)

6. a SkyPilot Orchestrator linked to the AWS account, if orchestrator is set to skypilot

7. a SageMaker Step Operator linked to the AWS account

8. an AWS Service Connector configured with the IAM role credentials and used to authenticate all ZenML components with your AWS account

To use the ZenML stack, you will need to install the required integrations:

• for the local or SageMaker orchestrator:

zenml integration install aws s3

• for the SkyPilot orchestrator:

zenml integration install aws s3 skypilot_aws

GCP

The original documentation for the ZenML GCP Terraform module contains extensive information about required permissions, inputs, outputs and provisioned resources. This is a summary of the key points from that documentation.

Authentication

To authenticate with GCP, you need to have the gcloud CLI installed on your machine and you need to have run gcloud init or gcloud auth login to set up your credentials.

Example Terraform Configuration

Here is an example Terraform configuration file for deploying a ZenML stack on AWS:

module "zenml_stack" {
  source = "zenml-io/zenml-stack/gcp"

  # Required inputs
  project_id = "<your-gcp-project-id>"
  zenml_server_url = "https://<zenml-server-url>"
  zenml_api_key = "<your-api-key>"

  # Optional inputs
  region = "<your-gcp-region>"
  orchestrator = "<your-orchestrator-type>" # e.g., "local", "vertex", "skypilot" or "airflow"
}
output "zenml_stack_id" {
  value = module.zenml_stack.zenml_stack_id
}
output "zenml_stack_name" {
  value = module.zenml_stack.zenml_stack_name
}

Stack Components

The Terraform module will create a ZenML stack configuration with the following components:

1. an GCP Artifact Store linked to a GCS bucket

2. an GCP Container Registry linked to a Google Artifact Registry

3. depending on the orchestrator input variable:

4. a local Orchestrator, if orchestrator is set to local. This can be used in combination with the Vertex AI Step Operator to selectively run some steps locally and some on Vertex AI.

5. a Vertex AI Orchestrator linked to the GCP project, if orchestrator is set to vertex (default)

6. a SkyPilot Orchestrator linked to the GCP project, if orchestrator is set to skypilot

7. an Airflow Orchestrator linked to the Cloud Composer environment, if orchestrator is set to airflow

8. a Google Cloud Build Image Builder linked to your GCP project

9. a Vertex AI Step Operator linked to the GCP project

10. a GCP Service Connector configured with the GCP service account credentials or the GCP Workload Identity Provider configuration and used to authenticate all ZenML components with the GCP resources

To use the ZenML stack, you will need to install the required integrations:

• for the local and Vertex AI orchestrators:

zenml integration install gcp

• for the SkyPilot orchestrator:

zenml integration install gcp skypilot_gcp

• for the Airflow orchestrator:

zenml integration install gcp airflow

Azure

The original documentation for the ZenML Azure Terraform module contains extensive information about required permissions, inputs, outputs and provisioned resources. This is a summary of the key points from that documentation.

Authentication

To authenticate with Azure, you need to have the Azure CLI installed on your machine and you need to have run az login to set up your credentials.

Example Terraform Configuration

Here is an example Terraform configuration file for deploying a ZenML stack on AWS:

module "zenml_stack" {
  source = "zenml-io/zenml-stack/azure"

  # Required inputs
  zenml_server_url = "https://<zenml-server-url>"
  zenml_api_key = "<your-api-key>"

  # Optional inputs
  location = "<your-azure-location>"
  orchestrator = "<your-orchestrator-type>" # e.g., "local", "skypilot_azure"
}
output "zenml_stack_id" {
  value = module.zenml_stack.zenml_stack_id
}
output "zenml_stack_name" {
  value = module.zenml_stack.zenml_stack_name
}

Stack Components

The Terraform module will create a ZenML stack configuration with the following components:

1. an Azure Artifact Store linked to an Azure Storage Account and Blob Container

2. an ACR Container Registry linked to an Azure Container Registry

3. depending on the orchestrator input variable:

4. a local Orchestrator, if orchestrator is set to local. This can be used in combination with the AzureML Step Operator to selectively run some steps locally and some on AzureML.

5. an Azure SkyPilot Orchestrator linked to the Azure subscription, if orchestrator is set to skypilot (default)

6. an AzureML Orchestrator linked to an AzureML Workspace, if orchestrator is set to azureml

7. an AzureML Step Operator linked to an AzureML Workspace

8. an Azure Service Connector configured with Azure Service Principal credentials and used to authenticate all ZenML components with the Azure resources

To use the ZenML stack, you will need to install the required integrations:

• for the local and AzureML orchestrators:

zenml integration install azure

• for the SkyPilot orchestrator:

zenml integration install azure skypilot_azure

How to clean up the Terraform stack deployments

Cleaning up the resources provisioned by Terraform is as simple as running the terraform destroy command in the directory where you have your Terraform configuration file. This will remove all the resources that were provisioned by the Terraform module and will also delete the ZenML stack that was registered with your ZenML server.

terraform destroy