Skip to content

Latest commit

 

History

History
2245 lines (1105 loc) · 86.6 KB

api-overview.md

File metadata and controls

2245 lines (1105 loc) · 86.6 KB
Raw

API Reference

Packages

components.platform.opendatahub.io/v1alpha1

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

Resource Types

CodeFlare

CodeFlare is the Schema for the codeflares API

Appears in:

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string CodeFlare
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 CodeFlareSpec
status CodeFlareStatus

CodeFlareCommonSpec

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

CodeFlareCommonStatus

CodeFlareCommonStatus defines the shared observed state of CodeFlare

Appears in:

CodeFlareList

CodeFlareList contains a list of CodeFlare

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string CodeFlareList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items CodeFlare array

CodeFlareSpec

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

CodeFlareStatus

CodeFlareStatus defines the observed state of CodeFlare

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

DSCCodeFlare

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]
devFlags DevFlags Add developer fields

DSCCodeFlareStatus

DSCCodeFlareStatus contains the observed state of the CodeFlare 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]

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]
devFlags DevFlags Add developer fields

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]
devFlags DevFlags Add developer fields

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]

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]
devFlags DevFlags Add developer fields
serving ServingSpec Serving configures the KNative-Serving stack used for model serving. A Service
Mesh (Istio) is prerequisite, since it is used as networking layer.
defaultDeploymentMode DefaultDeploymentMode Configures the default deployment mode for Kserve. This can be set to 'Serverless' or 'RawDeployment'.
The value specified in this field will be used to set the default deployment mode in the 'inferenceservice-config' configmap for Kserve.
This field is optional. If no default deployment mode is specified, Kserve will use Serverless mode.		 Enum: [Serverless RawDeployment]
Pattern: ^(Serverless|RawDeployment)$
nim NimSpec Configures and enables NVIDIA NIM 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" : 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]
devFlags DevFlags Add developer fields

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" : 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]

DSCModelMeshServing

DSCModelMeshServing contains all the configuration exposed in DSC instance for ModelMeshServing 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]
devFlags DevFlags Add developer fields

DSCModelMeshServingStatus

DSCModelMeshServingStatus contains the observed state of the ModelMeshServing 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]
devFlags DevFlags Add developer fields
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]

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]
devFlags DevFlags Add developer fields

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]

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]
devFlags DevFlags Add developer fields

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]
devFlags DevFlags Add developer fields

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]
devFlags DevFlags Add developer fields

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

Appears in:

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

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

DashboardCommonStatus

DashboardCommonStatus defines the shared observed state of Dashboard

Appears in:

Field Description Default Validation
url string

DashboardList

DashboardList contains a list of Dashboard

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string DashboardList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Dashboard array

DashboardSpec

DashboardSpec defines the desired state of Dashboard

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

DashboardStatus

DashboardStatus defines the observed state of Dashboard

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array
url string

DataSciencePipelines

DataSciencePipelines is the Schema for the datasciencepipelines API

Appears in:

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
devFlags DevFlags Add developer fields

DataSciencePipelinesCommonStatus

DataSciencePipelinesCommonStatus defines the shared observed state of DataSciencePipelines

Appears in:

DataSciencePipelinesList

DataSciencePipelinesList contains a list of DataSciencePipelines

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string DataSciencePipelinesList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items DataSciencePipelines array

DataSciencePipelinesSpec

DataSciencePipelinesSpec defines the desired state of DataSciencePipelines

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

DataSciencePipelinesStatus

DataSciencePipelinesStatus defines the observed state of DataSciencePipelines

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

DefaultDeploymentMode

Underlying type: string

Validation:

  • Pattern: ^(Serverless|RawDeployment)$

Appears in:

Field Description
Serverless Serverless will be used as the default deployment mode for Kserve. This requires Serverless and ServiceMesh operators configured as dependencies.
RawDeployment RawDeployment will be used as the default deployment mode for Kserve.

Kserve

Kserve is the Schema for the kserves API

Appears in:

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
devFlags DevFlags Add developer fields
serving ServingSpec Serving configures the KNative-Serving stack used for model serving. A Service
Mesh (Istio) is prerequisite, since it is used as networking layer.
defaultDeploymentMode DefaultDeploymentMode Configures the default deployment mode for Kserve. This can be set to 'Serverless' or 'RawDeployment'.
The value specified in this field will be used to set the default deployment mode in the 'inferenceservice-config' configmap for Kserve.
This field is optional. If no default deployment mode is specified, Kserve will use Serverless mode.		 Enum: [Serverless RawDeployment]
Pattern: ^(Serverless|RawDeployment)$
nim NimSpec Configures and enables NVIDIA NIM integration

KserveCommonStatus

KserveCommonStatus defines the shared observed state of Kserve

Appears in:

KserveList

KserveList contains a list of Kserve

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string KserveList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Kserve array

KserveSpec

KserveSpec defines the desired state of Kserve

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields
serving ServingSpec Serving configures the KNative-Serving stack used for model serving. A Service
Mesh (Istio) is prerequisite, since it is used as networking layer.
defaultDeploymentMode DefaultDeploymentMode Configures the default deployment mode for Kserve. This can be set to 'Serverless' or 'RawDeployment'.
The value specified in this field will be used to set the default deployment mode in the 'inferenceservice-config' configmap for Kserve.
This field is optional. If no default deployment mode is specified, Kserve will use Serverless mode.		 Enum: [Serverless RawDeployment]
Pattern: ^(Serverless|RawDeployment)$
nim NimSpec Configures and enables NVIDIA NIM integration

KserveStatus

KserveStatus defines the observed state of Kserve

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

Kueue

Kueue is the Schema for the kueues API

Appears in:

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:

Field Description Default Validation
devFlags DevFlags Add developer fields

KueueCommonStatus

KueueCommonStatus defines the shared observed state of Kueue

Appears in:

KueueList

KueueList contains a list of Kueue

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string KueueList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Kueue array

KueueSpec

KueueSpec defines the desired state of Kueue

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

KueueStatus

KueueStatus defines the observed state of Kueue

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

ModelController

ModelController is the Schema for the modelcontroller API, it is a shared component between kserve and modelmeshserving

Appears in:

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 keep devflags and management spec

Appears in:

Field Description Default Validation
managementState ManagementState
nim NimSpec
devFlags DevFlags Add developer fields

ModelControllerList

ModelControllerList contains a list of ModelController

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string ModelControllerList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ModelController array

ModelControllerMMSpec

a mini version of the DSCModelMeshServing only keep devflags and management spec

Appears in:

Field Description Default Validation
managementState ManagementState
devFlags DevFlags Add developer fields

ModelControllerSpec

ModelControllerSpec defines the desired state of ModelController

Appears in:

Field Description Default Validation
kserve ModelControllerKerveSpec ModelMeshServing DSCModelMeshServing json:"modelMeshServing,omitempty"
modelMeshServing ModelControllerMMSpec

ModelControllerStatus

ModelControllerStatus defines the observed state of ModelController

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

ModelMeshServing

ModelMeshServing is the Schema for the modelmeshservings API

Appears in:

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string ModelMeshServing
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 ModelMeshServingSpec
status ModelMeshServingStatus

ModelMeshServingCommonSpec

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

ModelMeshServingCommonStatus

ModelMeshServingCommonStatus defines the shared observed state of ModelMeshServing

Appears in:

ModelMeshServingList

ModelMeshServingList contains a list of ModelMeshServing

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string ModelMeshServingList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ModelMeshServing array

ModelMeshServingSpec

ModelMeshServingSpec defines the desired state of ModelMeshServing

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

ModelMeshServingStatus

ModelMeshServingStatus defines the observed state of ModelMeshServing

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

ModelRegistry

ModelRegistry is the Schema for the modelregistries API

Appears in:

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

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields
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

ModelRegistryList

ModelRegistryList contains a list of ModelRegistry

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string ModelRegistryList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ModelRegistry array

ModelRegistrySpec

ModelRegistrySpec defines the desired state of ModelRegistry

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields
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])?)?$

ModelRegistryStatus

ModelRegistryStatus defines the observed state of ModelRegistry

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array
registriesNamespace string

NimSpec

nimSpec enables NVIDIA NIM integration

Appears in:

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

Ray

Ray is the Schema for the rays API

Appears in:

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:

Field Description Default Validation
devFlags DevFlags Add developer fields

RayCommonStatus

RayCommonStatus defines the shared observed state of Ray

Appears in:

RayList

RayList contains a list of Ray

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string RayList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Ray array

RaySpec

RaySpec defines the desired state of Ray

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

RayStatus

RayStatus defines the observed state of Ray

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

TrainingOperator

TrainingOperator is the Schema for the trainingoperators API

Appears in:

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:

Field Description Default Validation
devFlags DevFlags Add developer fields

TrainingOperatorCommonStatus

TrainingOperatorCommonStatus defines the shared observed state of TrainingOperator

Appears in:

TrainingOperatorList

TrainingOperatorList contains a list of TrainingOperator

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string TrainingOperatorList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items TrainingOperator array

TrainingOperatorSpec

TrainingOperatorSpec defines the desired state of TrainingOperator

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

TrainingOperatorStatus

TrainingOperatorStatus defines the observed state of TrainingOperator

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

TrustyAI

TrustyAI is the Schema for the trustyais API

Appears in:

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
devFlags DevFlags Add developer fields

TrustyAICommonStatus

TrustyAICommonStatus defines the shared observed state of TrustyAI

Appears in:

TrustyAIList

TrustyAIList contains a list of TrustyAI

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string TrustyAIList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items TrustyAI array

TrustyAISpec

TrustyAISpec defines the desired state of TrustyAI

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

TrustyAIStatus

TrustyAIStatus defines the observed state of TrustyAI

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

Workbenches

Workbenches is the Schema for the workbenches API

Appears in:

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
devFlags DevFlags Add developer fields

WorkbenchesCommonStatus

WorkbenchesCommonStatus defines the shared observed state of Workbenches

Appears in:

WorkbenchesList

WorkbenchesList contains a list of Workbenches

Field Description Default Validation
apiVersion string components.platform.opendatahub.io/v1alpha1
kind string WorkbenchesList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Workbenches array

WorkbenchesSpec

WorkbenchesSpec defines the desired state of Workbenches

Appears in:

Field Description Default Validation
devFlags DevFlags Add developer fields

WorkbenchesStatus

WorkbenchesStatus defines the observed state of Workbenches

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array

datasciencecluster.opendatahub.io/components

datasciencecluster.opendatahub.io/v1

Resource Types

AuthSpec

Appears in:

Field Description Default Validation
namespace string Namespace where it is deployed. If not provided, the default is to
use '-auth-provider' suffix on the ApplicationsNamespace of the DSCI.		 MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
audiences string Audiences is a list of the identifiers that the resource server presented
with the token identifies as. Audience-aware token authenticators will verify
that the token was intended for at least one of the audiences in this list.
If no audiences are provided, the audience will default to the audience of the
Kubernetes apiserver (kubernetes.default.svc).		 [https://kubernetes.default.svc]

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]

Components

Appears in:

Field Description Default Validation
dashboard DSCDashboard Dashboard component configuration.
workbenches DSCWorkbenches Workbenches component configuration.
modelmeshserving DSCModelMeshServing ModelMeshServing component configuration.
datasciencepipelines DSCDataSciencePipelines DataSciencePipeline component configuration.
Requires OpenShift Pipelines Operator to be installed before enable component
kserve DSCKserve Kserve component configuration.
Requires OpenShift Serverless and OpenShift Service Mesh Operators to be installed before enable component
Does not support enabled ModelMeshServing at the same time
kueue DSCKueue Kueue component configuration.
codeflare DSCCodeFlare CodeFlare component configuration.
If CodeFlare Operator has been installed in the cluster, it should be uninstalled first before enabling component.
ray DSCRay Ray component configuration.
trustyai DSCTrustyAI TrustyAI component configuration.
modelregistry DSCModelRegistry ModelRegistry component configuration.
trainingoperator DSCTrainingOperator Training 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.
modelmeshserving DSCModelMeshServingStatus ModelMeshServing component status.
datasciencepipelines DSCDataSciencePipelinesStatus DataSciencePipeline component status.
kserve DSCKserveStatus Kserve component status.
kueue DSCKueueStatus Kueue component status.
codeflare DSCCodeFlareStatus CodeFlare component status.
ray DSCRayStatus Ray component status.
trustyai DSCTrustyAIStatus TrustyAI component status.
modelregistry DSCModelRegistryStatus ModelRegistry component status.
trainingoperator DSCTrainingOperatorStatus Training Operator component status.

ControlPlaneSpec

Appears in:

Field Description Default Validation
name string Name is a name Service Mesh Control Plane. Defaults to "data-science-smcp". data-science-smcp
namespace string Namespace is a namespace where Service Mesh is deployed. Defaults to "istio-system". istio-system MaxLength: 63
Pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?)?$
metricsCollection string MetricsCollection specifies if metrics from components on the Mesh namespace
should be collected. Setting the value to "Istio" will collect metrics from the
control plane and any proxies on the Mesh namespace (like gateway pods). Setting
to "None" will disable metrics collection.		 Istio Enum: [Istio None]

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 Phase describes the Phase of DataScienceCluster reconciliation state
This is used by OLM UI to provide status information to the user
conditions Condition array Conditions describes the state of the DataScienceCluster resource.
observedGeneration integer The generation observed by the deployment controller.
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

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.

ServiceMeshSpec

ServiceMeshSpec configures Service Mesh.

Appears in:

Field Description Default Validation
managementState ManagementState Removed Enum: [Managed Unmanaged Removed]
controlPlane ControlPlaneSpec ControlPlane holds configuration of Service Mesh used by Opendatahub.
auth AuthSpec Auth holds configuration of authentication and authorization services
used by Service Mesh in Opendatahub.

ServingSpec

ServingSpec specifies the configuration for the KNative Serving components and their bindings with the Service Mesh.

Appears in:

Field Description Default Validation
managementState ManagementState Managed Enum: [Managed Unmanaged Removed]
name string Name specifies the name of the KNativeServing resource that is going to be
created to instruct the KNative Operator to deploy KNative serving components.
This resource is created in the "knative-serving" namespace.		 knative-serving
ingressGateway GatewaySpec IngressGateway allows to customize some parameters for the Istio Ingress Gateway
that is bound to KNative-Serving.

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 DSCMonitoring Enable monitoring on specified namespace
serviceMesh ServiceMeshSpec Configures Service Mesh as networking layer for Data Science Clusters components.
The Service Mesh is a mandatory prerequisite for single model serving (KServe) and
you should review this configuration if you are planning to use KServe.
For other components, it enhances user experience; e.g. it provides unified
authentication giving a Single Sign On experience.
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 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 .

services.platform.opendatahub.io/v1alpha1

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

Resource Types

DSCMonitoring

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])?)?$

Monitoring

Monitoring is the Schema for the monitorings API

Appears in:

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 Dashboard

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])?)?$

MonitoringList

MonitoringList contains a list of Monitoring

Field Description Default Validation
apiVersion string services.platform.opendatahub.io/v1alpha1
kind string MonitoringList
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 ListMeta Refer to Kubernetes API documentation for fields of metadata.
items Monitoring array

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])?)?$

MonitoringStatus

MonitoringStatus defines the observed state of Monitoring

Appears in:

Field Description Default Validation
phase string
observedGeneration integer
conditions Condition array
url string