IBMLicenseServiceReporter/v1alpha1
IBM License Service Reporter is a singleton that might be used in a single or multi-cluster environment. It aggregates data that is pushed from IBM License Services, which are deployed on clusters and from IBM License Metric Tool (ILMT). For more information, see License Service Reporter.
To find the license terms for the particular IBM product for which you are deploying this component, see IBM Terms.
IBM License Service Reporter is an optionally installed add-on and is one of services of Cloud Pak foundational services. With the IBM License Service Reporter, customers can:
- See IBM software deployments on a single dashboard, verify, and maintain license compliance and avoid audit infractions
- See historical data on IBM software deployments to support making informed decisions for future purchases
- See details of software deployments, including source (IBM License Metric Tool for VMs, License Service for containers), cluster, and quantities of licenses deployed
- Identify which software deployments are VMs versus containers and can use this information to evaluate workloads for modernization.
apiVersion
Description: APIVersion defines the versioned schema of this representation of an object. Servers convert recognized schemas to the latest internal value, and might reject unrecognized values. For more information, see API Conventions: Resources.
Type: string
| Property | Type | Description |
|---|---|---|
| apiVersion | string | APIVersion defines the versioned schema of this representation of an object. Servers convert recognized schemas to the latest internal value, and might reject unrecognized values. For more information, see API Conventions: Resources. |
kind
Description: Kind is a string value representing the REST resource that this object represents. Servers might infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. For more information, see API Conventions: Types (Kinds)
Type: string
| Property | Type | Description |
|---|---|---|
| kind | string | Kind is a string value representing the REST resource that this object represents. Servers might infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. For more information, see API Conventions: Types (Kinds) |
metadata
Description: (No Description)
Type: object
| Property | Type | Description |
|---|---|---|
| metadata | object | (No Description) |
spec
Description: IBMLicenseServiceReporterSpec defines the desired state of IBMLicenseServiceReporter
Type: object
| Property | Type | Description |
|---|---|---|
| spec | object | IBMLicenseServiceReporterSpec defines the desired state of IBMLicenseServiceReporter |
| spec.apiSecretToken | string | A secret name used to store an application token, either one that exists, or one that will be created |
| spec.authContainer | object | Authentication Image Settings |
| spec.authContainer.imageName | string | IBM License Service Reporter docker Image Name overrides the default value and disable the image env value in operator deployment |
| spec.authContainer.imagePullPolicy | string | PullPolicy describes a policy for if/when to pull a container image |
| spec.authContainer.imageRegistry | string | IBM License Service Reporter docker Image Registry overrides the default value and disable the image env value in operator deployment |
| spec.authContainer.imageTagPostfix | string | IBM License Service Reporter docker Image Tag or Digest, overrides the default value and disable the image env value in operator deployment |
| spec.authContainer.resources | object | ResourceRequirements describes the compute resource requirements. |
| spec.authContainer.resources.limits | object | Limits describe the maximum amount of compute resources allowed. For more information, see Resource Management for Pods and Containers |
| spec.authContainer.resources.requests | object | Requests describe 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. For more information, see Resource Management for Pods and Containers |
| spec.authentication | object | License Service Reporter oauth2-proxy configuration |
| spec.authentication.oauth | object | (No Description) |
| spec.authentication.oauth.enabled | Boolean | (No Description) |
| spec.authentication.oauth.parameters | array | (No Description) |
| spec.authentication.useradmin | object | (No Description) |
| spec.authentication.useradmin.enabled | Boolean | (No Description) |
| spec.capacity | (No Type) | Persistent Volume Claim Capacity |
| spec.databaseContainer | object | Database Settings |
| spec.databaseContainer.imageName | string | IBM License Service Reporter docker Image Name, overrides the default value and disable the image env value in operator deployment |
| spec.databaseContainer.imagePullPolicy | string | PullPolicy describes a policy for if/when to pull a container image |
| spec.databaseContainer.imageRegistry | string | IBM License Service Reporter docker Image Registry overrides the default value and disable the image env value in operator deployment |
| spec.databaseContainer.imageTagPostfix | string | IBM License Service Reporter docker Image Tag or Digest, overrides the default value and disable the image env value in operator deployment |
| spec.databaseContainer.resources | object | ResourceRequirements describes the compute resource requirements. |
| spec.databaseContainer.resources.limits | object | Limits describe the maximum amount of compute resources allowed. For more information, see Resource Management for Pods and Containers |
| spec.databaseContainer.resources.requests | object | Requests describe the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits. If that is explicitly specified, the request otherwise defaults to an implementation-defined value. For more information, see Resource Management for Pods and Containers |
| spec.envVariable | object | Environment variable setting |
| spec.httpsCertsSource | string | options: self-signed or custom |
| spec.imagePullSecrets | array | Array of pull secrets that should include existing at InstanceNamespace secret to allow pulling IBM License Service Reporter image |
| spec.license | object | IBM License Service Reporter license acceptance. |
| spec.license.accept | Boolean | By installing the IBM License Service Reporter, you accept the license terms for the particular IBM product for which you are deploying this component. |
| spec.logLevel | string | Should application pod show additional information, options: DEBUG, INFO, VERBOSE |
| spec.receiverContainer | object | Receiver Settings |
| spec.receiverContainer.imageName | string | IBM License Service Reporter docker Image Name overrides the default value and disable the image env value in operator deployment |
| spec.receiverContainer.imagePullPolicy | string | PullPolicy describes a policy for if/when to pull a container image |
| spec.receiverContainer.imageRegistry | string | IBM License Service Reporter docker Image Registry overrides the default value and disable the image env value in operator deployment |
| spec.receiverContainer.imageTagPostfix | string | IBM License Service Reporter docker Image Tag or Digest, overrides the default value and disable the image env value in operator deployment |
| spec.receiverContainer.resources | object | ResourceRequirements describes the compute resource requirements. |
| spec.receiverContainer.resources.limits | object | Limits describe the maximum amount of compute resources allowed. For more information, see Resource Management for Pods and Containers |
| spec.receiverContainer.resources.requests | object | Requests describe 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. For more information, see Resource Management for Pods and Containers |
| spec.reporterUIContainer | object | Receiver Settings |
| spec.reporterUIContainer.imageName | string | IBM License Service Reporter docker Image Name overrides the default value and disable the image env value in operator deployment |
| spec.reporterUIContainer.imagePullPolicy | string | PullPolicy describes a policy for if you must pull a container image |
| spec.reporterUIContainer.imageRegistry | string | IBM License Service Reporter docker Image Registry, overrides the default value and disable the image env value in operator deployment |
| spec.reporterUIContainer.imageTagPostfix | string | IBM License Service Reporter docker Image Tag or Digest, overrides the default value and disable the image env value in operator deployment |
| spec.reporterUIContainer.resources | object | ResourceRequirements describes the compute resource requirements. |
| spec.reporterUIContainer.resources.limits | object | Limits describe the maximum amount of compute resources allowed. For more information, see Resource Management for Pods and Containers |
| spec.reporterUIContainer.resources.requests | object | Requests describe 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. For more information, see Resource Management for Pods and Containers |
| spec.routeOptions | object | Route parameters |
| spec.routeOptions.tls | object | TLSConfig defines the 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 might provide its own destination CA and perform hostname validation by 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 might make its own decisions on which ports to expose, this is normally port 80.
|
| spec.routeOptions.tls.key | string | key provides key file contents |
| spec.routeOptions.tls.termination | string | termination indicates termination type.
|
| spec.storageClass | string | Storage class that is used by database to provide persistency |
| spec.version | string | Version |
status
Description: IBMLicenseServiceReporterStatus defines the observed state of IBMLicenseServiceReporter
Type: object
| Property | Type | Description |
|---|---|---|
| status | object | IBMLicenseServiceReporterStatus defines the observed state of IBMLicenseServiceReporter |
| status.LicenseServiceReporterPods | array | Important: Run operator-sdk generate k8s to regenerate the code after modifying this file. For information on adding custom validation by using kubebuilder tags, see Generating CRD |