Skip to content

Commit

Permalink
chore(doc): update
Browse files Browse the repository at this point in the history
Signed-off-by: Liang Huang <[email protected]>
  • Loading branch information
yellow-shine committed May 16, 2024
1 parent bfd4a97 commit a65a032
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 21 deletions.
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ The Terraform provider for Zilliz Cloud acts as a bridge between Terraform and t
This guide provides a comprehensive overview of using Terraform with Zilliz Cloud. Here are the resources to get you started:

* **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. Explore various cluster configuration options: [Tutorial: Creating Zilliz Cloud Cluster Resources with Terraform](./create-cluster.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)
* **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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tutorial: Creating Zilliz a Standard Cloud Cluster Resources with Terraform
# Tutorial: Creating a Standard Cluster

This tutorial guides you through managing Zilliz Cloud clusters using the `zillizcloud_cluster` resource within Terraform. You'll learn how to:

Expand All @@ -12,23 +12,29 @@ This tutorial guides you through managing Zilliz Cloud clusters using the `zilli
Before you begin, make sure you have completed the initial setup steps outlined in the [Getting Started with Zilliz Cloud Terraform Provider](./get-start.md) guide. Additionally, ensure that you have the necessary permissions and access credentials to interact with the Zilliz Cloud API.


## Retrieving Project IDs in Your Zilliz Cloud Account
## Retrieving Your Zilliz Cloud Project ID

[How Can I Obtain the Project ID ?](https://support.zilliz.com/hc/en-us/articles/22048954409755-How-Can-I-Obtain-the-Project-ID)
There are two ways to find your Zilliz Cloud project ID:

For convenience, you can use the `zillizcloud_project` data source to retrieve the ID of default project for your Zilliz Cloud account.
**1. Zilliz Cloud Console:**

Refer to the Zilliz Cloud documentation for details on obtaining your project ID through the console: [How Can I Obtain the Project ID?](https://support.zilliz.com/hc/en-us/articles/22048954409755-How-Can-I-Obtain-the-Project-ID)

## Acquiring Region IDs for Zilliz Cloud Cluster
**2. Zilliz Cloud Data Source (Optional):**

[Cloud Providers & Regions](https://docs.zilliz.com/docs/cloud-providers-and-regions)
For convenience, you can use the `zillizcloud_project` data source to retrieve the ID of the default project associated with your Zilliz Cloud account.

In this tutorial, we will use the `aws-us-east-2` region.
## Selecting a Zilliz Cloud Region

This tutorial will use the `aws-us-east-2` region. However, you can choose a different region based on your needs.

For a full list of available cloud providers and regions, refer to the Zilliz Cloud documentation: [Cloud Providers & Regions](https://docs.zilliz.com/docs/cloud-providers-and-regions)

### Creating a Cluster

With the `project ID` and `region ID` at hand, creating Zilliz Cloud clusters is straightforward. Below is an illustrative example defining zillizcloud_cluster resources within Terraform configuration:

Append the following code to your `main.tf` file mentioned in the [Getting Started with Zilliz Cloud Terraform Provider](./get-start.md) guide.

```hcl
Expand All @@ -45,8 +51,10 @@ resource "zillizcloud_cluster" "standard_plan_cluster" {
project_id = data.zillizcloud_project.default.id # Linking to the project ID fetched earlier
}
```
This example will create a Zilliz Cloud cluster:
- **Standard Plan Cluster**: This configuration creates a more advanced cluster named "Cluster-02" in the `aws-us-east-2` region. It uses the "Standard" service plan with a compute unit size of 1, optimized for performance, making it suitable for more demanding workloads.
**Explanation of the Configuration:**

This code creates a Zilliz Cloud cluster named "Cluster-02" in the "aws-us-east-2" region. It serves the "Standard" plan with a single, performance-optimized compute unit, making it suitable for workloads requiring more processing power.


### Planning and Applying Changes

Expand Down
34 changes: 23 additions & 11 deletions docs/create-a-starter-cluster.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,43 @@
# Tutorial: Creating Zilliz a Starter Cloud Cluster Resources with Terraform
## Tutorial: Creating a Starter 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 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.

- 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.
- Verify the creation of your Zilliz Cloud clusters.
**You'll learn how to:**

- Define a **Starter 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](./get-start.md) guide. Additionally, ensure that you have the necessary permissions and access credentials to interact with the Zilliz Cloud API.


### Creating a Cluster

With the `project ID` at hand, creating Zilliz Cloud clusters is straightforward. Below is an illustrative example defining zillizcloud_cluster resources within Terraform configuration:
Append the following code to your `main.tf` file mentioned in the [Getting Started with Zilliz Cloud Terraform Provider](./get-start.md) guide.


```hcl
data "zillizcloud_project" "default" {}
data "zillizcloud_project" "default" {
# Fetching the default project information to be used in cluster provisioning
}
resource "zillizcloud_cluster" "starter_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
}
```
This example will create two Zilliz Cloud clusters:
- **Starter Cluster**: This configuration creates a basic cluster named "Cluster-01" within the default project. It's suitable for initial testing or small-scale applications.


**Explanation:**

- This configuration defines a `zillizcloud_cluster` resource named `starter_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

Expand All @@ -46,3 +55,6 @@ Review the plan generated by Terraform and confirm to apply the changes. Terrafo

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.

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

0 comments on commit a65a032

Please sign in to comment.