v1beta1

Documentation

Overview

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

Index

• Variables
• type Notebook
  • func (in *Notebook) DeepCopy() *Notebook
  • func (in *Notebook) DeepCopyInto(out *Notebook)
  • func (in *Notebook) DeepCopyObject() runtime.Object
  • func (*Notebook) Hub()
  • func (r *Notebook) SetupWebhookWithManager(mgr ctrl.Manager) error
• type NotebookCondition
  • func (in *NotebookCondition) DeepCopy() *NotebookCondition
  • func (in *NotebookCondition) DeepCopyInto(out *NotebookCondition)
• type NotebookList
  • func (in *NotebookList) DeepCopy() *NotebookList
  • func (in *NotebookList) DeepCopyInto(out *NotebookList)
  • func (in *NotebookList) DeepCopyObject() runtime.Object
• type NotebookSpec
  • func (in *NotebookSpec) DeepCopy() *NotebookSpec
  • func (in *NotebookSpec) DeepCopyInto(out *NotebookSpec)
• type NotebookStatus
  • func (in *NotebookStatus) DeepCopy() *NotebookStatus
  • func (in *NotebookStatus) DeepCopyInto(out *NotebookStatus)
• type NotebookTemplateSpec
  • func (in *NotebookTemplateSpec) DeepCopy() *NotebookTemplateSpec
  • func (in *NotebookTemplateSpec) DeepCopyInto(out *NotebookTemplateSpec)

Variables

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

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

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

	Spec   NotebookSpec   `json:"spec,omitempty"`
	Status NotebookStatus `json:"status,omitempty"`
}

Notebook is the Schema for the notebooks API

func (*Notebook) DeepCopy

func (in *Notebook) DeepCopy() *Notebook

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

func (*Notebook) DeepCopyInto

func (in *Notebook) DeepCopyInto(out *Notebook)

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

func (*Notebook) DeepCopyObject

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

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

func (*Notebook) Hub

func (*Notebook) Hub()

Hub marks this type as a conversion hub.

func (*Notebook) SetupWebhookWithManager

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

type NotebookCondition

type NotebookCondition struct {
	// Type is the type of the condition. Possible values are Running|Waiting|Terminated
	Type string `json:"type"`
	// Status is the status of the condition. Can be True, False, Unknown.
	Status string `json:"status"`
	// Last time we probed the condition.
	// +optional
	LastProbeTime metav1.Time `json:"lastProbeTime,omitempty"`
	// Last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// (brief) reason the container is in the current state
	// +optional
	Reason string `json:"reason,omitempty"`
	// Message regarding why the container is in the current state.
	// +optional
	Message string `json:"message,omitempty"`
}

func (*NotebookCondition) DeepCopy

func (in *NotebookCondition) DeepCopy() *NotebookCondition

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

func (*NotebookCondition) DeepCopyInto

func (in *NotebookCondition) DeepCopyInto(out *NotebookCondition)

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

type NotebookList

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

NotebookList contains a list of Notebook

func (*NotebookList) DeepCopy

func (in *NotebookList) DeepCopy() *NotebookList

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

func (*NotebookList) DeepCopyInto

func (in *NotebookList) DeepCopyInto(out *NotebookList)

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

func (*NotebookList) DeepCopyObject

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

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

type NotebookSpec

type NotebookSpec struct {
	// Template describes the notebooks that will be created.
	Template NotebookTemplateSpec `json:"template,omitempty"`
}

NotebookSpec defines the desired state of Notebook

func (*NotebookSpec) DeepCopy

func (in *NotebookSpec) DeepCopy() *NotebookSpec

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

func (*NotebookSpec) DeepCopyInto

func (in *NotebookSpec) DeepCopyInto(out *NotebookSpec)

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

type NotebookStatus

type NotebookStatus struct {
	// Conditions is an array of current conditions
	Conditions []NotebookCondition `json:"conditions"`
	// ReadyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
	ReadyReplicas int32 `json:"readyReplicas"`
	// ContainerState is the state of underlying container.
	ContainerState corev1.ContainerState `json:"containerState"`
}

NotebookStatus defines the observed state of Notebook

func (*NotebookStatus) DeepCopy

func (in *NotebookStatus) DeepCopy() *NotebookStatus

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

func (*NotebookStatus) DeepCopyInto

func (in *NotebookStatus) DeepCopyInto(out *NotebookStatus)

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

type NotebookTemplateSpec

type NotebookTemplateSpec struct {
	Spec corev1.PodSpec `json:"spec,omitempty"`
}

func (*NotebookTemplateSpec) DeepCopy

func (in *NotebookTemplateSpec) DeepCopy() *NotebookTemplateSpec

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

func (*NotebookTemplateSpec) DeepCopyInto

func (in *NotebookTemplateSpec) DeepCopyInto(out *NotebookTemplateSpec)

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