v1

Documentation

Overview

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

Index

• Variables
• type DSCInitialization
  • func (in *DSCInitialization) DeepCopy() *DSCInitialization
  • func (in *DSCInitialization) DeepCopyInto(out *DSCInitialization)
  • func (in *DSCInitialization) DeepCopyObject() runtime.Object
• type DSCInitializationList
  • func (in *DSCInitializationList) DeepCopy() *DSCInitializationList
  • func (in *DSCInitializationList) DeepCopyInto(out *DSCInitializationList)
  • func (in *DSCInitializationList) DeepCopyObject() runtime.Object
• type DSCInitializationSpec
  • func (in *DSCInitializationSpec) DeepCopy() *DSCInitializationSpec
  • func (in *DSCInitializationSpec) DeepCopyInto(out *DSCInitializationSpec)
• type DSCInitializationStatus
  • func (in *DSCInitializationStatus) DeepCopy() *DSCInitializationStatus
  • func (in *DSCInitializationStatus) DeepCopyInto(out *DSCInitializationStatus)
• type DevFlags
  • func (in *DevFlags) DeepCopy() *DevFlags
  • func (in *DevFlags) DeepCopyInto(out *DevFlags)
• type Monitoring
  • func (in *Monitoring) DeepCopy() *Monitoring
  • func (in *Monitoring) DeepCopyInto(out *Monitoring)
• type TrustedCABundleSpec
  • func (in *TrustedCABundleSpec) DeepCopy() *TrustedCABundleSpec
  • func (in *TrustedCABundleSpec) DeepCopyInto(out *TrustedCABundleSpec)

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "dscinitialization.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 DSCInitialization

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

	Spec   DSCInitializationSpec   `json:"spec,omitempty"`
	Status DSCInitializationStatus `json:"status,omitempty"`
}

DSCInitialization is the Schema for the dscinitializations API.

func (*DSCInitialization) DeepCopy

func (in *DSCInitialization) DeepCopy() *DSCInitialization

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

func (*DSCInitialization) DeepCopyInto

func (in *DSCInitialization) DeepCopyInto(out *DSCInitialization)

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

func (*DSCInitialization) DeepCopyObject

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

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

type DSCInitializationList

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

DSCInitializationList contains a list of DSCInitialization.

func (*DSCInitializationList) DeepCopy

func (in *DSCInitializationList) DeepCopy() *DSCInitializationList

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

func (*DSCInitializationList) DeepCopyInto

func (in *DSCInitializationList) DeepCopyInto(out *DSCInitializationList)

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

func (*DSCInitializationList) DeepCopyObject

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

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

type DSCInitializationSpec

type DSCInitializationSpec struct {
	// Namespace for applications to be installed, non-configurable, default to "opendatahub"
	// +kubebuilder:default:=opendatahub
	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=1
	ApplicationsNamespace string `json:"applicationsNamespace"`
	// Enable monitoring on specified namespace
	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=2
	// +optional
	Monitoring Monitoring `json:"monitoring,omitempty"`
	// 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.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=3
	// +optional
	ServiceMesh infrav1.ServiceMeshSpec `json:"serviceMesh,omitempty"`
	// 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.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=4
	// +optional
	TrustedCABundle TrustedCABundleSpec `json:"trustedCABundle,omitempty"`
	// Internal development useful field to test customizations.
	// This is not recommended to be used in production environment.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,order=5
	// +optional
	DevFlags *DevFlags `json:"devFlags,omitempty"`
}

DSCInitializationSpec defines the desired state of DSCInitialization.

func (*DSCInitializationSpec) DeepCopy

func (in *DSCInitializationSpec) DeepCopy() *DSCInitializationSpec

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

func (*DSCInitializationSpec) DeepCopyInto

func (in *DSCInitializationSpec) DeepCopyInto(out *DSCInitializationSpec)

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

type DSCInitializationStatus

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

	// Conditions describes the state of the DSCInitializationStatus resource
	// +operator-sdk:csv:customresourcedefinitions:type=status
	// +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"`
}

DSCInitializationStatus defines the observed state of DSCInitialization.

func (*DSCInitializationStatus) DeepCopy

func (in *DSCInitializationStatus) DeepCopy() *DSCInitializationStatus

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

func (*DSCInitializationStatus) DeepCopyInto

func (in *DSCInitializationStatus) DeepCopyInto(out *DSCInitializationStatus)

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

type DevFlags

type DevFlags struct {
	// Custom manifests uri for odh-manifests
	// +optional
	ManifestsUri string `json:"manifestsUri,omitempty"`
	// +kubebuilder:validation:Enum=devel;development;prod;production
	// +kubebuilder:default="production"
	LogMode string `json:"logmode,omitempty"`
}

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

func (*DevFlags) DeepCopy

func (in *DevFlags) DeepCopy() *DevFlags

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

func (*DevFlags) DeepCopyInto

func (in *DevFlags) DeepCopyInto(out *DevFlags)

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

type Monitoring

type Monitoring struct {
	// 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.
	// +kubebuilder:validation:Enum=Managed;Removed
	ManagementState operatorv1.ManagementState `json:"managementState,omitempty"`
	// +kubebuilder:default=opendatahub
	// Namespace for monitoring if it is enabled
	Namespace string `json:"namespace,omitempty"`
}

func (*Monitoring) DeepCopy

func (in *Monitoring) DeepCopy() *Monitoring

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

func (*Monitoring) DeepCopyInto

func (in *Monitoring) DeepCopyInto(out *Monitoring)

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

type TrustedCABundleSpec

type TrustedCABundleSpec struct {
	// managementState indicates whether and how the operator should manage customized CA bundle
	// +kubebuilder:validation:Enum=Managed;Removed;Unmanaged
	// +kubebuilder:default=Removed
	ManagementState operatorv1.ManagementState `json:"managementState"`
	// 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 .
	// +kubebuilder:default=""
	CustomCABundle string `json:"customCABundle"`
}

func (*TrustedCABundleSpec) DeepCopy

func (in *TrustedCABundleSpec) DeepCopy() *TrustedCABundleSpec

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

func (*TrustedCABundleSpec) DeepCopyInto

func (in *TrustedCABundleSpec) DeepCopyInto(out *TrustedCABundleSpec)

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