Create a CockroachDB dSource with GCP ingestion in DCT

The following procedure provides details on creating a dSource with GCP ingestion type. 

Prerequisites 

• The source and staging instances must meet the host requirements as described in Requirements for CockroachDB Staging/Target hosts. 

• The accessibility of the backup location within the GCP bucket from the Staging host must be verified prior to ingestion. 

Procedure

1. Log in to DCT.

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

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

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

5. Enter the CockroachDB specific parameters for your dSource configuration. 

   • Environment User: Select the environment user. For example, delphix.
   • dSource Type: Select the dSource Type. For example, GCP.

   • Enter the dSource (GCP) details: 

   • Mount Path:The path on the host where Delphix will mount the dSource files via NFS. 

   • IP Address / Hostname of the Staging Cluster: IP Address / Hostname of the interface for the staging Cluster (default 127.0.0.1).

   • Staging CockroachDB Port Number: Staging DB port for cluster’s inter-node communication. 

   • Staging CockroachDB Console Port Number: Staging Console port for HTTP requests.

   • CockroachDB Backup’s Subdirectory Path: CockroachDB Backup’s Subdirectory Absolute Path where backups are located in GCP Bucket 

   • CockroachDB Backup’s Bucket or Container Name: Storage bucket or container name including absolute path where CockroachDB backups are located.

   • Authentication Option for GCP Buckets: 

     • Specified Authentication: Need to specify GCP credentials in dSource configuration fields:

       • Encoded JSON Object Key: Specify JSON encoded key associated with object storage holding CockroachDB backups.

     • Implicit Authentication: Store GCP credentials in JSON file on the staging host. 

       • For using implicit authentication with GCP bucket, create a service account corresponding to the bucket. 

       • Download the service account key for the service account using Google Cloud Console. 

       • Location of JSON Credential File: Specify path of json file containing the key. 

   • Skip Checking Localities: Select the checkbox to skip checking the localities of a cluster before a restore. 

   • Secure Mode: Option to run the CockroachDB server in secure mode 

   • Certificate directory path: The absolute path to the certificate directory, it must have valid certificates containing the IP address or hostname for the CockroachDB server.

     • You must specify the input “Certificate directory path” when “Secure Mode” option is selected. 

     • For more detailed guidance on CockroachDB certificate generation, refer to the official documentation:  CockroachDB Certificate Generation. 

   • CockroachDB Cluster Node Count: Number of nodes that consists of a Staging CockroachDB cluster. Minimum: 3 and Maximum: 9 

   • CockroachDB Parameters: These are node-level configuration parameters passed as command-line arguments when starting the CockroachDB process.

     Example:

     --max-sql-memory=0.25, --cache=0.25

     • Parameter Name: CockroachDB Cluster configuration parameter name.

     • Parameter Value: CockroachDB Cluster configuration parameter value.

   • CockroachDB Cluster Parameters: These are cluster-wide settings applied after the cluster is initialized using the SET CLUSTER SETTING command.

     Example:

     SET CLUSTER SETTING kv.bulk_io_write.restore_node_concurrency = 8

     • Cluster Parameter Name:CockroachDB cluster-level configuration parameter name.

     • Cluster Parameter Value: CockroachDB cluster-level configuration parameter value.

   • Additional Nodes: Specify the node configuration for each node the CRDB cluster.  

     • Environment: Select environment on which node has to be created. 

     • Environment User: Select environment user corresponding to the environment. 

     • IP Address / Hostname: IP Address / Hostname of the interface for the staging node(default 0.0.0.0) 

     • CockroachDB Port Number: Staging DB port for node’s inter-node communication 

     • CockroachDB Console Port Number: Staging Console port for HTTP requests 

     • Certificate directory path: The absolute path to the certificate directory, it must have valid certificates containing the IP address or hostname for the CockroachDB server 

     • Append cluster CRDB parameters: Check with box if the cluster configuration parameters are applicable for the node. 

     • Additional Node Configuration Parameters: Additional CockroachDB configuration parameters to start the node. 

   • Enable PITR: Select the check box to enable ingest backups up to a provided timestamp.
     
   • End time for ingestion (PITR): Timestamp up to which the backups would be restored.
   • Enable only full backup ingestion: Select the check box to ingest only full backup from a series of incremental data available in the backup location.
6. Then click Next to proceed further.

7. Enter the details for dSource Name and Target group on the dSource configuration page and click Next. 

8. On the Data management page, select the following and click Next.

   • Staging Environment: This will be your staging host where source config was created.

   • User: Database OS user with required privileges for linking the dataset. 

   • Select the Resynchronize dSource under the Snapshot Parameters section for a non-incremental load of data from the source similar to when the dSource was created. This action avoids duplicating storage requirements and maintains a Timeflow history.

9. On the next screens, configure a policy, hooks, and review the configuration, then click on Next button to view the summary. 

10. Click the Submit button which will initiate the linking process.

11. Once dSource is created successfully, you can review the dSource under Data > Data Management > dSource Name.