Skip to content

api-overview.md

Latest commit

 

History

History
3403 lines (1666 loc) · 133 KB

api-overview.md

File metadata and controls

3403 lines (1666 loc) · 133 KB

API Reference

Packages

components.platform.opendatahub.io/v1alpha1

Package v1 contains API Schema definitions for the components v1 API group

Resource Types

APIKeysConfig

APIKeysConfig defines configuration options for API key management.

Appears in:

Field Description Default Validation
maxExpirationDays integer MaxExpirationDays is the maximum allowed expiration in days for API keys.
When set, users cannot create API keys with expiration longer than this value.
Examples: 30 (one month), 90 (three months), 365 (one year).
If not set, no expiration limit is enforced.		 Minimum: 1
Optional: {}

ArgoWorkflowsControllersSpec

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the bundled Argo Workflows controllers.
It will only upgrade the Argo Workflows controllers if it is safe to do so. This is the default
behavior.
- "Removed" : the operator is not managing the bundled Argo Workflows controllers and will not install it.
If it is installed, the operator will remove it but will not remove other Argo Workflows
installations.		 Managed Enum: [Managed Removed]

DSCDashboard

DSCDashboard contains all the configuration exposed in DSC instance for Dashboard component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCDashboardStatus

DSCDashboardStatus contains the observed state of the Dashboard exposed in the DSC instance

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCDataSciencePipelines

DSCDataSciencePipelines contains all the configuration exposed in DSC instance for DataSciencePipelines component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]
argoWorkflowsControllers ArgoWorkflowsControllersSpec

DSCDataSciencePipelinesStatus

DSCDataSciencePipelinesStatus contains the observed state of the DataSciencePipelines exposed in the DSC instance

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCFeastOperator

DSCFeastOperator defines the configuration exposed in the DSC instance for FeastOperator

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCFeastOperatorStatus

DSCFeastOperatorStatus struct holds the status for the FeastOperator component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCKserve

DSCKserve contains all the configuration exposed in DSC instance for Kserve component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]
rawDeploymentServiceConfig RawServiceConfig Configures the type of service that is created for InferenceServices using RawDeployment.
The values for RawDeploymentServiceConfig can be "Headless" (default value) or "Headed".
Headless: to set "ServiceClusterIPNone = true" in the 'inferenceservice-config' configmap for Kserve.
Headed: to set "ServiceClusterIPNone = false" in the 'inferenceservice-config' configmap for Kserve.		 Headless Enum: [Headless Headed]
nim NimSpec Configures and enables NVIDIA NIM integration
modelsAsService DSCModelsAsServiceSpec Configures and enables Models as a Service integration
wva WVASpec Configures and enables workload-variant-autoscaler (WVA) integration

DSCKserveStatus

DSCKserveStatus contains the observed state of the Kserve exposed in the DSC instance

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCKueue

DSCKueue contains all the configuration exposed in DSC instance for Kueue component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : present for backwards compatibility with OLM upgrades, but not supported at runtime.
The operator will reject this value. Use "Unmanaged" or "Removed" instead.
- "Unmanaged" : the operator will not deploy or manage the component's lifecycle, but may create supporting configuration resources.
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Unmanaged Removed]
defaultLocalQueueName string Configures the automatically created, in the managed namespaces, local queue name. default
defaultClusterQueueName string Configures the automatically created cluster queue name. default

DSCKueueStatus

DSCKueueStatus contains the observed state of the Kueue exposed in the DSC instance

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : present for backwards compatibility with OLM upgrades, but not supported at runtime.
The operator will reject this value. Use "Unmanaged" or "Removed" instead.
- "Unmanaged" : the operator will not deploy or manage the component's lifecycle, but may create supporting configuration resources.
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Unmanaged Removed]

DSCLlamaStackOperator

DSCLlamaStackOperator contains all the configuration exposed in DSC instance for LlamaStackOperator component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCLlamaStackOperatorStatus

DSCLlamaStackOperatorStatus struct holds the status for the LlamaStackOperator component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCMLflowOperator

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCMLflowOperatorStatus

DSCMLflowOperatorStatus contains the observed state of the MLflowOperator exposed in the DSC instance

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCModelRegistry

DSCModelRegistry contains all the configuration exposed in DSC instance for ModelRegistry component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]
registriesNamespace string Namespace for model registries to be installed, configurable only once when model registry is enabled, defaults to "odh-model-registries" odh-model-registries MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$

DSCModelRegistryStatus

DSCModelRegistryStatus struct holds the status for the ModelRegistry component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCModelsAsServiceSpec

DSCModelsAsServiceSpec enables ModelsAsService integration

Appears in:

Field Description Default Validation
managementState ManagementState Removed Enum: [Managed Removed]

DSCRay

DSCRay contains all the configuration exposed in DSC instance for Ray component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCRayStatus

DSCRayStatus struct holds the status for the Ray component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCSparkOperator

DSCSparkOperator contains all the configuration exposed in DSC instance

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCSparkOperatorStatus

DSCSparkOperatorStatus contains the observed state exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCTrainer

DSCTrainer contains all the configuration exposed in DSC instance for Trainer component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCTrainerStatus

DSCTrainerStatus struct holds the status for the Trainer component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCTrainingOperator

DSCTrainingOperator contains all the configuration exposed in DSC instance for TrainingOperator component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCTrainingOperatorStatus

DSCTrainingOperatorStatus struct holds the status for the TrainingOperator component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCTrustyAI

DSCTrustyAI contains all the configuration exposed in DSC instance for TrustyAI component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]
eval TrustyAIEvalSpec Eval configuration for TrustyAI evaluations

DSCTrustyAIStatus

DSCTrustyAIStatus struct holds the status for the TrustyAI component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

DSCWorkbenches

DSCWorkbenches contains all the configuration exposed in DSC instance for Workbenches component

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]
workbenchNamespace string Namespace for workbenches to be installed, configurable only once when workbenches are enabled, defaults to "opendatahub" opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$

DSCWorkbenchesStatus

DSCWorkbenchesStatus struct holds the status for the Workbenches component exposed in the DSC

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]

Dashboard

Dashboard is the Schema for the dashboards API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string Dashboard
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DashboardSpec
status DashboardStatus

DashboardCommonSpec

DashboardCommonSpec spec defines the shared desired state of Dashboard (used in DSC and Dashboard CR).

Appears in:

DashboardCommonStatus

DashboardCommonStatus defines the shared observed state of Dashboard

Appears in:

Field Description Default Validation
url string

DashboardSpec

DashboardSpec defines the desired state of Dashboard (Dashboard CR only).

Appears in:

Field Description Default Validation
gateway GatewaySpec Gateway configuration for dashboard ingress (synced from GatewayConfig by the DSC controller when creating the Dashboard CR).

DashboardStatus

DashboardStatus defines the observed state of Dashboard

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
url string

DataSciencePipelines

DataSciencePipelines is the Schema for the datasciencepipelines API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string DataSciencePipelines
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DataSciencePipelinesSpec
status DataSciencePipelinesStatus

DataSciencePipelinesCommonSpec

Appears in:

Field Description Default Validation
argoWorkflowsControllers ArgoWorkflowsControllersSpec

DataSciencePipelinesCommonStatus

DataSciencePipelinesCommonStatus defines the shared observed state of DataSciencePipelines

Appears in:

Field Description Default Validation
releases ComponentRelease array

DataSciencePipelinesSpec

DataSciencePipelinesSpec defines the desired state of DataSciencePipelines

Appears in:

Field Description Default Validation
argoWorkflowsControllers ArgoWorkflowsControllersSpec

DataSciencePipelinesStatus

DataSciencePipelinesStatus defines the observed state of DataSciencePipelines

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

FeastOperator

FeastOperator is the Schema for the FeastOperator API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string FeastOperator
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec FeastOperatorSpec
status FeastOperatorStatus

FeastOperatorCommonSpec

FeastOperatorCommonSpec defines the common spec shared across APIs for FeastOperator

Appears in:

FeastOperatorCommonStatus

FeastOperatorCommonStatus defines the shared observed state of FeastOperator

Appears in:

Field Description Default Validation
releases ComponentRelease array

FeastOperatorSpec

FeastOperatorSpec defines the desired state of FeastOperator

Appears in:

FeastOperatorStatus

FeastOperatorStatus defines the observed state of FeastOperator

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

GatewayRef

GatewayRef defines the reference to the global Gateway (Gw API) where models should be published to when exposed as services.

Appears in:

Field Description Default Validation
namespace string Namespace is the namespace where the Gateway resource is located. openshift-ingress MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
name string Name is the name of the Gateway resource. maas-default-gateway MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$

Kserve

Kserve is the Schema for the kserves API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string Kserve
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KserveSpec
status KserveStatus

KserveCommonSpec

KserveCommonSpec spec defines the shared desired state of Kserve

Appears in:

Field Description Default Validation
rawDeploymentServiceConfig RawServiceConfig Configures the type of service that is created for InferenceServices using RawDeployment.
The values for RawDeploymentServiceConfig can be "Headless" (default value) or "Headed".
Headless: to set "ServiceClusterIPNone = true" in the 'inferenceservice-config' configmap for Kserve.
Headed: to set "ServiceClusterIPNone = false" in the 'inferenceservice-config' configmap for Kserve.		 Headless Enum: [Headless Headed]
nim NimSpec Configures and enables NVIDIA NIM integration
modelsAsService DSCModelsAsServiceSpec Configures and enables Models as a Service integration
wva WVASpec Configures and enables workload-variant-autoscaler (WVA) integration

KserveCommonStatus

KserveCommonStatus defines the shared observed state of Kserve

Appears in:

Field Description Default Validation
releases ComponentRelease array

KserveSpec

KserveSpec defines the desired state of Kserve

Appears in:

Field Description Default Validation
rawDeploymentServiceConfig RawServiceConfig Configures the type of service that is created for InferenceServices using RawDeployment.
The values for RawDeploymentServiceConfig can be "Headless" (default value) or "Headed".
Headless: to set "ServiceClusterIPNone = true" in the 'inferenceservice-config' configmap for Kserve.
Headed: to set "ServiceClusterIPNone = false" in the 'inferenceservice-config' configmap for Kserve.		 Headless Enum: [Headless Headed]
nim NimSpec Configures and enables NVIDIA NIM integration
modelsAsService DSCModelsAsServiceSpec Configures and enables Models as a Service integration
wva WVASpec Configures and enables workload-variant-autoscaler (WVA) integration

KserveStatus

KserveStatus defines the observed state of Kserve

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

Kueue

Kueue is the Schema for the kueues API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string Kueue
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KueueSpec
status KueueStatus

KueueCommonSpec

Appears in:

KueueCommonStatus

KueueCommonStatus defines the shared observed state of Kueue

Appears in:

Field Description Default Validation
releases ComponentRelease array

KueueDefaultQueueSpec

Appears in:

Field Description Default Validation
defaultLocalQueueName string Configures the automatically created, in the managed namespaces, local queue name. default
defaultClusterQueueName string Configures the automatically created cluster queue name. default

KueueManagementSpec

KueueManagementSpec struct defines the component's management configuration.

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : present for backwards compatibility with OLM upgrades, but not supported at runtime.
The operator will reject this value. Use "Unmanaged" or "Removed" instead.
- "Unmanaged" : the operator will not deploy or manage the component's lifecycle, but may create supporting configuration resources.
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Unmanaged Removed]

KueueSpec

KueueSpec defines the desired state of Kueue

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : present for backwards compatibility with OLM upgrades, but not supported at runtime.
The operator will reject this value. Use "Unmanaged" or "Removed" instead.
- "Unmanaged" : the operator will not deploy or manage the component's lifecycle, but may create supporting configuration resources.
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Unmanaged Removed]
defaultLocalQueueName string Configures the automatically created, in the managed namespaces, local queue name. default
defaultClusterQueueName string Configures the automatically created cluster queue name. default

KueueStatus

KueueStatus defines the observed state of Kueue

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

LlamaStackOperator

LlamaStackOperator is the Schema for the LlamaStackOperator API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string LlamaStackOperator
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec LlamaStackOperatorSpec
status LlamaStackOperatorStatus

LlamaStackOperatorCommonSpec

Appears in:

LlamaStackOperatorCommonStatus

LlamaStackOperatorCommonStatus defines the shared observed state of LlamaStackOperator

Appears in:

Field Description Default Validation
releases ComponentRelease array

LlamaStackOperatorSpec

LlamaStackOperatorSpec defines the desired state of LlamaStackOperator

Appears in:

LlamaStackOperatorStatus

LlamaStackOperatorStatus defines the observed state of LlamaStackOperator

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

MLflowOperator

MLflowOperator is the Schema for the MLflowOperators API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string MLflowOperator
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec MLflowOperatorSpec
status MLflowOperatorStatus

MLflowOperatorCommonSpec

Appears in:

MLflowOperatorCommonStatus

MLflowOperatorCommonStatus defines the shared observed state of MLflowOperator

Appears in:

Field Description Default Validation
releases ComponentRelease array

MLflowOperatorSpec

Appears in:

MLflowOperatorStatus

MLflowOperatorStatus defines the observed state of MLflowOperator

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

ModelController

ModelController is the Schema for the modelcontroller API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string ModelController
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ModelControllerSpec
status ModelControllerStatus

ModelControllerKerveSpec

a mini version of the DSCKserve only keeps management, NIM, and WVA spec

Appears in:

Field Description Default Validation
managementState ManagementState
nim NimSpec
wva WVASpec

ModelControllerMRSpec

Appears in:

Field Description Default Validation
managementState ManagementState

ModelControllerSpec

ModelControllerSpec defines the desired state of ModelController

Appears in:

Field Description Default Validation
kserve ModelControllerKerveSpec
modelRegistry ModelControllerMRSpec

ModelControllerStatus

ModelControllerStatus defines the observed state of ModelController

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array

ModelRegistry

ModelRegistry is the Schema for the modelregistries API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string ModelRegistry
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ModelRegistrySpec
status ModelRegistryStatus

ModelRegistryCommonSpec

ModelRegistryCommonSpec spec defines the shared desired state of ModelRegistry (used in DSC and ModelRegistry CR).

Appears in:

Field Description Default Validation
registriesNamespace string Namespace for model registries to be installed, configurable only once when model registry is enabled, defaults to "odh-model-registries" odh-model-registries MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$

ModelRegistryCommonStatus

ModelRegistryCommonStatus defines the shared observed state of ModelRegistry

Appears in:

Field Description Default Validation
registriesNamespace string
releases ComponentRelease array

ModelRegistrySpec

ModelRegistrySpec defines the desired state of ModelRegistry (ModelRegistry CR only).

Appears in:

Field Description Default Validation
registriesNamespace string Namespace for model registries to be installed, configurable only once when model registry is enabled, defaults to "odh-model-registries" odh-model-registries MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
gateway GatewaySpec Gateway configuration for model registry ingress (synced from GatewayConfig by the DSC controller when creating the ModelRegistry CR).

ModelRegistryStatus

ModelRegistryStatus defines the observed state of ModelRegistry

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
registriesNamespace string
releases ComponentRelease array

ModelsAsService

ModelsAsService is the Schema for the modelsasservice API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string ModelsAsService
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ModelsAsServiceSpec
status ModelsAsServiceStatus

ModelsAsServiceSpec

ModelsAsServiceSpec defines the desired state of ModelsAsService

Appears in:

Field Description Default Validation
gatewayRef GatewayRef GatewayRef specifies which Gateway (Gateway API) to use for exposing model endpoints.
If omitted, defaults to openshift-ingress/maas-default-gateway.		 Optional: {}
apiKeys APIKeysConfig APIKeys contains configuration for API key management. Optional: {}

ModelsAsServiceStatus

ModelsAsServiceStatus defines the observed state of ModelsAsService

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array

NimSpec

nimSpec enables NVIDIA NIM integration

Appears in:

Field Description Default Validation
managementState ManagementState Managed Enum: [Managed Removed]
airGapped boolean When true, NIM integration assumes an air-gapped cluster. External API calls
and the NIM model list ConfigMap creation are skipped, while status conditions
are marked successful with an air-gapped message.		 false Optional: {}

RawServiceConfig

Underlying type: string

Validation:

  • Enum: [Headless Headed]

Appears in:

Field Description
Headless
Headed

Ray

Ray is the Schema for the rays API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string Ray
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec RaySpec
status RayStatus

RayCommonSpec

Appears in:

RayCommonStatus

RayCommonStatus defines the shared observed state of Ray

Appears in:

Field Description Default Validation
releases ComponentRelease array

RaySpec

RaySpec defines the desired state of Ray

Appears in:

RayStatus

RayStatus defines the observed state of Ray

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

SparkOperator

SparkOperator is the Schema for the sparkoperators API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string SparkOperator
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec SparkOperatorSpec
status SparkOperatorStatus

SparkOperatorCommonSpec

Appears in:

SparkOperatorCommonStatus

SparkOperatorCommonStatus defines the shared observed state

Appears in:

Field Description Default Validation
releases ComponentRelease array

SparkOperatorSpec

SparkOperatorSpec defines the desired state of SparkOperator

Appears in:

SparkOperatorStatus

SparkOperatorStatus defines the observed state

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

Trainer

Trainer is the Schema for the trainers API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string Trainer
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec TrainerSpec
status TrainerStatus

TrainerCommonSpec

Appears in:

TrainerCommonStatus

TrainerCommonStatus defines the shared observed state of Trainer

Appears in:

Field Description Default Validation
releases ComponentRelease array

TrainerSpec

TrainerSpec defines the desired state of Trainer

Appears in:

TrainerStatus

TrainerStatus defines the observed state of Trainer

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

TrainingOperator

TrainingOperator is the Schema for the trainingoperators API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string TrainingOperator
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec TrainingOperatorSpec
status TrainingOperatorStatus

TrainingOperatorCommonSpec

Appears in:

TrainingOperatorCommonStatus

TrainingOperatorCommonStatus defines the shared observed state of TrainingOperator

Appears in:

Field Description Default Validation
releases ComponentRelease array

TrainingOperatorSpec

TrainingOperatorSpec defines the desired state of TrainingOperator

Appears in:

TrainingOperatorStatus

TrainingOperatorStatus defines the observed state of TrainingOperator

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

TrustyAI

TrustyAI is the Schema for the trustyais API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string TrustyAI
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec TrustyAISpec
status TrustyAIStatus

TrustyAICommonSpec

Appears in:

Field Description Default Validation
eval TrustyAIEvalSpec Eval configuration for TrustyAI evaluations

TrustyAICommonStatus

TrustyAICommonStatus defines the shared observed state of TrustyAI

Appears in:

Field Description Default Validation
releases ComponentRelease array

TrustyAIEvalSpec

TrustyAIEvalSpec defines evaluation configuration for TrustyAI

Appears in:

Field Description Default Validation
lmeval TrustyAILMEvalSpec LMEval configuration for model evaluations

TrustyAILMEvalSpec

TrustyAILMEvalSpec defines configuration for LMEval evaluations

Appears in:

Field Description Default Validation
permitCodeExecution string PermitCodeExecution controls whether code execution is allowed during evaluations deny Enum: [allow deny]
permitOnline string PermitOnline controls whether online access is allowed during evaluations deny Enum: [allow deny]

TrustyAISpec

TrustyAISpec defines the desired state of TrustyAI

Appears in:

Field Description Default Validation
eval TrustyAIEvalSpec Eval configuration for TrustyAI evaluations

TrustyAIStatus

TrustyAIStatus defines the observed state of TrustyAI

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array

WVASpec

WVASpec enables workload-variant-autoscaler integration

Appears in:

Field Description Default Validation
managementState ManagementState Removed Enum: [Managed Removed]

Workbenches

Workbenches is the Schema for the workbenches API

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string Workbenches
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec WorkbenchesSpec
status WorkbenchesStatus

WorkbenchesCommonSpec

Appears in:

Field Description Default Validation
workbenchNamespace string Namespace for workbenches to be installed, configurable only once when workbenches are enabled, defaults to "opendatahub" opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$

WorkbenchesCommonStatus

WorkbenchesCommonStatus defines the shared observed state of Workbenches

Appears in:

Field Description Default Validation
releases ComponentRelease array
workbenchNamespace string

WorkbenchesSpec

WorkbenchesSpec defines the desired state of Workbenches

Appears in:

Field Description Default Validation
workbenchNamespace string Namespace for workbenches to be installed, configurable only once when workbenches are enabled, defaults to "opendatahub" opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$

WorkbenchesStatus

WorkbenchesStatus defines the observed state of Workbenches

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
releases ComponentRelease array
workbenchNamespace string

datasciencecluster.opendatahub.io/components

datasciencecluster.opendatahub.io/v1

Package v1 contains API Schema definitions for the datasciencecluster v1 API group

Resource Types

Components

Appears in:

Field Description Default Validation
dashboard DSCDashboard Dashboard component configuration.
workbenches DSCWorkbenches Workbenches component configuration.
datasciencepipelines DSCDataSciencePipelines DataSciencePipeline component configuration.
kserve DSCKserve Kserve component configuration.
Only RawDeployment mode is supported.
kueue DSCKueueV1 Kueue component configuration.
ray DSCRay Ray component configuration.
trustyai DSCTrustyAI TrustyAI component configuration.
modelregistry DSCModelRegistry ModelRegistry component configuration.
trainingoperator DSCTrainingOperator Training Operator component configuration.
feastoperator DSCFeastOperator Feast Operator component configuration.
llamastackoperator DSCLlamaStackOperator LlamaStack Operator component configuration.

ComponentsStatus

ComponentsStatus defines the custom status of DataScienceCluster components.

Appears in:

Field Description Default Validation
dashboard DSCDashboardStatus Dashboard component status.
workbenches DSCWorkbenchesStatus Workbenches component status.
datasciencepipelines DSCDataSciencePipelinesStatus DataSciencePipeline component status.
kserve DSCKserveStatus Kserve component status.
kueue DSCKueueStatus Kueue component status.
ray DSCRayStatus Ray component status.
trustyai DSCTrustyAIStatus TrustyAI component status.
modelregistry DSCModelRegistryStatus ModelRegistry component status.
trainingoperator DSCTrainingOperatorStatus Training Operator component status.
feastoperator DSCFeastOperatorStatus Feast Operator component status.
llamastackoperator DSCLlamaStackOperatorStatus LlamaStack Operator component status.

DSCKueueV1

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Unmanaged" : the operator will not deploy or manage the component's lifecycle, but may create supporting configuration resources.
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Unmanaged Removed]
defaultLocalQueueName string Configures the automatically created, in the managed namespaces, local queue name. default
defaultClusterQueueName string Configures the automatically created cluster queue name. default

DataScienceCluster

DataScienceCluster is the Schema for the datascienceclusters API.

Field Description Default Validation
apiVersion string datasciencecluster.opendatahub.io/v1
kind string DataScienceCluster
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DataScienceClusterSpec
status DataScienceClusterStatus

DataScienceClusterSpec

DataScienceClusterSpec defines the desired state of the cluster.

Appears in:

Field Description Default Validation
components Components Override and fine tune specific component configurations.

DataScienceClusterStatus

DataScienceClusterStatus defines the observed state of DataScienceCluster.

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
relatedObjects ObjectReference array RelatedObjects is a list of objects created and maintained by this operator.
Object references will be added to this list after they have been created AND found in the cluster.
errorMessage string
installedComponents object (keys:string, values:boolean) List of components with status if installed or not
components ComponentsStatus Expose component's specific status
release Release Version and release type

KueueManagementSpecV1

KueueManagementSpec struct defines the component's management configuration.

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Unmanaged" : the operator will not deploy or manage the component's lifecycle, but may create supporting configuration resources.
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Unmanaged Removed]

datasciencecluster.opendatahub.io/v2

Package v2 contains API Schema definitions for the datasciencecluster v2 API group.

Resource Types

Components

Appears in:

Field Description Default Validation
dashboard DSCDashboard Dashboard component configuration.
workbenches DSCWorkbenches Workbenches component configuration.
aipipelines DSCDataSciencePipelines AIPipelines component configuration.
kserve DSCKserve Kserve component configuration.
Only RawDeployment mode is supported.
kueue DSCKueue Kueue component configuration.
ray DSCRay Ray component configuration.
trustyai DSCTrustyAI TrustyAI component configuration.
modelregistry DSCModelRegistry ModelRegistry component configuration.
trainingoperator DSCTrainingOperator Training Operator component configuration.
feastoperator DSCFeastOperator Feast Operator component configuration.
llamastackoperator DSCLlamaStackOperator LlamaStack Operator component configuration.
mlflowoperator DSCMLflowOperator MLflow Operator component configuration.
trainer DSCTrainer Trainer component configuration.
sparkoperator DSCSparkOperator SparkOperator component configuration.

ComponentsStatus

ComponentsStatus defines the custom status of DataScienceCluster components.

Appears in:

Field Description Default Validation
dashboard DSCDashboardStatus Dashboard component status.
workbenches DSCWorkbenchesStatus Workbenches component status.
aipipelines DSCDataSciencePipelinesStatus AIPipelines component status.
kserve DSCKserveStatus Kserve component status.
kueue DSCKueueStatus Kueue component status.
ray DSCRayStatus Ray component status.
trustyai DSCTrustyAIStatus TrustyAI component status.
modelregistry DSCModelRegistryStatus ModelRegistry component status.
trainingoperator DSCTrainingOperatorStatus Training Operator component status.
feastoperator DSCFeastOperatorStatus Feast Operator component status.
llamastackoperator DSCLlamaStackOperatorStatus LlamaStack Operator component status.
mlflowoperator DSCMLflowOperatorStatus MLflow Operator component status.
trainer DSCTrainerStatus Trainer component status.
sparkoperator DSCSparkOperatorStatus SparkOperator component status.

DataScienceCluster

DataScienceCluster is the Schema for the datascienceclusters API.

Field Description Default Validation
apiVersion string datasciencecluster.opendatahub.io/v2
kind string DataScienceCluster
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DataScienceClusterSpec
status DataScienceClusterStatus

DataScienceClusterSpec

DataScienceClusterSpec defines the desired state of the cluster.

Appears in:

Field Description Default Validation
components Components Override and fine tune specific component configurations.

DataScienceClusterStatus

DataScienceClusterStatus defines the observed state of DataScienceCluster.

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
relatedObjects ObjectReference array RelatedObjects is a list of objects created and maintained by this operator.
Object references will be added to this list after they have been created AND found in the cluster.
errorMessage string
components ComponentsStatus Expose component's specific status
release Release Version and release type

dscinitialization.opendatahub.io/services

dscinitialization.opendatahub.io/v1

Package v1 contains API Schema definitions for the dscinitialization v1 API group

Resource Types

DSCInitialization

DSCInitialization is the Schema for the dscinitializations API.

Field Description Default Validation
apiVersion string dscinitialization.opendatahub.io/v1
kind string DSCInitialization
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DSCInitializationSpec
status DSCInitializationStatus

DSCInitializationSpec

DSCInitializationSpec defines the desired state of DSCInitialization.

Appears in:

Field Description Default Validation
applicationsNamespace string Namespace for applications to be installed, non-configurable, default to "opendatahub" opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
monitoring DSCIMonitoring Enable monitoring on specified namespace
trustedCABundle TrustedCABundleSpec When set to Managed, adds odh-trusted-ca-bundle Configmap to all namespaces that includes
cluster-wide Trusted CA Bundle in .data["ca-bundle.crt"].
Additionally, this fields allows admins to add custom CA bundles to the configmap using the .CustomCABundle field.
devFlags DevFlags Internal development useful field to test customizations.
This is not recommended to be used in production environment.

DSCInitializationStatus

DSCInitializationStatus defines the observed state of DSCInitialization.

Appears in:

Field Description Default Validation
phase string Phase describes the Phase of DSCInitializationStatus
This is used by OLM UI to provide status information to the user
conditions Condition array Conditions describes the state of the DSCInitializationStatus resource
relatedObjects ObjectReference array RelatedObjects is a list of objects created and maintained by this operator.
Object references will be added to this list after they have been created AND found in the cluster
errorMessage string
release Release Version and release type

DevFlags

DevFlags defines list of fields that can be used by developers to test customizations. This is not recommended to be used in production environment.

Appears in:

Field Description Default Validation
manifestsUri string ## DEPRECATED ## : ManifestsUri set on DSCI is not maintained.
Custom manifests uri for odh-manifests
logmode string ## DEPRECATED ##: Ignored, use LogLevel instead production Enum: [devel development prod production default]
logLevel string Override Zap log level. Can be "debug", "info", "error" or a number (more verbose).

TrustedCABundleSpec

Appears in:

Field Description Default Validation
managementState ManagementState managementState indicates whether and how the operator should manage customized CA bundle Removed Enum: [Managed Removed Unmanaged]
customCABundle string A custom CA bundle that will be available for all components in the
Data Science Cluster(DSC). This bundle will be stored in odh-trusted-ca-bundle
ConfigMap .data.odh-ca-bundle.crt .

dscinitialization.opendatahub.io/v2

Package v2 contains API Schema definitions for the dscinitialization v2 API group.

Resource Types

DSCInitialization

DSCInitialization is the Schema for the dscinitializations API.

Field Description Default Validation
apiVersion string dscinitialization.opendatahub.io/v2
kind string DSCInitialization
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec DSCInitializationSpec
status DSCInitializationStatus

DSCInitializationSpec

DSCInitializationSpec defines the desired state of DSCInitialization.

Appears in:

Field Description Default Validation
applicationsNamespace string Namespace for applications to be installed, non-configurable, default to "opendatahub" opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
monitoring DSCIMonitoring Enable monitoring on specified namespace
trustedCABundle TrustedCABundleSpec When set to Managed, adds odh-trusted-ca-bundle Configmap to all namespaces that includes
cluster-wide Trusted CA Bundle in .data["ca-bundle.crt"].
Additionally, this fields allows admins to add custom CA bundles to the configmap using the .CustomCABundle field.
devFlags DevFlags Internal development useful field to test customizations.
This is not recommended to be used in production environment.

DSCInitializationStatus

DSCInitializationStatus defines the observed state of DSCInitialization.

Appears in:

Field Description Default Validation
phase string Phase describes the Phase of DSCInitializationStatus
This is used by OLM UI to provide status information to the user
conditions Condition array Conditions describes the state of the DSCInitializationStatus resource
relatedObjects ObjectReference array RelatedObjects is a list of objects created and maintained by this operator.
Object references will be added to this list after they have been created AND found in the cluster
errorMessage string
release Release Version and release type

DevFlags

DevFlags defines list of fields that can be used by developers to test customizations. This is not recommended to be used in production environment.

Appears in:

Field Description Default Validation
logLevel string Override Zap log level. Can be "debug", "info", "error" or a number (more verbose).

TrustedCABundleSpec

Appears in:

Field Description Default Validation
managementState ManagementState managementState indicates whether and how the operator should manage customized CA bundle Removed Enum: [Managed Removed Unmanaged]
customCABundle string A custom CA bundle that will be available for all components in the
Data Science Cluster(DSC). This bundle will be stored in odh-trusted-ca-bundle
ConfigMap .data.odh-ca-bundle.crt .

infrastructure.opendatahub.io/v1

Resource Types

CertType

Underlying type: string

Appears in:

Field Description
SelfSigned
Provided
OpenshiftDefaultIngress

CertificateSpec

CertificateSpec represents the specification of the certificate securing communications of an Istio Gateway.

Appears in:

Field Description Default Validation
secretName string SecretName specifies the name of the Kubernetes Secret resource that contains a
TLS certificate secure HTTP communications for the KNative network.
type CertType Type specifies if the TLS certificate should be generated automatically, or if the certificate
is provided by the user. Allowed values are:
* SelfSigned: A certificate is going to be generated using an own private key.
* Provided: Pre-existence of the TLS Secret (see SecretName) with a valid certificate is assumed.
* OpenshiftDefaultIngress: Default ingress certificate configured for OpenShift		 OpenshiftDefaultIngress Enum: [SelfSigned Provided OpenshiftDefaultIngress]

GatewaySpec

GatewaySpec represents the configuration of the Ingress Gateways.

Appears in:

Field Description Default Validation
domain string Domain specifies the host name for intercepting incoming requests.
Most likely, you will want to use a wildcard name, like *.example.com.
If not set, the domain of the OpenShift Ingress is used.
If you choose to generate a certificate, this is the domain used for the certificate request.
certificate CertificateSpec Certificate specifies configuration of the TLS certificate securing communication
for the gateway.

HardwareIdentifier

Appears in:

Field Description Default Validation
displayName string The display name of identifier.
identifier string The resource identifier of the hardware device.
minCount IntOrString The minimum count can be an integer or a string.
maxCount IntOrString The maximum count can be an integer or a string.
defaultCount IntOrString The default count can be an integer or a string.
resourceType string The type of identifier. could be "CPU", "Memory", or "Accelerator". Leave it undefined for the other types. Enum: [CPU Memory Accelerator]

HardwareProfile

HardwareProfile is the Schema for the hardwareprofiles API.

Field Description Default Validation
apiVersion string infrastructure.opendatahub.io/v1
kind string HardwareProfile
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec HardwareProfileSpec
status HardwareProfileStatus

HardwareProfileSpec

HardwareProfileSpec defines the desired state of HardwareProfile.

Appears in:

Field Description Default Validation
identifiers HardwareIdentifier array The array of identifiers
scheduling SchedulingSpec SchedulingSpec specifies how workloads using this hardware profile should be scheduled.

HardwareProfileStatus

HardwareProfileStatus defines the observed state of HardwareProfile.

Appears in:

KueueSchedulingSpec

KueueSchedulingSpec defines queue-based scheduling configuration.

Appears in:

Field Description Default Validation
localQueueName string LocalQueueName specifies the name of the local queue to use for workload scheduling.
When specified, workloads using this hardware profile will be submitted to the
specified queue and the queue's configuration will determine the actual node
placement and tolerations.		 MinLength: 1
Required: {}
priorityClass string PriorityClass specifies the name of the WorkloadPriorityClass associated with the HardwareProfile.

NodeSchedulingSpec

NodeSchedulingSpec defines direct node scheduling configuration.

Appears in:

Field Description Default Validation
nodeSelector object (keys:string, values:string) NodeSelector specifies the node selector to use for direct node scheduling.
Workloads will be scheduled only on nodes that match all the specified labels.
tolerations Toleration array Tolerations specifies the tolerations to apply to workloads for direct node scheduling.
These tolerations allow workloads to be scheduled on nodes with matching taints.

SchedulingSpec

SchedulingSpec allows for specifying either kueue-based scheduling or direct node scheduling. CEL Rule 1: If schedulingType is "Queue", the 'kueue' field (with a non-empty localQueueName) must be set, and the 'node' field must not be set. CEL Rule 2: If schedulingType is "Node", the 'node' field must be set, and the 'kueue' field must not be set.

Appears in:

Field Description Default Validation
type SchedulingType SchedulingType is the scheduling method discriminator.
Users must set this value to indicate which scheduling method to use.
The value of this field should match exactly one configured scheduling method.
Valid values are "Queue" and "Node".		 Enum: [Queue Node]
Required: {}
kueue KueueSchedulingSpec Kueue specifies queue-based scheduling configuration.
This field is only valid when schedulingType is "Queue".
node NodeSchedulingSpec node specifies direct node scheduling configuration.
This field is only valid when schedulingType is "Node".

SchedulingType

Underlying type: string

SchedulingType defines the scheduling method for the hardware profile.

Appears in:

Field Description
Queue QueueScheduling indicates that workloads should be scheduled through a queue.
Node NodeScheduling indicates that workloads should be scheduled directly to nodes.

infrastructure.opendatahub.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group.

Resource Types

HardwareIdentifier

Appears in:

Field Description Default Validation
displayName string The display name of identifier.
identifier string The resource identifier of the hardware device.
minCount IntOrString The minimum count can be an integer or a string.
maxCount IntOrString The maximum count can be an integer or a string.
defaultCount IntOrString The default count can be an integer or a string.
resourceType string The type of identifier. could be "CPU", "Memory", or "Accelerator". Leave it undefined for the other types. Enum: [CPU Memory Accelerator]

HardwareProfile

HardwareProfile is the Schema for the hardwareprofiles API.

Field Description Default Validation
apiVersion string infrastructure.opendatahub.io/v1alpha1
kind string HardwareProfile
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec HardwareProfileSpec
status HardwareProfileStatus

HardwareProfileSpec

HardwareProfileSpec defines the desired state of HardwareProfile.

Appears in:

Field Description Default Validation
identifiers HardwareIdentifier array The array of identifiers
scheduling SchedulingSpec SchedulingSpec specifies how workloads using this hardware profile should be scheduled.

HardwareProfileStatus

HardwareProfileStatus defines the observed state of HardwareProfile.

Appears in:

KueueSchedulingSpec

KueueSchedulingSpec defines queue-based scheduling configuration.

Appears in:

Field Description Default Validation
localQueueName string LocalQueueName specifies the name of the local queue to use for workload scheduling.
When specified, workloads using this hardware profile will be submitted to the
specified queue and the queue's configuration will determine the actual node
placement and tolerations.		 MinLength: 1
Required: {}
priorityClass string PriorityClass specifies the name of the WorkloadPriorityClass associated with the HardwareProfile.

NodeSchedulingSpec

NodeSchedulingSpec defines direct node scheduling configuration.

Appears in:

Field Description Default Validation
nodeSelector object (keys:string, values:string) NodeSelector specifies the node selector to use for direct node scheduling.
Workloads will be scheduled only on nodes that match all the specified labels.
tolerations Toleration array Tolerations specifies the tolerations to apply to workloads for direct node scheduling.
These tolerations allow workloads to be scheduled on nodes with matching taints.

SchedulingSpec

SchedulingSpec allows for specifying either kueue-based scheduling or direct node scheduling. CEL Rule 1: If schedulingType is "Queue", the 'kueue' field (with a non-empty localQueueName) must be set, and the 'node' field must not be set. CEL Rule 2: If schedulingType is "Node", the 'node' field must be set, and the 'kueue' field must not be set.

Appears in:

Field Description Default Validation
type SchedulingType SchedulingType is the scheduling method discriminator.
Users must set this value to indicate which scheduling method to use.
The value of this field should match exactly one configured scheduling method.
Valid values are "Queue" and "Node".		 Enum: [Queue Node]
Required: {}
kueue KueueSchedulingSpec Kueue specifies queue-based scheduling configuration.
This field is only valid when schedulingType is "Queue".
node NodeSchedulingSpec node specifies direct node scheduling configuration.
This field is only valid when schedulingType is "Node".

SchedulingType

Underlying type: string

SchedulingType defines the scheduling method for the hardware profile.

Appears in:

Field Description
Queue QueueScheduling indicates that workloads should be scheduled through a queue.
Node NodeScheduling indicates that workloads should be scheduled directly to nodes.

services.platform.opendatahub.io/v1alpha1

Package v1 contains API Schema definitions for the services v1 API group

Resource Types

Alerting

Alerting configuration for Prometheus

Appears in:

Auth

Auth is the Schema for the auths API

Field Description Default Validation
apiVersion string services.platform.opendatahub.io/v1alpha1
kind string Auth
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec AuthSpec
status AuthStatus

AuthSpec

AuthSpec defines the desired state of Auth

Appears in:

Field Description Default Validation
adminGroups string array AdminGroups cannot contain 'system:authenticated' (security risk) or empty strings, and must not be empty
allowedGroups string array AllowedGroups cannot contain empty strings, but 'system:authenticated' is allowed for general access

AuthStatus

AuthStatus defines the observed state of Auth

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array

CookieConfig

CookieConfig defines cookie settings for OAuth2 proxy

Appears in:

Field Description Default Validation
expire Duration Expire duration for OAuth2 proxy session cookie (e.g., "24h", "8h")
This controls how long the session cookie is valid before requiring re-authentication.		 24h
refresh Duration Refresh duration for OAuth2 proxy to refresh access tokens (e.g., "2h", "1h", "30m")
This must be LESS than the OIDC provider's Access Token Lifespan to avoid token expiration.
For example, if Keycloak Access Token Lifespan is 1 hour, set this to "30m" or "45m".		 1h

DSCIMonitoring

Appears in:

Field Description Default Validation
managementState ManagementState Set to one of the following values:
- "Managed" : the operator is actively managing the component and trying to keep it active.
It will only upgrade the component if it is safe to do so
- "Removed" : the operator is actively managing the component and will not install it,
or if it is installed, the operator will try to remove it		 Enum: [Managed Removed]
namespace string monitoring spec exposed to DSCI api
Namespace for monitoring if it is enabled		 opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
metrics Metrics metrics collection
traces Traces Tracing configuration for OpenTelemetry instrumentation
alerting Alerting Alerting configuration for Prometheus
collectorReplicas integer CollectorReplicas specifies the number of replicas in opentelemetry-collector. If not set, it defaults
to 1 on single-node clusters and 2 on multi-node clusters.

GatewayConfig

GatewayConfig is the Schema for the gatewayconfigs API

Field Description Default Validation
apiVersion string services.platform.opendatahub.io/v1alpha1
kind string GatewayConfig
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec GatewayConfigSpec
status GatewayConfigStatus

GatewayConfigSpec

GatewayConfigSpec defines the desired state of GatewayConfig

Appears in:

Field Description Default Validation
ingressMode IngressMode IngressMode specifies how the Gateway is exposed externally.
"OcpRoute" uses ClusterIP with standard OpenShift Routes (default for new deployments).
"LoadBalancer" uses a LoadBalancer service type (requires cloud or MetalLB).		 Enum: [OcpRoute LoadBalancer]
oidc OIDCConfig OIDC configuration (used when cluster is in OIDC authentication mode)
certificate CertificateSpec Certificate specifies configuration of the TLS certificate securing communication for the gateway.
domain string Domain specifies the host name for intercepting incoming requests.
Most likely, you will want to use a wildcard name, like *.example.com.
If not set, the domain of the OpenShift Ingress is used.
If you choose to generate a certificate, this is the domain used for the certificate request.
Example: *.example.com, example.com, apps.example.com		 Pattern: ^(\*\.)?([a-z0-9]([-a-z0-9]*[a-z0-9])?\.)*[a-z0-9]([-a-z0-9]*[a-z0-9])?$
subdomain string Subdomain configuration for the GatewayConfig
Example: my-gateway, custom-gateway		 MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)$
cookie CookieConfig Cookie configuration (applies to both OIDC and OpenShift OAuth)
authTimeout string AuthTimeout is the duration Envoy waits for auth proxy responses.
Requests timeout with 403 if exceeded.
Deprecated: Use AuthProxyTimeout instead.		 Pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
authProxyTimeout Duration AuthProxyTimeout defines the timeout for external authorization service calls (e.g., "5s", "10s")
This controls how long Envoy waits for a response from the authentication proxy before timing out 403 response.
networkPolicy NetworkPolicyConfig NetworkPolicy configuration for kube-auth-proxy
providerCASecretName string ProviderCASecretName is the name of the secret containing the CA certificate for the authentication provider
Used when the OAuth/OIDC provider uses a self-signed or custom CA certificate.
Secret must exist in the openshift-ingress namespace and contain a 'ca.crt' key with the PEM-encoded CA certificate.
verifyProviderCertificate boolean VerifyProviderCertificate controls TLS certificate verification for the authentication provider.
When true (default), certificates are verified against the system trust store and providerCASecretName.
When false, certificate verification is disabled (development/testing only).
WARNING: Setting this to false disables security and should only be used in non-production environments.
For production use with self-signed certificates, use ProviderCASecretName instead.		 true
enableK8sTokenValidation boolean EnableK8sTokenValidation enables Kubernetes service account token validation via TokenReview API.
When enabled, kube-auth-proxy validates bearer tokens as service account tokens alongside OAuth/OIDC authentication.
This allows service accounts to authenticate via bearer tokens while human users authenticate via OAuth/OIDC.		 true

GatewayConfigStatus

GatewayConfigStatus defines the observed state of GatewayConfig

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
domain string Domain is the computed gateway domain (subdomain + cluster domain or default)
This is the single source of truth for the gateway domain used by all components

IngressMode

Underlying type: string

IngressMode defines how the Gateway exposes its endpoints externally.

Validation:

  • Enum: [OcpRoute LoadBalancer]

Appears in:

Field Description
OcpRoute IngressModeOcpRoute uses ClusterIP service with standard OpenShift Routes.
This is the default for new deployments and works without additional infrastructure.
LoadBalancer IngressModeLoadBalancer uses a LoadBalancer service type.
This requires a load balancer provider (cloud or MetalLB).

IngressPolicyConfig

IngressPolicyConfig defines ingress NetworkPolicy rules

Appears in:

Field Description Default Validation
enabled boolean Enabled determines whether ingress rules are applied.
When true, creates NetworkPolicy allowing traffic only from Gateway pods and monitoring namespaces.		 Required: {}

Metrics

Metrics defines the desired state of metrics for the monitoring service

Appears in:

Field Description Default Validation
storage MetricsStorage
replicas integer Replicas specifies the number of replicas in monitoringstack. If not set, it defaults
to 1 on single-node clusters and 2 on multi-node clusters.		 Minimum: 0
exporters object (keys:string, values:RawExtension) Exporters defines custom metrics exporters for sending metrics to external observability tools.
Each key represents the exporter name, and the value contains the exporter configuration.
The configuration follows the OpenTelemetry Collector exporter format.
Reserved names 'prometheus' and 'otlp/tempo' cannot be used as they conflict with built-in exporters.
Maximum 10 exporters allowed, each config must be less than 10KB (enforced at reconciliation time).

MetricsStorage

MetricsStorage defines the storage configuration for the monitoring service

Appears in:

Field Description Default Validation
size Quantity Size specifies the storage size for the MonitoringStack (e.g, "5Gi", "10Mi") 5Gi
retention string Retention specifies how long metrics data should be retained (e.g., "1d", "2w") 90d

Monitoring

Monitoring is the Schema for the monitorings API

Field Description Default Validation
apiVersion string services.platform.opendatahub.io/v1alpha1
kind string Monitoring
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
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
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec MonitoringSpec
status MonitoringStatus

MonitoringCommonSpec

MonitoringCommonSpec spec defines the shared desired state of Monitoring

Appears in:

Field Description Default Validation
namespace string monitoring spec exposed to DSCI api
Namespace for monitoring if it is enabled		 opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
metrics Metrics metrics collection
traces Traces Tracing configuration for OpenTelemetry instrumentation
alerting Alerting Alerting configuration for Prometheus
collectorReplicas integer CollectorReplicas specifies the number of replicas in opentelemetry-collector. If not set, it defaults
to 1 on single-node clusters and 2 on multi-node clusters.

MonitoringSpec

MonitoringSpec defines the desired state of Monitoring

Appears in:

Field Description Default Validation
namespace string monitoring spec exposed to DSCI api
Namespace for monitoring if it is enabled		 opendatahub MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
metrics Metrics metrics collection
traces Traces Tracing configuration for OpenTelemetry instrumentation
alerting Alerting Alerting configuration for Prometheus
collectorReplicas integer CollectorReplicas specifies the number of replicas in opentelemetry-collector. If not set, it defaults
to 1 on single-node clusters and 2 on multi-node clusters.

MonitoringStatus

MonitoringStatus defines the observed state of Monitoring

Appears in:

Field Description Default Validation
phase string
observedGeneration integer The generation observed by the resource controller.
conditions Condition array
url string

NetworkPolicyConfig

NetworkPolicyConfig defines network policy configuration for kube-auth-proxy. When nil or when Ingress is nil, NetworkPolicy ingress rules are enabled by default to restrict access to kube-auth-proxy pods.

Appears in:

Field Description Default Validation
ingress IngressPolicyConfig Ingress defines ingress NetworkPolicy rules.
When nil, ingress rules are applied by default (allows traffic from Gateway pods and monitoring namespaces).
When specified, Enabled must be set to true to apply rules or false to skip NetworkPolicy creation.
Set Enabled=false only in development environments or when using alternative network security controls.

OIDCConfig

OIDCConfig defines OIDC provider configuration

Appears in:

Field Description Default Validation
issuerURL string OIDC issuer URL Required: {}
clientID string OIDC client ID Required: {}
clientSecretRef SecretKeySelector Reference to secret containing client secret Required: {}
secretNamespace string Namespace where the client secret is located
If not specified, defaults to openshift-ingress

Traces

Traces enables and defines the configuration for traces collection

Appears in:

Field Description Default Validation
storage TracesStorage
sampleRatio string SampleRatio determines the sampling rate for traces
Value should be between 0.0 (no sampling) and 1.0 (sample all traces)		 0.1 Pattern: ^(0(\.[0-9]+)?|1(\.0+)?)$
tls TracesTLS TLS configuration for Tempo gRPC connections
exporters object (keys:string, values:RawExtension) Exporters defines custom trace exporters for sending traces to external observability tools.
Each key represents the exporter name, and the value contains the exporter configuration.
The configuration follows the OpenTelemetry Collector exporter format.

TracesStorage

TracesStorage defines the storage configuration for tracing

Appears in:

Field Description Default Validation
backend string Backend defines the storage backend type.
Valid values are "pv", "s3", and "gcs".		 pv Enum: [pv s3 gcs]
size string Size specifies the size of the storage.
This field is optional.
secret string Secret specifies the secret name for storage credentials.
This field is required when the backend is not "pv".
retention Duration Retention specifies how long trace data should be retained globally (e.g., "60m", "10h") 2160h

TracesTLS

TracesTLS defines TLS configuration for trace ingestion and query APIs

Appears in:

Field Description Default Validation
enabled boolean Enabled enables TLS for Tempo OTLP ingestion (gRPC/HTTP) and query APIs (HTTP)
TLS is disabled by default to maintain backward compatibility
certificateSecret string CertificateSecret specifies the name of the secret containing TLS certificates
If not specified, OpenShift service serving certificates will be used
caConfigMap string CAConfigMap specifies the name of the ConfigMap containing the CA certificate
Required for mutual TLS authentication