DOC-14248-Encryption-At-Rest-Backup1#4131
Draft
supritha-kumar wants to merge 2 commits into
Draft
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the Backup & Restore management documentation to add guidance for “encryption at rest” support in backup repositories and to refresh various UI/prose descriptions in the same page.
Changes:
- Adds new sections describing backup encryption-at-rest concepts, supported workflows, repository configuration, and restore behavior for encrypted repositories.
- Updates a number of UI-instruction sentences (including terminology such as “dropdown menu”) and revises various occurrences of “one” → “1”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| * Key Encryption Keys (KEKs) — The repository encryption key is itself encrypted (enveloped) using either a passphrase-derived key or an external key from a Key Management Service (KMS). | ||
|
|
||
| For more information about the core encryption-at-rest architecture, including DEKs and KEKs, see xref:learn/security/encryption-at-rest.adoc[Encryption at Rest]. |
| See xref:backup-restore/cbbackupmgr-encryption.adoc[cbbackupmgr encryption] for details. | ||
|
|
||
| * Backup Service — The Backup Service UI in Couchbase Web Console provides encryption options when creating a repository. | ||
| You can specify the KMS key URL, region, endpoint, and authentication type directly in the Create Repository dialog. |
| + | ||
| Click the control that appears at the right-hand side of the *Select plan* dialog's interactive text-field. | ||
| A pull-down menu appears with the following options: | ||
| A dropdown menu appears with the following options: |
Comment on lines
+176
to
+177
| Alternatively, to choose a specific frequency, access the control on the *Period* field. | ||
| A dropdown menu appears: |
| image::manage-backup-restore/periodPullDownMenu.png[,420,align=left] | ||
| + | ||
| From the pull-down menu, select *Hours*, to set the frequency is in units of hours. | ||
| From the dropdown menu, select *Hours*, to set the frequency is in units of hours. |
| These can be used to search for a specific document within the repository. | ||
| Optionally, the subset of backups within the repository can be specified, by means of the *Start* and *End* fields. | ||
| For example, by accessing the control at the left-hand side of the *Start* field, a pull-down menu is displayed: this lists backups any one of which can be used as the starting point for the search. | ||
| For example, by accessing the control at the left-hand side of the *Start* field, a dropdown menu is displayed: this lists backups any 1 of which can be used as the starting point for the search. |
|
|
||
| . To specify the first backup, access the interactive control at the right-hand side of the *Start* field. | ||
| This produces a pull-down menu that displays all available backups for this repository: | ||
| This produces a dropdown menu that displays all available backups for this repository: |
|
|
||
| . Select a backup that will be the starting backup for the merge. | ||
| Then, access the control at the right-hand side of the *End* field, and select, from its pull-down menu, a backup that will be the ending backup for the merge. | ||
| Then, access the control at the right-hand side of the *End* field, and select, from its dropdown menu, a backup that will be the ending backup for the merge. |
| Then, access the control at the right-hand side of the *End* field, and select, from its dropdown menu, a backup that will be the ending backup for the merge. | ||
|
|
||
| . Left-click on the *Merge Backups* button, at the lower right of the dialog. | ||
| The dialog now disappears, and any you will receive a console notification stating that you have triggered a merge. |
| image:manage-backup-restore/scheduleOptionsMenu.png[,420,align=left] | ||
|
|
||
| The pull-down menu thus displayed contains three kinds of scheduling option. | ||
| The dropdown menu thus displayed contains three kinds of scheduling option. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.