Upgrading DataStage Enterprise Plus

A project administrator can upgrade the DataStage Enterprise Plus service on IBM® Cloud Pak for Data.

Before you begin

Required role: To complete this task, you must be an administrator of the project (namespace) where DataStage Enterprise Plus is installed.

Before you upgrade DataStage Enterprise Plus, ensure that:

If you are upgrading multiple services on your cluster, you must run the upgrades one at a time and wait until the upgrade completes before upgrading another service. You cannot run the upgrades in parallel.

Tip: For a list of all available options, enter the following command:
./cpd-cli upgrade --help

Procedure

  1. Complete the appropriate steps to upgrade DataStage Enterprise Plus on your environment:
  2. Verifying that the upgrade completed successfully
  3. Checking for available patches
  4. Complete the tasks listed in What to do next

Upgrading on clusters connected to the internet

From your installation node:

  1. Change to the directory where you placed the Cloud Pak for Data command-line interface and the repo.yaml file.
  2. Log in to your Red Hat OpenShift cluster as a project administrator:
    oc login OpenShift_URL:port
  3. Run the following command to see a preview of what will change when you upgrade the service.
    Important: If you are using the internal Red Hat OpenShift registry and you are using the default self-signed certificate, specify the --insecure-skip-tls-verify flag to prevent x509 errors.
    ./cpd-cli upgrade \
    --repo ./repo.yaml \
    --assembly ds \
    --arch Cluster_architecture \  
    --namespace Project \
    --storageclass Storage_class_name \
    --transfer-image-to Registry_location \
    --cluster-pull-prefix Registry_from_cluster \
    --ask-pull-registry-credentials \
    --ask-push-registry-credentials \
    --latest-dependency \
    --dry-run
    Important: By default, this command gets the latest assembly. If you want to upgrade to a specific version of DataStage Enterprise Plus, add the following line to your command after the --assembly flag:
    --version Assembly_version \

    The --latest-dependency flag gets the latest version of the dependent assemblies. If you remove the --latest-dependency flag, the installer will either leave the dependent assemblies at the current version or get the minimum version of the dependent assemblies.

    Ensure that you use the same flags that your cluster administrator used when they completed Preparing to upgrade DataStage Enterprise Plus. If your cluster administrator used the --version flag, ensure that you specify the same version of the assembly.

    If you are upgrading with Portworx storage, add the following line to your upgrade command after the --storageclass flag:
    --override-config portworx \
    If you are upgrading with OpenShift Container Storage, add the following line to your upgrade command after the --storageclass flag:
    --override-config ocs \

    Replace the following values:

    Variable Replace with
    Assembly_version
    The version of DataStage Enterprise Plus that you want to install. The assembly versions are listed in System requirements for services.
    Cluster_architecture Specify the architecture of your cluster hardware:
    • For x86-64 hardware, remove this flag or specify x86_64
    Project Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
    Storage_class_name Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.

    Refresh 2 or later If you are using the 3.5.2 version of the cpd-cli, remove the --storageclass flag from your command. The cpd-cli upgrade command uses the storage class that was specified during installation.

    Registry_location Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
    Registry_from_cluster Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
  4. Rerun the previous command without the --dry-run flag to upgrade the service.

Upgrading on air-gapped clusters

From your installation node:

  1. Change to the directory where you placed the Cloud Pak for Data command-line interface.
  2. Log in to your Red Hat OpenShift cluster as a project administrator:
    oc login OpenShift_URL:port
  3. Run the following command to see a preview of what will change when you upgrade the service.
    Important: If you are using the internal Red Hat OpenShift registry:
    • Do not specify the --ask-pull-registry-credentials parameter.
    • If you are using the default self-signed certificate, specify the --insecure-skip-tls-verify flag to prevent x509 errors.
    ./cpd-cli upgrade \
    --assembly ds \
    --arch Cluster_architecture \
    --namespace Project \
    --storageclass Storage_class_name \
    --cluster-pull-prefix Registry_from_cluster \
    --ask-pull-registry-credentials \
    --load-from Image_directory_location \
    --latest-dependency \
    --dry-run
    Note: If the assembly was downloaded using the delta-images command, remove the --latest-dependency flag from the command. If you don't remove the --latest-dependency flag you will get an error indicating that the flag cannot be used.

    Ask your cluster administrator whether they specified the --latest-dependency flag when they completed Preparing to upgrade DataStage Enterprise Plus. If they ran the adm command with the --latest-dependency flag, you must also run the install command with the flag.

    If you are upgrading with Portworx storage, add the following line to your upgrade command after the --storageclass flag:
    --override-config portworx \
    If you are upgrading with OpenShift Container Storage, add the following line to your upgrade command after the --storageclass flag:
    --override-config ocs \

    Replace the following values:

    Variable Replace with
    Cluster_architecture Specify the architecture of your cluster hardware:
    • For x86-64 hardware, remove this flag or specify x86_64
    Project Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
    Storage_class_name Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.

    Refresh 2 or later If you are using the 3.5.2 version of the cpd-cli, remove the --storageclass flag from your command. The cpd-cli upgrade command uses the storage class that was specified during installation.

    Registry_from_cluster Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
    Image_directory_location Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
  4. Rerun the previous command without the --dry-run flag to upgrade the service.

Verifying that the upgrade completed successfully

From your installation node:

  1. Run the following command:
    ./cpd-cli status \
    --assembly ds \
    --namespace Project

    Replace Project with the value you used in the preceding commands.

    • If the upgrade completed successfully, the status of the assembly and the modules in the assembly is Ready.
    • If the upgrade failed, contact IBM Support for assistance.

Checking for available patches

Determine whether there are any patches available the version of DataStage Enterprise Plus that you installed:

Clusters connected to the internet
Run the following command to check for patches:
./cpd-cli status \
--repo ./repo.yaml \
--namespace Project \ 
--assembly ds \
--patches \
--available-updates 
Air-gapped clusters
See the list of Available patches for DataStage for IBM Cloud Pak for Data.

If you need to apply patches to the service, follow the guidance in Applying patches.

What to do next

Complete the following steps after upgrading from Cloud Pak for Data version 3.0.1 to 3.5.0 or applying patches on top of version 3.5.0.
  1. Log in to the DataStage Enterprise Plus conductor pod:
    oc exec -it is-en-conductor-0  -n <namespace> bash
  2. Map isadmin to dsadm:
    cd /opt/IBM/InformationServer/ASBNode/bin/
    ./DirectoryCommand.sh -user isadmin -password <IS_PASSWD> -url https://is-servicesdocker:9446
    -datastage_server IS-EN-CONDUCTOR-0.EN-COND -set_default_ds_credentials "dsadm~<DSADM_PASSWORD>"
  3. Restart the NodeEngine:
    /opt/IBM/InformationServer/ASBNode/bin/NodeAgents.sh stop
    /opt/IBM/InformationServer/ASBNode/bin/NodeAgents.sh start

The service is ready to use. See Transforming data (DataStage).