Extending Data Replication capabilities

To access extended Data Replication capabilities you can purchase additional Data Replication licenses, and an instance administrator can install the additional licenses in the same Data Replication service.

Roles and permissions: Instance administrator To complete this task the first time, you must be the instance administrator who installed the Data Replication service.

About this task

Each additional license that you install provides a specific set of plug-ins to extend your Data Replication capabilities. Each additional license provides new source and target connection datasource types. All license capabilities are defined to the Data Replication service as Data Replication extensions. The replication extension is an OpenShift® custom resource with all the capabilities of a specific license.

Before you begin

Ensure that the Data Replication service is installed.
Ensure that the environment variables are set up:
The commands in this task use environment variables so that you can run the commands exactly as written. If you don't have the script that defines the environment variables, see Setting up installation environment variables. To use the environment variables from the script, you must source the environment variables before you run the commands in this task.

Procedure

To install the extensions that you purchased:

View installed licenses.
Before you install an additional license, check to see what is already installed:

You can use OpenShift native command line tools on your local workstation to view and allocate Data Replication extensions. Use the following command to view your existing installed licenses:
```
oc get replicationextensions
```
Tip: If you don't want to use the long form: replicationextensions you can also use any of the following short form alternatives in the command: replextns, replextn, replxtn, replxtns, replextns.

Choose the licenses to install.

Depending on the license extensions you purchased, you can install one or more of the following extensions.

License	Value
IBM® Data Replication Cartridge	IDRC
IBM InfoSphere® Data Replication Cartridge	IIDRC
IBM Data Replication Modernization	IDRM
IBM InfoSphere Data Replication Modernization	IIDRM
IBM Data Replication for Db2® z/OS® Cartridge	IDRZOS
IBM InfoSphere Data Replication for watsonx.data™ Cartridge	IIDRWXTO
IBM InfoSphere Data Replication Cartridge Add-on for IBM watsonx.data	IIDRWXAO

Install the license extensions.

The installation process automatically allocates a replication extension for the license and enables its capabilities. You can install multiple replication extensions with the same Data Replication service. If you need to install more than one license extension, run each command one at a time.

Note: After you add each license, you might not see the new source and target data source types in the GUI until the license installation is complete. The new capabilities provided by the additional license should appear in the replication creation GUI as new source and target connection datasource types, based on the specific license's capabilities.

You can install any of the following replication extensions:

IBM Data Replication Cartridge replication extension (IDRC)

If you want to add IBM Data Replication Cartridge to your Data Replication installation, run the following command:

cat << EOF | oc apply -f -
apiVersion: replication.cpd.ibm.com/v1
kind: ReplicationExtension
metadata:
  name: "idrc-replication-extension"
  namespace: ${PROJECT_CPD_INST_OPERANDS} 
  labels:
    icpdsupport/addOnId: data-replication
spec:
  license:
    accept: true
    license: IDRC
  extensions: |
    [
      {
          "extension_point_id": "plugin_extension",
          "extension_name": "idrc-replication-extension",
          "details": {
            "location_conf": "extension.conf"
          }
      }
    ]
  extension.conf: |
    {
      "plugins": [
            "com.ibm.replication.saas/plugin-db2-woc-egest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-egest/1.0.0",
            "com.ibm.replication.saas/plugin-postgresql-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-oracle-xstream-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-json-egest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-avro-egest/1.0.0",
            "com.ibm.replication.saas/plugin-access-server-common/1.0.0",
            "com.ibm.replication.saas/plugin-watsonx-data-writer/1.0.0"
       ]
     }
EOF

IBM InfoSphere Data Replication Cartridge (IIDRC)

If you want to add IBM InfoSphere Data Replication Cartridge to your Data Replication installation, run the following command:

cat << EOF | oc apply -f -
apiVersion: replication.cpd.ibm.com/v1
kind: ReplicationExtension
metadata:
  name: "iidrc-replication-extension"
  namespace: ${PROJECT_CPD_INST_OPERANDS} 
  labels:
    icpdsupport/addOnId: data-replication
spec:
  license:
    accept: true
    license: IIDRC
  extensions: |
    [
      {
          "extension_point_id": "plugin_extension",
          "extension_name": "iidrc-replication-extension",
          "details": {
            "location_conf": "extension.conf"
          }
      }
    ]
  extension.conf: |
    {
      "plugins": [
            "com.ibm.replication.saas/plugin-db2-woc-egest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-egest/1.0.0",
            "com.ibm.replication.saas/plugin-postgresql-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-oracle-xstream-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-json-egest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-avro-egest/1.0.0",
            "com.ibm.replication.saas/plugin-access-server-common/1.0.0"
       ]
     }
EOF

IBM Data Replication Modernization (IDRM)

If you want to add IBM Data Replication Modernization to your Data Replication installation, run the following command:

cat << EOF | oc apply -f -
apiVersion: replication.cpd.ibm.com/v1
kind: ReplicationExtension
metadata:
  name: "idrm-replication-extension"
  namespace: ${PROJECT_CPD_INST_OPERANDS} 
  labels:
    icpdsupport/addOnId: data-replication
spec:
  license:
    accept: true
    license: IDRM
  extensions: |
    [
      {
          "extension_point_id": "plugin_extension",
          "extension_name": "idrm-replication-extension",
          "details": {
            "location_conf": "extension.conf"
          }
      }
    ]
  extension.conf: |
    {
      "plugins": [
            "com.ibm.replication.saas/plugin-db2-woc-egest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-egest/1.0.0",
            "com.ibm.replication.saas/plugin-postgresql-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-oracle-xstream-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-json-egest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-avro-egest/1.0.0",
            "com.ibm.replication.saas/plugin-access-server-common/1.0.0",
            "com.ibm.replication.saas/plugin-watsonx-data-writer/1.0.0"
       ]
     }
EOF

IBM InfoSphere Data Replication Modernization (IIDRM)

If you want to add IBM InfoSphere Data Replication Modernization to your Data Replication installation, run the following command:

cat << EOF | oc apply -f -
apiVersion: replication.cpd.ibm.com/v1
kind: ReplicationExtension
metadata:
  name: "iidrm-replication-extension"
  namespace: ${PROJECT_CPD_INST_OPERANDS} 
  labels:
    icpdsupport/addOnId: data-replication
spec:
  license:
    accept: true
    license: IIDRM
  extensions: |
    [
      {
          "extension_point_id": "plugin_extension",
          "extension_name": "iidrm-replication-extension",
          "details": {
            "location_conf": "extension.conf"
          }
      }
    ]
  extension.conf: |
    {
      "plugins": [
            "com.ibm.replication.saas/plugin-db2-woc-egest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-db2-udb-egest/1.0.0",
            "com.ibm.replication.saas/plugin-postgresql-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-oracle-xstream-ingest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-json-egest/1.0.0",
            "com.ibm.replication.saas/plugin-kafka-avro-egest/1.0.0",
            "com.ibm.replication.saas/plugin-access-server-common/1.0.0"
       ]
     }
EOF

IBM Data Replication for Db2 z/OS Cartridge (IDRZOS)

If you want to add IBM Data Replication for Db2 z/OS Cartridge to your Data Replication installation, run the following command:

cat << EOF | oc apply -f -
apiVersion: replication.cpd.ibm.com/v1
kind: ReplicationExtension
metadata:
  name: "zos-replication-extension"
  namespace: ${PROJECT_CPD_INST_OPERANDS} 
  labels:
    icpdsupport/addOnId: data-replication
spec:
  license:
    accept: true
    license: IDRZOS
  extensions: |
    [
      {
          "extension_point_id": "plugin_extension",
          "extension_name": "zos-replication-extension",
          "details": {
            "location_conf": "extension.conf"
          }
      }
    ]
  extension.conf: |
    {
      "plugins": [
          "com.ibm.replication.saas/plugin-db2-woc-egest/1.0.0",
          "com.ibm.replication.saas/plugin-db2-z-ingest/1.0.0",
          "com.ibm.replication.saas/plugin-kafka-json-egest/1.0.0",
          "com.ibm.replication.saas/plugin-kafka-avro-egest/1.0.0",
          "com.ibm.replication.saas/plugin-db2-udb-egest/1.0.0",
          "com.ibm.replication.saas/plugin-access-server-common/1.0.0",
       ]
     }
EOF

IBM InfoSphere Data Replication for watsonx.data Cartridge (IIDRWXTO)

If you want to add IBM InfoSphere Data Replication for watsonx.data Cartridge to your Data Replication installation, run the following command:

cat << EOF | oc apply -f -
apiVersion: replication.cpd.ibm.com/v1
kind: ReplicationExtension
metadata:
  name: "iidrwxto-replication-extension"
  namespace: ${PROJECT_CPD_INST_OPERANDS} 
  labels:
    icpdsupport/addOnId: data-replication
spec:
  license:
    accept: true
    license: IIDRWXTO
  extensions: |
    [
      {
          "extension_point_id": "plugin_extension",
          "extension_name": "iidrwxto-replication-extension",
          "details": {
            "location_conf": "extension.conf"
          }
      }
    ]
  extension.conf: |
    {
      "plugins": [
         "com.ibm.replication.saas/plugin-postgresql-ingest/1.0.0",
         "com.ibm.replication.saas/plugin-oracle-xstream-ingest/1.0.0",
         "com.ibm.replication.saas/plugin-db2-udb-ingest/1.0.0",
         "com.ibm.replication.saas/plugin-access-server-common/1.0.0",
         "com.ibm.replication.saas/plugin-watsonx-data-writer/1.0.0"
       ]
     }
EOF

IBM InfoSphere Data Replication Cartridge Add-on for IBM watsonx.data (IIDRWXAO)

If you want to add IBM InfoSphere Data Replication Cartridge Add-on for IBM watsonx.data to your Data Replication installation, run the following command:

cat << EOF | oc apply -f -
apiVersion: replication.cpd.ibm.com/v1
kind: ReplicationExtension
metadata:
  name: "iidrwxao-replication-extension"
  namespace: ${PROJECT_CPD_INST_OPERANDS} 
  labels:
    icpdsupport/addOnId: data-replication
spec:
  license:
    accept: true
    license: IIDRWXAO
  extensions: |
    [
      {
          "extension_point_id": "plugin_extension",
          "extension_name": "iidrwxao-replication-extension",
          "details": {
            "location_conf": "extension.conf"
          }
      }
    ]
  extension.conf: |
    {
      "plugins": [
         "com.ibm.replication.saas/plugin-watsonx-data-writer/1.0.0"
       ]
     }
EOF

What to do next

Additional licenses are ready to use with the Data Replication service. For more information, see Getting started with Data Replication.