v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the automl v1alpha1 API group +kubebuilder:object:generate=true +groupName=automl.cloudai.kubeflow.org

Index

• Variables
• type ModelSync
  • func (in *ModelSync) DeepCopy() *ModelSync
  • func (in *ModelSync) DeepCopyInto(out *ModelSync)
  • func (in *ModelSync) DeepCopyObject() runtime.Object
  • func (r *ModelSync) Default()
  • func (r *ModelSync) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *ModelSync) ValidateCreate() error
  • func (r *ModelSync) ValidateDelete() error
  • func (r *ModelSync) ValidateUpdate(old runtime.Object) error
• type ModelSyncList
  • func (in *ModelSyncList) DeepCopy() *ModelSyncList
  • func (in *ModelSyncList) DeepCopyInto(out *ModelSyncList)
  • func (in *ModelSyncList) DeepCopyObject() runtime.Object
• type ModelSyncSpec
  • func (in *ModelSyncSpec) DeepCopy() *ModelSyncSpec
  • func (in *ModelSyncSpec) DeepCopyInto(out *ModelSyncSpec)
• type ModelSyncStatus
  • func (in *ModelSyncStatus) DeepCopy() *ModelSyncStatus
  • func (in *ModelSyncStatus) DeepCopyInto(out *ModelSyncStatus)
• type Parameter
  • func (in *Parameter) DeepCopy() *Parameter
  • func (in *Parameter) DeepCopyInto(out *Parameter)
• type PipelineRunTemplate
  • func (in *PipelineRunTemplate) DeepCopy() *PipelineRunTemplate
  • func (in *PipelineRunTemplate) DeepCopyInto(out *PipelineRunTemplate)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "automl.cloudai.kubeflow.org", Version: "v1alpha1"}

	// 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 ModelSync

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

	Spec   ModelSyncSpec   `json:"spec,omitempty"`
	Status ModelSyncStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status ModelSync is the Schema for the modelsyncs API

func (*ModelSync) DeepCopy

func (in *ModelSync) DeepCopy() *ModelSync

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

func (*ModelSync) DeepCopyInto

func (in *ModelSync) DeepCopyInto(out *ModelSync)

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

func (*ModelSync) DeepCopyObject

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

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

func (*ModelSync) Default

func (r *ModelSync) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*ModelSync) SetupWebhookWithManager

func (r *ModelSync) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*ModelSync) ValidateCreate

func (r *ModelSync) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*ModelSync) ValidateDelete

func (r *ModelSync) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*ModelSync) ValidateUpdate

func (r *ModelSync) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type ModelSyncList

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

ModelSyncList contains a list of ModelSync

func (*ModelSyncList) DeepCopy

func (in *ModelSyncList) DeepCopy() *ModelSyncList

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

func (*ModelSyncList) DeepCopyInto

func (in *ModelSyncList) DeepCopyInto(out *ModelSyncList)

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

func (*ModelSyncList) DeepCopyObject

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

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

type ModelSyncSpec

type ModelSyncSpec struct {
	// NeedsSyncUrl URL of the service that determines whether an update is needed.
	NeedsSyncUrl string `json:"needsSyncUrl,omitempty"`

	// Parameters configures how parameters returned by the sync URL should be passed to the pipeline.
	Parameters []Parameter `json:"parameters,omitempty"`

	PipelineRunTemplate PipelineRunTemplate `json:"pipelineRunTemplate,omitempty"`

	// The number of successful finished jobs to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	// +optional
	SuccessfulPipelineRunsHistoryLimit *int32 `json:"successfulPipelineRunsHistoryLimit,omitempty"`

	// The number of failed finished jobs to retain.
	// This is a pointer to distinguish between explicit zero and not specified.
	// +optional
	FailedPipelineRunsHistoryLimit *int32 `json:"failedPipelineRunsHistoryLimit,omitempty"`
}

ModelSyncSpec defines the desired state of ModelSync

func (*ModelSyncSpec) DeepCopy

func (in *ModelSyncSpec) DeepCopy() *ModelSyncSpec

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

func (*ModelSyncSpec) DeepCopyInto

func (in *ModelSyncSpec) DeepCopyInto(out *ModelSyncSpec)

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

type ModelSyncStatus

type ModelSyncStatus struct {

	// A list of pointers to currently running PipelineRuns.
	// +optional
	Active []corev1.ObjectReference `json:"active,omitempty"`
}

ModelSyncStatus defines the observed state of ModelSync

func (*ModelSyncStatus) DeepCopy

func (in *ModelSyncStatus) DeepCopy() *ModelSyncStatus

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

func (*ModelSyncStatus) DeepCopyInto

func (in *ModelSyncStatus) DeepCopyInto(out *ModelSyncStatus)

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

type Parameter

type Parameter struct {
	// NeedsSyncName is the name of the parameter as returned by the NeedsSyncUrl
	// Leave empty if its the same as pipelineName.
	NeedsSyncName string `json:"needsSyncName,omitEmpty"`
	// PipelineName is the corresponding name of the parameter in the pipeline.
	PipelineName string `json:"pipelineName,omitEmpty"`
}

Parameter configures a parameter

func (*Parameter) DeepCopy

func (in *Parameter) DeepCopy() *Parameter

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

func (*Parameter) DeepCopyInto

func (in *Parameter) DeepCopyInto(out *Parameter)

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

type PipelineRunTemplate

type PipelineRunTemplate struct {
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Spec tk.PipelineRunSpec `json:"spec,omitempty"`
}

PipelineRunTemplate is a template for pipeline runs.

func (*PipelineRunTemplate) DeepCopy

func (in *PipelineRunTemplate) DeepCopy() *PipelineRunTemplate

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

func (*PipelineRunTemplate) DeepCopyInto

func (in *PipelineRunTemplate) DeepCopyInto(out *PipelineRunTemplate)

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