Installing the product data export and import utility

Important: IBM® Cloud Pak for Data Version 4.5 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.5 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

The product data export and import utility exports and imports data, including metadata, between your IBM Cloud Pak for Data deployments.

Before you begin

Security and roles: cpdtool and cpd-cli export-import require cluster administrator or similar roles.

About this task

The product data export and import utility exports data from one Cloud Pak for Data installation and imports the data to another installation.

The product data export and import utility consists of the following components:

  1. The cpdtool command line interface, included as part of the cpd-cli export-import command.
  2. The cpdtool docker image.

These instructions assume that the IBM Cloud Pak for Data control plane is already installed on your Red Hat® OpenShift® cluster.

Procedure

To install the cpdtool image:

  1. Check whether Docker or Podman is available on the system. If neither of them are available, install one of them.

    You can use either Docker or Podman to install the cpdtool Docker image.

    Tip: For more information about installing Podman, see the Podman installation instructions.
  2. Install the cpdtool Docker image.

    The following examples install the cpdtool image by using Podman.

    Note: If your Docker image registry is different than what is shown in the examples, change the appropriate flags.

    OpenShift 4.x example:

    IMAGE_REGISTRY=`oc get route -n openshift-image-registry | grep image-registry | awk '{print $2}'`
echo $IMAGE_REGISTRY
NAMESPACE=`oc project -q`
echo $NAMESPACE
CPU_ARCH=`uname -m`
echo $CPU_ARCH
BUILD_NUM=`./cpd-cli export-import version | grep "Build Number" |cut -d : -f 2 | xargs`
echo $BUILD_NUM

# Pull cpdtool image from IBM Cloud Container Registry
podman pull icr.io/cpopen/cpd/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH}
# Push image to internal registry
podman login -u kubeadmin -p $(oc whoami -t) $IMAGE_REGISTRY --tls-verify=false
podman tag icr.io/cpopen/cpd/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH} $IMAGE_REGISTRY/$NAMESPACE/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH}
podman push $IMAGE_REGISTRY/$NAMESPACE/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH} --tls-verify=false

    OpenShift 3.11 example:

    Note: Cloud Pak for Data 4.5 does not support OpenShift 3.11. This example can be used to migrate an OpenShift 3.11 installation to a supported OpenShift 4.x version before upgrading to Cloud Pak for Data 4.5.
    IMAGE_REGISTRY=`oc registry info`
echo $IMAGE_REGISTRY
NAMESPACE=`oc project -q`
echo $NAMESPACE
CPU_ARCH=`uname -m`
echo $CPU_ARCH
BUILD_NUM=`./cpd-cli export-import version | grep "Build Number" |cut -d : -f 2 | xargs`
echo $BUILD_NUM

# Pull cpdtool image from IBM Cloud Container Registry
podman pull icr.io/cpopen/cpd/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH}
# Push image to internal registry
podman login -u ocadmin -p $(oc whoami -t) $IMAGE_REGISTRY --tls-verify=false
podman tag icr.io/cpopen/cpd/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH} $IMAGE_REGISTRY/$NAMESPACE/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH}
podman push $IMAGE_REGISTRY/$NAMESPACE/cpdtool:4.0.0-${BUILD_NUM}-${CPU_ARCH} --tls-verify=false

What to do next

Migrating data between Cloud Pak for Data installations