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 c4c9fd4 commit 0b9b454
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
10 changes: 9 additions & 1 deletion docs/create-a-standard-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ resource "zillizcloud_cluster" "standard_plan_cluster" {
cu_type = "Performance-optimized" # The type of compute unit, optimized for performance
project_id = data.zillizcloud_project.default.id # Linking to the project ID fetched earlier
}
```
**Explanation of the Configuration:**

Expand All @@ -66,11 +68,17 @@ terraform apply -auto-approve

**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.

Review the plan generated by Terraform and confirm to apply the changes. Terraform will orchestrate the creation of the specified clusters based on your configuration.
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
- [Upgrading Zilliz Cloud Cluster Compute Unit Size with Terraform](./scale-cluster.md)
24 changes: 23 additions & 1 deletion docs/create-a-starter-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ resource "zillizcloud_cluster" "starter_cluster" {
project_id = data.zillizcloud_project.default.id
}
output "cluster_connect_address" {
value = zillizcloud_cluster.starter_cluster.connect_address
}
output "cluster_username" {
value = zillizcloud_cluster.starter_cluster.username
}
output "cluster_password" {
sensitive = true
value = zillizcloud_cluster.starter_cluster.password
}
```


Expand All @@ -45,16 +55,28 @@ Once you've defined the cluster resources, it's time to apply the changes to pro

```bash
terraform apply -auto-approve

Outputs:

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

**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.

Review the plan generated by Terraform and confirm to apply the changes. Terraform will orchestrate the creation of the specified clusters based on your configuration.
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
- Explore creating a Standard Cluster with more resources using the guide: [Creating a Standard Cluster](./create-a-standard-cluster.md)

6 changes: 6 additions & 0 deletions docs/scale-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ resource "zillizcloud_cluster" "standard_plan_cluster" {
Terraform will now initiate the upgrade process, scaling your Zilliz Cloud cluster to the specified CU size.


## Destroying the Cluster(Optional)
if you want to destroy the cluster, you can run the following command:
```
$ terraform destroy
```

### Verifying the Upgrade

Once Terraform finishes applying the changes, you can verify that the CU size of your cluster has been upgraded successfully via the Zilliz Cloud dashboard. Log in to your Zilliz Cloud account and navigate to the Clusters section in the dashboard. Select the upgraded cluster and view its details. The CU size should now reflect the value you specified in your Terraform configuration.
Expand Down

0 comments on commit 0b9b454

Please sign in to comment.