Add explanation to dual-layer encryption #22210
Conversation
Signed-off-by: Xiaoguang Sun <sunxiaoguang@gmail.com>
Summary of ChangesHello @sunxiaoguang, 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 enhances the TiDB Cloud security documentation by introducing a comprehensive explanation of dual-layer encryption. The update aims to provide users with a clearer understanding of how their data is protected at rest, detailing the mechanisms and applicability across different TiDB Cloud cluster types. This improves the clarity and completeness of the security concepts documentation. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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
|
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a helpful explanation of dual-layer encryption to the security concepts documentation. My review provides a few suggestions to improve the clarity, conciseness, and flow of the new content, ensuring it aligns with the repository's style guide. The proposed changes aim to make the explanation of the two encryption layers more explicit and improve overall readability.
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>
lilin90
added
area/tidb-cloud
ti-chi-bot
bot
removed
the
missing-translation-status
|
|
||
| - Dual-layer encryption is disabled by default for {{{ .starter }}} clusters and enabled by default for {{{ .essential }}} clusters. | ||
|
|
||
| - Dual-layer encryption is mandatory for TiDB Cloud Dedicated clusters. |
There was a problem hiding this comment.
This sentence is ambiguous and can be interpreted in two different ways:
- Dual-layer encryption is enabled by default for TiDB Cloud Dedicated clusters, and users should not disable it.
- Dual-layer encryption is enabled by default for TiDB Cloud Dedicated clusters, and users cannot disable it.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
|
||
| **Dual-layer encryption** | ||
|
|
||
| - Dual-layer encryption protects data with two or more independent layers of encryption. This method provides enhanced security by protecting against the compromise of any single encryption layer. |
There was a problem hiding this comment.
Not sure if we need to remove "or more" here as there are only two layers in the context of this doc
|
|
||
| - Dual-layer encryption is disabled by default for {{{ .starter }}} clusters and enabled by default for {{{ .essential }}} clusters. | ||
|
|
||
| - Dual-layer encryption is mandatory for TiDB Cloud Dedicated clusters. |
There was a problem hiding this comment.
This sentence is ambiguous and can be interpreted in two different ways:
- Dual-layer encryption is enabled by default for TiDB Cloud Dedicated clusters, and users should not disable it.
- Dual-layer encryption is enabled by default for TiDB Cloud Dedicated clusters, and users cannot disable it.
3 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Dual-layer encryption is mentioned in https://www.pingcap.com/tidb-cloud-essential-pricing-details/ but it is not explained anywhere in documentation. So this PR adds the explanation for it.
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?