Skip to content

Commit

Permalink
fix wording
Browse files Browse the repository at this point in the history
  • Loading branch information
aditi-khare-mongoDB committed Dec 18, 2024
1 parent d6044e7 commit 08f4c23
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,4 @@ notes.md
list.out

encrypted-cluster
*.pid
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ If you have a question about Mongoose (not a bug report) please post it to eithe
* execute `npm run test-tsd` to run the typescript tests
* execute `npm run ts-benchmark` to run the typescript benchmark "performance test" for a single time.
* 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.
* 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.
* 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.

## Documentation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# creates a encrypted cluster (sharded on 8.0 server)
# note: in order to use FLE with mongodb, we must
# have mongocryptd or the shared library downloaded
# have an enterprise server >= 4.2

# this script downloads all tools required to use FLE with mongodb, then starts a cluster of the provided configuration (sharded on 8.0 server)

export CWD=$(pwd);
mkdir encrypted-cluster
cd encrypted-cluster

# note:
# we're using drivers-evergreen-tools which is a repo that handles cluster set-up for us.
# we're using drivers-evergreen-tools which is a repo used by MongoDB drivers to start clusters for testing.
# if you'd like to make changes to the cluster settings, edit the exported variables below.
# for configuration options for the exported variables, see here: https://github.com/mongodb-labs/drivers-evergreen-tools/blob/master/.evergreen/run-orchestration.sh
# after this script is run, the encrypted-cluster/ folder will notably contain the following:
Expand Down
8 changes: 4 additions & 4 deletions scripts/run-encryption-tests-local.sh
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/usr/bin/env bash

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

export CWD=$(pwd);

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

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

0 comments on commit 08f4c23

Please sign in to comment.