Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 3.42 KB

create-a-free-cluster.md

File metadata and controls

83 lines (56 loc) · 3.42 KB

Tutorial: Creating a Free Plan Cluster with Terraform

This tutorial guides you through creating a basic Free Plan cluster in Zilliz Cloud using the zillizcloud_cluster resource within Terraform. Free Plan cluster is suitable for for learning experimenting, and prototype purposes.

Check out the Select the Right Cluster Plan for more information on the available plans.

You'll learn how to:

  • Define a Free Plan cluster in Terraform configuration.
  • Review and apply changes to provision the cluster in Zilliz Cloud.
  • Verify the creation of your Zilliz Cloud cluster.

Prerequisites

Before you begin, make sure you have completed the initial setup steps outlined in the Getting Started with Zilliz Cloud Terraform Provider guide. Additionally, ensure that you have the necessary permissions and access credentials to interact with the Zilliz Cloud API.

Creating a Cluster

Append the following code to your main.tf file mentioned in the Getting Started with Zilliz Cloud Terraform Provider guide.

data "zillizcloud_project" "default" {
  # Fetching the default project information to be used in cluster provisioning
}

resource "zillizcloud_cluster" "free_plan_cluster" {
  # Name for your cluster
  cluster_name = "Cluster-01"
  # ID of the default project retrieved from data source
  project_id   = data.zillizcloud_project.default.id 
}

output "cluster_connect_address" {
  value = zillizcloud_cluster.free_plan_cluster.connect_address
}
output "cluster_username" {
  value = zillizcloud_cluster.free_plan_cluster.username
}
output "cluster_password" {
  sensitive = true
  value = zillizcloud_cluster.free_plan_cluster.password
}

Explanation:

  • This configuration defines a zillizcloud_cluster resource named free_plan_cluster.
    • cluster_name: Sets the name of your cluster (here, "Cluster-01").
    • project_id: Retrieves the ID of the default project using the data.zillizcloud_project.default.id attribute.

Planning and Applying Changes

Once you've defined the cluster resources, it's time to apply the changes to provision the Zilliz Cloud clusters. Navigate to your Terraform project directory and execute the following commands:

terraform apply -auto-approve

Outputs:

cluster_connect_address = "https://in03-559dde3b4b6de3a.api.gcp-us-west1.zillizcloud.com"
cluster_username = "db_559dde3b4b6de3a"
cluster_password = <sensitive>

Note: The -auto-approve flag avoids prompting for confirmation before applying the changes. Use caution, especially in production environments. It's recommended to thoroughly review the plan before applying.

Terraform will orchestrate the creation of the specified clusters based on your configuration. Once the process is complete, Terraform will display the output values for the cluster's connection address, username, and password.

Verifying Provisioned Clusters

After applying the changes, you can verify the provisioned Zilliz Cloud clusters either through the Zilliz Cloud dashboard. Ensure that the clusters are created with the desired configurations and are functioning as expected.

Destroying the Cluster(Optional)

If you want to destroy the cluster, you can run the following command:

$ terraform destroy

Next Steps