v1

Documentation

Overview

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

Index

• Variables
• type Components
  • func (in *Components) DeepCopy() *Components
  • func (in *Components) DeepCopyInto(out *Components)
• type ComponentsStatus
  • func (in *ComponentsStatus) DeepCopy() *ComponentsStatus
  • func (in *ComponentsStatus) DeepCopyInto(out *ComponentsStatus)
• type DataScienceCluster
  • func (in *DataScienceCluster) DeepCopy() *DataScienceCluster
  • func (in *DataScienceCluster) DeepCopyInto(out *DataScienceCluster)
  • func (in *DataScienceCluster) DeepCopyObject() runtime.Object
  • func (d *DataScienceCluster) GetComponents() ([]components.ComponentInterface, error)
• type DataScienceClusterList
  • func (in *DataScienceClusterList) DeepCopy() *DataScienceClusterList
  • func (in *DataScienceClusterList) DeepCopyInto(out *DataScienceClusterList)
  • func (in *DataScienceClusterList) DeepCopyObject() runtime.Object
• type DataScienceClusterSpec
  • func (in *DataScienceClusterSpec) DeepCopy() *DataScienceClusterSpec
  • func (in *DataScienceClusterSpec) DeepCopyInto(out *DataScienceClusterSpec)
• type DataScienceClusterStatus
  • func (in *DataScienceClusterStatus) DeepCopy() *DataScienceClusterStatus
  • func (in *DataScienceClusterStatus) DeepCopyInto(out *DataScienceClusterStatus)

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "datasciencecluster.opendatahub.io", Version: "v1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type Components

type Components struct {
	// Dashboard component configuration.
	Dashboard dashboard.Dashboard `json:"dashboard,omitempty"`

	// Workbenches component configuration.
	Workbenches workbenches.Workbenches `json:"workbenches,omitempty"`

	// ModelMeshServing component configuration.
	// Does not support enabled Kserve at the same time
	ModelMeshServing modelmeshserving.ModelMeshServing `json:"modelmeshserving,omitempty"`

	// DataServicePipeline component configuration.
	// Require OpenShift Pipelines Operator to be installed before enable component
	DataSciencePipelines datasciencepipelines.DataSciencePipelines `json:"datasciencepipelines,omitempty"`

	// Kserve component configuration.
	// Require OpenShift Serverless and OpenShift Service Mesh Operators to be installed before enable component
	// Does not support enabled ModelMeshServing at the same time
	Kserve kserve.Kserve `json:"kserve,omitempty"`

	// Kueue component configuration.
	Kueue kueue.Kueue `json:"kueue,omitempty"`

	// CodeFlare component configuration.
	// If CodeFlare Operator has been installed in the cluster, it should be uninstalled first before enabled component.
	CodeFlare codeflare.CodeFlare `json:"codeflare,omitempty"`

	// Ray component configuration.
	Ray ray.Ray `json:"ray,omitempty"`

	// TrustyAI component configuration.
	TrustyAI trustyai.TrustyAI `json:"trustyai,omitempty"`

	// ModelRegistry component configuration.
	ModelRegistry modelregistry.ModelRegistry `json:"modelregistry,omitempty"`

	//Training Operator component configuration.
	TrainingOperator trainingoperator.TrainingOperator `json:"trainingoperator,omitempty"`
}

func (*Components) DeepCopy

func (in *Components) DeepCopy() *Components

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Components.

func (*Components) DeepCopyInto

func (in *Components) DeepCopyInto(out *Components)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ComponentsStatus

type ComponentsStatus struct {
	// ModelRegistry component status
	ModelRegistry *status.ModelRegistryStatus `json:"modelregistry,omitempty"`
}

ComponentsStatus defines the custom status of DataScienceCluster components.

func (*ComponentsStatus) DeepCopy

func (in *ComponentsStatus) DeepCopy() *ComponentsStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComponentsStatus.

func (*ComponentsStatus) DeepCopyInto

func (in *ComponentsStatus) DeepCopyInto(out *ComponentsStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DataScienceCluster

type DataScienceCluster struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DataScienceClusterSpec   `json:"spec,omitempty"`
	Status DataScienceClusterStatus `json:"status,omitempty"`
}

DataScienceCluster is the Schema for the datascienceclusters API.

func (*DataScienceCluster) DeepCopy

func (in *DataScienceCluster) DeepCopy() *DataScienceCluster

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DataScienceCluster.

func (*DataScienceCluster) DeepCopyInto

func (in *DataScienceCluster) DeepCopyInto(out *DataScienceCluster)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DataScienceCluster) DeepCopyObject

func (in *DataScienceCluster) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*DataScienceCluster) GetComponents

func (d *DataScienceCluster) GetComponents() ([]components.ComponentInterface, error)

type DataScienceClusterList

type DataScienceClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []DataScienceCluster `json:"items"`
}

DataScienceClusterList contains a list of DataScienceCluster.

func (*DataScienceClusterList) DeepCopy

func (in *DataScienceClusterList) DeepCopy() *DataScienceClusterList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DataScienceClusterList.

func (*DataScienceClusterList) DeepCopyInto

func (in *DataScienceClusterList) DeepCopyInto(out *DataScienceClusterList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DataScienceClusterList) DeepCopyObject

func (in *DataScienceClusterList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DataScienceClusterSpec

type DataScienceClusterSpec struct {
	// Override and fine tune specific component configurations.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=1
	Components Components `json:"components,omitempty"`
}

DataScienceClusterSpec defines the desired state of the cluster.

func (*DataScienceClusterSpec) DeepCopy

func (in *DataScienceClusterSpec) DeepCopy() *DataScienceClusterSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DataScienceClusterSpec.

func (*DataScienceClusterSpec) DeepCopyInto

func (in *DataScienceClusterSpec) DeepCopyInto(out *DataScienceClusterSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DataScienceClusterStatus

type DataScienceClusterStatus struct {
	// Phase describes the Phase of DataScienceCluster reconciliation state
	// This is used by OLM UI to provide status information to the user
	Phase string `json:"phase,omitempty"`

	// Conditions describes the state of the DataScienceCluster resource.
	// +optional
	Conditions []conditionsv1.Condition `json:"conditions,omitempty"`

	// 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.
	// +optional
	RelatedObjects []corev1.ObjectReference `json:"relatedObjects,omitempty"`
	ErrorMessage   string                   `json:"errorMessage,omitempty"`

	// List of components with status if installed or not
	InstalledComponents map[string]bool `json:"installedComponents,omitempty"`

	// Expose component's specific status
	// +optional
	Components ComponentsStatus `json:"components,omitempty"`

	// Version and release type
	Release cluster.Release `json:"release,omitempty"`
}

DataScienceClusterStatus defines the observed state of DataScienceCluster.

func (*DataScienceClusterStatus) DeepCopy

func (in *DataScienceClusterStatus) DeepCopy() *DataScienceClusterStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DataScienceClusterStatus.

func (*DataScienceClusterStatus) DeepCopyInto

func (in *DataScienceClusterStatus) DeepCopyInto(out *DataScienceClusterStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.