Skip to content

Commit 08f4c23

Browse files
fix wording
1 parent d6044e7 commit 08f4c23

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,4 @@ notes.md
6969
list.out
7070

7171
encrypted-cluster
72+
*.pid

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ If you have a question about Mongoose (not a bug report) please post it to eithe
4646
* execute `npm run test-tsd` to run the typescript tests
4747
* execute `npm run ts-benchmark` to run the typescript benchmark "performance test" for a single time.
4848
* execute `npm run ts-benchmark-watch` to run the typescript benchmark "performance test" while watching changes on types folder. Note: Make sure to commit all changes before executing this command.
49-
* in order to run tests that require an encrypted cluster locally, run `npm run test-encryption-local`. Alternatively, you can start an encrypted cluster using the `scripts/start-encrypted-cluster.sh` file.
49+
* in order to run tests that require an cluster with encryption locally, run `npm run test-encryption-local`. Alternatively, you can start an encrypted cluster using the `scripts/start-cluster-with-encryption.sh` file.
5050

5151
## Documentation
5252

scripts/start-encrypted-cluster.sh renamed to scripts/configure-cluster-with-encryption.sh

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
# creates a encrypted cluster (sharded on 8.0 server)
1+
# note: in order to use FLE with mongodb, we must
2+
# have mongocryptd or the shared library downloaded
3+
# have an enterprise server >= 4.2
4+
5+
# this script downloads all tools required to use FLE with mongodb, then starts a cluster of the provided configuration (sharded on 8.0 server)
26

37
export CWD=$(pwd);
48
mkdir encrypted-cluster
59
cd encrypted-cluster
610

711
# note:
8-
# we're using drivers-evergreen-tools which is a repo that handles cluster set-up for us.
12+
# we're using drivers-evergreen-tools which is a repo used by MongoDB drivers to start clusters for testing.
913
# if you'd like to make changes to the cluster settings, edit the exported variables below.
1014
# for configuration options for the exported variables, see here: https://github.com/mongodb-labs/drivers-evergreen-tools/blob/master/.evergreen/run-orchestration.sh
1115
# after this script is run, the encrypted-cluster/ folder will notably contain the following:

scripts/run-encryption-tests-local.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
#!/usr/bin/env bash
22

3-
# sets up an encrypted mongodb cluster, adds relevant variables to the environment, and runs encryption tests
3+
# sets up mongodb cluster and encryption configuration, adds relevant variables to the environment, and runs encryption tests
44

55
export CWD=$(pwd);
66

7-
# set up encrypted mongodb cluster if the encrypted-cluster folder does not exist
8-
# note: for tooling, cluster set-up and configuration look into the 'scripts/start-encrypted-cluster.sh' script
7+
# set up mongodb cluster and encryption configuration if the encrypted-cluster folder does not exist
8+
# note: for tooling, cluster set-up and configuration look into the 'scripts/start-cluster-with-encryption.sh' script
99
if [ -d "encrypted-cluster" ]; then
1010
cd encrypted-cluster
1111
else
12-
source $CWD/scripts/start-encrypted-cluster.sh
12+
source $CWD/scripts/start-cluster-with-encryption.sh
1313
fi
1414

1515
# extracts MONGOOSE_TEST_URI and CRYPT_SHARED_LIB_PATH from .yml file into environment variables for this test run

0 commit comments

Comments
 (0)