Configuring data sources

After deploying License Service Reporter, configure the License Service instance to enable data feeds from your clusters to License Service Reporter.

Note: If you use the License Service Reporter version 3.23, see Configuring data sources. Opens in a new tab

Complete the following actions to configure the following data sources to deliver licensing data to the License Service Reporter.

Configuring the License Service instance for OpenShift clusters

Configure the License Service instance to enable data feeds from for all remaining clusters to License Service Reporter for multi-cluster aggregations. Configure all clusters with software that should be included in the licensing calculations.

Optionally, you can configure the License Service instance if you want to set the custom cluster name and ID. By default, the cluster name is set to the name of the first master node, and an ID is set to the kube-system namespace UID.

Important: Cluster ID and cluster name are included in the audit snapshot and must be clear for an auditor to identify the cluster.

Restriction: Cluster ID and cluster name cannot be changed after you configure the instance.

  1. Copy the secret with a License Service Reporter token from the cluster where the License Service Reporter is deployed.

    1. Log in to the OpenShift console of the cluster where you deployed the License Service Reporter.

    2. Go to Workloads > Secrets and select the project where the License Service Reporter is installed.

    3. Find and select ibm-license-service-reporter-token.

    4. Go to the YAML tab and copy the entire YAML with the secret.

  2. Create the secret with a token on the cluster from which you want to retrieve licensing data.

    1. Log in to the OpenShift cluster console.

    2. Go to Workloads > Secrets.

    3. Expand the Create menu and select From YAML.

    4. Paste the contents of the YAML that you copied in step 1d into the editor. Ensure that the namespace in the YAML is the same as the namespace of the new secret. If the namespace in the YAML is different, you must update the namespace with the namespace of the new secret.

    5. Delete ownerReferences section and click Create.

  3. Modify the License Service instance to enable data feeds from the cluster to the License Service Reporter.

    1. Log in to your OpenShift cluster console.

    2. Go to Operators > Installed Operators.

    3. Find and select the IBM Licensing Operator.

    4. Go to the IBM License Service tab.

    5. Edit the instance by expanding the menu at the end of the line and selecting Edit IBMLicensing.

    6. Add the following content to the spec section in the YAML and click Save.

      sender:
        reporterSecretToken: ibm-license-service-reporter-token
        reporterURL: <reporter_url>
        clusterID: <cluster_id>
        clusterName: <your_cluster_name>
      

      Where

      • <reporter_url> is a URL of the License Service Reporter that you deployed. To get the URL, complete the following steps:

        1. Log in to the OpenShift console of the cluster where you deployed the License Service Reporter.

        2. Go to Networking > Routes and select the namespace where you deployed the License Service Reporter.r.

        3. Find ibm-license-service-reporter and copy the link that is provided under Location.

      Note: From IBM Cloud Pak foundational services version 3.6.x, the clusterID and clusterName parameters are optional. If you do not need to customize the ID and name of the cluster, remove the parameter from the sender section. Cluster ID and cluster name are included in the audit snapshot and must be clear for an auditor to identify the cluster.

      Restriction: Cluster ID and cluster name cannot be changed after you configure the instance.

      • <cluster_id> - By default, the cluster ID is set to the kube-system namespace UID. To set a custom ID, include this parameter in the YAML and provide a custom value expressed by a unique alphanumeric string that defines the cluster.

      • <cluster_name> - By default, the cluster name is set to the name of the first master node. To set a custom cluster name, include the parameter in the YAML and provide a custom, unique name that identifies the cluster on the License Service Reporter user interface.

Configuring the License Service instance for non-OpenShift clusters

You can configure License Service instance for non-OpenShift Kubernetes clusters to deliver data to License Reporter under following circumstances:

Optionally, you can configure the License Service instance if you want to set the custom cluster name and ID. By default, the cluster name is set to the name of the first master node, and an ID is set to the kube-system namespace UID.

Important: Cluster ID and cluster name are included in the audit snapshot and must be clear for an auditor to identify the cluster.

Restriction: Cluster ID and cluster name cannot be changed after you configure the instance.

To configure the License Service instance for non-OpenShift Kubernetes clusters, complete the following steps.

  1. Copy the secret with the License Service Reporter token from the cluster where the License Service Reporter is deployed.

    1. Log in to the cluster where you deployed License Service Reporter and run the following command.

      kubectl get secret ibm-license-service-reporter-token -o yaml -n <enter the namespace of the License Service Reporter> > reporter-token.yml
      
    2. Open reporter-token.yml in the text editor and remove the ownerReferences section.

  2. Create the secret with a token on the cluster from which you want to retrieve license usage data. Log in to the cluster and run the following command to create a secret.

    kubectl apply -f reporter-token.yml -n <enter the namespace of the License Service Reporter>
    
  3. Modify the License Service instance to enable data feeds from the cluster to the License Service Reporter.

    1. Run the following command.

      kubectl edit IBMLicensing -o yaml -n <enter the namespace of the License Service>
      
    2. Modify the .yaml, add the following content under the 'spec' section and save the file.

      sender:
        reporterSecretToken: ibm-license-service-reporter-token
        reporterURL: <reporter_url>
        clusterID: <cluster_id>
        clusterName: <cluster_name>
      

      Where

      • <reporter_url> is a URL of the License Service Reporter that you deployed. To get the URL, complete the following steps:

        1. Log in to the OpenShift console of the cluster where you deployed the License Service Reporter.

        2. Go to Networking > Routes and select the namespace where you deployed the License Service Reporter.

        3. Find ibm-license-service-reporter and copy the link that is provided under Location.

          Note: You can also use the following command:

             `kubectl get routes -n <enter the namespace of the License Service Reporter> | grep ibm-license-service-reporter | awk '{print $2}'`
          

      Note: From IBM Cloud Pak foundational services version 3.6.x, the clusterID and clusterName parameters are optional. If you do not need to customize the ID and name of the cluster, remove the parameter from the sender section. Cluster ID and cluster name are included in the audit snapshot and must be clear for an auditor to identify the cluster.

      Restriction: Cluster ID and cluster name cannot be changed after you configure the instance.

      • <cluster_id> is an optional parameter. By default, the cluster ID is set to the kube-system namespace UID. To set a custom ID, include this parameter in the YAML and provide a custom value expressed by a unique alphanumeric string that defines the cluster.

      • <cluster_name> is an optional parameter. By default, the cluster name is set to the name of the first master node. To set a custom cluster name, include the parameter in the YAML and provide a custom, unique name that identifies the cluster on the License Service Reporter user interface.

Delivering license usage of software from License Metric Tool

For more information, see Delivering license usage of IBM Cloud Pak solutions and stand-alone containerized software installed in non-containerized environment from License Metric Tool to License Service Reporter Opens in a new tab.

Uploading License Service data from offline environments (AWS/Fargate–dedicated)

This feature is available from IBM Cloud Pak® foundational services version 3.21.x.

Prerequisites:

Note: If upload fails with error 422, make sure that the audit snapshot is generated from the correct License Service version, and that you use License Service Reporter that supports the upload.

If you use License Service to track license usage in offline environments, you can upload the audit snapshot that is generated for offline environments into License Service Reporter. Thanks to the upload, the additional measurements are included in the collective license usage statistics on the Licensing dashboard and in License Service Reporter reports.

Procedure

Complete the following actions to upload audit snapshots from offline environments into the License Service Reporter.

  1. Generate an audit snapshot from the offline environment. For more information and instructions, see Retrieving an audit snapshot.

  2. Upload the generated audit snapshot .zip package into License Service Reporter with the following CURL query:

    curl -k -X PUT -F 'file=@<audit_snapshot_file_name.zip>' "<License Service Reporter URL>/snapshot?token=<token>"
    

    where:

    <audit_snapshot_file_name.zip> is the name of your audit snapshot package

    <token> is your authentication token for connecting to License Service Reporter. For more information, see Obtaining and updating an API token.

    <License Service Reporter URL> is the URL of your License Service Reporter instance. For more information, see Obtaining License Service Reporter URL.

    For more information about this API, see License Service Reporter Swagger API schema.

    Note: The audit snapshot can cover data from any period, however the package cannot exceed 1 MB. If your package contains large amounts of data, upload takes long and you are notified that the connection being prematurely closed, change your load balancer settings.

    During the upload, the License Service Reporter verifies the audit snapshot checksums and the signature to ensure data authenticity.

Verification

If upload completes successfully, you get the HTTP 200 response with the following message: Audit snapshot file upload finished successfully.

Changing load balancer settings

If your package contains large amounts of data, you might need to increase the load balancer timeout to receive the correct response from the server. Otherwise, upload times out with an error message that the client prematurely closed the connection while reading the response header. The timeout occurs when the process does not finish within the timeout period that is currently set for load balancer.

Note: If load balancer closes connection with License Service Reporter due to exceeded timeout, it does not always mean that the upload failed as the process continues anyway. Check logs to verify whether the upload was successful or not.

For example, if you have the HAProxy load balancer, complete the following steps to change the client and server timeout value:

  1. On the load balancer node, edit the /etc/haproxy/haproxy.cfg file. In the defaults section, change the values for timeout client and timeout server from 1m to 5m.

  2. Run the following command to restart HAProxy: systemctl restart haproxy.

Configuring the License Service instance for OpenShift clusters

Note: Data sent by License Service (License Service Reporter data source) will be visible in License Service Reporter after around an hour of configuring the data sources.

After you deploy the License Service instance successfully, you can verify whether the License Service has connected to the License Service Reporter and sent data. After around 10 minutes of deploying the License Services instance, check the License Service logs and look for the following similar entries:

2022-09-14 12:17:46.840 [scheduling-1] INFO  Starting sender task
2022-09-14 12:17:46.852 [scheduling-1] INFO  License Service Reporter URL = https://console-openshift-console.apps.ls-js.cp.fyre.ibm.com, cluster name = my_cluster, cluster ID = my_cluster_id
2022-09-14 12:17:46.934 [scheduling-1] INFO  Connected to License Service Reporter 1.18.0
2022-09-14 12:17:46.968 [scheduling-1] INFO  Sending data from 2022-09-14 to 2022-09-14
2022-09-14 12:17:47.478 [scheduling-1] INFO  Sending data to https://console-openshift-console.apps.ls-js.cp.fyre.ibm.com/snapshot?token=*****
2022-09-14 12:17:47.640 [scheduling-1] INFO  Saving last hub synchronization date = 2022-09-14
2022-09-14 12:17:47.662 [scheduling-1] INFO  Sender task finished

If you find these entries in the License Service logs, it confirms that the License Service has connected to the License Service Reporter successfully. If no data is visible in License Service Reporter after configuring data sources, see Troubleshooting License Service Reporter