v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the kfdef v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/kfctl/v3/pkg/apis/apps/kfupdate +k8s:defaulter-gen=TypeMeta +groupName=kfupdate.apps.kubeflow.org

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type KfDefRef
  • func (in *KfDefRef) DeepCopy() *KfDefRef
  • func (in *KfDefRef) DeepCopyInto(out *KfDefRef)
• type KfUpgrade
  • func LoadKfUpgradeFromUri(configFile string) (*KfUpgrade, error)
  • func (in *KfUpgrade) DeepCopy() *KfUpgrade
  • func (in *KfUpgrade) DeepCopyInto(out *KfUpgrade)
  • func (in *KfUpgrade) DeepCopyObject() runtime.Object
  • func (u *KfUpgrade) WriteToFile(path string) error
• type KfUpgradeCondition
  • func (in *KfUpgradeCondition) DeepCopy() *KfUpgradeCondition
  • func (in *KfUpgradeCondition) DeepCopyInto(out *KfUpgradeCondition)
• type KfUpgradeConditionType
• type KfUpgradeList
  • func (in *KfUpgradeList) DeepCopy() *KfUpgradeList
  • func (in *KfUpgradeList) DeepCopyInto(out *KfUpgradeList)
  • func (in *KfUpgradeList) DeepCopyObject() runtime.Object
• type KfUpgradeSpec
  • func (in *KfUpgradeSpec) DeepCopy() *KfUpgradeSpec
  • func (in *KfUpgradeSpec) DeepCopyInto(out *KfUpgradeSpec)
• type KfUpgradeStatus
  • func (in *KfUpgradeStatus) DeepCopy() *KfUpgradeStatus
  • func (in *KfUpgradeStatus) DeepCopyInto(out *KfUpgradeStatus)

Constants

const (
	KfUpgradeFile = "update.yaml"
)

Variables

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

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme is required by pkg/kfdef/...
	AddToScheme = localSchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/kfdef/listers/...

Types

type KfDefRef

type KfDefRef struct {
	// Name of the referrent.
	Name string `json:"name,omitempty"`

	// Version of the referent.
	// +optional
	Version string `json:"version,omitempty"`
}

func (*KfDefRef) DeepCopy

func (in *KfDefRef) DeepCopy() *KfDefRef

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

func (*KfDefRef) DeepCopyInto

func (in *KfDefRef) DeepCopyInto(out *KfDefRef)

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

type KfUpgrade

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

	Spec   KfUpgradeSpec   `json:"spec,omitempty"`
	Status KfUpgradeStatus `json:"status,omitempty"`
}

KfUpgrade is the Schema for the applications API +k8s:openapi-gen=true

func LoadKfUpgradeFromUri

func LoadKfUpgradeFromUri(configFile string) (*KfUpgrade, error)

LoadKfUpgradeFromUri constructs a KfUpgrade given the path to a YAML file. configFile is the path to the YAML file containing the KfDef spec. Can be any URI supported by hashicorp go-getter.

func (*KfUpgrade) DeepCopy

func (in *KfUpgrade) DeepCopy() *KfUpgrade

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

func (*KfUpgrade) DeepCopyInto

func (in *KfUpgrade) DeepCopyInto(out *KfUpgrade)

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

func (*KfUpgrade) DeepCopyObject

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

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

func (*KfUpgrade) WriteToFile

func (u *KfUpgrade) WriteToFile(path string) error

WriteToFile write the KfUpgrade to a file.

type KfUpgradeCondition

type KfUpgradeCondition struct {
	// Type of deployment condition.
	Type KfUpgradeConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=KfDefConditionType"`
	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"`
	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,6,opt,name=lastUpdateTime"`
	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,7,opt,name=lastTransitionTime"`
	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"`
	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"`
}

func (*KfUpgradeCondition) DeepCopy

func (in *KfUpgradeCondition) DeepCopy() *KfUpgradeCondition

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

func (*KfUpgradeCondition) DeepCopyInto

func (in *KfUpgradeCondition) DeepCopyInto(out *KfUpgradeCondition)

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

type KfUpgradeConditionType

type KfUpgradeConditionType string

const (
	// KfDeploying means Kubeflow is in the process of being deployed.
	KfUpgradeInProgress KfUpgradeConditionType = "InProgress"

	// KfSucceeded means Kubeflow was successfully deployed.
	KfUpgradeSucceeded KfUpgradeConditionType = "Succeeded"

	// KfFailed meansthere was a problem deploying Kubeflow.
	KfUpgradeFailed KfUpgradeConditionType = "Failed"

	// InvalidKfUpgradeSpecReason indicates the KfUpgrade was not valid.
	InvalidKfUpgradeSpecReason = "InvalidKfUpgradeSpec"
)

type KfUpgradeList

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

KfUpgradeList contains a list of KfUpgrade

func (*KfUpgradeList) DeepCopy

func (in *KfUpgradeList) DeepCopy() *KfUpgradeList

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

func (*KfUpgradeList) DeepCopyInto

func (in *KfUpgradeList) DeepCopyInto(out *KfUpgradeList)

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

func (*KfUpgradeList) DeepCopyObject

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

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

type KfUpgradeSpec

type KfUpgradeSpec struct {
	// Reference to the current (existing) KfDef.
	CurrentKfDef *KfDefRef `json:"currentKfDef,omitempty"`

	// Reference to the new KfDef.
	// +optional
	NewKfDef *KfDefRef `json:"newKfDef,omitempty"`

	// Base config file used to generate the new KfDef.
	// +optional
	BaseConfigPath string `json:"baseConfigPath,omitempty"`
}

func (*KfUpgradeSpec) DeepCopy

func (in *KfUpgradeSpec) DeepCopy() *KfUpgradeSpec

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

func (*KfUpgradeSpec) DeepCopyInto

func (in *KfUpgradeSpec) DeepCopyInto(out *KfUpgradeSpec)

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

type KfUpgradeStatus

type KfUpgradeStatus struct {
	Conditions []KfUpgradeCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,6,rep,name=conditions"`
}

KfUpgradeStatus defines the observed state of KfUpgrade

func (*KfUpgradeStatus) DeepCopy

func (in *KfUpgradeStatus) DeepCopy() *KfUpgradeStatus

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

func (*KfUpgradeStatus) DeepCopyInto

func (in *KfUpgradeStatus) DeepCopyInto(out *KfUpgradeStatus)

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