CommonService/v3
CommonService is the schema for the commonservices API. This API is used to configure general foundational services configurations, such as sizing and catalogsource. See description of fields for more details. An instance of this custom resource
definition (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.
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 Convention: 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 Convention: Types (Kinds) |
metadata
Description: (No Description)
Type: object
| Property | Type | Description |
|---|---|---|
| metadata | object | (No Description) |
spec
Description: CommonServiceSpec defines the desired state of CommonService
Type: object
| Property | Type | Description |
|---|---|---|
| spec | object | CommonServiceSpec defines the desired state of CommonService |
| spec.BYOCACertificate | Boolean | BYOCACertificate enables the option to replace the cs-ca-certificate with your own CA certificate |
| spec.catalogName | string | CatalogName is the name of the CatalogSource that will be used for ODLM and other services in foundational services |
| spec.catalogNamespace | string | CatalogNamespace is the namespace of the CatalogSource that will be used for ODLM and other services in foundational services |
| spec.defaultAdminUser | string | DefalutAdminUser is the name of the default admin user for foundational services IM, default is cpadmin |
| spec.features | object | Features define the configurations of Cloud Pak Services |
| spec.features.apiCatalog | object | APICatalog defines the configuration of APICatalog |
| spec.features.apiCatalog.storageClass | string | (No Description) |
| spec.features.bedrockshim | object | Bedrockshim defines the configuration of Bedrockshim |
| spec.features.bedrockshim.crossplaneProviderRemoval | Boolean | (No Description) |
| spec.features.bedrockshim.enabled | Boolean | (No Description) |
| spec.fipsEnabled | Boolean | FipsEnabled enables FIPS mode for foundational services |
| spec.installPlanApproval | string | InstallPlanApproval sets the approval mode for ODLM and other foundational services: Manual or Automatic |
| spec.license | object | LicenseList defines the license specification in CSV |
| spec.license.accept | Boolean | For more information on accepting the license, see Licensing |
| spec.license.key | string | The license key for this deployment. |
| spec.license.license | string | The license being accepted where the component has multiple. |
| spec.license.use | string | The type of license being accepted. |
| spec.manualManagement | Boolean | (No Description) |
| spec.operatorNamespace | string | OperatorNamespace describes the namespace where operators will be installed in such as ODLM. This will also apply to all services in foundational services, for example ODLM installs IM operator in this namespace |
| spec.profileController | string | ProfileController enables Turbonomic to automatically handle sizing of foundational services. The default value is 'default' |
| spec.routeHost | string | RouteHost describes the hostname for the foundational services route, and can be configured only during pre-installation of IM |
| spec.services | array | Services describe the CPU, memory, and replica configuration for individual services in foundational services |
| spec.servicesNamespace | string | ServicesNamespace describes the namespace where operands will be created in such as OperandRegistry and OperandConfig. This will also apply to all services in foundational services, for example IM creates operands in this namespace |
| spec.size | string | Size describes the T-shirt size of foundational services: starterset, small, medium, or large |
| spec.storageClass | string | StorageClass describes the storage class to use for the foundational services PVCs |
status
Description: CommonServiceStatus defines the observed state of CommonService
Type: object
| Property | Type | Description |
|---|---|---|
| status | object | CommonServiceStatus defines the observed state of CommonService |
| status.bedrockOperators | array | (No Description) |
| status.configStatus | object | ConfigStatus describes various configurations currently applied onto the foundational services installer. |
| status.configStatus.catalogName | string | CatalogName is the name of the CatalogSource foundational services is using |
| status.configStatus.catalogNamespace | string | CatalogNamespace is the namespace of the CatalogSource |
| status.configStatus.configurable | Boolean | Configurable indicates whether this CommonService CR is the one that can be used to configure the foundational services' installer. Other CommonService CRs configurations will not take effect, except for sizing |
| status.configStatus.operatorDeployed | Boolean | OperatorDeployed indicates whether the OperandRegistry has been created or not. |
| status.configStatus.operatorNamespace | string | OperatorNamespace is the namespace of where the foundational services' operators will be installed in. |
| status.configStatus.servicesDeployed | Boolean | ServicesDeployed indicates whether the OperandConfig has been created or not. |
| status.configStatus.servicesNamespace | string | ServicesNamespace is the namespace where the foundational services' operands will be created in. |
| status.configStatus.topologyConfigurableCRs | array | TopologyConfigurableCRs describes the configurable CommonService CR |
| status.overallStatus | string | OverallStatus describes whether the Installation for the foundational services has succeeded or not |
| status.phase | string | Phase describes the phase of the overall installation |