Skip to content

Commit f4f4ef0

Browse files
author
Divjot Arora
authored
GODRIVER-1406 FLE GA docs changes (#225)
- Remove "beta" annotations from docs - Update the instructions to install libmongocrypt
1 parent 08f9f9e commit f4f4ef0

File tree

4 files changed

+18
-21
lines changed

4 files changed

+18
-21
lines changed

.evergreen/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ functions:
7676
if [ "Windows_NT" = "$OS" ]; then
7777
mkdir -p c:/libmongocrypt/include
7878
mkdir -p c:/libmongocrypt/bin
79-
curl https://s3.amazonaws.com/mciuploads/libmongocrypt/windows-test/master/latest/libmongocrypt.tar.gz --output libmongocrypt.tar.gz
79+
curl https://s3.amazonaws.com/mciuploads/libmongocrypt/windows/latest_release/libmongocrypt.tar.gz --output libmongocrypt.tar.gz
8080
tar -xvzf libmongocrypt.tar.gz
8181
cp ./bin/mongocrypt.dll c:/libmongocrypt/bin
8282
cp ./include/mongocrypt/*.h c:/libmongocrypt/include

mongo/client_encryption.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ import (
2020
)
2121

2222
// ClientEncryption is used to create data keys and explicitly encrypt and decrypt BSON values.
23-
// This type is in beta. The API does not have any stability guarantees and backwards-breaking changes may be made
24-
// before the final release.
2523
type ClientEncryption struct {
2624
crypt *driver.Crypt
2725
keyVaultClient *Client

mongo/doc.go

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -82,27 +82,29 @@
8282
// Client-side encryption is a new feature in MongoDB 4.2 that allows specific data fields to be encrypted. Using this
8383
// feature requires specifying the "cse" build tag during compilation.
8484
//
85-
// Important: This feature is beta. The API for both automatic and explicit encryption/decryption does not have any
86-
// stability guarantees and backwards-breaking changes may be made before the final release.
87-
//
8885
// Note: Auto encryption is an enterprise-only feature.
8986
//
90-
// The libmongocrypt C library is required when using client-side encryption. To install libmongocrypt, do the following:
87+
// The libmongocrypt C library is required when using client-side encryption. To install libmongocrypt, follow the
88+
// instructions for your operating system:
9189
//
92-
// // run the clone command in an empty folder because the compile script will create new directories.
93-
// git clone https://github.com/mongodb/libmongocrypt
94-
// ./libmongocrypt/.evergreen/compile.sh
90+
// 1. Linux: follow the instructions listed at
91+
// https://github.com/mongodb/libmongocrypt#installing-libmongocrypt-from-distribution-packages to install the correct
92+
// deb/rpm package.
9593
//
96-
// // Linux/Darwin: (this requires pkg-config to be installed on the system)
97-
// Add <installation_dir>/install/libmongocrypt/lib/pkgconfig:<installation_dir>/install/mongo-c-driver/lib/pkgconfig to PKG_CONFIG_PATH.
98-
// Add <installation_dir>/install/libmongocrypt/lib to LD_LIBRARY_PATH
94+
// 2. Mac: Follow the instructions listed at https://github.com/mongodb/libmongocrypt#installing-libmongocrypt-on-macos
95+
// to install packages via brew and compile the libmongocrypt source code.
9996
//
100-
// // Windows:
101-
// mkdir -p c:/libmongocrypt/include
97+
// 3. Windows:
10298
// mkdir -p c:/libmongocrypt/bin
103-
// cp ./install/libmongocrypt/lib/mongocrypt.dll c:/libmongocrypt/bin
104-
// cp ./install/libmongocrypt/include/mongocrypt/*.h c:/libmongocrypt/include
105-
// // add c:/libmongocrypt/bin to PATH
99+
// mkdir -p c:/libmongocrypt/include
100+
//
101+
// // Run the curl command in an empty directory as it will create new directories when unpacked.
102+
// curl https://s3.amazonaws.com/mciuploads/libmongocrypt/windows/latest_release/libmongocrypt.tar.gz --output libmongocrypt.tar.gz
103+
// tar -xvzf libmongocrypt.tar.gz
104+
//
105+
// cp ./bin/mongocrypt.dll c:/libmongocrypt/bin
106+
// cp ./include/mongocrypt/*.h c:/libmongocrypt/include
107+
// export PATH=$PATH:/cygdrive/c/libmongocrypt/bin
106108
//
107109
// libmongocrypt communicates with the mongocryptd process for automatic encryption. This process can be started manually
108110
// or auto-spawned by the driver itself. To enable auto-spawning, ensure the process binary is on the PATH. To start it

mongo/options/autoencryptionoptions.go

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ package options
2020
//
2121
// Enabling Client Side Encryption reduces the maximum document and message size (using a maxBsonObjectSize of 2MiB and
2222
// maxMessageSizeBytes of 6MB) and may have a negative performance impact.
23-
//
24-
// This type is in beta. The API does not have any stability guarantees and backwards-breaking changes may be made
25-
// before the final release.
2623
type AutoEncryptionOptions struct {
2724
KeyVaultClientOptions *ClientOptions
2825
KeyVaultNamespace string

0 commit comments

Comments
 (0)