Table of contents

Installing Cognos Analytics

A project administrator can install Cognos Analytics on IBM® Cloud Pak for Data.

Permissions you need for this task
You must be an administrator of the OpenShift® project (Kubernetes namespace) where you will deploy Cognos Analytics.
Information you need to complete this task
  • Cognos Analytics needs only the restricted security context constraint (SCC).
  • Cognos Analytics must be installed in the same project as Cloud Pak for Data.
  • Cognos Analytics requires the Cloud Pak for Data common core services. If the common core services are not installed in the project where you plan to install Cognos Analytics, the common core services will be automatically installed when you install Cognos Analytics, which will increase the amount of time the installation takes to complete.
  • Cognos Analytics uses the following storage classes. If you don't use these storage classes on your cluster, ensure that you have a storage class with an equivalent definition:
    • OpenShift Container Storage: ocs-storagecluster-cephfs
    • NFS: managed-nfs-storage
    • Portworx: portworx-shared-gp3
    • IBM Cloud File Storage: ibmc-file-gold-gid or ibm-file-custom-gold-gid

Before you begin

Ensure that the cluster meets the minimum requirements for installing Cognos Analytics. For details, see System requirements.

Additionally, ensure that a cluster administrator completed the required Pre-installation tasks for your environment. Specifically, verify that a cluster administrator completed the following tasks:

  1. Cloud Pak for Data is installed. For details, see Installing Cloud Pak for Data.
  2. For environments that use a private container registry, such as air-gapped environments, the Cognos Analytics software images are mirrored to the private container registry. For details, see Mirroring images to your container registry.
  3. The cluster is configured to pull the Cognos Analytics software images. For details, see Configuring your cluster to pull images.
  4. The Cognos Analytics operator subscription exists. For details, see Creating operator subscriptions.

If these tasks are not complete, the Cognos Analytics installation will fail.


Complete the following tasks to install Cognos Analytics:

  1. Installing the service
  2. Verifying the installation
  3. What to do next

Installing the service

To install Cognos Analytics:

  1. Log in to Red Hat® OpenShift Container Platform as a user with sufficient permissions to complete the task:
    oc login OpenShift_URL:port
  2. Create a CAService custom resource to install Cognos Analytics.

    The recommended storage class names are described in Setting up shared persistent storage.

    Create a custom resource with the following format.

    cat <<EOF |oc apply -f -
    kind: CAService
      name: ca-addon-cr     # This is the recommended name, but you can change it
      namespace: project-name     # Replace with the project where you will install Cognos Analytics
      version: 4.0.1
        accept: true
      namespace: project-name     # Replace with the project where you will install Cognos Analytics
      storage_class: storage-class-name  # See the guidance in "Information you need to complete this task"

Verifying the installation

When you create the custom resource, the Cognos Analytics operator processes the contents of the custom resource and starts up the microservices that comprise Cognos Analytics, including CAService. (The CAService microservice is defined by the ca-addon-cr custom resource.) Cognos Analytics is installed when the CAService status is Completed.

To check the status of the installation:

  1. Change to the project where you installed Cognos Analytics:
    oc project project-name
  2. Get the status of Cognos Analytics (ca-addon-cr):
    oc get CAService ca-addon-cr -o jsonpath='{.status.caAddonStatus} {"\n"}'

    Cognos Analytics is ready when the command returns Completed

What to do next

After you install the service, you must provision it. For details, see Provisioning the Cognos Analytics service.

You will also need to configure the content store for Cognos Analytics. For details, see Configuring the content store for Cognos Analytics.