The virtual database (VDB) is a Delphix virtualized copy of your source database that runs on your Target Environment. A VDB is provisioned from a dSource or VDB snapshot.

The connector provisions and manages VDBs directly on target hosts. VDB provisioning does not use Yugabyte Anywhere.

An environment can be associated with only one dSource/VDB at a time.

Prerequisites

  • Meet the following requirements to create a VDB:

  • Identify an originating dataset and snapshot.

    • Link a dSource by following the instructions in Linking a YugabyteDB dSource.

    • Select a VDB that has been previously provisioned.

  • Set up a YugabyteDB target environment as described in YugabyteDB support and requirements.

Procedure

Perform the following steps to provision a YugabyteDB VDB.

  1. Login to the Delphix Management application.

  2. Navigate to the Manage > Datasets page and select a dataset.

  3. Under the Timeflow tab, identify a snapshot, hover over it, and select the Provision a VDB button.

  4. On the Target Environment page, perform the following actions:

    • From the Environment dropdown list, select a target environment. This will dynamically populate the other properties.

    • From the Installation dropdown list, select the specific YugabyteDB installation that you want to use.

    • From the User dropdown list, select the environment user that matches the YugabyteDB Instance Owner as configured in the prerequisites.

      Note: The ability to select different instance owners is only applicable when you have multiple users configured in that environment.

  5. On the Target Configuration page, perform the following actions:

    • VDB Name: Enter the desired name for the Virtual Database (VDB). This will be the identifier for the provisioned VDB in Delphix.

    • Mount Path on Target Host:Provide the absolute path where the Delphix filesystem will be mounted on the target host. This directory must be writable by the selected environment user.

    • Enable Authentication on Cluster (Optional): Check this box if the VDB cluster requires authentication.

      • Database Password: When authentication is enabled, enter the VDB cluster password. The field is prefilled with a default value; change it for your environment.

    • IP Address / Hostname of the Primary Node: Enter the IP address or fully qualified hostname of the primary node. If TLS is enabled, the node certificate file name and certificate must match this value.

    • Additional Nodes: Use this section to configure one or more additional nodes (if the VDB will span multiple nodes):

      • Environment: Select the environment where the additional node is hosted.

      • Environment User: Specify the OS user with SSH access to the additional node.

      • IP Address / Hostname of Additional Node: Provide the IP address or fully qualified domain name for each additional node.

    • Server Tuning Parameters: Specify any advanced configuration parameters that should be applied to the server during VDB provisioning:

      • Parameter Name: Enter the specific configuration file parameter (e.g., max_connections, yb_enable_log_retention_policy).

      • Parameter Value: Input the desired value for the specified configuration parameter.

      • Server Type: Select the server type where this parameter should be applied. Options typically include Master and TServer. Use the Add button to define multiple server tuning entries for various parameters and server types.

    • Port List: Review or customize the bind ports used by the YugabyteDB services. These should match the networking and security configuration of your target infrastructure:

      • RPC Bind Port for TServer: 9100 (default)

      • RPC Bind Port for Master: 7100 (default)

      • Web UI Port for Master: 7000 (default)

      • PGSQL Proxy Bind Port for TServer: 5433 (default PostgreSQL-compatible service)

      • CQL Proxy Bind Port for TServer: 9042 (default Cassandra-compatible service)

    • TLS Management Mode: Select Disabled, Customer Self-Signed, or CA-Signed. YBA Self-Signed (Auto) is not available for VDBs.

    • Node Certificates Directory: Enter the absolute path on each VDB host to the directory containing ca.crt, node.<address>.crt, and node.<address>.key for node-to-node encryption.

    • Client Certificates Directory: Enter the absolute path on each VDB host to the directory containing the same files for client-to-node encryption. You can use the same directory for node and client certificates. See Yugabyte TLS prerequisites.

  6. On the Configuration page, perform the following:

    • Specify the VDB Name of the YugabyteDB VDB.

    • Select the Target Group to organize the VDB under a dataset group

      • Click the Add Dataset Group button to create a new group.

  7. (Optional) On the Policies page, select a previously defined VDB Snapshot Policy or the Use group policy checkbox.

  8. (Optional) On the Masking page, enable the Mask this VDB checkbox to mask the database following a successful provision.

    • This feature may be disabled or unavailable if the chosen snapshot is already masked or the Delphix Continuous Compliance Engine is disconnected.

  9. (Optional) On the Hooks page, select a Hook Point and then click the plus button (+)to add a script that you want to run. You can define scripts to run at multiple hook points in the process.

  10. In the Summary tab, review the configuration profile for your VDB.

  11. Click Submit.

Last updated
Oct 22, 2026