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
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.
- Installing the
IBM Cloud Pak foundational servicesoperator
- Installing License Service in your cluster
- Verifying the installation
- Accessing the licensing data
- An OpenShift Container Platform cluster must be installed. For the supported OpenShift Container Platform versions, see Supported OpenShift versions and platforms.
- License Service uses the following hardware resources:
- CPU limits: 500m
- Memory limits: 512Mi
2. Installing the IBM Cloud Pak foundational services operator
You must complete these tasks from your OpenShift cluster console.
Create the IBM Cloud Pak foundational services catalog source.
Log in to your OpenShift cluster console.
Click the plus icon. You see the Import YAML dialog box.
IBM Cloud Pak foundational servicessource. You need to create a
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
Click Create. The catalog source
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
Create a namespace for the
IBM Cloud Pak foundational servicesoperator. You need a dedicated namespace for the operator.
From the navigation pane, click Home > Projects. The Projects page is displayed.
Click Create Project. A Create Project area is displayed.
Enter details of the namespace that you are creating. Specify ibm-common-services as the name.
Click Create. The namespace for your
IBM Cloud Pak foundational servicesoperator is created.
IBM Cloud Pak foundational servicesoperator that you created.
From the navigation pane, click Operators > OperatorHub. The OperatorHub page is displayed.
In the All Items field, enter
IBM Cloud Pak foundational services. The IBM Cloud Pak foundational services operator is displayed.
Click the IBM Cloud Pak foundational services tile. The IBM Cloud Pak foundational services window is displayed.
Click Install. You see the Install Operator page.
Set Update Channel to the
Set Installation Mode to A specific namespace on the cluster, and set the Installed Namespace to the
Set Approval Strategy to
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.
- From the navigation pane, click Operators > Installed Operators.
- Set Project to All projects and search for
Operand Deployment Lifecycle Manager.
- To create the instance, click Operand Deployment Lifecycle Manager, select the OperandRequest tab.
- Click Create OperandRequest, and select YAML View.
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
OperandRequestin any namespace. If you are creating the
OperandRequestin a different namespace than where
OperandConfigcustom resources are, change the
namespace:parameter value to the namespace from where you are creating the
OperandRequest. And, add the
registryNamespace: ibm-common-servicesin the OperandRequest.
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:
You can configure optional License Service parameters, for more information, seeLicense Service settings.
You can authorize the foundational service operators to manage service workload across namespaces. For more information, see Authorizing foundational services to perform operations on workloads in a namespace.
To integrate with License Service APIs, create bindings. For more information, see Accessing the services.
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.