Table of contents

Installing Open Data for Industries

A project administrator can install the Open Data for Industries 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 you will deploy Open Data for Industries.

Before you install Open Data for Industries, ensure that:

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

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

Procedure

  1. Complete the appropriate steps to install Open Data for Industries on your environment:
  2. Verifying that the installation completed successfully
  3. Configuring and validating the service
  4. What to do next

Installing 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 be installed when you install 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 install \
    --repo ./repo.yaml \
    --assembly ibm-osdu \
    --arch Cluster_architecture \
    --namespace Project \
    --storageclass Storage_class_name \
    --transfer-image-to Registry_location \
    --cluster-pull-prefix Registry_from_cluster \
    --ask-push-registry-credentials \
    --latest-dependency \
    --dry-run
    Important: By default, this command gets the latest version of the assembly. If you want to install a specific version of Open Data for Industries, 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 get the minimum version of the dependent assemblies.

    Replace the following values:

    Variable Replace with
    Assembly_version
    The version of Open Data for Industries 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 Specify osdu.
    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.
    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 install the service.

Installing 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 be installed when you install 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 install \
    --assembly ibm-osdu \
    --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.

    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 Specify osdu.
    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.
    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 The location of the cpd-cli-workspace directory.

    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 install the service.

Verifying that the installation completed successfully

From your installation node:

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

    Replace Project with the value you used in when you installed Open Data for Industries.

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

Configuring and validating the service

Note: The procedures in this section require a file named ODforI_utilities_tools.tar. Download the following file from IBM Passport Advantage®:
  • Part number: G00FGZX
  • Description: IBM Open Data for Industries Installation Utility Tools V1.0 Multiplatform
  • File name: ODforI_utilities_tools.tar

Before you can use Open Data for Industries, you must run a one-time script that prepares the environment with the necessary configuration.

From your installation node:
  1. Log in to your Red Hat OpenShift cluster as a project administrator:
    oc login OpenShift_URL:port
  2. Decompress ODforI_utilities_tools.tar, which contains the configuration scripts postInstall_script.sh. In the following example, the tar file is extracted to a directory named ODI_Install:
    tar -xvf ODforI_utilities_tools.tar -C ODI_Install
  3. Change to the directory where the tar file was decompressed.
  4. Run the postInstall_script.sh script, by running the following command:
    ./postInstall_script.sh <ingress_certificate_name>
    Note: You can retrieve the <ingress_certificate_name> in the Secrets section of the openshift-ingress namespace in the OpenShift web console.

The Open Data for Industries environment is now configured for first use.

Although optional, you can verify your cluster through the administration console:
  1. Log in to your Red Hat OpenShift cluster as a project administrator:
    oc login OpenShift_URL:port
  2. Go to the Networking page of the osdu project.
  3. On the Networking page, expand the Route section and click the URL under 'Location' column for route named 'osdu-cpd'.
  4. Authenticate with default user and password.
  5. Select 'Platform Management' on the landing page.
  6. On the 'Platform Management' page, click the 'Services' section.
  7. Validate 'IBM Open Energy Data' as one of the services on the landed page.
  8. Click the 'IBM Open Energy Data' hyperlink to validate the running pods.
Although optional, you can check to see whether you can interact with the API:
  1. Decompress ODforI_utilities_tools.tar, which contains the test script, sanity-test-cpd.sh. In the following example, the tar file is extracted to a directory named ODI_Install:
    tar -xvf ODforI_utilities_tools.tar -C ODI_Install
  2. Change to the directory where the tar file was decompressed.
  3. Run the sanity-test-cpd.sh script, by running the following command:
    ./sanity-test-cpd.sh

    The sanity-test-cpd.sh script validates that all the common services are up and running.

What to do next