forked from cockroachdb/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Lauren
committed
Sep 3, 2020
1 parent
3782674
commit 50694a2
Showing
39 changed files
with
2,290 additions
and
330 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
For examples of advanced `BACKUP` and `RESTORE` use cases, see [Back up and Restore Data - Advanced Options](backup-and-restore-advanced-options.html). Advanced examples include: | ||
For examples of advanced `BACKUP` and `RESTORE` use cases, see: | ||
|
||
- [Incremental backups with a specified destination](backup-and-restore-advanced-options.html#incremental-backups-with-explicitly-specified-destinations) | ||
- [Backup with revision history and point-in-time restore](backup-and-restore-advanced-options.html#backup-with-revision-history-and-point-in-time-restore) | ||
- [Locality-aware backup and restore](backup-and-restore-advanced-options.html#locality-aware-backup-and-restore) | ||
- [Encrypted backup and restore](backup-and-restore-advanced-options.html#encrypted-backup-and-restore) | ||
- [Restore into a different database](backup-and-restore-advanced-options.html#restore-into-a-different-database) | ||
- [Remove the foreign key before restore](backup-and-restore-advanced-options.html#remove-the-foreign-key-before-restore) | ||
- [Restoring users from `system.users` backup](backup-and-restore-advanced-options.html#restoring-users-from-system-users-backup) | ||
- [Incremental backups with a specified destination](take-full-and-incremental-backups.html#incremental-backups-with-explicitly-specified-destinations) | ||
- [Backup with revision history and point-in-time restore](take-backups-with-revision-history-and-restore-from-a-point-in-time.html) | ||
- [Locality-aware backup and restore](take-and-restore-locality-aware-backups.html) | ||
- [Encrypted backup and restore](take-and-restore-encrypted-backups.html) | ||
- [Restore into a different database](restore.html#restore-into-a-different-database) | ||
- [Remove the foreign key before restore](restore.html#remove-the-foreign-key-before-restore) | ||
- [Restoring users from `system.users` backup](restore.html#restoring-users-from-system-users-backup) |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
You can encrypt full or incremental backups by using the [`encryption_passphrase` option](backup.html#with-encryption-passphrase). Files written by the backup (including `BACKUP` manifests and data files) are encrypted using the specified passphrase to derive a key. To restore the encrypted backup, the same `encryption_passphrase` option (with the same passphrase) must included in the [`RESTORE`](restore.html) statement. | ||
|
||
When used with [incremental backups](backup.html#incremental-backups), the `encryption_passphrase` option is applied to all the [backup file URLs](backup.html#backup-file-urls), which means the same passphrase must be used when appending another incremental backup to an existing backup. Similarly, when used with [locality-aware backups](backup-and-restore-advanced-options.html#locality-aware-backup-and-restore), the passphrase provided is applied to files in all localities. | ||
When used with [incremental backups](backup.html#incremental-backups), the `encryption_passphrase` option is applied to all the [backup file URLs](backup.html#backup-file-urls), which means the same passphrase must be used when appending another incremental backup to an existing backup. Similarly, when used with [locality-aware backups](take-and-restore-locality-aware-backups.html), the passphrase provided is applied to files in all localities. | ||
|
||
Encryption is done using [AES-256-GCM](https://en.wikipedia.org/wiki/Galois/Counter_Mode), and GCM is used to both encrypt and authenticate the files. A random [salt](https://en.wikipedia.org/wiki/Salt_(cryptography)) is used to derive a once-per-backup [AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) key from the specified passphrase, and then a random [initialization vector](https://en.wikipedia.org/wiki/Initialization_vector) is used per-file. CockroachDB uses [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) with 64,000 iterations for the key derivation. | ||
|
||
{{site.data.alerts.callout_info}} | ||
`BACKUP` and `RESTORE` will use more memory when using encryption, as both the plain-text and cipher-text of a given file are held in memory during encryption and decryption. | ||
{{site.data.alerts.end}} | ||
|
||
For an example of an encrypted backup, see [Create an encrypted backup](backup-and-restore-advanced-options.html#create-an-encrypted-backup). | ||
For an example of an encrypted backup, see [Create an encrypted backup](take-and-restore-encrypted-backups.html). |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.