Skip to content

Commit

Permalink
chore(doc): update (#28)
Browse files Browse the repository at this point in the history
Signed-off-by: Liang Huang <[email protected]>
  • Loading branch information
yellow-shine authored May 16, 2024
1 parent 7e25b6d commit 1ee68fb
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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 Free Plan Clusters for learning, experimenting, and prototype;: [Creating a Free Plan Cluster](./create-a-free-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)
Expand Down
9 changes: 4 additions & 5 deletions docs/create-a-free-cluster.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## 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 clusters are suitable for for learning experimenting, and prototype purposes.
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](https://docs.zilliz.com/docs/select-zilliz-cloud-service-plans) for more information on the available plans.

**You'll learn how to:**

- Define a **Free Plan 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.

Expand Down Expand Up @@ -61,8 +61,8 @@ terraform apply -auto-approve
Outputs:

cluster_connect_address = "https://in03-559dde3b4b6de3a.api.gcp-us-west1.zillizcloud.com"
cluster_password = <sensitive>
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.
Expand All @@ -80,5 +80,4 @@ $ terraform destroy
```

## Next Steps
- Explore creating a Standard Plan Cluster with more resources using the guide: [Creating a Standard Plan Cluster](./create-a-standard-cluster.md)

- Explore creating a **Standard Plan** Cluster: [Creating a Standard Plan Cluster](./create-a-standard-cluster.md)
6 changes: 5 additions & 1 deletion docs/get-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,8 @@ provider "zillizcloud" {
}
```

By following these steps, you should have the Zilliz Cloud Terraform provider configured and ready to use in your Terraform projects.
By following these steps, you should have the Zilliz Cloud Terraform provider configured and ready to move on to the next steps.

## Next Steps
- Explore creating a **Free Plan** Cluster: [Creating a Free Plan Cluster](./create-a-free-cluster.md)
- Explore creating a **Standard Plan** Cluster: [Creating a Standard Plan Cluster](./create-a-standard-cluster.md)
4 changes: 0 additions & 4 deletions docs/import-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,3 @@ Here's a step-by-step guide on importing an existing Zilliz Cloud cluster into y

This command will display the attributes and current configuration of the imported cluster.


## Next Steps
- [Tutorial: Creating Zilliz Cloud Cluster Resources with Terraform](./create-cluster.md)

0 comments on commit 1ee68fb

Please sign in to comment.