[DOCS-15163] [Drivers] Errors in Doc Created: 09/Mar/22  Updated: 24/May/23  Resolved: 11/Jan/23

Status: Closed
Project: Documentation
Component/s: drivers
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major - P3
Reporter: Greg Cox Assignee: Jordan Smith
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 4 weeks ago

 Description   

https://docs.mongodb.com/drivers/security/client-side-field-level-encryption-local-key-to-kms/

Section 4 - "Create a New Data Encryption Key" 

Java Sync instructions missing

 
String keyVaultNamespace = "admin.datakeys";
ClientEncryption clientEncryption = ClientEncryptions.create(ClientEncryptionSettings.builder() ...
 
and wrong parenthesis and comma positioning:
 

BsonString masterKeyArn = new BsonString("<Master Key ARN>"); // e.g. "arn:aws:kms:us-east-2:111122223333:alias/test-key"
BsonString masterKeyRegion = new BsonString("<Master Key Region>")
DataKeyOptions dataKeyOptions = new DataKeyOptions().masterKey(
new BsonDocument()
.append("key", masterKeyArn));
.append("region", masterKeyRegion)

should be

BsonString masterKeyArn = new BsonString("<Master Key ARN>"); // e.g. "arn:aws:kms:us-east-2:111122223333:alias/test-key"
BsonString masterKeyRegion = new BsonString("<Master Key Region>")
DataKeyOptions dataKeyOptions = new DataKeyOptions().masterKey(
new BsonDocument()
.append("key", masterKeyArn)
.append("region", masterKeyRegion));


 Comments   
Comment by Githook User [ 11/Jan/23 ]

Author:

{'name': 'Jordan Smith', 'email': '45415425+jordan-smith721@users.noreply.github.com', 'username': 'jordan-smith721'}

Message: DOCS-15163 Clarify keyVaultNamespace and tutorial files (#2342)

  • clarifying keyVaultNamespace and separate files
  • csfle clarifications
  • qe clarifications
  • build errors
  • typo
  • typo
Comment by Greg Cox [ 10/Jan/23 ]

Hi jordan.smith@mongodb.com Yes this sounds perfect thanks

Comment by Jordan Smith [ 06/Jan/23 ]

Hi greg.cox@mongodb.com, apologies on the late response to this ticket, we had some issues with it not showing up in our prioritization sheet.

The page that you reported this issue on no longer exists, and we have moved our KMS tutorials for CSFLE to the following page: https://www.mongodb.com/docs/manual/core/csfle/tutorials/

 

We would like to still address your initial concern regarding the keyVaultNamespace. Currently it is instantiated in an earlier step on the tutorials, but not used until several steps later, which could be confusing for any readers who do not follow the full tutorial. As a solution to this, we are proposing to add a callout to the text in the steps where keyVaultNamespace is used, informing the user that it was instantiated in an earlier text.

 

Would this be a sufficient fix for this ticket, given the changes to the documentation since this was opened?

Thanks!

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