Update terraform new resource docs #21140

FingerLeader · 2025-06-09T14:38:04Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Signed-off-by: FingerLeader <[email protected]>

ti-chi-bot · 2025-06-09T14:38:14Z

Hi @FingerLeader. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

gemini-code-assist

Summary of Changes

Hello @FingerLeader, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces new documentation for using the TiDB Cloud Terraform provider to manage Dedicated clusters. It provides step-by-step guides and examples for creating, modifying, importing, and deleting dedicated clusters and their components (like TiFlash and additional TiDB node groups) using Infrastructure as Code principles.

Highlights

New Documentation: Added a comprehensive new documentation page (tidb-cloud/terraform-use-dedicated-cluster-resource.md) detailing how to manage TiDB Cloud Dedicated clusters using the tidbcloud_dedicated_cluster Terraform resource.
Resource Management: The new document covers the full lifecycle of a dedicated cluster via Terraform, including creation, modification (adding TiFlash, scaling, pausing/resuming), adding/updating/deleting TiDB node groups, importing existing clusters, and deletion.
Terraform Examples: Includes detailed Terraform HCL code examples and corresponding terraform apply, terraform state show, and terraform show command outputs for each operation (create, modify, delete, import).
Data Source Usage: Explains how to use the tidbcloud_projects data source to retrieve project IDs necessary for cluster creation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a new documentation page for the tidbcloud_dedicated_cluster Terraform resource. The document is comprehensive, covering creation, modification (including TiFlash, scaling, pausing/resuming, and node group management), importing, and deleting dedicated clusters. It also explains how to use the tidbcloud_projects data source.

The review focuses on resolving TO DO items, ensuring consistency in examples (especially resource names like example_cluster), correcting internal links, improving the clarity of steps and explanations, and adhering to markdown and language style guidelines. Specific suggestions include rephrasing for formality and conciseness, and correcting list numbering for better logical flow.

gemini-code-assist · 2025-06-09T14:40:14Z

tidb-cloud/terraform-use-dedicated-cluster-resource.md

+<!-- TO DO -->
+> **Note:**
+>
+> Before you begin, make sure that you have set a CIDR in the TiDB Cloud console. For more information, see [Set a CIDR](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-cidr-for-a-region). You can also [create a `dedicated_network_container` resource](xxxx) to manage your CIDR.


This section contains a "TO DO" comment and a placeholder link (xxxx).

Please remove the  comment if there's no specific pending information for this exact spot.

The link (xxxx) for dedicated_network_container resource needs to be updated with the correct URL if the document exists, or the sentence should be rephrased/removed if the resource or its documentation is not yet available.

gemini-code-assist · 2025-06-09T14:40:14Z

tidb-cloud/terraform-use-dedicated-cluster-resource.md

+      Enter a value: yes
+
+    tidbcloud_dedicated_cluster.example_cluster: Creating...
+    tidbcloud_dedicated_cluster.example: Still creating... [10s elapsed]


The resource name in this example output is example, but the Terraform configuration (e.g., line 150) uses example_cluster. This inconsistency appears in several example outputs throughout the document. Please ensure all example outputs consistently use example_cluster to match the defined resource name.

Suggested change

tidbcloud_dedicated_cluster.example: Still creating... [10s elapsed]

tidbcloud_dedicated_cluster.example_cluster: Still creating... [10s elapsed]

gemini-code-assist · 2025-06-09T14:40:15Z

tidb-cloud/terraform-use-dedicated-cluster-resource.md

+1. Add an import block for the new dedicated cluster resource
+
+- Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the cluster ID:
+
+    ```
+    import {
+      to = tidbcloud_dedicated_cluster.example_cluster
+      id = "${id}"
+    }
+    ```
+2. Generate the new configuration file
+
+Generate the new configuration file for the new dedicated cluster resource according to the import block:
+
+  ```shell
+  terraform plan -generate-config-out=generated.tf
+  ```
+
+Do not specify an existing `.tf` file name in the preceding command. Otherwise, Terraform will return an error.
+
+1. Review and apply the generated configuration


The numbering for the steps under "Import a cluster" is inconsistent. Step "1. Add an import block..." is followed by sub-step "- Add the following...". Then step "2. Generate..." is followed by a step incorrectly numbered as "1. Review and apply...". This should be "3. Review and apply...". Please ensure consistent and sequential numbering for steps.

gemini-code-assist · 2025-06-09T14:40:15Z

tidb-cloud/terraform-use-dedicated-cluster-resource.md

+    ```
+    $ terraform state show tidbcloud_dedicated_cluster.example_cluster
+
+    # tidbcloud_cluster.example_cluster:


The comment in the example output refers to tidbcloud_cluster.example_cluster. Since this document is about the dedicated cluster resource, it should be tidbcloud_dedicated_cluster.example_cluster. Please check and correct this in all similar example outputs.

Suggested change

# tidbcloud_cluster.example_cluster:

# tidbcloud_dedicated_cluster.example_cluster:

gemini-code-assist · 2025-06-09T14:40:15Z

tidb-cloud/terraform-use-dedicated-cluster-resource.md

+
+### Add a TiFlash component
+
+1. In the `cluster.tf` file that is used when you [create the cluster](#create-a-cluster-using-the-cluster-resource), add the `tiflash_node_setting` configuration.


The anchor #create-a-cluster-using-the-cluster-resource appears to be from a different document. It should point to the relevant section within this document for creating a dedicated cluster. This issue also occurs on lines 571, 677, and 832.

A possible correct anchor would be #create-a-dedicated-cluster-using-the-dedicated-cluster-resource.

Suggested change

1. In the `cluster.tf` file that is used when you [create the cluster](#create-a-cluster-using-the-cluster-resource), add the `tiflash_node_setting` configuration.

1. In the `cluster.tf` file that is used when you [create the cluster](#create-a-dedicated-cluster-using-the-dedicated-cluster-resource), add the `tiflash_node_setting` configuration.

tidb-cloud/terraform-use-dedicated-cluster-resource.md

gemini-code-assist · 2025-06-09T14:40:16Z

tidb-cloud/terraform-use-dedicated-cluster-resource.md

+
+## Delete a Dedicated cluster
+
+To delete a Dedicated cluster, you can delete the configuration of the `dedicated_cluster` resource, then use the `terraform apply` command to destroy the resource:


For consistency with the resource name used elsewhere, this should be tidbcloud_dedicated_cluster resource.

Suggested change

To delete a Dedicated cluster, you can delete the configuration of the `dedicated_cluster` resource, then use the `terraform apply` command to destroy the resource:

To delete a Dedicated cluster, you can delete the configuration of the `tidbcloud_dedicated_cluster` resource, then use the `terraform apply` command to destroy the resource:

tidb-cloud/terraform-use-dedicated-cluster-resource.md

Signed-off-by: FingerLeader <[email protected]>

ti-chi-bot · 2025-06-10T08:18:38Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from hfxsd. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Signed-off-by: FingerLeader <[email protected]>

tidb-cloud/terraform-use-dedicated-cluster-resource.md

hfxsd · 2025-06-13T02:40:55Z

tidb-cloud/terraform-use-dedicated-cluster-resource.md

+
+## Prerequisites
+
+- [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) at least v0.4.0.


Suggested change

- [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) at least v0.4.0.

- [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) v0.4.0 or later.

Signed-off-by: FingerLeader <[email protected]>

…update-terraform

Signed-off-by: FingerLeader <[email protected]>

FingerLeader · 2025-06-16T13:19:33Z

this PR reopen in #21189

FingerLeader added 4 commits June 9, 2025 21:57

tmp save

357759e

Signed-off-by: FingerLeader <[email protected]>

Merge branch 'master' into update-terraform

a6067e8

add dedicated cluster

738a0bd

Signed-off-by: FingerLeader <[email protected]>

add dedicated cluster

5a301f1

Signed-off-by: FingerLeader <[email protected]>

ti-chi-bot bot added the contribution This PR is from a community contributor. label Jun 9, 2025

ti-chi-bot bot added needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 9, 2025

gemini-code-assist bot reviewed Jun 9, 2025

View reviewed changes

FingerLeader added 3 commits June 10, 2025 15:34

add dedicated cluster

ebc6861

Signed-off-by: FingerLeader <[email protected]>

add dedicated cluster

e4239a4

Signed-off-by: FingerLeader <[email protected]>

add dedicated cluster

22b5c62

Signed-off-by: FingerLeader <[email protected]>

hfxsd self-assigned this Jun 10, 2025

hfxsd self-requested a review June 10, 2025 07:54

FingerLeader added 2 commits June 10, 2025 16:17

fix some bot comments

d984149

Signed-off-by: FingerLeader <[email protected]>

fix some bot comments

eb72484

Signed-off-by: FingerLeader <[email protected]>

FingerLeader and others added 2 commits June 10, 2025 16:20

Apply suggestions from code review

8cd9988

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

change status to state

985b696

Signed-off-by: FingerLeader <[email protected]>

hfxsd added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed missing-translation-status This PR does not have translation status info. labels Jun 10, 2025

add sql user

a6bba61

Signed-off-by: FingerLeader <[email protected]>

FingerLeader changed the base branch from master to release-8.1 June 13, 2025 06:44

FingerLeader changed the base branch from release-8.1 to master June 13, 2025 06:46

refined format and wording

89f38ba

hfxsd reviewed Jun 13, 2025

View reviewed changes

Apply suggestions from code review

8363270

FingerLeader added 3 commits June 15, 2025 18:26

add vpc peering

8e54b40

Signed-off-by: FingerLeader <[email protected]>

Merge branch 'update-terraform' of github.com:FingerLeader/docs into …

5205ca3

…update-terraform

add private network connection & network container

d9eb668

Signed-off-by: FingerLeader <[email protected]>

FingerLeader closed this Jun 16, 2025

FingerLeader deleted the update-terraform branch June 16, 2025 13:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update terraform new resource docs #21140

Update terraform new resource docs #21140

Uh oh!

FingerLeader commented Jun 9, 2025 •

edited by hfxsd

Loading

Uh oh!

ti-chi-bot bot commented Jun 9, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Jun 9, 2025

Uh oh!

gemini-code-assist bot Jun 9, 2025

Uh oh!

gemini-code-assist bot Jun 9, 2025

Uh oh!

gemini-code-assist bot Jun 9, 2025

Uh oh!

gemini-code-assist bot Jun 9, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist bot Jun 9, 2025

Uh oh!

Uh oh!

ti-chi-bot bot commented Jun 10, 2025

Uh oh!

Uh oh!

hfxsd Jun 13, 2025

Uh oh!

FingerLeader commented Jun 16, 2025

Uh oh!

Uh oh!

	tidbcloud_dedicated_cluster.example: Still creating... [10s elapsed]
	tidbcloud_dedicated_cluster.example_cluster: Still creating... [10s elapsed]

	# tidbcloud_cluster.example_cluster:
	# tidbcloud_dedicated_cluster.example_cluster:


		### Add a TiFlash component

		1. In the `cluster.tf` file that is used when you [create the cluster](#create-a-cluster-using-the-cluster-resource), add the `tiflash_node_setting` configuration.


		## Delete a Dedicated cluster

		To delete a Dedicated cluster, you can delete the configuration of the `dedicated_cluster` resource, then use the `terraform apply` command to destroy the resource:


		## Prerequisites

		- [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) at least v0.4.0.

Update terraform new resource docs #21140

Update terraform new resource docs #21140

Uh oh!

Conversation

FingerLeader commented Jun 9, 2025 • edited by hfxsd Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

Uh oh!

ti-chi-bot bot commented Jun 9, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist bot Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ti-chi-bot bot commented Jun 10, 2025

Uh oh!

Uh oh!

hfxsd Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

FingerLeader commented Jun 16, 2025

Uh oh!

Uh oh!

FingerLeader commented Jun 9, 2025 •

edited by hfxsd

Loading