Preparing to install IBM InfoSphere Change Data Capture software

Before you can install the IBM® InfoSphere® Change Data Capture software components that are required to support replication for shadow tablestables, you must get your DB2® server ready.

To prepare for InfoSphere CDC software installation:

1. Ensure that you gather all the required information to install all the InfoSphere CDC software components.

   In the following table, a variable name is given to each item to be used as reference throughout all the shadow tables documentation.

   Table 1. Variable names that are referenced in the documentation

   Variable name	Description
   db2-instance-name	The name of the DB2 instance that owns db2-database-name.
   db2-instance-dir	The DB2 instance home directory of db2-instance-name.
   db2-database-name	The database name that contains shadow tables and the metadata tables that are stored by InfoSphere CDC.
   db2-metadata-schema-name	The schema name for the set of metadata tables that InfoSphere CDC creates in db2-database-name. InfoSphere CDC maintains them to store data about your current replication configuration for shadow tables.
   db2-instance-owner	The name of the DB2 user that owns db2-instance-name.
   db2-cdc-user	The name of the DB2 user that holds DATAACCESS and either SYSADM or DBADM authority. InfoSphere CDC connects to db2-database-name with db2-cdc-user. During installation, InfoSphere CDC creates metadata tables. After installation, InfoSphere CDC reads DB2 log files for data replication. You can use one single account as cdc-user and db2-cdc-user.
   db2-cdc-user-group	The primary operating system group for the db2-cdc-user.
   cdc-installation-archive-name	The name of archive file that contains the installation program for InfoSphere CDC for DB2 for LUW. The following names are examples of archive files for InfoSphere CDC for DB2 for LUW Version 10.2.1 Interim Fix 12: IIDR_1021_InterimFix12_Linuxx86_DB2LUW_for_all_licenses.zip IIDR_1021_InterimFix12_AIX_DB2LUW_for_all_licenses.zip
   cdc-installation-binary-name	The name of the installation program for InfoSphere CDC for DB2 for LUW. The following names are examples of installation programs for InfoSphere CDC for DB2 for LUW Version 10.2.1: setup-cdc-linux-x86-db2luw.bin setup-cdc-aix-db2luw.bin The following names are examples of installation programs for InfoSphere CDC for DB2 for LUW Version 10.2.1 Interim Fix 12: setup-1021-InterimFix12-linux-x86-db2luw.bin setup-1021-InterimFix12-aix-power-db2luw.bin
   cdc-server-host	The name of the server to install InfoSphere CDC for DB2 for LUW. Use the same server where the db2-instance-name resides.
   cdc-user	The operating system user name to install, configure, and upgrade InfoSphere CDC. This user must have access to the local database directory of db2-instance-name: db2-instance-dir/db2-instance-name/NODE0000/sqldbdir.
   cdc-user-group	The primary operating system group for cdc-user.
   cdc-user-home-dir	The home directory of cdc-user.
   cdc-installation-dir	The installation directory of InfoSphere CDC for DB2 for LUW. Ensure that the cdc-user has read and write permissions on the installation directory. The default installation directory is /opt/IBM/InfoSphereChangeDataCapture/ReplicationEngineforIBMDB2
   cdc-instance-name	The name of the InfoSphere CDC instance that is responsible for replication of shadow tables.
   cdc-port	The port number that InfoSphere CDC uses for communication with clients that are running InfoSphere CDC Management Console or command-line utilities. The default value for cdc-port is 10901.
   cdc-staging-store-size	The disk space (in GB) allocated to the staging store, which is a cache of change data that is read from the database logs. In most cases, the default value is appropriate for replicating shadow tables. For more information about store disk quota, see Sizing considerations for the staging store. The default value for cdc-staging-store-size is 100.
   cdc-subscription-name	The name given to a group of table mappings.
   cdc-max-instance-memory	The maximum amount of memory (RAM) to be used by the Java™ (JVM) running InfoSphere CDC for DB2 for LUW. For a typical environment with shadow tables, use 3.5 GB. A setting of 3584 works well for most environments. For more information, see Assessing disk space and memory requirements. The default value for cdc-max-instance-memory is 1024.
   cdc-bit-version	The bit-version of your DB2 database instance, either 64 or 32. The default value for cdc-bit-version is 64.
   cdc-refresh-loader-path	The directory to store files for bulk inserts into db2-database-name that you specify while you configure the InfoSphere CDC instance. This directory must be accessible to both cdc-user and db2-instance-owner. For better I/O performance, specify a path on a separate file system.
   cdc-refresh-loader-backup-path	The value of the refresh_loader_backup_path system parameter in InfoSphere CDC. Ensure that the directory that you specified in this parameter exists and meets the following conditions: The file system used for this path on the HADR primary server must be accessible from all of the standby servers by using the same mount point for a shared file system. An NFS share is sufficient for this purpose. Both InfoSphere CDC and DB2 database manager need read and write permissions to this path. For each table mapping, any time a refresh occurs, InfoSphere CDC creates a new folder cdc-refresh-loader-backup-path/BACKUP_COPY/load_image_folder_generated_by_CDC to save the DB2 load image, which is then replayed on the HADR standby. This generated folder needs to be created with modes bits (file system permissions) of 770 at a minimum, so that both the owner, creator and primary group have read and write permissions.
   cdc-acceptable-latency-in-seconds	The value of the acceptable_latency_in_seconds_for_column_organized_tables system parameter in InfoSphere CDC. The default value is 5 seconds, which works well for most workloads. The general guideline is less than the value of the CURRENT REFRESH AGE special register. For more information, see Setting up replication for shadow tables with IBM InfoSphere CDC Management Console. The default value for cdc-acceptable-latency-in-seconds is 5.
   access-server-installation-archive-name	The name of archive file that contains the installation program for InfoSphere CDC Access Server. The following names are examples of archive files for InfoSphere CDC Access Server Version 10.2.1 Interim Fix 5: IIDR_1021_InterimFix5_Linuxx86_AccessServer_for_all_licenses.zip IIDR_1021_InterimFix5_AIX_AccessServer_for_all_licenses.zip
   access-server-installation-binary-name	The name of the installation program for InfoSphere CDC Access Server. The following names are examples of installation programs for InfoSphere CDC Access Server Version 10.2.1 Interim Fix 5: cdcaccess-10.2.1_Interim_Fix_5-2231-linux-x86-setup.bin cdcaccess-10.2.1_Interim_Fix_5-2231-aix-power-setup.bin
   access-server-installation-dir	The installation directory for InfoSphere CDC Access Server. Ensure that the cdc-user has read and write permissions on the installation directory. The default installation directory is /opt/IBM/InfoSphereChangeDataCapture/AccessServer.
   access-server-host	The name of the server to install InfoSphere CDC Access Server. For shadow tables, installing this component on the same server as InfoSphere CDC for DB2 for LUW works well.
   access-server-port	The port number that InfoSphere CDC Access Server uses to communicate with InfoSphere CDC Management Console. The default value for access-server-port is 10101.
   access-server-user	The InfoSphere CDC Access Server administration user to log in to InfoSphere CDC Management Console or the CHCCLP command-line interface to perform various administration tasks, such as creating a new datastore and managing a subscription. This user must have the SYSADMIN role and define as a manager to grant privileges to manage datastores and user accounts in the Access Manager perspective of Management Console. For information about how to create access-server-user, see Configuring IBM InfoSphere Change Data Capture software for shadow tables.
   access-server-datastore-name	The name of a datastore that identifies cdc-instance-name to the Access Server.
   management-console-installation-archive-name	The name of archive file that contains the installation program for InfoSphere CDC Management Console. The following example is the name for InfoSphere CDC Management Console Version 10.2.1 Interim Fix 5: IIDR_1021_InterimFix5_Windows_ManagementConsole_for_all_licenses.zip
   management-console-installation-binary-name	The name of the installation program for InfoSphere CDC Management Console. The following example is the name for InfoSphere CDC Management Console Version 10.2.1 Interim Fix 5: IIDR_1021_InterimFix5_Linuxx86_AccessServer_for_all_licenses.zip (Linux) IIDR_1021_InterimFix5_AIX_AccessServer_for_all_licenses.zip (AIX)
   management-console-installation-dir	The directory to install InfoSphere CDC Management Console. The default installation directory is C:\Program Files\IBM\InfoSphere Change Data Capture\Management Console.
   management-console-workstation	The name of a Windows workstation to install InfoSphere CDC Management Console.

2. Ensure that you can log in to the cdc-server-host as cdc-user. Also, ensure that cdc-user has access to the following files:
   • The installation directory for each software component. cdc-user must be the owner of these directories.
   • The local database directory for the DB2 instance. cdc-user must have access to the db2-instance-dir/db2-instance-name/NODE0000/sqldbdir directory with drwxrwxr-x permissions.
   For example, as root, create a CDC user and a group by running the following commands:
   • On AIX® operating systems:

     mkgroup cdc-user-group
     mkuser home=cdc-user-home-dir pgrp=cdc-user-group groups=cdc-user-group 
     cdc-user
     passwd cdc-user

   • On Linux operating systems:

     groupadd cdc-user-group 
     useradd -d cdc-user-home-dir -g cdc-user-group -m cdc-user
     passwd cdc-user

3. Ensure that you have access to db2-cdc-user with the appropriate authorization. InfoSphere CDC prompts you for a DB2 user name and its password during installation. It stores it in an obfuscated format in the installation directory of the corresponding InfoSphere CDC software component. To restrict access to this sensitive data, secure the installation directory of the InfoSphere CDC software component by changing the file permissions so that only cdc-user and members of its group can access it.
4. Ensure that db2-cdc-user has access to db2-metadata-schema-name and can create objects under this schema.
5. If you want to specify cdc-refresh-loader-path as a refresh loader path, ensure that the directory exists and secure the file permissions so that it can be only accessed by cdc-user and db2-instance-owner.
6. If you have the access-server-host or the cdc-server-host behind a firewall, you must create rules to allow communication between the clients and the services in the access-server-host or the cdc-server-host.
   The following table shows the number of ports that are required by InfoSphere CDC software component:

   Table 2. Required ports for InfoSphere CDC software components

   InfoSphere CDC software component	Ports	Details
   InfoSphere CDC for DB2 for LUW	cdc-port	This is the port number that you specified when you created the datastore for shadow tables.
   InfoSphere CDC Access Server	2*MC_users + 1	Where MC_users is the number of users for InfoSphere CDC Management Console. If InfoSphere CDC Access Server is installed in a separate computer than the InfoSphere CDC Management Console, double this amount. One input and output port for the shadow tables datastore, per installation of Management Console - i.e port requirement for each user connection Two input and output ports for the shadow tables datastore
   InfoSphere CDC Management Console	3	One input and output port to the InfoSphere CDC Access Server One input port from the InfoSphere CDC Access Server One input and output port for the shadow tables datastore

   The following table shows the firewall rules that are required for each InfoSphere CDC component:

   Table 3. Firewall rules for InfoSphere CDC components:

   InfoSphere CDC software component	Details
   InfoSphere CDC for DB2 for LUW	Configuration with dynamic source ports Configure a firewall rule to allow traffic from any source port to the cdc-port. Configuration with static source ports Configure a firewall rule to allow traffic from a range of source ports to the cdc-port. InfoSphere CDC uses the next available por in the range that you specified for the access-server-host.
   InfoSphere CDC Access Server	Configuration with dynamic source ports Configure a firewall rule to allow traffic from any source port to the access-server-port. Configuration with static source ports Configure a firewall rule to allow traffic from a range of source ports to the access-server-port. InfoSphere CDC uses the next available por in the range that you specified for the InfoSphere CDC Management Console.

   For more information about firewall configuration for InfoSphere CDC, see Configuring firewall settings for outbound ports.