ibm-licensing-operator

README

IMPORTANT: The master branch contains the currently developed version of License Service and its content should not be used. Switch to another branch to view the content for the already-released version of License Service, for example release-<version> branch.

You can install License Service with ibm-licensing-operator to collect license usage information in two scenarios:

• License Service as a part of an IBM Cloud Pak (included in IBM Cloud Pak foundational services)
• License Service without an IBM Cloud Pak

ibm-licensing-operator

Scenario: License Service as a part of an IBM Cloud Pak (included in IBM Cloud Pak foundational services)

Important: Do not install this operator directly. Only install this operator using the IBM IBM Cloud Pak foundational services operator. For more information about installing this operator and other foundational services operators, see Installer documentation. If you are using this operator as part of an IBM Cloud Pak, see the documentation for that IBM Cloud Pak to learn more about how to install and use the operator service. For more information about IBM Cloud Paks, see IBM Cloud Paks that use IBM Cloud Pak foundational services.

You can use the ibm-licensing-operator to install License Service as a part of IBM Cloud Pak foundational services or an IBM Cloud Pak. You can use License Service to collect information about license usage of IBM containerized products and IBM Cloud Paks per cluster. You can retrieve license usage data through a dedicated API call and generate an audit snapshot on demand.

For more information about the available IBM Cloud Pak foundational services, see the IBM Documentation.

Supported platforms

Red Hat OpenShift Container Platform 4.2 or newer installed on Linux x86_64, Linux on Power (ppc64le), Linux on IBM Z and LinuxONE.

Operator versions

• 1.0.0, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.2.2, 1.2.3, 1.3.1, 1.4.1, 1.5.0, 1.6.0, 1.7.0, 1.8.0, 1.9.0, 1.10.0, 1.11.0, 1.12.0, 1.13.0, 1.14.0, 1.15.0, 1.16.0, 1.17.0

Prerequisites

Before you install this operator, you need to first install the operator dependencies and prerequisites:

• For the list of operator dependencies, see Dependencies of the IBM Cloud Pak foundational services in the IBM Documentation.
• For the list of prerequisites for installing the operator, see Preparing to install services documentation in the IBM Documentation.

Important: If you installed License Service with the stand-alone IBM containerized software and you want to install an IBM Cloud Pak, it is recommended to first uninstall License Service from every cluster. Before uninstalling, the best practice is to retrieve an audit snapshot to ensure no data is lost. The Cloud Pak will install a new instance of License Service. This is a temporary action that we would like to automate in the future.

Documentation

To install the operator with the IBM Cloud Pak foundational services Operator follow the installation and configuration instructions within the IBM Documentation.

• If you are using the operator as part of an IBM Cloud Pak, see the documentation for that IBM Cloud Pak. For a list of IBM Cloud Paks, see IBM Cloud Paks that use IBM Cloud Pak foundational services.
• If you are using the operator with an IBM Containerized Software as a part of IBM Cloud Pak foundational services, see the Installer documentation in IBM Documentation.

SecurityContextConstraints Requirements

License Service supports running with the OpenShift Container Platform 4.3 default restricted Security Context Constraints (SCCs).

For more information about the OpenShift Container Platform Security Context Constraints, see Managing Security Context Constraints.

ibm-licensing-operator for deploying License Service without an IBM Cloud Pak

Scenario: Learn how to deploy License Service on Kubernetes clusters without an IBM CLoud Pak

You can use the ibm-licensing-operator to install License Service on any Kubernetes cluster without an IBM Cloud Pak. License Service collects information about license usage of IBM Containerized Products. You can retrieve license usage data through a dedicated API call and generate an audit snapshot on demand.

Product documentation

For the overview and documentation, see License Service deployment without an IBM Cloud Pak.

Note: License Service Reporter, which is an extension of License Service that aggregates the license usage data from multiple clusters, is not available without an IBM Cloud Pak on OpenShift Container Platform. License Service Reporter is only available as a part of an IBM Cloud Pak on OpenShift Container Platform (included in IBM Cloud Pak foundational services).