Skip to main content
Skip table of contents

Environment operations

Adding an environment

Follow the steps below to add source, staging and target environments.

  1. Login to the Delphix management application.

  2. Click Manage.

  3. Select Environments.

  4. Click on the Plus icon next to Environments.

  5. In the Add environment dialog, select Unix/Linux.

  6. Select Standalone host or Oracle cluster, depending on the type of environment you are adding.

  7. For a standalone environment enter the Host IP address.

  8. For clustered environments, enter the Node address and Cluster home.

  9. Enter an optional Name for the environment.

  10. Enter the SSH port. The default value is 22.

  11. Enter a Username for the environment.

  12. Select a Login Type:
    Username and Password - enter the OS username and password, or
    Username and Public Key - enter the OS username, and select Password Vault  from an existing Enterprise Password Vault
    Info : For using Public Key Authentication
    If you want to use public-key encryption for logging into your Unix-based environment:

    1. Select Public key for the Login type.

    2. Click View public key.

    3. Copy the public key that is displayed, and append it to the end of your ~/.ssh/authorized_keys file. If this file does not exist, you will need to create it.

      1. Run chmod 600 ~/.ssh/authorized_keys to allow only the file's owner to read and write to it (make sure the file is owned by the user).

      2. Run chmod 755 ~ to restrict access to the user's home directory so no other user may write to it.

      3. Run chmod 700 ~/.ssh so that others cannot write to it. The ~/.ssh directory cannot be writable by group or other users. Otherwise, authentication will fail.

  13. The public key needs to be added only once per user and per environment.

  14. For Password login, click Verify credentials to test the username and password.

  15. Enter a Toolkit path. The toolkit directory stores scripts used for Delphix Continuous Data Engine operations, and should have a persistent working directory rather than a temporary one. The toolkit directory will have a separate subdirectory for each database instance. The toolkit path must have 0770 permissions and at least 345MB of free space.

  16. Click Submit.

Refreshing an environment

After you make changes to an environment that you have already set up in the Delphix Management application, such as installing a new database home, creating a new database, or adding a new listener, the environment may need to be refreshed to reflect these changes. 

During environment discovery and environment refreshes, Delphix Continuous Data Engine  pushes a new copy of the toolkit to each staging and target  environment and replaces the old toolkit with the newer one. The toolkit includes:

  • A Java Runtime Environment (JRE)

  • Delphix jar files

  • The HostChecker utility

  • Scripts for managing the environment and/or VDBs

  • Delphix Connector log files

When you refresh the environment, it will push the toolkit back to the directory identified as the Toolkit Path for the given environment. Once this completes, the dSource can be brought back online.

Delphix Continuous Data Engine then executes some of these scripts to discover information about the objects in your environment (where the databases are installed, the database names, information required to connect to these databases, etc.). In some environments (Windows in particular), the scripts are customized to fit your environment. 

An environment refresh or discovery operation does not alter the source configuration of manually added databases. If you have added the databases manually, then Delphix Continuous Data Engine does not update its source configuration upon discovering a change.

  1. Login to the Delphix Management application.

  2. Click Manage.

  3. Select Environments.

  4. In the Environments panel, click the name of the environment you want to refresh.

  5. Select the Refresh icon.

  6. In the Refresh confirmation dialog select Refresh.

Adding a dataset

While adding an environment to the Delphix Continuous Data Engine, all database installation homes on it are automatically discovered. However, if a database installation home is not automatically discovered, you can add it manually to the environment. This feature may vary for different connectors, for workflow related information, refer to the connector specific documentation. 

Below is an example of how to add a dataset home for Oracle.

  1. Login to the Delphix management application.

  2. Click Manage.

  3. Select Environments.

  4. Select an Environment.

  5. Click the Databases tab.

  6. Click the Add dataset home button.

  7. Enter the Installation home.

  8. Enter the Version of the Installation Home.

  9. Enter the Oracle base of the Installation Home.

  10. Enter the Bits of the Oracle Home.

  11. When finished, click Add.

Adding a database 

An environment contains installations, that are database installations in the environment. Each environment may have any number of installations associated with it.

A database object defines the configuration of the dSource, sometimes called a Source Config or Instance, and is required to create a dSource. You can create any number of database objects using an installation, which represents known database instances. Databases only need to be identified on source or staging environments, not target environments.

For Oracle, SQL Server, and some other connectors, known databases are automatically added during discovery. However, not all support automatic database discovery, such as PostgreSQL, or databases can be missed by the discovery feature. In these scenarios, you must create the database manually.

Follow the steps below to create a database, or Source Config, on a source or staging environment:

  1. Login to the Delphix Management application.

  2. Click Manage.

  3. Select Environments.

  4. Select one of the configured source or staging environments.

  5. Select the Databases tab.

  6. Select one of the Dataset Home installations, in some connectors there will be no installation but a placeholder for installation.

  7. Select the Add Database plus (+) button to specify the database configuration. Input fields for database installation may vary connector to connector. To know about the exact input fields you can refer to the connector specific documentation.

Adding a database using the CLI

The equivalent of adding a database in the CLI is creating a new `sourceconfig` object. Follow the directions below on how to do so.

Login to Delphix Continuous Data Engine as an admin user:


Execute the commands below:

set type=<AppDataStagedSourceConfig>
set databaseName=<dbname>
set repository="<repository name>"
set parameters="{\"name\":\"<source config name>\"}"

Deleting an environment

Deleting an environment in Delphix Continuous Data will remove all data and configurations related to that environment. This action only affects the environment metadata stored in Delphix Continuous Data. It will not affect your database installations on the hosts or clusters that the environment is referencing.

Before deleting an environment, you must first delete all dependencies, such as dSources and virtual databases (VDBs)

  1. Login to the Delphix Management application.

  2. Select Environments.

  3. In the Environments panel, select the environment you want to delete.

  4. Click the Actions (...) menu, and select Delete.

  5. In the Delete Environment confirmation dialog click Delete.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.