Skip to content

Commit 06f023d

Browse files
DOCS-15163 Clarify keyVaultNamespace and tutorial files (#2342)
* clarifying keyVaultNamespace and separate files * csfle clarifications * qe clarifications * build errors * typo * typo * feedback
1 parent ab91e88 commit 06f023d

File tree

20 files changed

+357
-16
lines changed

20 files changed

+357
-16
lines changed

source/core/csfle/tutorials/aws/aws-automatic.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ Create the Application
9393

9494
.. step:: Create a Unique Index on your {+key-vault-long+}
9595

96+
.. _csfle-aws-create-index:
97+
9698
.. include:: /includes/tutorials/automatic/aws/key-vault-index.rst
9799

98100
.. step:: Create a New {+dek-long+}
@@ -135,6 +137,44 @@ Create the Application
135137

136138
.. step:: Configure the MongoClient
137139

140+
.. tip::
141+
142+
Follow the remaining steps in this tutorial in a separate file
143+
from the one created in the previous steps.
144+
145+
.. tabs-drivers::
146+
147+
.. tab::
148+
:tabid: java-sync
149+
150+
To view the complete code for this file, see
151+
`our Github repository <{+sample-app-url-csfle+}/java/aws/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
152+
153+
.. tab::
154+
:tabid: nodejs
155+
156+
To view the complete code for this file, see
157+
`our Github repository <{+sample-app-url-csfle+}/node/aws/reader/insert_encrypted_document.js>`__.
158+
159+
.. tab::
160+
:tabid: python
161+
162+
To view the complete code for this file, see
163+
`our Github repository <{+sample-app-url-csfle+}/python/aws/reader/insert_encrypted_document.py>`__.
164+
165+
.. tab::
166+
:tabid: csharp
167+
168+
To view the complete code for this file, see
169+
`our Github repository <{+sample-app-url-csfle+}/dotnet/aws/reader/CSFLE/InsertEncryptedDocument.cs>`__
170+
171+
.. tab::
172+
:tabid: go
173+
174+
To view the complete code for this file, see
175+
`our Github repository <{+sample-app-url-csfle+}/go/aws/reader/insert-encrypted-document.go>`__.
176+
177+
138178
.. include:: /includes/tutorials/automatic/aws/client.rst
139179

140180
.. step:: Insert a Document with Encrypted Fields

source/core/csfle/tutorials/azure/azure-automatic.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ Create the Application
9090
:style: normal
9191

9292
.. step:: Create a Unique Index on your {+key-vault-long+}
93+
94+
.. _csfle-azure-create-index:
9395

9496
.. include:: /includes/tutorials/automatic/azure/key-vault-index.rst
9597

@@ -133,6 +135,43 @@ Create the Application
133135

134136
.. step:: Configure the MongoClient
135137

138+
.. tip::
139+
140+
Follow the remaining steps in this tutorial in a separate file from the
141+
one created in the previous steps.
142+
143+
.. tabs-drivers::
144+
145+
.. tab::
146+
:tabid: java-sync
147+
148+
To view the complete code for this file, see
149+
`our Github repository <{+sample-app-url-csfle+}/java/azure/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
150+
151+
.. tab::
152+
:tabid: nodejs
153+
154+
To view the complete code for this file, see
155+
`our Github repository <{+sample-app-url-csfle+}/node/azure/reader/insert_encrypted_document.js>`__.
156+
157+
.. tab::
158+
:tabid: python
159+
160+
To view the complete code for this file, see
161+
`our Github repository <{+sample-app-url-csfle+}/python/azure/reader/insert_encrypted_document.py>`__.
162+
163+
.. tab::
164+
:tabid: csharp
165+
166+
To view the complete code for this file, see
167+
`our Github repository <{+sample-app-url-csfle+}/dotnet/azure/reader/CSFLE/InsertEncryptedDocument.cs>`__
168+
169+
.. tab::
170+
:tabid: go
171+
172+
To view the complete code for this file, see
173+
`our Github repository <{+sample-app-url-csfle+}/go/azure/reader/insert-encrypted-document.go>`__.
174+
136175
.. include:: /includes/tutorials/automatic/azure/client.rst
137176

138177
.. step:: Insert a Document with Encrypted Fields

source/core/csfle/tutorials/gcp/gcp-automatic.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ your application to see relevant code samples.
9494

9595
.. step:: Create a Unique Index on your {+key-vault-long+}
9696

97+
.. _csfle-gcp-create-index:
98+
9799
.. include:: /includes/tutorials/automatic/gcp/key-vault-index.rst
98100

99101
.. step:: Create a {+dek-long+}
@@ -136,6 +138,43 @@ your application to see relevant code samples.
136138

137139
.. step:: Configure the MongoClient
138140

141+
.. tip::
142+
143+
Follow the remaining steps in this tutorial in a separate file
144+
from the one created in the previous steps.
145+
146+
.. tabs-drivers::
147+
148+
.. tab::
149+
:tabid: java-sync
150+
151+
To view the complete code for this file, see
152+
`our Github repository <{+sample-app-url-csfle+}/java/gcp/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
153+
154+
.. tab::
155+
:tabid: nodejs
156+
157+
To view the complete code for this file, see
158+
`our Github repository <{+sample-app-url-csfle+}/node/gcp/reader/insert_encrypted_document.js>`__.
159+
160+
.. tab::
161+
:tabid: python
162+
163+
To view the complete code for this file, see
164+
`our Github repository <{+sample-app-url-csfle+}/python/gcp/reader/insert_encrypted_document.py>`__.
165+
166+
.. tab::
167+
:tabid: csharp
168+
169+
To view the complete code for this file, see
170+
`our Github repository <{+sample-app-url-csfle+}/dotnet/gcp/reader/CSFLE/InsertEncryptedDocument.cs>`__
171+
172+
.. tab::
173+
:tabid: go
174+
175+
To view the complete code for this file, see
176+
`our Github repository <{+sample-app-url-csfle+}/go/gcp/reader/insert-encrypted-document.go>`__.
177+
139178
.. include:: /includes/tutorials/automatic/gcp/client.rst
140179

141180
.. step:: Insert a Document with Encrypted Fields

source/core/csfle/tutorials/kmip/kmip-automatic.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ your application to see relevant code samples.
9595

9696
.. step:: Create a Unique Index on Your Key Vault Collection
9797

98+
.. _csfle-kmip-create-index:
99+
98100
.. include:: /includes/tutorials/automatic/kmip/key-vault-index.rst
99101

100102
.. step:: Create a {+dek-long+}
@@ -137,6 +139,43 @@ your application to see relevant code samples.
137139

138140
.. step:: Configure the MongoClient
139141

142+
.. tip::
143+
144+
Follow the remaining steps in this tutorial in a separate file
145+
from the one created in the previous steps.
146+
147+
.. tabs-drivers::
148+
149+
.. tab::
150+
:tabid: java-sync
151+
152+
To view the complete code for this file, see
153+
`our Github repository <{+sample-app-url-csfle+}/java/kmip/reader/src/main/java/com/mongodb/csfle/InsertEncryptedDocument.java>`__.
154+
155+
.. tab::
156+
:tabid: nodejs
157+
158+
To view the complete code for this file, see
159+
`our Github repository <{+sample-app-url-csfle+}/node/kmip/reader/insert_encrypted_document.js>`__.
160+
161+
.. tab::
162+
:tabid: python
163+
164+
TTo view the complete code for this file, see
165+
`our Github repository <{+sample-app-url-csfle+}/python/kmip/reader/insert_encrypted_document.py>`__.
166+
167+
.. tab::
168+
:tabid: csharp
169+
170+
To view the complete code for this file, see
171+
`our Github repository <{+sample-app-url-csfle+}/dotnet/kmip/reader/CSFLE/InsertEncryptedDocument.cs>`__
172+
173+
.. tab::
174+
:tabid: go
175+
176+
To view the complete code for this file, see
177+
`our Github repository <{+sample-app-url-csfle+}/go/kmip/reader/insert-encrypted-document.go>`__.
178+
140179
.. include:: /includes/tutorials/automatic/kmip/client.rst
141180

142181
.. step:: Insert a Document with Encrypted Fields

source/core/queryable-encryption/tutorials/aws/aws-automatic.txt

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,49 @@ Create the Application
142142

143143
.. step:: Configure your MongoClient for Encrypted Reads and Writes
144144

145+
.. tip::
146+
147+
Follow the remaining steps in this tutorial in a separate file
148+
from the one created in the previous steps.
149+
150+
.. tabs-drivers::
151+
152+
.. tab::
153+
:tabid: shell
154+
155+
To view the complete code for this file, see
156+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/mongosh/aws/reader/insert_encrypted_document.js>`__.
157+
158+
.. tab::
159+
:tabid: nodejs
160+
161+
To view the complete code for this file, see
162+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/node/aws/reader/insert_encrypted_document.js>`__.
163+
164+
.. tab::
165+
:tabid: python
166+
167+
To view the complete code for this file, see
168+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/python/aws/reader/insert_encrypted_document.py>`__.
169+
170+
.. tab::
171+
:tabid: java-sync
172+
173+
To view the complete code for this file, see
174+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/java/aws/reader/src/main/java/com/mongodb/qe/InsertEncryptedDocument.java>`__.
175+
176+
.. tab::
177+
:tabid: go
178+
179+
To view the complete code for this file, see
180+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/go/aws/reader/insert-encrypted-document.go>`__.
181+
182+
.. tab::
183+
:tabid: csharp
184+
185+
To view the complete code for this file, see
186+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/dotnet/aws/reader/QueryableEncryption/InsertEncryptedDocument.cs>`__.
187+
145188
.. include:: /includes/queryable-encryption/tutorials/automatic/aws/client.rst
146189

147190
.. step:: Insert a Document with Encrypted Fields

source/core/queryable-encryption/tutorials/azure/azure-automatic.txt

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,49 @@ Create the Application
141141

142142
.. step:: Configure your MongoClient for Encrypted Reads and Writes
143143

144+
.. tip::
145+
146+
Follow the remaining steps in this tutorial in a separate file
147+
from the one created in the previous steps.
148+
149+
.. tabs-drivers::
150+
151+
.. tab::
152+
:tabid: shell
153+
154+
To view the complete code for this file, see
155+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/mongosh/azure/reader/insert_encrypted_document.js>`__.
156+
157+
.. tab::
158+
:tabid: nodejs
159+
160+
To view the complete code for this file, see
161+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/node/azure/reader/insert_encrypted_document.js>`__.
162+
163+
.. tab::
164+
:tabid: python
165+
166+
To view the complete code for this file, see
167+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/python/azure/reader/insert_encrypted_document.py>`__.
168+
169+
.. tab::
170+
:tabid: java-sync
171+
172+
To view the complete code for this file, see
173+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/java/azure/reader/src/main/java/com/mongodb/qe/InsertEncryptedDocument.java>`__.
174+
175+
.. tab::
176+
:tabid: go
177+
178+
To view the complete code for this file, see
179+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/go/azure/reader/insert-encrypted-document.go>`__.
180+
181+
.. tab::
182+
:tabid: csharp
183+
184+
To view the complete code for this file, see
185+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/dotnet/azure/reader/QueryableEncryption/InsertEncryptedDocument.cs>`__.
186+
144187
.. include:: /includes/queryable-encryption/tutorials/automatic/azure/client.rst
145188

146189
.. step:: Insert a Document with Encrypted Fields

source/core/queryable-encryption/tutorials/gcp/gcp-automatic.txt

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,49 @@ your application to see relevant code samples.
144144

145145
.. step:: Configure your MongoClient for Encrypted Reads and Writes
146146

147+
.. tip::
148+
149+
Follow the remaining steps in this tutorial in a separate file
150+
from the one created in the previous steps.
151+
152+
.. tabs-drivers::
153+
154+
.. tab::
155+
:tabid: shell
156+
157+
To view the complete code for this file, see
158+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/mongosh/gcp/reader/insert_encrypted_document.js>`__.
159+
160+
.. tab::
161+
:tabid: nodejs
162+
163+
To view the complete code for this file, see
164+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/node/gcp/reader/insert_encrypted_document.js>`__.
165+
166+
.. tab::
167+
:tabid: python
168+
169+
To view the complete code for this file, see
170+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/python/gcp/reader/insert_encrypted_document.py>`__.
171+
172+
.. tab::
173+
:tabid: java-sync
174+
175+
To view the complete code for this file, see
176+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/java/gcp/reader/src/main/java/com/mongodb/qe/InsertEncryptedDocument.java>`__.
177+
178+
.. tab::
179+
:tabid: go
180+
181+
To view the complete code for this file, see
182+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/go/gcp/reader/insert-encrypted-document.go>`__.
183+
184+
.. tab::
185+
:tabid: csharp
186+
187+
To view the complete code for this file, see
188+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/dotnet/gcp/reader/QueryableEncryption/InsertEncryptedDocument.cs>`__.
189+
147190
.. include:: /includes/queryable-encryption/tutorials/automatic/gcp/client.rst
148191

149192
.. step:: Insert a Document with Encrypted Fields

0 commit comments

Comments
 (0)