Deploying License Service Reporter
Deploy License Reporter on a cluster and use it as an aggregator to view the collective license usage of your products that are deployed on multiple clusters. You can deploy License Reported by using the the OpenShift console or the CLI.
Supported platforms
License Service Reporter is only supported on Linux® x86_64 on Red Hat® OpenShift® Container Platform.
Hardware requirements
- CPU limits: 900m
- Memory limits: 896Mi
Prerequisites
Deploy License Service Reporter on the OpenShift-managed cluster where the IBM Cloud Paks® are deployed.
Deployment
Use one of the following procedures to deploy License Service Reporter on a cluster.
- Deploying License Service Reporter by using the OpenShift console
- Deploying License Service Reporter by using the CLI
Deploying License Service Reporter by using the OpenShift console
-
Log in to your OpenShift cluster console.
-
Go to Operators > Installed Operators.
-
Set the project to All Projects.
-
Find and select the IBM Licensing Operator.
-
On the IBM License Service Reporter tile, click Create instance.
-
Review the contents of the editor. Make sure that the definition contains the following information. If not, paste the following content into the editor, and click Create.
apiVersion: operator.ibm.com/v1alpha1 kind: IBMLicenseServiceReporter metadata: labels: app.kubernetes.io/instance: ibm-licensing-operator app.kubernetes.io/managed-by: ibm-licensing-operator app.kubernetes.io/name: ibm-licensing name: instance namespace: ibm-common-services
Note: License Service Reporter uses the default storage class. To use a different storage class, add and define the 'storageClass' parameter in the
spec
section. For example:spec: storageClass: storage-class-internal
-
Go back to Operators > Installed Operators.
-
Find and select Operand Deployment Lifecycle Manager.
-
Go to the OperandConfig tab, and click the common-service instance.
-
Find the ibm-licensing-operator and add IBMLicenseServiceReporter: {} to its spec section. For example:
- name: ibm-licensing-operator
spec:
IBMLicenseServiceReporter: {} # <- this needs to be added
IBMLicensing:
datasource: datacollector
resources:
limits:
cpu: 300m
memory: 850Mi
requests:
cpu: 200m
memory: 430Mi
operandBindInfo: {}
- To apply the changes, click Save.
Deploying License Service Reporter by using the CLI
-
Create the
license-reporter.yaml
file with the following content:apiVersion: operator.ibm.com/v1alpha1 kind: IBMLicenseServiceReporter metadata: labels: app.kubernetes.io/instance: ibm-licensing-operator app.kubernetes.io/managed-by: ibm-licensing-operator app.kubernetes.io/name: ibm-licensing name: instance namespace: ibm-common-services
Note: License Service Reporter uses the default storage class. To use a different storage class, add and define the 'storageClass' parameter in the
spec
section. For example:spec: storageClass: storage-class-internal
-
Run the following command:
oc apply -f license-reporter.yaml
-
Edit the OperandConfig custom resource. To include License Service Reporter, run the following command:
oc edit OperandConfig common-service -n ibm-common-services
-
Search for ibm-licensing-operator with the following command and click Enter:
?ibm-licensing-operator
-
Type i and edit the spec section of the ibm-licensing-operator by adding IBMLicenseServiceReporter: {}. For example:
- name: ibm-licensing-operator spec: IBMLicenseServiceReporter: {} IBMLicensing:
-
Click Esc and type :x to save your changes.
-
Optional: If you have issues with applying the changes, save, change and update the yaml.
-
Save the .yaml into a file by running the following command.
oc get OperandConfig common-service -n ibm-common-services -o yaml > opconfig.yaml
-
Add IBMLicenseServiceReporter: {} under the ibm-licensing-operator spec section.
-
Apply the yaml with the following command:
oc apply -f opconfig.yaml
-