Skip to content

Commit 569e1af

Browse files
author
Chris Cho
authored
DOCSP-13100: add link to pymongocrypt build instructions (#698)
* DOCSP-13100: add link to pymongocrypt build instructions
1 parent e2a64cd commit 569e1af

File tree

2 files changed

+31
-16
lines changed

2 files changed

+31
-16
lines changed

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

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ content: |
9090
9191
.. code-block:: java
9292
93-
// TODO: verify correctness
9493
Map<String, Object> providerDetails = new HashMap<String, Object>();
9594
9695
providerDetails.put("tenantId", new BsonString("<Azure account organization>"));
@@ -105,6 +104,12 @@ content: |
105104
.kmsProviders(kmsProviders)
106105
.build();
107106
107+
.. note::
108+
109+
To use the Azure Key Vault, you must use `mongodb-crypt <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
110+
version 1.1 or later in your application's environment.
111+
112+
108113
.. tab::
109114
:tabid: nodejs
110115
@@ -129,6 +134,12 @@ content: |
129134
}
130135
}
131136
137+
.. note::
138+
139+
To use the Azure Key Vault, you must use ``pymongocrypt`` version
140+
1.1 or later in your application's environment. Follow our guide
141+
to `build libmongocrypt from source <https://github.com/mongodb/libmongocrypt/tree/master/bindings/python#installing-from-source>`__.
142+
132143
.. tab::
133144
:tabid: csharp
134145
@@ -155,9 +166,10 @@ content: |
155166
156167
.. note::
157168
158-
To use the AWS Key Vault, you must use
169+
To use the Azure KMS, you must use
159170
`libmongocrypt <https://github.com/mongodb/libmongocrypt#installing-libmongocrypt-on-windows>`__ version 1.1 or later in your application's environment.
160171
172+
161173
---
162174
title: Create a New Data Encryption Key
163175
ref: create-a-new-data-key
@@ -215,11 +227,6 @@ content: |
215227
216228
BsonBinary dataKeyId = clientEncryption.createDataKey("azure", dataKeyOptions);
217229
218-
.. note::
219-
220-
To use the Azure Key Vault, you must use `mongodb-crypt <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
221-
version 1.1 or later in your application's environment.
222-
223230
.. tab::
224231
:tabid: nodejs
225232
@@ -241,11 +248,6 @@ content: |
241248
"keyVaultEndpoint": "<Azure key vault endpoint>"
242249
}
243250
244-
.. note::
245-
246-
To use the Azure Key Vault, you must use `pymongocrypt <https://pypi.org/project/pymongocrypt/>`__
247-
version 1.1 or later in your application's environment.
248-
249251
.. tab::
250252
:tabid: csharp
251253
@@ -274,10 +276,6 @@ content: |
274276
var dataKeyIdBase64 = Convert.ToBase64String(GuidConverter.ToBytes(dataKeyId, GuidRepresentation.Standard));
275277
Console.WriteLine($"Azure DataKeyId [base64]: {dataKeyIdBase64}");
276278
277-
.. note::
278-
279-
To use the AWS Key Vault, you must use
280-
`libmongocrypt <https://github.com/mongodb/libmongocrypt#installing-libmongocrypt-on-windows>`__ version 1.1 or later in your application's environment.
281279
282280
---
283281
title: Update the Automatic Encryption JSON Schema

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,12 @@ content: |
106106
107107
kmsProviders.put("gcp", providerDetails);
108108
109+
.. note::
110+
111+
To use the GCP KMS, you must use
112+
`mongodb-crypt <https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
113+
version 1.1 or later in your application's environment.
114+
109115
.. tab::
110116
:tabid: nodejs
111117
@@ -126,6 +132,12 @@ content: |
126132
}
127133
}
128134
135+
.. note::
136+
137+
To use the GCP KMS, you must use ``pymongocrypt`` version
138+
1.1 or later in your application's environment. Follow our guide
139+
to `build libmongocrypt from source <https://github.com/mongodb/libmongocrypt/tree/master/bindings/python#installing-from-source>`__.
140+
129141
.. tab::
130142
:tabid: csharp
131143
@@ -147,6 +159,11 @@ content: |
147159
}
148160
kmsProviders.Add("gcp", gcpKmsOptions);
149161
162+
.. note::
163+
164+
To use the GCP KMS, you must use
165+
`libmongocrypt <https://github.com/mongodb/libmongocrypt#installing-libmongocrypt-on-windows>`__ version 1.1 or later in your application's environment.
166+
150167
---
151168
title: Create a New Data Encryption Key
152169
ref: create-a-new-data-key-gcp

0 commit comments

Comments
 (0)