Skip to main content
Skip table of contents

Requirements for cockroachDB source databases

The source database requirements are listed below:

  1. Retrieve a comprehensive list of CockroachDB Backup’s subdirectories absolute paths by executing the following command:

    CODE
    SHOW BACKUPS IN 's3://{bucket name}/{path}?AWS_ACCESS_KEY_ID={placeholder}&AWS_SECRET_ACCESS_KEY={placeholder}';
CODE
SHOW BACKUPS IN 'nodelocal:/self/nfsmount/backups';
CODE
SHOW BACKUPS IN 'gs://{bucket name}/{path}?AUTH=specified&CREDENTIALS={placeholder}';

The format of the CockroachDB Backup’s subdirectory path follows a date-based naming scheme, specifically <year>/<month>/<day>-<timestamp>..

  1. Before initiating the restoration process on the staging database, make sure to identify the following key information:

  • For AWS

    • Storage Bucket Name (AWS S3): Record the name of the storage bucket in AWS S3, including the absolute path where CockroachDB backups are situated in AWS S3.

    • AWS_ACCESS_KEY_ID: The account access name or key associated with object storage holding CockroachDB backups, as it serves a crucial role in authentication.

    • AWS_SECRET_ACCESS_KEY: The account secret access key associated with the account name field. This is essentially the password that gives access to CockroachDB backups.

  • For GCP

    • Before initiating the restoration process on the staging database, make sure to identify the following key information:

      • Storage Bucket name (GCP): Record the name of the storage bucket in GCP, including the absolute path where CockroachDB backups are situated in GCP bucket. 

      • Credentials: The secret access key associated with the GCP bucket. This is essentially the password that gives access to CockroachDB backups.  

    • This pertinent information can be extracted from the backup command utilized for backing up the CockroachDB full cluster on GCP storage, exemplified by the following command: 

      CODE
      SHOW BACKUPS IN 'gs://{bucket name}?AUTH=specified&CREDENTIALS={placeholder}';

This pertinent information can be extracted from the backup command utilized for backing up the CockroachDB full cluster on AWS S3 storage, exemplified by the following command:

BACKUP INTO 's3://{BUCKET NAME}?AWS_ACCESS_KEY_ID={KEY ID}&AWS_SECRET_ACCESS_KEY={SECRET ACCESS KEY}' AS OF SYSTEM TIME '-10s';

Requirements for CockroachDB staging and target environments

The Staging and Target environments have the same set of requirements for CockroachDB. 

Network and Connectivity Requirements

Ensure that the requirements for Delphix Engine network connectivity are met before proceeding further. 

For CockroachDB connector specific network and connectivity requirements, see the relevant topics below.

Ports for AWS S3 / GCP / Disk backup Ingestion

cockroach_arch2.png

JavaScript errors detected

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

If this problem persists, please contact our support.