Skip to content

Commit 77df340

Browse files
authored
Restore description of run-orchestration environment variables (#609)
1 parent 2faa128 commit 77df340

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

.evergreen/run-orchestration.sh

+16
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22
# shellcheck shell=sh
33
set -eu
44

5+
# Supported environment variables:
6+
# AUTH Set to "auth" to enable authentication. Defaults to "noauth"
7+
# SSL Set to "yes" to enable SSL. Defaults to "nossl"
8+
# TOPOLOGY Set to "server", "replica_set", or "sharded_cluster". Defaults to "server" (i.e. standalone).
9+
# LOAD_BALANCER Set to a non-empty string to enable load balancer. Only supported for sharded clusters.
10+
# STORAGE_ENGINE Set to a non-empty string to use the <topology>/<storage_engine>.json configuration (e.g. STORAGE_ENGINE=inmemory).
11+
# REQUIRE_API_VERSION Set to a non-empty string to set the requireApiVersion parameter. Currently only supported for standalone servers.
12+
# DISABLE_TEST_COMMANDS Set to a non-empty string to use the <topology>/disableTestCommands.json configuration (e.g. DISABLE_TEST_COMMANDS=1).
13+
# MONGODB_VERSION Set to a MongoDB version to use for download-mongodb.sh. Defaults to "latest".
14+
# MONGODB_DOWNLOAD_URL Set to a MongoDB download URL to use for download-mongodb.sh.
15+
# ORCHESTRATION_FILE Set to a non-empty string to use the <topology>/<orchestration_file>.json configuration.
16+
# SKIP_CRYPT_SHARED Set to a non-empty string to skip downloading crypt_shared
17+
# MONGODB_BINARIES Set to a non-empty string to set the path to the MONGODB_BINARIES for mongo orchestration.
18+
# PYTHON Set to a non-empty string to set the Python binary to use.
19+
# INSTALL_LEGACY_SHELL Set to a non-empty string to install the legacy mongo shell.
20+
521
# See https://stackoverflow.com/questions/35006457/choosing-between-0-and-bash-source/35006505#35006505
622
# Why we need this syntax when sh is not aliased to bash (this script must be able to be called from sh)
723
# shellcheck disable=SC3028

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ TOPOLOGY=replica_set MONGODB_VERSION=7.0 make run-server
9494

9595
See (run-orchestration.sh)[./evergreen/run-orchestration.sh] for the available environment variables.
9696

97+
In order to use custom certificates in your server, copy the client certificate file to
98+
`$MONGO_ORCHESTRATION_HOME/lib/client.pem` (where `MONGO_ORCHESTRATION_HOME`
99+
defaults to `$DRIVERS_TOOLS/.evergreen/orchestration`), e.g.
100+
101+
```bash
102+
# Replace Mongo Orchestration's client certificate.
103+
cp ${PROJECT_DIRECTORY}/test/certificates/client.pem ${MONGO_ORCHESTRATION_HOME}/lib/client.pem
104+
```
105+
97106
## Linters and Formatters
98107

99108
This repo uses [pre-commit](https://pre-commit.com/) for managing linting and formatting of the codebase.

0 commit comments

Comments
 (0)