Staging Pull uses Yugabyte Anywhere (YBA) to restore the most recent completed full backup and the most recent completed incremental backup from the same schedule. YBA resolves the backup chain. Each dSource snapshot reflects the latest completed backup. You cannot select a specific incremental backup or restore to a point in time.

Supported backup storage locations

  • AWS S3

  • Azure Blob Storage

Prerequisites

  • A YBA instance must be deployed and accessible from the staging host.

  • Completed YSQL full backups, and optionally incremental backups, must be available in AWS S3 or Azure Blob Storage. See Additional YugabyteDB staging prerequisites for ingestion using backups for backup schedule and storage setup.

  • The staging and target environments must meet the requirements described in the Yugabyte network and connectivity requirements.

  • For multi-node staging configurations, the replication factor must be configured in the dSource parameters. Starting with connector v2025.1.0, multi-node YugabyteDB cluster provisioning is supported directly through YBA.

Backup Location

Enter the path to the universe folder in AWS S3 or Azure Blob Storage. Do not enter the path to an individual backup folder.

Procedure

Perform the following steps to create a source config on the staging environment:

  1. Log in to DCT.

  2. Add a source config against the discovered staging or target YugabyteDB environment . For more information, read Create a source configuration for Connectors in DCT.

  3. Go to Data> Data Management >dSources and click +dSource.

  4. On the Select Data Source page, select the YugabyteDB dSource.

  5. Once the YugabyteDB dSource is selected, the following configuration settings will appear. Do the following:

    • Enter the Database Name.

    • Optionally, enter a custom mount base using the Mount Base parameter.

    • Ingestion Type: Staging Pull

    • Mount Path on Staging Host: Enter the absolute path where Delphix filesystem will be mounted on the staging host

    • IP Address / Hostname of the Staging Cluster: Enter the IP address or fully qualified domain name (FQDN) of the node or load-balanced interface that will be used by Delphix to communicate with the YugabyteDB staging cluster.

    • Yugabyte Anywhere URL: Enter the base URL (e.g., https://yba.example.com or https://10.43.52.215) of the Yugabyte Anywhere instance that manages the target Universe. This will be used by the connector for REST API operations.

    • Yugabyte Anywhere API Key: Enter a valid API key with sufficient privileges to authenticate REST API requests to Yugabyte Anywhere for Universe creation, backup retrieval, and other operations.

    • SSH Private Key Path: Enter the absolute path, on the staging host, to the PEM-formatted SSH private key that YBA uses for passwordless login to the universe nodes. The file must be readable by the staging OS user (recommended permissions: 0400).

    • Universe Identifier: Enter the unique identifier (configured name) of the YugabyteDB Universe that will be used during the staging and provisioning process. This links the backup/restore process to the correct Universe within Yugabyte Anywhere.

    • Backup Storage Type: Select Azure or S3.

    • Backup Location: Enter the full path to the universe folder in the backup storage. For example, https://<account>.blob.core.windows.net/<container>/univ-<id> or s3://<bucket>/univ-<id>.

    • Azure Storage SAS Token: For Azure Blob Storage, enter the SAS token used to access the container.

    • Use IAM Instance Profile: For S3, select this check box to authenticate with the IAM instance profile attached to the staging host instead of AWS keys.

    • AWS Access Key ID / AWS Secret Access Key: For S3 when not using an IAM instance profile, enter the AWS access key pair.

    • AWS Region: For S3, enter the bucket region, such as us-east-1. This field is required when using an IAM instance profile.

    • Database Names: Enter the names of the YugabyteDB Databases to be restored. If multiple keyspaces are required, separate them using commas (e.g., Database1,Database2).

    • Enable Cluster Authentication: Select this check box to enable secure authentication for accessing the YugabyteDB cluster.

    • Cluster Authentication Details -> Database Password: Enter the password that will be used to authenticate against the YugabyteDB database. Required only if cluster authentication is enabled.

    • Additional Nodes: Use this section to define additional nodes (e.g., other hosts in the YugabyteDB cluster) that are part of the configuration. Click on Add to add a Node.

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

      • Environment User: Enter the OS-level user (e.g., yugabyte) that Delphix should use to connect to this additional node.

      • IP Address / Hostname of Additional Node: Enter the IP address or fully qualified domain name (FQDN) of the additional cluster node.

    • Server Tuning Parameters: Apply advanced configuration settings to optimize performance and resource usage for specific node types.

      • Parameter Name: Define advanced configuration parameters that should be written into the YugabyteDB configuration file.

      • Parameter Value: Define advanced configuration parameters that should be written into the YugabyteDB configuration file.

      • Server Type: Select the server type to which the tuning parameter applies. Example values: Master, TServer. Use the Add button to define multiple server tuning entries for various parameters and server types.

    • Port List: This section configures the bind ports for communication between YugabyteDB services.

      • RPC Bind Port for TServer: 9100 (By default)

      • RPC Bind Port for Master: 7100 (By default)

      • PGSQL Proxy Bind Port for TServer: 5433 (By default)

      • CSQL Proxy Bind Port for TServer: 9042 (By default)

    • TLS Management Mode: Select Disabled, YBA Self-Signed (Auto), Customer Self-Signed, or CA-Signed.

    • Certificate Label: Enter the name under which the certificate is registered in YBA. Leave blank to use delphix-tls-<universe name>.

    • Root CA Cert Path: Enter the path to the PEM root CA certificate on the staging node for Customer Self-Signed mode, or a path that exists on every universe node for CA-Signed mode.

    • Root CA Key Path: For Customer Self-Signed mode, enter the path to the root CA private key on the staging node.

    • Node Cert Path / Node Key Path: For CA-Signed mode, enter the paths to the per-node certificate and key. Use the same paths on every node.

    • Client Cert Path / Client Key Path: For CA-Signed mode, enter the paths to the per-node client certificate and key.

  6. Click Next.

  7. On the dSource Configuration page, enter a dSource name and select a group for your dSource. Adding a dSource to a dataset group allows you to manage user permissions for that database and its objects, including snapshots.

  8. On the Data Management page, specify your staging environment, user, and snapshot parameters. Select the Resynchronize dSource check box to rebuild the staging universe from the backups in Backup Location. Delphix restores the most recent completed full backup and the most recent completed incremental backup, then takes a new snapshot. This operation is similar to creating a new dSource, but maintains timeflow history. Backups taken after resynchronization are picked up the next time you resynchronize.

  9. On the Policies page, apply policy details to the dSource if needed, then click Next to continue.

  10. On the Hooks page, select a Hook Point and then click +add to add a script that you want to run at that hook point. You have the flexibility to define scripts to run at multiple hook points in the process.

  11. On the Summary page, review the configuration profile for your dSource.

  12. Click Submit. The Delphix Continuous Data Engine will initiate two jobs, namely DB_Link and DB_Sync to create the dSource.

 

Last updated
Oct 19, 2026