[DOCS-13121] Investigate changes in SERVER-44044: Remove unused second parameter from KeyVault.createDataKey() Created: 16/Oct/19  Updated: 13/Nov/23  Resolved: 04/Feb/20

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: 4.3.1, 4.2.3, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Ravind Kumar (Inactive)
Resolution: Fixed Votes: 0
Labels: docs-4.2-client-side-encryption
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-44044 Remove unused second parameter from K... Closed
Participants:
Days since reply: 4 years, 1 week, 1 day ago
Epic Link: DOCS: 4.4 Server Release Work
Story Points: 2

 Description   

Description

Downstream Change Summary

Update documentation for KeyVault.createKey() to note that CMK is not required/rejected for local KMS.

Check the server-side commit to validate workflow before documenting.

Description of Linked Ticket

In the 4.2 mongo shell, KeyVault.createKey() takes three parameters. The second parameter customerMasterKey indicates that the user should set a CMK for the local KMS.

From discussions, this appears to be a vestigial parameter in the context of the local KMS that is ultimately not used. The generateDataKey method eventually boils down to an kms_local.encrypt where the specified CMK is unused.

The documentation will be modified to have users input an empty string ("") for the parameter. To clean this up, the second parameter should be optional (or rejected?) when kms = "local" .

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 04/Feb/20 ]

Author:

{'username': 'rkumar-mongo', 'name': 'Ravind Kumar', 'email': 'ravind.kumar@mongodb.com'}

Message: DOCS-13121: Remove unused second param for 'local' KMS on KeyVault.createKey
Branch: master
https://github.com/mongodb/docs/commit/89f84cefe2f3cf07e04f786334fc7d5929cb14fe

Comment by Ravind Kumar (Inactive) [ 29/Jan/20 ]

Blocked until resources free up to resolve this work.

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