Installing IBM Cloud Pak foundational services with License Service only

You can use the IBM Cloud Pak foundational services operator to install IBM Cloud Pak foundational services with License Service only, if required.

Note: When you install IBM Cloud Pak foundational services with License Service only, Administration panel with the Licensing summary card, and License Service Reporter user interface are not available.

The IBM Cloud Pak foundational services operator, including the Operand Deployment Lifecycle Manager and License Service, by default, are installed in the ibm-common-services namespace.

The Operand Deployment Lifecycle Manager watches all the namespaces in the cluster. The IBM Cloud Pak foundational services operator manages the lifecycle of the License Service operator.

Installation steps

  1. Prerequisites
  2. Installing the IBM Cloud Pak foundational services operator
  3. Installing License Service in your cluster
  4. Verifying the installation
  5. Accessing the licensing data

1. Prerequisites

2. Installing the IBM Cloud Pak foundational services operator

You must complete these tasks from your OpenShift cluster console.

  1. Create the IBM Cloud Pak foundational services catalog source.

    1. Log in to your OpenShift cluster console.

    2. Click the plus icon. You see the Import YAML dialog box.

    3. Create the IBM Cloud Pak foundational services source. You need to create a CatalogSource.

      To create a CatalogSource, paste the following definition in the YAML dialog box:

        apiVersion: operators.coreos.com/v1alpha1
 kind: CatalogSource
 metadata:
   name: ibm-operator-catalog
   namespace: openshift-marketplace
 spec:
   displayName: ibm-operator-catalog
   publisher: IBM Content
   sourceType: grpc
   image: icr.io/cpopen/ibm-operator-catalog
   updateStrategy:
     registryPoll:
       interval: 45m

    4. Click Create. The catalog source ibm-operator-catalog is created.

    5. Verify that the source container is running.

      oc -n openshift-marketplace get pod | grep ibm-operator-catalog

      The response resembles the following example:

      ibm-operator-catalog-r9ht7                                        1/1     Running

  2. Create a namespace for the IBM Cloud Pak foundational services operator. You need a dedicated namespace for the operator.

    1. From the navigation pane, click Home > Projects. The Projects page is displayed.

    2. Click Create Project. A Create Project area is displayed.

    3. Enter details of the namespace that you are creating. Specify ibm-common-services as the name.

    4. Click Create. The namespace for your IBM Cloud Pak foundational services operator is created.

  3. Install the IBM Cloud Pak foundational services operator that you created.

    1. From the navigation pane, click Operators > OperatorHub. The OperatorHub page is displayed.

    2. In the All Items field, enter IBM Cloud Pak foundational services. The IBM Cloud Pak foundational services operator is displayed.

    3. Click the IBM Cloud Pak foundational services tile. The IBM Cloud Pak foundational services window is displayed.

    4. Click Install. You see the Install Operator page.

    5. Set Update Channel to the v3 version.

    6. Set Installation Mode to A specific namespace on the cluster, and set the Installed Namespace to the ibm-common-servicesnamespace.

    7. Set Approval Strategy to Automatic.

    8. Click Install. After a few minutes, the IBM Cloud Pak foundational services operator and the Operand Deployment Lifecycle Manager operator are installed, and you can see these operators on the Installed Operators page.

Optionally, configure the IBM Cloud Pak foundational services webhook. For more information, see IBM Cloud Pak foundational services webhook. You can also perform optional configuration. For more information about available configurations, see Configuring IBM Cloud Pak foundational services by using the CommonService custom resource

3. Installing License Service in your cluster

Complete these steps to use the YAML view to create the OperandRequest instance for License Service.

  1. From the navigation pane, click Operators > Installed Operators.
  2. Set Project to All projects and search for Operand Deployment Lifecycle Manager.
  3. To create the instance, click Operand Deployment Lifecycle Manager, select the OperandRequest tab.
  4. Click Create OperandRequest, and select YAML View.

  5. Paste the following content in the YAML editor:

      apiVersion: operator.ibm.com/v1alpha1
  kind: OperandRequest
  metadata:
    name: common-service
    namespace: ibm-common-services
    labels:
      app.kubernetes.io/instance: operand-deployment-lifecycle-manager
      app.kubernetes.io/managed-by: operand-deployment-lifecycle-manager
      app.kubernetes.io/name: odlm
  spec:
    requests:
      - operands:
          - name: ibm-licensing-operator
        registry: common-service

    Note: You can create the OperandRequest in any namespace. If you are creating the OperandRequest in a different namespace than where OperandRegistry and OperandConfig custom resources are, change the namespace: parameter value to the namespace from where you are creating the OperandRequest. And, add the registryNamespace: ibm-common-services in the OperandRequest.

  6. Click Create.

    Note: You can perform the following configurations to customize your settings. However, these configurations are not needed for License Service to work on your cluster:

4. Verifying the installation

To verify the installation, check whether all the pods in the ibm-common-services namespace are running. Use the following command:

oc get pods -n ibm-common-services

As a response, you get a list of pods. All pods should be in Running status.

You can also use the following command to verify whether the foundational services are successfully installed:

oc -n ibm-common-services get csv

As a response, you get a list of Cluster Service Version resources that are installed. All CSVs should be in Succeeded phase.

5. Accessing the licensing data

To view the license usage for your cluster, use one of the APIs for retrieving License Service data. To learn how to retrieve the data , see Retrieving license usage data per cluster from License Service. For more information about License Service, see the License Service documentation.