IBMLicensing/v1alpha1
IBMLicensing custom resource is used to create an instance of the License Service, used 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. Documentation: For additional details regarding install parameters check: https://ibm.biz/icpfs39install. License: Please refer to the IBM Terms website (ibm.biz/lsvc-lic) to find the license terms for the particular IBM product for which you are deploying this component.
apiVersion
Description: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Type: string
| Property | Type | Description |
|---|---|---|
| apiVersion | string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kind
Description: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Type: string
| Property | Type | Description |
|---|---|---|
| kind | string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadata
Description: (No Description)
Type: object
| Property | Type | Description |
|---|---|---|
| metadata | object | (No Description) |
spec
Description: IBMLicensingSpec defines the desired state of IBMLicensing
Type: object
| Property | Type | Description |
|---|---|---|
| spec | object | IBMLicensingSpec defines the desired state of IBMLicensing |
| spec.apiSecretToken | string | Secret name used to store application token, either one that exists, or one that will be created |
| spec.chargebackEnabled | boolean | Consider updating to enable chargeback feature |
| spec.chargebackRetentionPeriod | integer | Chargeback data retention period in days. Default value is 62 days. |
| spec.datasource | string | Where should data be collected, options: metering, datacollector |
| spec.envVariable | object | Environment variable setting |
| spec.features | object | Set additional features under this field |
| spec.features.alerting | object | Change alerting settings. |
| spec.features.alerting.enabled | boolean | Should this function be enabled. |
| spec.features.auth | object | Authorization settings. |
| spec.features.auth.urlBasedEnabled | boolean | Enable URL based Auth |
| spec.features.hyperThreading | object | Configure if you have HyperThreading (HT) or Symmetrical Multi-Threading (SMT) enabled |
| spec.features.hyperThreading.threadsPerCore | integer | Set the value based on the lowest HT/SMT value based on the lowest configuration of worker nodes |
| spec.features.nssEnabled | boolean | Special terms, must be granted by IBM Pricing. |
| spec.features.prometheusQuerySource | object | Change prometheus query source settings. |
| spec.features.prometheusQuerySource.enabled | boolean | Should this function be enabled (by default it is). |
| spec.features.prometheusQuerySource.url | string | What url to use for prometheus API (by default use OCP Thanos Querier). |
| spec.httpsCertsSource | string | options: self-signed or custom |
| spec.httpsEnable | boolean | Enables https access at pod level, httpsCertsSource needed if true |
| spec.imageName | string | IBM Licensing Service docker Image Name, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment |
| spec.imagePullPolicy | string | PullPolicy describes a policy for if/when to pull a container image |
| spec.imagePullSecrets | array | Array of pull secrets which should include existing at InstanceNamespace secret to allow pulling IBM Licensing image |
| spec.imageRegistry | string | IBM Licensing Service docker Image Registry, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment |
| spec.imageTagPostfix | string | IBM Licensing Service docker Image Tag or Digest, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment |
| spec.ingressEnabled | boolean | Should Ingress be created to expose IBM Licensing Service API? |
| spec.ingressOptions | object | If ingress is enabled, you can set its parameters |
| spec.ingressOptions.annotations | object | Additional annotations that should include f.e. ingress class if using not default ingress controller |
| spec.ingressOptions.host | string | If you use non-default host include it here |
| spec.ingressOptions.path | string | Path after host where API will be available f.e. https://
|
| spec.ingressOptions.tls | array | TLS Options to enable secure connection |
| spec.instanceNamespace | string | Existing or to be created namespace where application will start. In case metering data collection is used, should be the same namespace as metering components |
| spec.license | object | IBM License Service license acceptance. |
| spec.license.accept | boolean | By installing the IBM License Service, you accept the license terms for the particular IBM product for which you are deploying this component: ibm.biz/lsvc-lic. |
| spec.logLevel | string | Should application pod show additional information, options: DEBUG, INFO, VERBOSE |
| spec.resources | object | ResourceRequirements describes the compute resource requirements. |
| spec.resources.limits | object | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| spec.resources.requests | object | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| spec.rhmpEnabled | boolean | Is Red Hat Marketplace enabled |
| spec.routeEnabled | boolean | Should Route be created to expose IBM Licensing Service API? (only on OpenShift cluster) |
| spec.routeOptions | object | Route parameters |
| spec.routeOptions.tls | object | TLSConfig defines config used to secure a route and provide termination |
| spec.routeOptions.tls.caCertificate | string | caCertificate provides the cert authority certificate contents |
| spec.routeOptions.tls.certificate | string | certificate provides certificate contents. This should be a single serving certificate, not a certificate chain. Do not include a CA certificate. |
| spec.routeOptions.tls.destinationCACertificate | string | destinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt termination this file should be provided in order to have routers use it for health checks on the secure connection. If this field is not specified, the router may provide its own destination CA and perform hostname validation using the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically verify. |
| spec.routeOptions.tls.insecureEdgeTerminationPolicy | string | insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While each router may make its own decisions on which ports to expose, this is normally port 80. - Allow: Traffic is sent to the server on the insecure port (default) - Disable: No traffic is allowed on the insecure port. - Redirect: Clients are redirected to the secure port. |
| spec.routeOptions.tls.key | string | key provides key file contents |
| spec.routeOptions.tls.termination | string | termination indicates termination type. - edge: TLS termination is done by the router and http is used to communicate with the backend (default) - passthrough: Traffic is sent straight to the destination without the router providing TLS termination - reencrypt: TLS termination is done by the router and https is used to communicate with the backend |
| spec.securityContext | object | If default SCC user ID fails, you can set runAsUser option to fix that |
| spec.securityContext.runAsUser | integer | (No Description) |
| spec.sender | object | Sender configuration, set if you have multi-cluster environment from which you collect data |
| spec.sender.clusterID | string | Unique ID of reporting cluster |
| spec.sender.clusterName | string | What is the name of this reporting cluster in multi-cluster system. If not provided, CLUSTER_ID will be used as CLUSTER_NAME at Operand level |
| spec.sender.reporterSecretToken | string | License Service Reporter authentication token, provided by secret that you need to create in instance namespace |
| spec.sender.reporterURL | string | URL for License Service Reporter receiver that collects and aggregate multi cluster licensing data. |
| spec.usageContainer | object | Usage Container Settings |
| spec.usageContainer.imageName | string | IBM Licensing Service docker Image Name, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment |
| spec.usageContainer.imagePullPolicy | string | PullPolicy describes a policy for if/when to pull a container image |
| spec.usageContainer.imageRegistry | string | IBM Licensing Service docker Image Registry, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment |
| spec.usageContainer.imageTagPostfix | string | IBM Licensing Service docker Image Tag or Digest, will override default value and disable IBM_LICENSING_IMAGE env value in operator deployment |
| spec.usageContainer.resources | object | ResourceRequirements describes the compute resource requirements. |
| spec.usageContainer.resources.limits | object | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| spec.usageContainer.resources.requests | object | Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
| spec.usageEnabled | boolean | Should collect usage based metrics? |
| spec.version | string | Version |
status
Description: IBMLicensingStatus defines the observed state of IBMLicensing
Type: object
| Property | Type | Description |
|---|---|---|
| status | object | IBMLicensingStatus defines the observed state of IBMLicensing |
| status.features | object | (No Description) |
| status.features.rhmpEnabled | boolean | (No Description) |
| status.licensingPods | array | The status of IBM License Service Pods. |
| status.state | string | State field that defines status of the IBMLicensing |