v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the notebook v1alpha1 API group +kubebuilder:object:generate=true +groupName=notebook.kubedl.io

Index

• Constants
• Variables
• func RegisterDefaults(scheme *runtime.Scheme) error
• func Resource(resource string) schema.GroupResource
• func SetDefaults_Notebook(in *Notebook)
• func SetObjectDefaults_Notebook(in *Notebook)
• func SetObjectDefaults_NotebookList(in *NotebookList)
• type Notebook
  • func (in *Notebook) DeepCopy() *Notebook
  • func (in *Notebook) DeepCopyInto(out *Notebook)
  • func (in *Notebook) DeepCopyObject() runtime.Object
• type 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)

Constants

const (
	NotebookNameLabel     = "notebook.kubedl.io/notebook-name"
	NotebookContainerName = "notebook"
	NotebookPortName      = "nb-port"
	NotebookDefaultPort   = 8888
	NotebookKind          = "Notebook"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "notebook.kubedl.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group-qualified GroupResource.

func SetDefaults_Notebook

func SetDefaults_Notebook(in *Notebook)

func SetObjectDefaults_Notebook

func SetObjectDefaults_Notebook(in *Notebook)

func SetObjectDefaults_NotebookList

func SetObjectDefaults_NotebookList(in *NotebookList)

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.

type NotebookCondition

type NotebookCondition string

const (
	NotebookCreated NotebookCondition = "Created"

	NotebookRunning NotebookCondition = "Running"

	NotebookTerminated NotebookCondition = "Terminated"
)

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 pod template for notebook
	Template v1.PodTemplateSpec `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 {
	// Notebook condition
	Condition NotebookCondition `json:"condition,omitempty"`

	// Message associated with the condition
	Message string `json:"message,omitempty"`

	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`

	// URL for the notebook
	Url string `json:"url,omitempty"`
}

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.