Enabling telemetry data collection for an instance of IBM Cloud Pak for Data

After you install the IBM Metrics Operator, you must create a secret that enables the IBM Metrics Operator to collect information from the project where IBM Cloud Pak for Data is installed.

Who needs to complete this task?

Cluster administrator A cluster administrator must complete this task.

When do you need to complete this task?

Repeat as needed Repeat this task for each instance of Cloud Pak for Data cluster that you want to connect to IBM Software Central.

Before you begin

A cluster administrator must complete Installing the IBM Data Reporter Operator for telemetry data collection.

To complete this task, you must have your IBM customer number.
Best practice: You can run many of the commands in this task exactly as written if you set up environment variables for your installation. For instructions, see Setting up installation environment variables.

Ensure that you source the environment variables before you run the commands in this task.

Procedure

  1. Log in to Red Hat® OpenShift® Container Platform as a user with sufficient permissions to complete the task.
    ${OC_LOGIN}
    Remember: OC_LOGIN is an alias for the oc login command.
  2. Set the following environment variables:
    1. Run the following command to set the DRO_HOST environment variable:
      export DRO_HOST=$(oc get route --namespace ibm-software-central ibm-data-reporter --template='{{ .spec.host }}')​
    2. Run the following command to set the DRO_TOKEN environment variable:
      export DRO_TOKEN=$(oc create token ibm-data-reporter-operator-api --namespace ibm-software-central --duration 99999h)​
    3. Set the CUSTOMER_NAME environment variable to the name of your company or account with IBM:
      export CUSTOMER_NAME=<company-or-account-name>
    4. Set the CUSTOMER_ICN environment variable to your IBM customer number::
      export CUSTOMER_ICN=<customer-number>

      For more information about your IBM customer number, see What is my IBM Customer Number (ICN)? on the IBM Support site.

    5. Set ENVIRONMENT_TYPE based on how you are using this instance of Cloud Pak for Data:
      Production environment
      export ENVIRONMENT_TYPE=production
      Proof-of-concept environment
      export ENVIRONMENT_TYPE=poc
      Test environment
      export ENVIRONMENT_TYPE=test
  3. Create a secret named dro-secret in the operands project for this instance of Cloud Pak for Data:
    oc create secret generic dro-secret \
    --namespace=${PROJECT_CPD_INST_OPERANDS} \
    --from-literal=host=${DRO_HOST} \
    --from-literal=token=${DRO_TOKEN} \
    --from-literal=customerName=${CUSTOMER_NAME} \
    --from-literal=customerICN=${CUSTOMER_ICN} \
    --from-literal=environment=${ENVIRONMENT_TYPE} \
    --from-literal=instanceName=${PROJECT_CPD_INST_OPERANDS}

Results

Usage reports are generated after you enable telemetry data collection for an instance of IBM Cloud Pak for Data. Your telemetry data is sent to IBM Software Central daily.

Approximately two days after you complete the setup, your data is visible on the Current usage page in IBM Software Central.