[DOCS-8856] Public API changes for encrypted backup Created: 24/Sep/16  Updated: 17/Jan/17  Resolved: 13/Jan/17

Status: Closed
Project: Documentation
Component/s: Cloud Manager, Ops Manager
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Bob Grabar Assignee: Robert Justice (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
Participants:
Days since reply: 7 years, 4 weeks, 2 days ago
Epic Link: C/OM Update API
Story Points: 1

 Description   

According to CLOUDP-17925, the Cloud team will make changes to the Public API to support encrypted backups, including:
Initiating (how?) encrypted backups
Initiating requests to rotate the key
Encryption fields/flags in backup-related resources

Changes needed:

  • Bug on the documentation: "Backup Configurations" -> "storageEngine" field should be "storageEngineName"
  • "Backup Configurations" -> New field "encryptionEnabled" indicates whether or not backup configuration is encrypted (boolean)
  • "Snapshots" -> New field "parts.encryptionEnabled" indicates whether or not snapshot data is encrypted (boolean)
  • "Snapshots" -> New field "parts.masterKeyUUID" is set with the masterKeyUUID of the encrypted data if encryption is enabled (String)
  • "Restores Jobs" -> New field "encryptionEnabled" indicates whether or not restored snapshot data is encrypted (boolean)
  • "Restore Jobs" -> New field "masterKeyUUID" is set with the masterKeyUUID of the encrypted data if encryption is enabled (String)
  • Add API changes for getting and rotating backup configuration keys...

Note - all of these are Ops Manager Only. The fields labeled encryptionEnabled will always be false in Cloud Manager, and the masterKeyUUID field will therefore never appear.



 Comments   
Comment by Githook User [ 17/Jan/17 ]

Author:

{u'name': u'Robert Justice', u'email': u'robertjustice@Roberts-MacBook-Air-2.local'}

Message: DOCS-8856: Updated API docs for backup configurations, snapshots, and restore jobs for encrypted backup support in 3.4
Branch: v3.4
https://github.com/10gen/mms-docs/commit/c9ca3a5fbd693c19ef648d54b071104441b47099

Comment by Githook User [ 17/Jan/17 ]

Author:

{u'name': u'Robert Justice', u'email': u'robertjustice@Roberts-MacBook-Air-2.local'}

Message: DOCS-8856: Updated API docs for backup configurations, snapshots, and restore jobs for encrypted backup support in 3.4
Branch: master
https://github.com/10gen/mms-docs/commit/ae492e4d4fac5cfbe2ce4f5fb4ad3a00551963c3

Generated at Thu Feb 08 07:57:06 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.