-
Notifications
You must be signed in to change notification settings - Fork 708
Add explanation to dual-layer encryption #22210
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?
Add explanation to dual-layer encryption #22210
Conversation
Signed-off-by: Xiaoguang Sun <[email protected]>
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
|
|
[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 |
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 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.
|
|
||
| - Dual-layer encryption is where two or more independent layers of encryption are enabled to protect against compromises of any one layer of encryption. Using two layers of encryption mitigates threats that come with encrypting data. | ||
|
|
||
| - All persisted data is encrypted-at-rest using the tool of the cloud provider that your cluster is running in. |
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.
For better clarity and adherence to the style guide's preference for active voice (line 43), consider rephrasing this sentence. Using 'encrypted at rest' instead of 'encrypted-at-rest' would also improve consistency with other parts of the document (e.g., line 230).
| - All persisted data is encrypted-at-rest using the tool of the cloud provider that your cluster is running in. | |
| - The cloud provider where your cluster is running encrypts all persisted data at rest using its native tools. |
References
- Passive voice overuse. "The cluster is started by TiUP" → "TiUP starts the cluster" (link)
|
|
||
| - All persisted data is encrypted-at-rest using the tool of the cloud provider that your cluster is running in. | ||
|
|
||
| - With dual-layer encryption enabled, data is automatically encrypted at rest using CMEK or escrow keys. |
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.
This sentence could be clearer about this being the second layer of encryption, building upon the cloud provider's encryption mentioned previously. The suggested phrasing makes this relationship explicit.
| - With dual-layer encryption enabled, data is automatically encrypted at rest using CMEK or escrow keys. | |
| - With dual-layer encryption enabled, TiDB Cloud adds a second layer of security by automatically encrypting data at rest using either CMEK or escrow keys. |
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>
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?