cloud: add terraform migrate cluster resource doc

[FingerLeader]

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.

• master (the latest development version)
• v9.0 (TiDB 9.0 versions)
• v8.5 (TiDB 8.5 versions)
• v8.4 (TiDB 8.4 versions)
• v8.3 (TiDB 8.3 versions)
• v8.1 (TiDB 8.1 versions)
• v7.5 (TiDB 7.5 versions)
• v7.1 (TiDB 7.1 versions)
• v6.5 (TiDB 6.5 versions)
• v6.1 (TiDB 6.1 versions)
• v5.4 (TiDB 5.4 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

[ti-chi-bot]

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.

[qiancai]

/ok-to-test

[qiancai]

/bot-review

[github-actions]

✅ AI review completed, 10 comments generated.

[Copilot]

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

[lilin90]

/gemini review

[gemini-code-assist]

Code Review

This pull request adds documentation for migrating cluster resources to serverless/dedicated cluster resources using Terraform. The documentation provides a step-by-step guide with commands and examples. Overall, the documentation is clear and helpful, but there are a few areas that could be improved for clarity and completeness.

Summary of Findings

• Prerequisites: Specific Terraform Provider Version: The prerequisite section mentions updating the TiDB Cloud Terraform Provider but uses a placeholder version (x.x.x). This should be replaced with a specific, tested version to ensure the instructions work correctly.
• Inconsistent Resource Naming in Examples: In Step 4, the example configurations for serverless and dedicated clusters use the same resource name (new_cluster). This could lead to confusion and should be clarified or corrected to use distinct names.
• Missing Context for your_target_cluster_resource: In Step 2, the documentation uses ${your_target_cluster_resource} without explicitly defining or explaining where this value comes from. It should be clarified that this is the full resource name as listed by terraform state list.

Merge Readiness

The pull request introduces a new documentation page for migrating cluster resources using Terraform. While the steps are generally well-explained, addressing the identified issues regarding the Terraform provider version, resource naming consistency, and clarification of variable usage would significantly improve the documentation's clarity and usability. I am unable to approve this pull request, and recommend that the author address the identified issues before merging.

[gemini-code-assist]

Using the same resource name new_cluster for both serverless and dedicated clusters might be confusing. Consider using distinct names to avoid potential issues.

Suggested change

	resource "tidbcloud_serverless_cluster" "new_cluster" {} # Serverless
	resource "tidbcloud_serverless_cluster" "new_cluster" {} # Dedicated
	resource "tidbcloud_serverless_cluster" "new_serverless_cluster" {} # Serverless
	resource "tidbcloud_dedicated_cluster" "new_dedicated_cluster" {} # Dedicated

[gemini-code-assist]

It would be helpful to clarify where the ${your_target_cluster_resource} value comes from. Perhaps reference the output of the command in Step 1?

Suggested change

	Run the `terraform state rm ${your_target_cluster_resource}` to delete the resource from state.
	Run the `terraform state rm tidbcloud_cluster.your_old_cluster` to delete the resource from state.

[gemini-code-assist]

To align with the previous suggestion, the resource names here should be updated to reflect the new resource names.

Suggested change

	terraform import tidbcloud_serverless_cluster.new_cluster ${id} # Serverless
	terraform import tidbcloud_dedicated_cluster.new_cluster ${id} # Dedicated
	terraform import tidbcloud_serverless_cluster.new_serverless_cluster ${id} # Serverless
	terraform import tidbcloud_dedicated_cluster.new_dedicated_cluster ${id} # Dedicated

[ti-chi-bot]

@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Code Review

This pull request adds documentation for migrating cluster resources to serverless/dedicated cluster resources using Terraform. The documentation provides a step-by-step guide with commands and examples. Overall, the documentation is clear and helpful, but there are a few areas that could be improved for clarity and completeness.

Summary of Findings

• Prerequisites: Specific Terraform Provider Version: The prerequisite section mentions updating the TiDB Cloud Terraform Provider but uses a placeholder version (x.x.x). This should be replaced with a specific, tested version to ensure the instructions work correctly.
• Inconsistent Resource Naming in Examples: In Step 4, the example configurations for serverless and dedicated clusters use the same resource name (new_cluster). This could lead to confusion and should be clarified or corrected to use distinct names.
• Missing Context for your_target_cluster_resource: In Step 2, the documentation uses ${your_target_cluster_resource} without explicitly defining or explaining where this value comes from. It should be clarified that this is the full resource name as listed by terraform state list.

Merge Readiness

The pull request introduces a new documentation page for migrating cluster resources using Terraform. While the steps are generally well-explained, addressing the identified issues regarding the Terraform provider version, resource naming consistency, and clarification of variable usage would significantly improve the documentation's clarity and usability. I am unable to approve this pull request, and recommend that the author address the identified issues before merging.

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.

dismiss

[ti-chi-bot]

[LGTM Timeline notifier]

Timeline:

• 2025-05-23 07:40:02.192600394 +0000 UTC m=+18628.137865245: ☑️ agreed by qiancai.
• 2025-05-23 08:40:22.704287927 +0000 UTC m=+22248.649552737: ☑️ agreed by Oreoxmt.

[qiancai]

/approve

[qiancai]

/approve

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [qiancai]

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

[ti-chi-bot]

In response to a cherrypick label: new pull request created to branch release-8.1: #21026.