v1

Documentation

Overview

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

Index

• Variables
• type FeatureConditionReason
• type FeatureTracker
  • func NewFeatureTracker(name, appNamespace string) *FeatureTracker
  • func (in *FeatureTracker) DeepCopy() *FeatureTracker
  • func (in *FeatureTracker) DeepCopyInto(out *FeatureTracker)
  • func (in *FeatureTracker) DeepCopyObject() runtime.Object
  • func (s *FeatureTracker) ToOwnerReference() metav1.OwnerReference
• type FeatureTrackerList
  • func (in *FeatureTrackerList) DeepCopy() *FeatureTrackerList
  • func (in *FeatureTrackerList) DeepCopyInto(out *FeatureTrackerList)
  • func (in *FeatureTrackerList) DeepCopyObject() runtime.Object
• type FeatureTrackerSpec
  • func (in *FeatureTrackerSpec) DeepCopy() *FeatureTrackerSpec
  • func (in *FeatureTrackerSpec) DeepCopyInto(out *FeatureTrackerSpec)
• type FeatureTrackerStatus
  • func (in *FeatureTrackerStatus) DeepCopy() *FeatureTrackerStatus
  • func (in *FeatureTrackerStatus) DeepCopyInto(out *FeatureTrackerStatus)
• type OwnerType
• type Source
  • func (in *Source) DeepCopy() *Source
  • func (in *Source) DeepCopyInto(out *Source)

Variables

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

var ConditionReason = struct {
	FailedApplying,
	PreConditions,
	ResourceCreation,
	LoadTemplateData,
	ApplyManifests,
	PostConditions,
	FeatureCreated FeatureConditionReason
}{
	FailedApplying:   "FailedApplying",
	PreConditions:    "PreConditions",
	ResourceCreation: "ResourceCreation",
	LoadTemplateData: "LoadTemplateData",
	ApplyManifests:   "ApplyManifests",
	PostConditions:   "PostConditions",
	FeatureCreated:   "FeatureCreated",
}

Types

type FeatureConditionReason

type FeatureConditionReason string

type FeatureTracker

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

	Spec   FeatureTrackerSpec   `json:"spec,omitempty"`
	Status FeatureTrackerStatus `json:"status,omitempty"`
}

FeatureTracker represents a cluster-scoped resource in the Data Science Cluster, specifically designed for monitoring and managing objects created via the internal Features API. This resource serves a crucial role in cross-namespace resource management, acting as an owner reference for various resources. The primary purpose of the FeatureTracker is to enable efficient garbage collection by Kubernetes. This is essential for ensuring that resources are automatically cleaned up and reclaimed when they are no longer required. +kubebuilder:object:root=true +kubebuilder:resource:scope=Cluster +kubebuilder:subresource:status

func NewFeatureTracker

func NewFeatureTracker(name, appNamespace string) *FeatureTracker

NewFeatureTracker instantiate FeatureTracker.

func (*FeatureTracker) DeepCopy

func (in *FeatureTracker) DeepCopy() *FeatureTracker

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

func (*FeatureTracker) DeepCopyInto

func (in *FeatureTracker) DeepCopyInto(out *FeatureTracker)

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

func (*FeatureTracker) DeepCopyObject

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

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

func (*FeatureTracker) ToOwnerReference

func (s *FeatureTracker) ToOwnerReference() metav1.OwnerReference

type FeatureTrackerList

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

FeatureTrackerList contains a list of FeatureTracker.

func (*FeatureTrackerList) DeepCopy

func (in *FeatureTrackerList) DeepCopy() *FeatureTrackerList

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

func (*FeatureTrackerList) DeepCopyInto

func (in *FeatureTrackerList) DeepCopyInto(out *FeatureTrackerList)

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

func (*FeatureTrackerList) DeepCopyObject

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

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

type FeatureTrackerSpec

type FeatureTrackerSpec struct {
	Source       Source `json:"source,omitempty"`
	AppNamespace string `json:"appNamespace,omitempty"`
}

FeatureTrackerSpec defines the desired state of FeatureTracker.

func (*FeatureTrackerSpec) DeepCopy

func (in *FeatureTrackerSpec) DeepCopy() *FeatureTrackerSpec

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

func (*FeatureTrackerSpec) DeepCopyInto

func (in *FeatureTrackerSpec) DeepCopyInto(out *FeatureTrackerSpec)

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

type FeatureTrackerStatus

type FeatureTrackerStatus struct {
	// Phase describes the Phase of FeatureTracker reconciliation state.
	// This is used by OLM UI to provide status information to the user.
	Phase string `json:"phase,omitempty"`
	// +optional
	Conditions []conditionsv1.Condition `json:"conditions,omitempty"`
}

FeatureTrackerStatus defines the observed state of FeatureTracker.

func (*FeatureTrackerStatus) DeepCopy

func (in *FeatureTrackerStatus) DeepCopy() *FeatureTrackerStatus

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

func (*FeatureTrackerStatus) DeepCopyInto

func (in *FeatureTrackerStatus) DeepCopyInto(out *FeatureTrackerStatus)

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

type OwnerType

type OwnerType string

const (
	ComponentType OwnerType = "Component"
	DSCIType      OwnerType = "DSCI"
	UnknownType   OwnerType = "Unknown"
)

type Source

type Source struct {
	Type OwnerType `json:"type,omitempty"`
	Name string    `json:"name,omitempty"`
}

Source describes the type of object that created the related Feature to this FeatureTracker.

func (*Source) DeepCopy

func (in *Source) DeepCopy() *Source

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

func (*Source) DeepCopyInto

func (in *Source) DeepCopyInto(out *Source)

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