From 7e25b6da4a7cde991785f849367f8262936f2c1e Mon Sep 17 00:00:00 2001 From: "sammy.huang" Date: Thu, 16 May 2024 18:49:15 +0800 Subject: [PATCH] chore(doc): update (#27) Signed-off-by: Liang Huang --- docs/README.md | 4 ++-- ...er-cluster.md => create-a-free-cluster.md} | 20 ++++++++++--------- docs/create-a-standard-cluster.md | 7 +++++-- docs/resources/cluster.md | 2 +- .../resources/zillizcloud_cluster/resource.tf | 2 +- 5 files changed, 20 insertions(+), 15 deletions(-) rename docs/{create-a-starter-cluster.md => create-a-free-cluster.md} (74%) diff --git a/docs/README.md b/docs/README.md index dadd4a9..6865f48 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,8 +11,8 @@ This guide provides a comprehensive overview of using Terraform with Zilliz Clou * **Installation**: Learn how to install the Zilliz Cloud Terraform provider and configure it within your Terraform project. Refer to the tutorial: [Getting Started with Zilliz Cloud Terraform Provider](./get-start.md) * **Cluster Management:** Discover how to define, provision, and manage Zilliz Cloud clusters using Terraform configurations. - * Create Starter Clusters for initial testing or small-scale applications: [Creating a Starter Cluster](./create-a-starter-cluster.md) - * Create Standard Clusters with more resources for production workloads: [Creating a Standard Cluster](./create-a-standard-cluster.md) + * Create Free Plan Clusters for learning, experimenting, and prototype;: [Creating a Free Plan Cluster](./create-a-free-cluster.md) + * Create Standard Plan Clusters with more resources for production workloads: [Creating a Standard Plan Cluster](./create-a-standard-cluster.md) * **Scaling Clusters**: Learn how to leverage Terraform to upgrade the compute unit size of your Zilliz Cloud clusters to meet changing workload demands: [Upgrading Zilliz Cloud Cluster Compute Unit Size with Terraform](./scale-cluster.md) * **Importing Existing Clusters**: Utilize Terraform to import existing Zilliz Cloud clusters into your Terraform state, enabling them to be managed alongside other infrastructure using Terraform configurations: [Import Existing Zilliz Cloud Cluster With Terraform](./import-cluster.md) diff --git a/docs/create-a-starter-cluster.md b/docs/create-a-free-cluster.md similarity index 74% rename from docs/create-a-starter-cluster.md rename to docs/create-a-free-cluster.md index cfb19ea..a169723 100644 --- a/docs/create-a-starter-cluster.md +++ b/docs/create-a-free-cluster.md @@ -1,10 +1,12 @@ -## Tutorial: Creating a Starter Cluster with Terraform +## Tutorial: Creating a Free Plan Cluster with Terraform -This tutorial guides you through creating a basic **Starter cluster** in Zilliz Cloud using the `zillizcloud_cluster` resource within Terraform. Starter clusters are suitable for initial testing or small-scale applications. +This tutorial guides you through creating a basic **Free Plan cluster** in Zilliz Cloud using the `zillizcloud_cluster` resource within Terraform. Free Plan clusters are suitable for for learning experimenting, and prototype purposes. + +Check out the [Select the Right Cluster Plan](https://docs.zilliz.com/docs/select-zilliz-cloud-service-plans) for more information on the available plans. **You'll learn how to:** -- Define a **Starter cluster** in Terraform configuration. +- 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. @@ -23,7 +25,7 @@ data "zillizcloud_project" "default" { # Fetching the default project information to be used in cluster provisioning } -resource "zillizcloud_cluster" "starter_cluster" { +resource "zillizcloud_cluster" "free_plan_cluster" { # Name for your cluster cluster_name = "Cluster-01" # ID of the default project retrieved from data source @@ -31,21 +33,21 @@ resource "zillizcloud_cluster" "starter_cluster" { } output "cluster_connect_address" { - value = zillizcloud_cluster.starter_cluster.connect_address + value = zillizcloud_cluster.free_plan_cluster.connect_address } output "cluster_username" { - value = zillizcloud_cluster.starter_cluster.username + value = zillizcloud_cluster.free_plan_cluster.username } output "cluster_password" { sensitive = true - value = zillizcloud_cluster.starter_cluster.password + value = zillizcloud_cluster.free_plan_cluster.password } ``` **Explanation:** -- This configuration defines a `zillizcloud_cluster` resource named `starter_cluster`. +- 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. @@ -78,5 +80,5 @@ $ terraform destroy ``` ## Next Steps -- Explore creating a Standard Cluster with more resources using the guide: [Creating a Standard Cluster](./create-a-standard-cluster.md) +- Explore creating a Standard Plan Cluster with more resources using the guide: [Creating a Standard Plan Cluster](./create-a-standard-cluster.md) diff --git a/docs/create-a-standard-cluster.md b/docs/create-a-standard-cluster.md index b9af80d..bb97665 100644 --- a/docs/create-a-standard-cluster.md +++ b/docs/create-a-standard-cluster.md @@ -1,7 +1,10 @@ -# Tutorial: Creating a Standard Cluster +## Tutorial: Creating a Standard Plan Cluster with Terraform -This tutorial guides you through managing Zilliz Cloud clusters using the `zillizcloud_cluster` resource within Terraform. You'll learn how to: +This tutorial guides you through managing a **Standard Plan** Cluster using the `zillizcloud_cluster` resource within Terraform. Standard Plan Cluster have more resources, compared to Free Plan Cluster and are suitable for production workloads. +Check out the [Select the Right Cluster Plan](https://docs.zilliz.com/docs/select-zilliz-cloud-service-plans) for more information on the available plans. + +**You'll learn how to:** - Retrieve project and region IDs for cluster creation. - Define clusters with various configurations in Terraform. - Plan and apply changes to provision clusters in Zilliz Cloud. diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md index 1457294..129f03b 100644 --- a/docs/resources/cluster.md +++ b/docs/resources/cluster.md @@ -28,7 +28,7 @@ data "zillizcloud_project" "default" { # Fetching the default project information to be used in cluster provisioning } -resource "zillizcloud_cluster" "starter_cluster" { +resource "zillizcloud_cluster" "free_plan_cluster" { # Defining a basic starter cluster cluster_name = "Cluster-01" # The name of the cluster project_id = data.zillizcloud_project.default.id # Linking to the project ID fetched earlier diff --git a/examples/resources/zillizcloud_cluster/resource.tf b/examples/resources/zillizcloud_cluster/resource.tf index e80b2e8..6ecb13a 100644 --- a/examples/resources/zillizcloud_cluster/resource.tf +++ b/examples/resources/zillizcloud_cluster/resource.tf @@ -13,7 +13,7 @@ data "zillizcloud_project" "default" { # Fetching the default project information to be used in cluster provisioning } -resource "zillizcloud_cluster" "starter_cluster" { +resource "zillizcloud_cluster" "free_plan_cluster" { # Defining a basic starter cluster cluster_name = "Cluster-01" # The name of the cluster project_id = data.zillizcloud_project.default.id # Linking to the project ID fetched earlier