Skip to content

Commit b0370e0

Browse files
DOCS-14648 CSFLE template clarification (#757)
* added note about substitution needed
1 parent f375306 commit b0370e0

File tree

4 files changed

+33
-1
lines changed

4 files changed

+33
-1
lines changed

source/includes/steps-fle-convert-to-a-remote-master-key-aws.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ content: |
7474
7575
2. Next, add your authentication credentials to your CSFLE-enabled client
7676
code:
77+
78+
.. include:: /includes/substitute-placeholders.rst
7779
7880
.. tabs-drivers::
7981
@@ -195,7 +197,9 @@ content: |
195197
196198
2. Once you have the required information, update and run the following code
197199
to generate the new data encryption key:
198-
200+
201+
.. include:: /includes/substitute-placeholders.rst
202+
199203
.. tabs-drivers::
200204
201205
.. tab::

source/includes/steps-fle-convert-to-a-remote-master-key-azure.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ content: |
8181
2. Next, update the KMS Provider configuration in your CSFLE-enabled client
8282
creation code:
8383
84+
.. include:: /includes/substitute-placeholders.rst
85+
8486
.. tabs-drivers::
8587
8688
.. tab::
@@ -247,6 +249,8 @@ content: |
247249
2. Once you have the required information, update and run the following code
248250
to generate a new data encryption key:
249251
252+
.. include:: /includes/substitute-placeholders.rst
253+
250254
.. tabs-drivers::
251255
252256
.. tab::

source/includes/steps-fle-convert-to-a-remote-master-key-gcp.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ content: |
9191
9292
2. Next, add your authentication credentials to your CSFLE-enabled client
9393
code:
94+
95+
.. include:: /includes/substitute-placeholders.rst
9496
9597
.. tabs-drivers::
9698
@@ -256,6 +258,8 @@ content: |
256258
2. Once you have the required information, update and run the following code
257259
to generate a new data encryption key:
258260
261+
.. include:: /includes/substitute-placeholders.rst
262+
259263
.. tabs-drivers::
260264
261265
.. tab::
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. note:: Placeholder Text
2+
3+
You must substitute all text in quotes and angle brackets with
4+
your KMS configuration values.
5+
6+
For example, the Node.js code prompts you to include an email as
7+
follows:
8+
9+
.. code-block:: javascript
10+
:copyable: false
11+
12+
email: "<GCP service account email>"
13+
14+
If your GCP service account email is "[email protected]", you should
15+
substitute the text as follows:
16+
17+
.. code-block:: javascript
18+
:copyable: false
19+
20+

0 commit comments

Comments
 (0)