Skip to content

Commit a9deb52

Browse files
author
Dave Cuthbert
authored
DOCSP-23879 csfle build failures (#223)
1 parent 4f14c9e commit a9deb52

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

source/includes/steps-createkey-aws-kms.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ content: |
2323
*Read* permissions for the KMS service.
2424
2525
In ``mongosh``, create a new
26-
:ref:`ClientSideFieldLevelEncryptionOptions` variable for storing the
26+
:ref:`autoEncryptionOpts` variable for storing the
2727
client-side field level encryption configuration, which contains these
2828
credentials:
2929
3030
.. code-block:: javascript
3131
32-
var ClientSideFieldLevelEncryptionOptions = {
32+
var autoEncryptionOpts = {
3333
"keyVaultNamespace" : "encryption.__dataKeys",
3434
"kmsProviders" : {
3535
"aws" : {
@@ -50,15 +50,15 @@ content: |
5050
5151
In ``mongosh``, use the :method:`Mongo()<Mongo()>` constructor to
5252
establish a database connection to the target cluster. Specify the
53-
:ref:`ClientSideFieldLevelEncryptionOptions` document as the second
53+
:ref:`autoEncryptionOpts` document as the second
5454
parameter to the :method:`Mongo()<Mongo()>` constructor to configure
5555
the connection for client-side field level encryption:
5656
5757
.. code-block:: javascript
5858
5959
csfleDatabaseConnection = Mongo(
6060
"mongodb://replaceMe.example.net:27017/?replicaSet=myMongoCluster",
61-
ClientSideFieldLevelEncryptionOptions
61+
autoEncryptionOpts
6262
)
6363
6464
Replace the ``replaceMe.example.net`` :ref:`URI <mongodb-uri>` with

source/includes/steps-createkey-azure-vault.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ content: |
2121
requires a valid Tenant ID, Client ID, and Client Secret.
2222
2323
In ``mongosh``, create a new
24-
:ref:`ClientSideFieldLevelEncryptionOptions` variable for storing the
24+
:ref:`autoEncryptionOpts` variable for storing the
2525
client-side field level encryption configuration, which contains these
2626
credentials:
2727
2828
.. code-block:: javascript
2929
30-
var ClientSideFieldLevelEncryptionOptions = {
30+
var autoEncryptionOpts = {
3131
"keyVaultNamespace" : "encryption.__dataKeys",
3232
"kmsProviders" : {
3333
"azure" : {
@@ -49,15 +49,15 @@ content: |
4949
5050
In ``mongosh``, use the :method:`Mongo()<Mongo()>` constructor to
5151
establish a database connection to the target cluster. Specify the
52-
:ref:`ClientSideFieldLevelEncryptionOptions` document as the second
52+
:ref:`autoEncryptionOpts` document as the second
5353
parameter to the :method:`Mongo()<Mongo()>` constructor to configure
5454
the connection for client-side field level encryption:
5555
5656
.. code-block:: javascript
5757
5858
csfleDatabaseConnection = Mongo(
5959
"mongodb://replaceMe.example.net:27017/?replicaSet=myMongoCluster",
60-
ClientSideFieldLevelEncryptionOptions
60+
autoEncryptionOpts
6161
)
6262
6363
Replace the ``replaceMe.example.net`` :ref:`URI <mongodb-uri>` with

source/includes/steps-createkey-gcp-kms.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ content: |
2121
requires your GCP Email and its associated Private Key.
2222
2323
In ``mongosh``, create a new
24-
:ref:`ClientSideFieldLevelEncryptionOptions` variable for storing the
24+
:ref:`autoEncryptionOpts` variable for storing the
2525
client-side field level encryption configuration, which contains these
2626
credentials:
2727
2828
.. code-block:: javascript
2929
30-
var ClientSideFieldLevelEncryptionOptions = {
30+
var autoEncryptionOpts = {
3131
"keyVaultNamespace" : "encryption.__dataKeys",
3232
"kmsProviders" : {
3333
"gcp" : {
@@ -48,15 +48,15 @@ content: |
4848
4949
In ``mongosh``, use the :method:`Mongo()<Mongo()>` constructor to
5050
establish a database connection to the target cluster. Specify the
51-
:ref:`ClientSideFieldLevelEncryptionOptions` document as the second
51+
:ref:`autoEncryptionOpts` document as the second
5252
parameter to the :method:`Mongo()<Mongo()>` constructor to configure
5353
the connection for client-side field level encryption:
5454
5555
.. code-block:: javascript
5656
5757
csfleDatabaseConnection = Mongo(
5858
"mongodb://replaceMe.example.net:27017/?replicaSet=myMongoCluster",
59-
ClientSideFieldLevelEncryptionOptions
59+
autoEncryptionOpts
6060
)
6161
6262
Replace the ``replaceMe.example.net`` :ref:`URI <mongodb-uri>` with

source/includes/steps-createkey-local-keyfile.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ level: 4
3535
content: |
3636
3737
In ``mongosh``, create a new
38-
:ref:`ClientSideFieldLevelEncryptionOptions` variable for storing the
38+
:ref:`autoEncryptionOpts` variable for storing the
3939
client-side field level encryption configuration, replacing
4040
``MY_LOCAL_KEY`` with the key generated in step 1:
4141
4242
.. code-block:: javascript
4343
44-
var ClientSideFieldLevelEncryptionOptions = {
44+
var autoEncryptionOpts = {
4545
"keyVaultNamespace" : "encryption.__dataKeys",
4646
"kmsProviders" : {
4747
"local" : {
@@ -58,15 +58,15 @@ content: |
5858
5959
In ``mongosh``, use the :method:`Mongo()<Mongo()>` constructor to
6060
establish a database connection to the target cluster. Specify the
61-
:ref:`ClientSideFieldLevelEncryptionOptions` document as the second
61+
:ref:`autoEncryptionOpts` document as the second
6262
parameter to the :method:`Mongo()<Mongo()>` constructor to configure
6363
the connection for client-side field level encryption:
6464
6565
.. code-block:: javascript
6666
6767
csfleDatabaseConnection = Mongo(
6868
"mongodb://replaceMe.example.net:27017/?replicaSet=myMongoCluster",
69-
ClientSideFieldLevelEncryptionOptions
69+
autoEncryptionOpts
7070
)
7171
7272
---

source/reference/methods.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ Connection Methods
384384
If omitted, :method:`Mongo` instantiates a connection to the
385385
localhost interface on the default port ``27017``.
386386

387-
* - ``ClientSideFieldLevelEncryptionOptions``
387+
* - ``autoEncryptionOpts``
388388

389389
- Document
390390

@@ -396,14 +396,14 @@ Connection Methods
396396
:manual:`Client-Side Field Level Encryption
397397
</core/security-client-side-encryption>`.
398398

399-
``ClientSideFieldLevelEncryptionOptions`` overrides the
399+
``autoEncryptionOpts`` overrides the
400400
existing client-side field level encryption configuration of
401401
the database connection. If omitted, :method:`Mongo()`
402402
inherits the client-side field level encryption configuration
403403
of the current database connection.
404404

405405
For documentation of usage and syntax, see
406-
:ref:`ClientSideFieldLevelEncryptionOptions`.
406+
:ref:`autoEncryptionOpts`.
407407

408408
* - :method:`Mongo.getDB()`
409409

0 commit comments

Comments
 (0)