Creating a service instance for Cognos Analytics programmatically

Information you need to complete this task

Review the following information before you create a service instance for Cognos Analytics:

Version requirements

All of the components that are associated with an instance of IBM Software Hub must be installed or created at the same release. For example, if Cognos Analytics is installed at Version 5.2.2, you must create the service instance at Version 5.2.2.

Important: Cognos Analytics uses a different version number from IBM Software Hub. This topic includes a table that shows the Cognos Analytics version for each refresh of IBM Software Hub. Use this table to find the correct version based on the version of IBM Software Hub that is installed.

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

• If you don't have the script that defines the environment variables, see Setting up installation environment variables.
• To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:

  source ./cpd_vars.sh

Before you begin

This task assumes that the following prerequisites are met:

You must have sufficient resources for the plan size that you select. If you do not have sufficient resources, the instance cannot be created.

Procedure

Complete the following tasks to create a service instance:

1. Creating a service instance
2. Validating that the service instance was created
3. What to do next

Creating a service instance

To create a service instance:

1. Change to the directory on your workstation where you want to create the JSON file that defines the service instance payload.
2. Set the environment variables that are used to populate the JSON payload for the service instance:
   1. Set the INSTANCE_NAME environment variable to the unique name that you want to use as the display name for the service instance:

      export INSTANCE_NAME="<display-name>"

      This name is displayed on the Instances page of the IBM Software Hub web client.

      The display name is a string and can contain alphanumeric characters (a-z, A-Z, 0-9), spaces ( ), dashes (-), underscores (_), and periods (.). Make sure that you surround the display name with quotation marks, as shown in the preceding export command.

   2. Set the INSTANCE_DESCRIPTION environment variable to the description that you want to use for the service instance:

      export INSTANCE_DESCRIPTION="<description>"

      This description is displayed on the Instances page of the IBM Software Hub web client.

      The description is a string and can contain alphanumeric characters, spaces, dashes, underscores, and periods. Make sure that you surround the display name with quotation marks, as shown in the preceding export command.

   3. Set the INSTANCE_VERSION environment variable to the version that corresponds to the version of IBM Software Hub on your cluster:

      export INSTANCE_VERSION=<version>

      Use the following table to determine the appropriate value:

      IBM Software Hub version	Service instance version
      5.2.2	28.2.0
      5.2.1	28.1.0
      5.2.0	28.0.0

   4. Set the INSTANCE_PROJECT to the project where you want to create the service instance:

      ---

      Create the service instance in the operands project

      export INSTANCE_PROJECT=${PROJECT_CPD_INST_OPERANDS}

      The command uses the PROJECT_CPD_INST_OPERANDS variable, which is already defined in your installation environment variables script.

      ---

      Create the service instance in a tethered project

      Important: If multiple tethered projects are associated with this instance of IBM Software Hub, make sure that the ${PROJECT_CPD_INSTANCE_TETHERED} environment variable is set to the correct project name before you run the export command:

      echo $PROJECT_CPD_INSTANCE_TETHERED

      export INSTANCE_PROJECT=${PROJECT_CPD_INSTANCE_TETHERED}

      ---

      Remember: You can create only one service instance in each project.
   5. Set the CONTENT_STORE_CONNECTION_NAME environment variable to the name of the platform connection that you created to connect to the content store for the service instance.

      export CONTENT_STORE_CONNECTION_NAME=<connection-display-name>

   6. Set the CONTENT_STORE_CONNECTION_PROPS environment variable based on whether you need to specify additional properties to connect to the content store through JDBC:
      • If you don't need to specify any additional connection properties, set:

        export CONTENT_STORE_CONNECTION_PROPS=""

      • If you need to specify additional connection properties, specify a semicolon-separated list of key-value pairs:

        export CONTENT_STORE_CONNECTION_PROPS=<key1=value1;key2=value2;...>

   7. Set the AUDIT_DB_CONNECTION_NAME environment variable to the name of the platform connection that you created to connect to the audit database for the service instance.

      export AUDIT_DB_CONNECTION_NAME=<connection-display-name>

   8. Set the AUDIT_DB_CONNECTION_PROPS environment variable based on whether you need to specify additional properties to connect to the audit database through JDBC:
      • If you don't need to specify any additional connection properties, set:

        export AUDIT_DB_CONNECTION_PROPS=""

      • If you need to specify additional connection properties, specify a semicolon-separated list of key-value pairs:

        export AUDIT_DB_CONNECTION_PROPS=<key1=value1;key2=value2;...>

   9. Set the INSTANCE_SIZE environment variable. The size determines the resources that are allocated to the service instance.

      export INSTANCE_SIZE=<size>

      Valid values are:

      • small_mincpureq
      • fixedminimum
      • xsmall
      • small
      • medium
      • large

      For more information about the resources associated with each size, see the component scaling guidance PDF, which you can download from the IBM Entitled Registry.

   10. Set the FIPS_MODE and FIPS_MODE_LABEL environment variables based on whether FIPS is enabled on the cluster:
       • If FIPS is not enabled on the cluster, set:

         export FIPS_MODE=""
         export FIPS_MODE_LABEL=""

       • If FIPS is enabled on the cluster, set:

         export FIPS_MODE=FIPS_140
         export FIPS_MODE_LABEL="FIPS 140-2"

   11. If you want to deliver reports through email, set the following environment variables to connect to an SMTP server.

       You can use the IBM Software Hub SMTP server or a separate SMTP server.

       1. Set the SMTP_ADDRESS environment variable to the IP address or fully qualified domain name of your SMTP server:

          export SMTP_ADDRESS=<server-address>

       2. Set the SMTP_PORT environment variable to the port number of your SMTP server.
          Important: If you specify a secure port, you must also set SMTP_TLS_CHECK environment variable to true and set the SMTP_CERT environment variable to the TLS certificate for your SMTP server.

          export SMTP_PORT=<port-number>

       3. Set the SMTP_TLS_CHECK environment variable based on whether you are connecting to a secure port on your SMTP server:
          • If you are connecting to a secure port, set:

            export SMTP_TLS_CHECK=true

          • If you are connecting to an insecure port, set:

            export SMTP_TLS_CHECK=false

       4. Set the SMTP_TLS_CERT environment variable based on whether you are connecting to a secure port on your SMTP server:
          • If you are connecting to a secure port, set the SMTP_TLS_CERT environment variable to the content of the TLS certificate.

            export SMTP_TLS_CERT="-----BEGIN CERTIFICATE-----
            <certificate-content>
            -----END CERTIFICATE-----"

          • If you are connecting to an insecure port, set:

            export SMTP_TLS_CERT=""

       5. Set the SMTP_USERNAME environment variable based on whether your SMTP server requires authentication:
          • If your SMTP server requires authentication, set the SMTP_USERNAME environment variable to the username of an SMTP server user:

            export SMTP_USERNAME=<username>

          • If your SMTP server does not require authentication, set:

            export SMTP_USERNAME=""

       6. Set the SMTP_PASSWORD environment variable based on whether your SMTP server requires authentication:
          • If your SMTP server requires authentication, set the SMTP_PASSWORD environment variable to the password of the SMTP server user that you specified in the previous step:

            export SMTP_PASSWORD=<password>

          • If your SMTP server does not require authentication, set:

            export SMTP_PASSWORD=""

       7. Set the SMTP_DEFAULT_SENDER environment variable based on whether your SMTP server uses a mailer daemon to send communications:
          • If your SMTP server does not use a mailer daemon to send communications, set the SMTP_DEFAULT_SENDER to the email address that you want to send communications from:

            export SMTP_DEFAULT_SENDER=<email-address>

          • If your SMTP server uses a mailer daemon to send communications but you want to override the default sender, set the SMTP_DEFAULT_SENDER to the email address that you want to send communications from:

            export SMTP_DEFAULT_SENDER=<email-address>

          • If your SMTP server uses a mailer daemon and you want to send communications from the mailer daemon, set:

            export SMTP_DEFAULT_SENDER=""

3. Create the cognos-analytics-instance.json payload file.

   The command that you run depends on whether you want connect to an SMTP server to deliver reports through email:

   Payload with SMTP parameters

   cat << EOF
   {
       "addon_type": "cognos-analytics-app",
       "display_name": "${INSTANCE_NAME}",
       "namespace": "${TETHERED_NAMESPAE}",
       "addon_version": "${ADDON_VERSION}",
       "create_arguments": {
           "deployment_id": "",
           "parameters": {
               "fileStorageClass": "${STG_CLASS_FILE}",
               "blockStorageClass": "${STG_CLASS_BLOCK}",
               "fips": "${FIPS_MODE_LABEL}",
               "planSize": "${PLAN_SIZE}",
               "audit": "${AUDIT_CONNECTION_NAME}",
               "auditProperty": "${AUDIT_DB_CONNECTION_PROPS}",
               "cs": "${CONTENT_STORE_CONNECTION_NAME}",
               "csProperty": "${CONTENT_STORE_CONNECTION_PROPS}",
               "smtp_address": "${SMTP_ADDRESS}",
               "smtp_port": "${SMTP_PORT}",
               "smtp_defaultSender": "${SMTP_DEFAULT_SENDER}",
               "smtp_name": "${SMTP_USERNAME}",
               "smtp_password": "${SMTP_PASSWORD}",
               "smtp_tlsCheck": "${SMTP_TLS_CHECK}",
               "smtp_tlsEnabledCert": "${SMTP_TLS_CERT}"
           },
           "resources": {},
           "description": "${INSTANCE_DESCRIPTION}",
           "owner_username": ""
       },
       "transient_fields": {}
   }
   EOF

   Payload without SMTP parameters

   cat << EOF
   {
       "addon_type": "cognos-analytics-app",
       "display_name": "${INSTANCE_NAME}",
       "namespace": "${TETHERED_NAMESPAE}",
       "addon_version": "${ADDON_VERSION}",
       "create_arguments": {
           "deployment_id": "",
           "parameters": {
               "fileStorageClass": "${STG_CLASS_FILE}",
               "blockStorageClass": "${STG_CLASS_BLOCK}",
               "fips": "${FIPS_MODE_LABEL}",
                "planSize": "${PLAN_SIZE}",
                "audit": "${AUDIT_CONNECTION_NAME}",
                "auditProperty": "${AUDIT_DB_CONNECTION_PROPS}",
                "cs": "${CONTENT_STORE_CONNECTION_NAME}",
                "csProperty": "${CONTENT_STORE_CONNECTION_PROPS}"
           },
           "resources": {},
           "description": "${INSTANCE_DESCRIPTION}",
           "owner_username": ""
       },
       "transient_fields": {}
   }
   EOF

   The following environment variables use the values that are already defined in your installation environment variables script:

   • ${STG_CLASS_BLOCK}
   • ${STG_CLASS_FILE}
4. Set the PAYLOAD_FILE environment variable to the fully qualified name of the JSON payload file on your workstation:

   export PAYLOAD_FILE=<fully-qualified-JSON-file-name>

5. Set the environment variables that are used to connect to the instance of IBM Software Hub where you want to create the service instance:
   1. Set the API_KEY environment variable to the API key that you created:

      export API_KEY=<your_api_key>

6. Create the service instance from the payload file.

   The command that you run depends on whether the instance of IBM Software Hub where you want to create the service instance uses a self-signed certificate or a certificate signed by a trusted certificate authority.

   ---

   The instance uses a certificate signed by a trusted certificate authority

   curl --request POST \
   --url "https://${CPD_ROUTE}/zen-data/v3/service_instances" \
   --header "Authorization: ZenApiKey ${API_KEY}" \
   --header 'Content-Type: application/json' \
   --data @${PAYLOAD_FILE}

   ---

   The instance uses a self-signed certificate (default)

   curl -k --request POST \
   --url "https://${CPD_ROUTE}/zen-data/v3/service_instances" \
   --header "Authorization: ZenApiKey ${API_KEY}" \
   --header 'Content-Type: application/json' \
   --data @${PAYLOAD_FILE}

   ---

   If the request was successful, the command returns one of the following HTTP response codes:

   • 200 - The request was successfully completed and the service instance was provisioned.
   • 202 - The request was successfully submitted. The service instance is being provisioned.

   If the request was not successful, use the HTTP response code to determine the reason.

Validating that the service instance was created

To validate that the service instance was created:

1. Set the INSTANCE_ID environment variable to the ID that was returned by the POST cURL command:

   export INSTANCE_ID=<ID-from-response>

2. Run the following command to get the status of the service instance:

   curl --request GET \ 
     --url "https://${CPD_ROUTE}/zen-data/v3/service_instances/${INSTANCE_ID}" \ 
     --header "Authorization: ZenApiKey ${AUTH_TOKEN}" \ 
     --header 'Content-Type: application/json'

   • If the request was successful, the command returns the following HTTP response code: 200
     Find the provision_status parameter in the JSON response.

     • If the value is RUNNING, the service instance was successfully created.
     • If the value is PROVISION_IN_PROGRESS, wait a few minutes and run the command again.
     • If the value is FAILED, review the pod logs for the ibm-cognos-addon-sp-deployment-*, ibm-ca-operator-controller-manager-*, zen-core-api, and zen-watcher pods for possible causes.
   • If the request was not successful, use the HTTP response code to determine the reason.

What to do next