-
Notifications
You must be signed in to change notification settings - Fork 705
add Premium feature documentation #21926
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
base: release-8.5
Are you sure you want to change the base?
Conversation
Signed-off-by: longjun <[email protected]>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
Summary of ChangesHello @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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
# 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word 'versions' is redundant when listing the TLS versions. Removing it will make the sentence more concise.
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
}); | ||
``` | ||
|
||
You can click **show example usage** to view detailed code examples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
### 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word 'versions' is redundant here and can be removed to make the sentence more concise.
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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word 'currently' is redundant and can be removed for conciseness.
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). |
Warning Gemini encountered an error creating the review. You can try again by commenting |
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>
@ljun0712: The following test failed, say
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. |
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?