Skip to content

Conversation

ljun0712
Copy link
Contributor

What is changed, added or deleted? (Required)

add Premium feature documentation

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

Copy link

ti-chi-bot bot commented Oct 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 assign overvenus for approval. 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

@ti-chi-bot ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Oct 16, 2025
Copy link

Summary of Changes

Hello @ljun0712, 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 significantly expands the TiDB Cloud documentation by introducing new guides for Premium cluster features. It covers essential security configurations like IP access lists and TLS connections, provides detailed instructions for connecting to Premium clusters via public endpoints, and clarifies the cluster deletion process. The changes aim to provide a more complete and consistent documentation experience for users of TiDB Cloud Premium.

Highlights

  • New Premium Feature Documentation: Added new documentation files covering key features for TiDB Cloud Premium clusters, including configuring IP access lists, connecting via public endpoints, and managing TLS connections.
  • Updated Connection Guides: Existing connection documentation has been updated to explicitly include TiDB Cloud Premium clusters, ensuring comprehensive guidance across all cluster tiers.
  • TLS Connection Details: A dedicated document for TLS connections to TiDB Cloud Premium clusters has been added, providing detailed steps and code examples for various programming languages and clients.
  • Cluster Deletion Process: New documentation outlines the process for deleting TiDB Cloud clusters, with specific considerations for Premium clusters regarding backups and restoration.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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 configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot ti-chi-bot bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Oct 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.

Code Review

This pull request adds documentation for the new TiDB Cloud Premium feature, including guides for IP access lists, public connections, cluster deletion, and TLS connections. The new content is comprehensive and well-structured. My review focuses on improving clarity, ensuring terminological consistency (using 'Premium' instead of 'Dedicated'), and correcting minor grammatical and formatting issues to align with the repository's style guide. I have provided specific suggestions to enhance readability and correctness.

@@ -0,0 +1,299 @@
---
title: TLS Connections to TiDB Cloud Premium
summary: Introduce TLS connections in TiDB Cloud premium.

Choose a reason for hiding this comment

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

low

The summary could be more descriptive for users. Also, 'premium' should be capitalized to 'Premium' for consistency.

Suggested change
summary: Introduce TLS connections in TiDB Cloud premium.
summary: Learn about TLS connections for TiDB Cloud Premium clusters.


# TLS Connections to TiDB Cloud Premium

On TiDB Cloud, establishing TLS connections is one of the basic security practices for connecting to TiDB Cloud Premium clusters. You can configure multiple TLS connections from your client, application, and development tools to your TiDB Cloud Premium cluster to protect data transmission security. For security reasons, TiDB Cloud Premium only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions.

Choose a reason for hiding this comment

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

low

The word 'versions' is redundant when listing the TLS versions. Removing it will make the sentence more concise.

Suggested change
On TiDB Cloud, establishing TLS connections is one of the basic security practices for connecting to TiDB Cloud Premium clusters. You can configure multiple TLS connections from your client, application, and development tools to your TiDB Cloud Premium cluster to protect data transmission security. For security reasons, TiDB Cloud Premium only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions.
On TiDB Cloud, establishing TLS connections is one of the basic security practices for connecting to TiDB Cloud Premium clusters. You can configure multiple TLS connections from your client, application, and development tools to your TiDB Cloud Premium cluster to protect data transmission security. For security reasons, TiDB Cloud Premium only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1.

}
```

Parameter descriptions:

Choose a reason for hiding this comment

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

low

This line uses a full-width colon () instead of a standard English colon (:).

Suggested change
Parameter descriptions
Parameter descriptions:

});
```

You can click **show example usage** to view detailed code examples.

Choose a reason for hiding this comment

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

low

For consistency with UI element styling, consider using sentence case for this link text, for example, 'Show example usage'.

Suggested change
You can click **show example usage** to view detailed code examples.
You can click **Show example usage** to view detailed code examples.


### Which TLS versions are supported to connect to my TiDB Cloud Premium cluster?

For security reasons, TiDB Cloud Premium only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details.

Choose a reason for hiding this comment

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

low

The word 'versions' is redundant here and can be removed to make the sentence more concise.

Suggested change
For security reasons, TiDB Cloud Premium only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details.
For security reasons, TiDB Cloud Premium only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details.


No.

TiDB Cloud Premium only supports one-way TLS authentication, and does not support two-way TLS authentication currently. If you need two-way TLS authentication, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).

Choose a reason for hiding this comment

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

low

The word 'currently' is redundant and can be removed for conciseness.

Suggested change
TiDB Cloud Premium only supports one-way TLS authentication, and does not support two-way TLS authentication currently. If you need two-way TLS authentication, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).
TiDB Cloud Premium only supports one-way TLS authentication, and does not support two-way TLS authentication. If you need two-way TLS authentication, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).

Copy link

Warning

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

@ljun0712 ljun0712 requested review from lilin90 and qqqdan October 16, 2025 13:21
ljun0712 and others added 10 commits October 16, 2025 22:39
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copy link

ti-chi-bot bot commented Oct 16, 2025

@ljun0712: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 22cc932 link true /test pull-verify

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@lilin90 lilin90 added the translation/no-need No need to translate this PR. label Oct 20, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Oct 20, 2025
@lilin90 lilin90 added missing-translation-status This PR does not have translation status info. area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. and removed missing-translation-status This PR does not have translation status info. labels Oct 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. size/XL Denotes a PR that changes 500-999 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.

2 participants