Foundational services custom resource definitions
Use the information on this page to learn about the custom resource definitions (CRDs) used by foundational services.
In Table 1, CRDs that do not have a hyperlink must not be manually edited unless otherwise instructed, and are manipulated only by the operator.
| Kind | API Version | Operator Name | Description |
|---|---|---|---|
| Authentication | v1alpha1 | ibm-iam-operator | The Authentication custom resource is used to create an instance of Identity Management service |
| Client | v1 | ibm-iam-operator | The Client custom resource is used for registering clients with Identity Management service |
| CommonService | v3 | ibm-common-service-operator | CommonService is the Schema for the commonservices API. This API is used to configure general foundational services configurations, such as sizing, catalogsource, etc. See description of fields for more details. An instance of this CRD is automatically created by the ibm-common-service-operator upon installation to trigger the installation of critical installer components such as operand-deployment-lifecycle-manager (ODLM), which is required to further install other services from foundational services, such as IM. |
| Elasticsearch | v1beta1 | elastic-operator | IBM Elastic operator provides Elasticsearch which enables the creation of elasticsearch clusters that can be comprised of multiple groups of elasticsearch nodes. This product is not deployable standalone and it is part of the LICCR already accepted. |
| IBMLicensing | v1alpha1 | ibm-licensing-operator | 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. |
| IBMLicensingDefinition | v1 | ibm-licensing-operator | IBMLicensingDefinition is a custom resource for internal use only. It is used by some IBM products to assign their pods to the licensed products for the licensing specific calculation, performed by the IBM License Service. It is prepared in close collaboration with those IBM products, and affects only them. It cannot be modified by a customer, to ensure compliance with the license usage metering and reporting. |
| IBMLicensingMetadata | v1alpha1 | ibm-licensing-operator | IBMLicensingMetadata is the schema for IBM License Service. Thanks to IBMLicensingMetadata, you can track the license usage of Virtual Processor Core (VPC) metric by Pods that are managed by automation, for which licensing annotations are not defined at the time of deployment, such as the open source OpenLiberty. |
| IBMLicensingQuerySource | v1 | ibm-licensing-operator | IBMLicensingQuerySource is a custom resource for internal use only. It is used by some IBM products to assign their pods to the licensed products for the licensing specific calculation, performed by the IBM License Service. It is prepared in close collaboration with those IBM products, and affects only them. It cannot be modified by a customer, to ensure compliance with the license usage metering and reporting. |
| KafkaRebalance | v1beta2 | ibm-event-operator-bundle | Used to define Kafka rebalance goals for Cruise Control to carry out. |
| Kafka | v1beta2 | ibm-event-operator-bundle | The specification of the Topic Operator, Kafka clusters, and ZooKeeper clusters. |
| KafkaTopic | v1beta2 | ibm-event-operator-bundle | Represents a Kafka topic. |
| KafkaUser | v1beta2 | ibm-event-operator-bundle | The CommonWebUI custom resource is used to create an instance of the service that serves a user interface to manage identity provider configurations. |
| CommonWebUI | v1alpha1 | ibm-commonui-operator | The CommonWebUI custom resource is used to create an instance of the service that serves a user interface to manage identity provider configurations |
| NavConfiguration | v1 | ibm-commonui-operator | The Navconfiguration custom resource is deprecated and is only used internally by the operator |
| SwitcherItem | v1alpha1 | ibm-commonui-operator | The SwitcherItem custom resource is deprecated and is only used internally by the operator |
| FlinkDeployment | v1beta1 | ibm-opencontent-flink-operator | ibm-opencontent-flink-operator is based on apache Flink Operator and provides the FlinkDeployment which is the custom resource that represents an actual Flink deployment (consisting of a JobManager and potentially many TaskManagers).
This product is not deployable standalone. |
| CertificateRequest | v1 | ibm-cert-manager-operator | A CertificateRequest is used to request a signed certificate from one of the configured issuers. All fields within the CertificateRequest's spec are immutable after creation. A CertificateRequest will either succeed or fail,
as denoted by its status.state field. A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used. |
| Certificate | v1 | ibm-cert-manager-operator | A Certificate resource should be created to ensure an up to date and signed x509 certificate is stored in the Kubernetes Secret resource named in spec.secretName. The stored certificate will be renewed before it expires (as configured
by spec.renewBefore). |
| CertManagerConfig | v1 | ibm-cert-manager-operator | CertManagerConfig is the Schema for the certmanagerconfigs API. |
| Challenge | v1 | ibm-cert-manager-operator | Challenge is a type to represent a Challenge request with an ACME server |
| ClusterIssuer | v1 | ibm-cert-manager-operator | A ClusterIssuer represents a certificate issuing authority which can be referenced as part of issuerRef fields. It is similar to an Issuer, however it is cluster-scoped and therefore can be referenced by resources that exist in
any namespace, not just the same namespace as the referent. |
| Issuer | v1 | ibm-cert-manager-operator | An Issuer represents a certificate issuing authority which can be referenced as part of issuerRef fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace. |
| Order | v1 | ibm-cert-manager-operator | Order is a type to represent an Order with an ACME server |
| IBMLicenseServiceReporter | v1alpha1 | ibm-license-service-reporter-operator | IBM License Service Reporter is a singleton which may be used in a single or multi-cluster environment. It aggregates data pushed from IBM License Services, deployed on clusters and from ILMT. For more information, see License Service Report. |