This page describes the steps for adding a MongoDB staging and target environment.

Prerequisites

  • A MongoDB staging environment must be setup with the necessary requirements as described in MongoDB requirements and prerequisites.

  • Install MongoDB binaries on staging and target servers.

  • Installation of the MongoDB connector is required before the discovery operation.

  • The $MONGO_PATH variable must be set on the staging and target host using $HOME/.setDelphixMongoEnv and MONGO_REPO_CFGFILE, which contains the binary path of MongoDB using the below procedure.

Procedure

  1. Login to the staging host as Delphix Continuous Data Engine OS user.

  2. Create a file named .setDelphixMongoEnv in the home directory of Delphix Continuous Data Engine user.

touch $HOME/.setDelphixMongoEnv

  1. Define the variable pointing to the config file for manual discovery of MongoDB instances. For example:

echo "MONGO_REPO_CFGFILE=<Delphix OS User Home directory>/.mongorepos.txt" > $HOME/.setDelphixMongoEnv

  1. Define the full path to the MongoDB binary in file represented by $MONGO_REPO_CFGFILE. For example:cv 

source $HOME/.setDelphixMongoEnv  
echo "MONGO_PATH=<mongodb installation home directory>/bin/mongod" > $MONGO_REPO_CFGFILE  

  1. If there are multiple version binaries, specify each in separate lines as shown below:

source $HOME/.setDelphixMongoEnv  
echo "MONGO_PATH=<mongodb installation home directory>/bin/mongod" > $MONGO_REPO_CFGFILE  
echo "MONGO_PATH=<mongodb installation home directory>/bin/mongod" >> $MONGO_REPO_CFGFILE 

  1. If the MongoDB database tools are installed at different location, specify the MongoDB tools path in separate lines as shown below:

source $HOME/.setDelphixMongoEnv  
echo "MONGO_PATH=<mongodb installation home directory>/bin/mongod:<mongodb-database-tools directory>/bin" > $MONGO_REPO_CFGFILE  
echo "MONGO_PATH=<mongodb installation home directory>/mongod:<mongodb-database-tools directory>/bin" >> $MONGO_REPO_CFGFILE 

  1. In a similar manner, more directories (such as directory containing MongoSync or mongosh) corresponding to a repository can be added as shown below:

source $HOME/.setDelphixMongoEnv  
echo "MONGO_PATH=/u01/mongodb603/bin/mongod:/u01/mongodb603/mongodb-database-tools/bin:/u01/mongodb603/mongosync/bin:/u01/mongodb603/mongo-shell/bin" > $MONGO_REPO_CFGFILE

  1. Login to the Delphix Management application.

  2. Click Manage -> Environments.

  3. Click the Actions ... menu and select Add Environment.

  4. From the Add Environment dialog window, select Unix/Linux.

  5. Select Standalone Host

  6. Click Next.

  7. Provide the name of the environment.

  8. Provide the Host IP address or host FQDN.

  9. Provide the SSH port. The default value is 22.

  10. Choose the Login Type that fits your setup. 

  • Username and Password – provide the environment username and password

  • Username and Public Key – provide the environment username 

  • Password Vault – select from an existing Enterprise Password Vault

  1. Provide an OS Username for the environment.

  2. If Applicable, provide an OS Password for the environment..

  3. For Password Login, click Validate to test the OS Username and OS Password.

  4. Enter Toolkit Path (ensure that the toolkit path does not have any spaces).

  5. To provide your own Oracle Java Development Kit, select the Provide my own JDK checkbox and click Next.

    1. On the Java Development Kit page, provide an absolute path to your Oracle JDK and click Next. 

  6. Click Submit

Points to Remember while creating $MONGO_REPO_CFGFILE

  1. Each line in the file represents a unique version of the installation. If there are multiple installations in an environment, the file will contain multiple lines.

  2. The mandatory binaries for a successful discovery are mongod and mongosh.

  3. Discovery of MongoDump, MongoRestore, and MongoSync are optional based on the dSource type.

  4. Multiple paths for each repository can be separated (first priority given to first path provided) for discovering all the desired binaries listed above.

  5. The path provided should contain the binary in the immediate directory. For example, for discovering /u01/mongo603/database-tools/bin/mongorestore, the path provided should be /u01/mongo603/database-tools/bin instead of /u01/mongo603/database-tools.

Add a MongoDB environment via DCT

Add MongoDB source, staging, and target environments so DCT can host connector operations, dSources, and VDBs. Complete the pre-registration steps on each host before adding it in DCT.

Pre-registration steps (on each host)

  • Create a file named .setDelphixMongoEnv in the home directory of the Delphix OS user and define the MONGO_REPO_CFGFILE variable pointing to a config file (for example, ~/.mongorepos.txt).

  • In that config file, define the MONGO_PATH variable pointing to the mongod binary.

  • Confirm the toolkit directory (for example, /var/tmp) is writable by the OS user and has at least 1.5 GB of free space.

  • Confirm that either netstat or ss is installed on the host.

Note: Only Unix/Linux hosts are supported for MongoDB environments. The OS and architecture of the staging and target host must match the source environment.

Procedure

  1. Log in to DCT.

  2. Open Infrastructure Connections.

  3. Select + Infrastructure Connections.

  4. On the Create Infrastructure Connection page, enter a Connection Name and select the CD Engine you connected earlier.

  5. Click Next. On the Host & Server page:

    1. Host OS: select Unix. MongoDB environments require Unix.

    2. Server Type: select Standalone or Cluster based on your topology.

  6. Click Next. On the Settings page, enter the following:

    1. Host/IP Address: Hostname or IP address of the environment host.

    2. SSH Port: SSH port for the host. Default: 22

    3. Login Settings: Select Username and Password, then provide OS credentials.

    4. Toolkit Path: Path to the persistent working directory (e.g. /var/tmp). Requires 0770 permissions and at least 1.5 GB of free space.

    5. Java Development Kit: By default, Delphix installs its own JDK. Select Provide my own JDK to specify a path on the host.

  7. Click Validate, confirm that validation succeeds, then click Next.

  8. Review the Summary and click Submit.

Repeat this procedure for all required environments (source, staging, and target hosts). After adding each environment, refresh it to detect the uploaded connector toolkit.

Last updated
Oct 9, 2026