Adding an instance of the CDC Replication Engine for MySQL Source (UNIX and Linux®)

You must add an instance of the CDC Replication Engine for MySQL Source before you can start replication.

1. If you are configuring the first instance of CDC Replication 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 2 and press Enter to add a new instance of CDC Replication.
5. Enter the name of the instance that you want to add and press Enter.

   The instance name must be unique.

6. 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 . 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.

7. Enter the maximum amount of disk space that will be utilized by the CDC Replication staging store on your source system. The default value is 100 GB.

   Specify 1 GB if you are creating an instance that will be used as a target of replication. This reduces the disk resources that CDC Replication requires on your target system.

8. 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 instance.

   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.

9. 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.
10. If you want to use TCP/IP as the exclusive method of communication between datastores, enter n and press Enter. If you want to have the option to use either a JMS provider or TCP/IP as the communications protocol, perform the following steps:

    A JMS provider should be used when characteristics of your network prevent the existence of a long-term, stable TCP/IP connection.

    1. Ensure that a queue has been created by your system administrator and is named correctly. Each CDC Replication instance that is to use a JMS message provider must have a queue named in the format CDC_<port>, where <port> is the five digit TCP listening port number of the instance. You can left-pad the number with zeroes if necessary to ensure five digits (example, CDC_00123).
    2. Enter y and press Enter.
    3. Enter 2 to add a JMS provider.
    4. Enter the fully qualified path to your JMS provider .jar file and press Enter.
    5. Enter 4 and press Enter to complete the configuration of the JMS providers.
    6. Enter 1 to add a JMS connection.
    7. Enter a JMS remote connection factory name and press Enter. For example, jms/ConnectionFactory. A connection factory encapsulates a set of connection configuration parameters that has been defined by an administrator. CDC Replication uses this to create a connection with your JMS provider.
    8. Enter the user name and press Enter.
    9. Enter the password to authenticate to the JMS server and press Enter.
    10. Enter the password a second time to confirm and press Enter.
    11. Enter the JNDI initial context and press Enter.
    12. Enter the URL that is relative to the JNDI Initial Context and press Enter.
    13. Enter the user name for the JNDI Principal and press Enter.
    14. Enter the JNDI credentials password and press Enter.
    15. Enter the password a second time to confirm and press Enter.
    16. Press Enter again to return to the Engine Communication Connection menu.
    17. Press 5 if you want to verify the connection and then press Enter to return to the Engine Communication Connection menu.

        If the JMS Provider is not configured correctly, CDC Replication will use TCP/IP as the communication protocol between datastores.

    18. Enter 7 to complete the configuration of the engine communication connection.
11. To configure MySQL Enterprise Edition, enter N to Are you configuring with MSQL Community Edition and follow these steps:
    1. Enter the database port and press Enter.
    2. Enter the specified database name and press Enter.
    3. Enter the MySQL Binary log name pattern and press Enter. This value is the pattern with which the binary log file name starts.
    4. Enter Y/N to configure advanced parameters. The default is N.
    5. At the prompt Would you like to retrieve database login credentials from an external secret store Java User Exit, choose one of the following options:

       Option	Steps
       External secret store with Java user exit	To use an external secret through Java user exit authentication, enter Y and press Enter. You are prompted to enter the Java class name of the external secret store user exit, for example com.datamirror.ts.external.keystore.VaultExternalSecretStoreTest. Enter the case-sensitive database user key from the external secret store for the specified database and press Enter. Enter the case-sensitive database password key from the external secret store for the specified database and press Enter. For more information, see Creating an instance by using database credentials stored in an external secret store
       User name and password	Enter the user name for the specified database and press Enter. Enter the password for the specified database and press Enter. The configuration tool searches the database for schemas.

    6. Enter the path for MySQL binary log directory and press Enter. This is the path where the MySQL binary logs are stored for CDC Replication reading.
    7. The configuration tool creates the CDC Replication instance and prompts you to start the instance. Enter Y to start the instance.
12. To configure MySQL Community Edition, enter Y to Are you configuring with MSQL Community Edition and follow these steps:
    1. Enter the file path of the MySQL JDBC driver jar file (for example, scratch/cdc/mysql-connector-java-5.1.47.jar) and press Enter.
    2. Enter the number that corresponds to the MySQL JDBC jar file and press Enter.
    3. Enter N for Show all classes and press Enter.
    4. Enter the number that corresponds to the class name of the JDBC driver (for example, com.mysql.jdbc.driver) and press Enter.
    5. Enter the JDBC connection URL (for example, jdbc:mysql://hostname:db_port/db_name?serverTimezone=UTC), and press Enter.
    6. Enter the MySQL binary log name pattern and press Enter.
       This value is the pattern with which the binary log file name starts.
    7. Enter N for Would you like to configure advanced parameters and press Enter.
    8. At the prompt Would you like to retrieve database login credentials from an external secret store Java User Exit, choose one of the following options:

       Option	Steps
       External secret store with Java user exit	To use an external secret through Java user exit authentication, enter Y and press Enter. You are prompted to enter the Java class name of the external secret store user exit, for example com.datamirror.ts.external.keystore.VaultExternalSecretStoreTest. Enter the case-sensitive database user key from the external secret store for the specified database and press Enter. Enter the case-sensitive database password key from the external secret store for the specified database and press Enter. For more information, see Creating an instance by using database credentials stored in an external secret store.
       User name and password	Enter N and press Enter. Enter the user name for the specified database and press Enter. Enter the password for the specified database and press Enter. The configuration tool searches the database for schemas.

    9. Enter the path for MySQL binary log directory and press Enter. This is the path where the MySQL binary logs are stored for CDC Replication reading.
    10. The configuration tool creates the CDC Replication instance and prompts you to start the instance. Enter Y to start the instance.