Adding an instance of the CDC Replication Engine for BigQuery (Linux®)

Before you can start replication, you must add and configure an instance.

Procedure

  1. If you are configuring the first instance of the CDC Replication Engine for BigQuery after installation, you can proceed to Step 3 of this procedure.
  2. At the command prompt, launch the configuration tool by issuing the following command in the specified directory: 
    /CDC_installation_directory/bin/dmconfigurets
  3. At the welcome message, press Enter to continue.
  4. Enter the name of the instance that you want to add and press Enter.
  5. Enter the port number which CDC Replication uses for communication with client workstations running Management Console and other servers. CDC Replication displays a default port of 12101. Press Enter.

    This port number is not applicable for other applications installed on the same server. You will use this port number when specifying access parameters for your datastore in the Access Manager perspective in Management Console.

  6. Enter the amount of physically available RAM that you want to allocate for this instance of CDC Replication and press Enter. By default, the configuration tool allocates 1024 MB of RAM for each 64-bit instance.
    Note: Using values other than the defaults or allocating more RAM than is physically available on your server should only be undertaken after considering the impacts on product performance.
  7. Select the encryption profile from the list.
    If you would like to enable TLS for communication between source and target, you must select an encryption profile with encryption enabled. Click Manage to view and manage the available encryption profiles. Encryption profiles can be shared between multiple instances of CDC Replication.
  8. The CDC Replication Engine for BigQuery instances require that you enable TLS for communication between source and target. Select an encryption profile with encryption enabled. Click Manage to view and manage the available encryption profiles. Encryption profiles can be shared between multiple instances of CDC Replication.
  9. At the prompt Would you like to retrieve database login credentials from an external secret store through a Java user exit? (y/n), specify the authentication method for the database. Choose one of these options:
    Authentication method Steps
    External secret store through Java™ user exit Choose whether to use an external secret through Java user exit authentication (y/n):
    y
    You are prompted to enter the Java class name of the external secret store user exit, for example com.datamirror.ts.external.keystore.VaultExternalSecretStoreTest.
    Do you like to retrieve database login credentials as Object (y/n)?
    y
    You are not required to provide JSON Key.
    n
    Enter BigQuery Service Account JSON Secret Store key and press Enter. For more details, see Creating an instance by using database credentials stored in an external secret store.
    n
    Avoid using an external secret store.
    BigQuery service account's JSON key file
    1. Enter n and press Enter.
    2. Enter the absolute path for the BigQuery service account's JSON key file and press Enter.
  10. Enter BigQuery Project ID and press Enter.

After you enter the json file path and configure the authentication method, the configuration tool searches the database for dataset.

Perform the following steps to download BigQuery service account's JSON key file:
  1. Log in to your Google account, The new way to cloud.
  2. Click Console to navigate to the Dashboard, where you can select your project.
  3. In the navigation menu, click APIs & Services, then Credentials.
  4. From the Create Credentials option, select the Service account key.
  5. Select the JSON key type to download the JSON credentials file for your system.

  1. Enter y/n to configure advanced parameters.
    The default is n
  2. Enter the number that corresponds to the dataset used by CDC Replication for metadata tables and press Enter. You can specify any BigQuery dataset except the one that is used by other installed instances of CDC Replication for the given database.

    If the number of detected datasets is large, The system offers the option of entering the dataset name directly, or you can press Enter to view the pages of dataset names.

    Note: CDC Replication metadata tables contain important configuration information and must be backed up as part of your database backup strategy.
  3. Enter the absolute path for the refresh loader and press Enter.
    The configuration tool creates the CDC Replication instance and prompts you to start the instance. Enter y to start the instance.
    Note: The configuration tool warns you if your configuration is about to overwrite the metadata for an existing instance.