Skip to content

Update terraform doc with new resources in v0.4 #21189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 24 commits into
base: release-8.1
Choose a base branch
from

Conversation

FingerLeader
Copy link
Contributor

First-time contributors' checklist

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

Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
@ti-chi-bot ti-chi-bot bot added contribution This PR is from a community contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Jun 16, 2025
Copy link

ti-chi-bot bot commented Jun 16, 2025

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.

@ti-chi-bot ti-chi-bot bot added 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 16, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @FingerLeader, I'm Gemini Code Assist1! 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 updates the documentation for the TiDB Cloud Terraform provider to include guides for several new resources introduced in v0.4. The added documents cover managing Dedicated and Serverless clusters, network configurations for Dedicated clusters, and branches and exports for Serverless clusters, providing users with instructions on how to create, modify (where applicable), import, and delete these resources using Terraform.

Highlights

  • New Dedicated Cluster Documentation: Added comprehensive documentation for managing TiDB Cloud Dedicated clusters using the tidbcloud_dedicated_cluster resource, covering creation, modification (scaling, pausing, adding/removing components/node groups), import, and deletion.
  • New Serverless Cluster Documentation: Added documentation for managing TiDB Cloud Serverless clusters using the tidbcloud_serverless_cluster resource, including creation, modification (display name, spending limit, endpoints, backups), import, and deletion.
  • New Network Resource Documentation: Introduced documentation for new Terraform resources related to network configurations for Dedicated clusters: tidbcloud_dedicated_network_container, tidbcloud_dedicated_vpc_peering, and tidbcloud_dedicated_private_endpoint_connection, detailing their creation, import, and deletion processes.
  • New Serverless Branch and Export Documentation: Added documentation for managing Serverless branches (tidbcloud_serverless_branch) and exports (tidbcloud_serverless_export) via Terraform, covering creation, import, and deletion.
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.

Footnotes

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

Copy link

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

@FingerLeader
Copy link
Contributor Author

/gemini review

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

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

@hfxsd hfxsd self-assigned this Jun 16, 2025
@hfxsd hfxsd added translation/doing This PR's assignee is translating this PR. translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. translation/doing This PR's assignee is translating this PR. labels Jun 16, 2025
@hfxsd hfxsd self-requested a review June 16, 2025 11:14
@hfxsd
Copy link
Collaborator

hfxsd commented Jun 16, 2025

/bot-review

Copy link

✅ AI review completed, 33 comments generated.

…-resource.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link

ti-chi-bot bot commented Jun 16, 2025

[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:

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

@FingerLeader
Copy link
Contributor Author

The bot suggestions are not good, I only accept one typo

Now you can manage the imported dedicated network container with Terraform.

## Delete a Dedicated network container
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. However, you must ensure that the status of the dedicated network container is not `ACTIVE`. If it is `ACTIVE`, you cannot delete it.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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. However, you must ensure that the status of the dedicated network container is not `ACTIVE`. If it is `ACTIVE`, you cannot delete it.
To delete a TiDB Cloud Dedicated cluster, you can delete the configuration of the `tidbcloud_dedicated_cluster` resource, and then use the `terraform apply` command to destroy the resource. However, ensure that the status of the dedicated network container is NOT `ACTIVE`. If it is `ACTIVE`, you cannot delete it.

hfxsd and others added 5 commits June 17, 2025 10:50
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Signed-off-by: FingerLeader <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution This PR is from a community contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/no-need No need to translate this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants