Add missing kms option to the RESTORE page

[lin-crl]

Jianwei Lin (lin-crl) commented:

Page: https://cockroachlabs.com/docs/v23.2/restore.html

What is the reason for your feedback?

[x] Missing the information I need

[ ] Too complicated

[ ] Out of date

[ ] Something is broken

[ ] Other

Additional details

It's missing kms options. A customer asks if it's possible to restore using KMS. The document doesn't show the option and gives them the impression that they cannot restore using KMS.

Jira Issue: DOC-10161

[lin-crl]

Running \h RESTORE does show KMS is an option

>\ h RESTORE
....
 Options:
   into_db: specify target database
   skip_missing_foreign_keys: remove foreign key constraints before restoring
   skip_missing_sequences: ignore sequence dependencies
   skip_missing_views: skip restoring views because of dependencies that cannot be restored
   skip_missing_sequence_owners: remove sequence-table ownership dependencies before restoring
   skip_missing_udfs: skip restoring
   encryption_passphrase=passphrase: decrypt BACKUP with specified passphrase
   kms="[kms_provider]://[kms_host]/[master_key_identifier]?[parameters]" : decrypt backups using KMS

[exalate-issue-sync]

Shannon Bradshaw (shannonbradshaw) commented:
I realize this is a SQL page, but the gap described is more of a DR question.

[exalate-issue-sync]

Kathryn May (kathancox) commented:
I’ll take a look, though we do list this on https://www.cockroachlabs.com/docs/stable/take-and-restore-encrypted-backups and the backup and restore overview page: https://www.cockroachlabs.com/docs/stable/backup-and-restore-overview#backup-and-restore-support .

I’ll make sure the {{kms}} option is added to the table with links out to the relevant pages.