v1alpha1

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 14, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source
const (
	LogLevelDebug   = "DEBUG"
	LogLevelInfo    = "INFO"
	LogLevelWarning = "WARNING"
)

Variables

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

Functions

This section is empty.

Types

type JupyterAuth added in v0.2.0

type JupyterAuth struct {
	// TODO(gaocegege): Is this field necessary since we make Token and Password a pointer?
	Mode     ModeJupyterAuth `json:"mode,omitempty"`
	Token    *string         `json:"token,omitempty"`
	Password *string         `json:"password,omitempty"`
}

JupyterAuth defines how to deal with jupyter notebook tokens or passwords. https://jupyter-notebook.readthedocs.io/en/stable/security.html

func (*JupyterAuth) DeepCopy added in v0.2.0

func (in *JupyterAuth) DeepCopy() *JupyterAuth

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

func (*JupyterAuth) DeepCopyInto added in v0.2.0

func (in *JupyterAuth) DeepCopyInto(out *JupyterAuth)

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

type JupyterGateway

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

	Spec   JupyterGatewaySpec   `json:"spec,omitempty"`
	Status JupyterGatewayStatus `json:"status,omitempty"`
}

JupyterGateway is the Schema for the jupytergateways API

func (*JupyterGateway) DeepCopy

func (in *JupyterGateway) DeepCopy() *JupyterGateway

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

func (*JupyterGateway) DeepCopyInto

func (in *JupyterGateway) DeepCopyInto(out *JupyterGateway)

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

func (*JupyterGateway) DeepCopyObject

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

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

type JupyterGatewayList

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

JupyterGatewayList contains a list of JupyterGateway

func (*JupyterGatewayList) DeepCopy

func (in *JupyterGatewayList) DeepCopy() *JupyterGatewayList

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

func (*JupyterGatewayList) DeepCopyInto

func (in *JupyterGatewayList) DeepCopyInto(out *JupyterGatewayList)

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

func (*JupyterGatewayList) DeepCopyObject

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

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

type JupyterGatewaySpec

type JupyterGatewaySpec struct {
	// Knernels defines the kernels in the gateway.
	// We will add kernels at runtime, thus we do not make it a type.
	Kernels []string `json:"kernels,omitempty"`
	// DefaultKernel defines the default kernel in the gateway.
	DefaultKernel *string `json:"defaultKernel,omitempty"`
	// Timeout (in seconds) after which a kernel is considered idle and
	// ready to be culled. Values of 0 or lower disable culling. Very
	// short timeouts may result in kernels being culled for users
	// with poor network connections.
	// Ref https://jupyter-notebook.readthedocs.io/en/stable/config.html
	CullIdleTimeout *int32 `json:"cullIdleTimeout,omitempty"`

	// The interval (in seconds) on which to check for idle kernels
	// exceeding the cull timeout value.
	CullInterval *int32 `json:"cullInterval,omitempty"`

	LogLevel *LogLevel `json:"logLevel,omitempty"`

	// Compute Resources required by this container.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	// +optional
	Resources *v1.ResourceRequirements `json:"resources,omitempty"`

	// Docker image name.
	// More info: https://kubernetes.io/docs/concepts/containers/images
	// This field defaults to ghcr.io/skai-x/enterprise-gateway:2.6.0
	// +optional
	Image string `json:"image,omitempty"`

	// ClusterRole for the gateway, which is used to create the kernel pods in the cluster. Defaults to enterprise-gateway-controller (created at startup).
	ClusterRole *string `json:"clusterRole,omitempty"`
}

JupyterGatewaySpec defines the desired state of JupyterGateway

func (*JupyterGatewaySpec) DeepCopy

func (in *JupyterGatewaySpec) DeepCopy() *JupyterGatewaySpec

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

func (*JupyterGatewaySpec) DeepCopyInto

func (in *JupyterGatewaySpec) DeepCopyInto(out *JupyterGatewaySpec)

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

type JupyterGatewayStatus

type JupyterGatewayStatus struct {
	appsv1.DeploymentStatus `json:",inline"`
}

JupyterGatewayStatus defines the observed state of JupyterGateway

func (*JupyterGatewayStatus) DeepCopy

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

func (*JupyterGatewayStatus) DeepCopyInto

func (in *JupyterGatewayStatus) DeepCopyInto(out *JupyterGatewayStatus)

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

type JupyterKernel added in v0.1.1

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

	Spec   JupyterKernelCRDSpec `json:"spec,omitempty"`
	Status JupyterKernelStatus  `json:"status,omitempty"`
}

JupyterKernel is the Schema for the jupyterkernels API

func (*JupyterKernel) DeepCopy added in v0.1.1

func (in *JupyterKernel) DeepCopy() *JupyterKernel

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

func (*JupyterKernel) DeepCopyInto added in v0.1.1

func (in *JupyterKernel) DeepCopyInto(out *JupyterKernel)

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

func (*JupyterKernel) DeepCopyObject added in v0.1.1

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

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

type JupyterKernelCRDSpec added in v0.1.1

type JupyterKernelCRDSpec struct {
	Template v1.PodTemplateSpec `json:"template,omitempty"`
}

JupyterKernelSpec defines the desired state of JupyterKernel

func (*JupyterKernelCRDSpec) DeepCopy added in v0.1.1

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

func (*JupyterKernelCRDSpec) DeepCopyInto added in v0.1.1

func (in *JupyterKernelCRDSpec) DeepCopyInto(out *JupyterKernelCRDSpec)

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

type JupyterKernelCondition added in v0.1.1

type JupyterKernelCondition struct {
	// Type of job condition.
	Type JupyterKernelConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status"`
	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty"`
	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty"`
	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`
	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
}

func (*JupyterKernelCondition) DeepCopy added in v0.1.1

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

func (*JupyterKernelCondition) DeepCopyInto added in v0.1.1

func (in *JupyterKernelCondition) DeepCopyInto(out *JupyterKernelCondition)

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

type JupyterKernelConditionType added in v0.1.1

type JupyterKernelConditionType string
const (
	JupyterKernelRunning   JupyterKernelConditionType = "Running"
	JupyterKernelFailed    JupyterKernelConditionType = "Failed"
	JupyterKernelSucceeded JupyterKernelConditionType = "Succeeded"
)

type JupyterKernelList added in v0.1.1

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

JupyterKernelList contains a list of JupyterKernel

func (*JupyterKernelList) DeepCopy added in v0.1.1

func (in *JupyterKernelList) DeepCopy() *JupyterKernelList

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

func (*JupyterKernelList) DeepCopyInto added in v0.1.1

func (in *JupyterKernelList) DeepCopyInto(out *JupyterKernelList)

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

func (*JupyterKernelList) DeepCopyObject added in v0.1.1

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

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

type JupyterKernelSpec

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

	Spec   JupyterKernelSpecSpec   `json:"spec,omitempty"`
	Status JupyterKernelSpecStatus `json:"status,omitempty"`
}

JupyterKernelSpec is the Schema for the jupyterkernelspecs API

func (*JupyterKernelSpec) DeepCopy

func (in *JupyterKernelSpec) DeepCopy() *JupyterKernelSpec

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

func (*JupyterKernelSpec) DeepCopyInto

func (in *JupyterKernelSpec) DeepCopyInto(out *JupyterKernelSpec)

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

func (*JupyterKernelSpec) DeepCopyObject

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

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

type JupyterKernelSpecList

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

JupyterKernelSpecList contains a list of JupyterKernelSpec

func (*JupyterKernelSpecList) DeepCopy

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

func (*JupyterKernelSpecList) DeepCopyInto

func (in *JupyterKernelSpecList) DeepCopyInto(out *JupyterKernelSpecList)

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

func (*JupyterKernelSpecList) DeepCopyObject

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

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

type JupyterKernelSpecSpec

type JupyterKernelSpecSpec struct {
	Language    string      `json:"language,omitempty"`
	DisplayName string      `json:"displayName,omitempty"`
	Image       string      `json:"image,omitempty"`
	Env         []v1.EnvVar `json:"env,omitempty"`
	Command     []string    `json:"command,omitempty"`
	ClassName   string      `json:"className,omitempty"`

	Template *v1.ObjectReference `json:"template,omitempty"`
}

JupyterKernelSpecSpec defines the desired state of JupyterKernelSpec

func (*JupyterKernelSpecSpec) DeepCopy

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

func (*JupyterKernelSpecSpec) DeepCopyInto

func (in *JupyterKernelSpecSpec) DeepCopyInto(out *JupyterKernelSpecSpec)

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

type JupyterKernelSpecStatus

type JupyterKernelSpecStatus struct {
}

JupyterKernelSpecStatus defines the observed state of JupyterKernelSpec

func (*JupyterKernelSpecStatus) DeepCopy

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

func (*JupyterKernelSpecStatus) DeepCopyInto

func (in *JupyterKernelSpecStatus) DeepCopyInto(out *JupyterKernelSpecStatus)

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

type JupyterKernelStatus added in v0.1.1

type JupyterKernelStatus struct {
	// Conditions is an array of current observed job conditions.
	Conditions []JupyterKernelCondition `json:"conditions"`

	// Represents time when the job was acknowledged by the job controller.
	// It is not guaranteed to be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// Represents time when the job was completed. It is not guaranteed to
	// be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// Represents last time when the job was reconciled. It is not guaranteed to
	// be set in happens-before order across separate operations.
	// It is represented in RFC3339 form and is in UTC.
	LastReconcileTime *metav1.Time `json:"lastReconcileTime,omitempty"`
}

JupyterKernelStatus defines the observed state of JupyterKernel

func (*JupyterKernelStatus) DeepCopy added in v0.1.1

func (in *JupyterKernelStatus) DeepCopy() *JupyterKernelStatus

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

func (*JupyterKernelStatus) DeepCopyInto added in v0.1.1

func (in *JupyterKernelStatus) DeepCopyInto(out *JupyterKernelStatus)

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

type JupyterKernelTemplate added in v0.1.1

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

	Spec   JupyterKernelTemplateSpec   `json:"spec,omitempty"`
	Status JupyterKernelTemplateStatus `json:"status,omitempty"`
}

JupyterKernelTemplate is the Schema for the jupyterkerneltemplates API

func (*JupyterKernelTemplate) DeepCopy added in v0.1.1

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

func (*JupyterKernelTemplate) DeepCopyInto added in v0.1.1

func (in *JupyterKernelTemplate) DeepCopyInto(out *JupyterKernelTemplate)

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

func (*JupyterKernelTemplate) DeepCopyObject added in v0.1.1

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

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

type JupyterKernelTemplateList added in v0.1.1

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

JupyterKernelTemplateList contains a list of JupyterKernelTemplate

func (*JupyterKernelTemplateList) DeepCopy added in v0.1.1

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

func (*JupyterKernelTemplateList) DeepCopyInto added in v0.1.1

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

func (*JupyterKernelTemplateList) DeepCopyObject added in v0.1.1

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

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

type JupyterKernelTemplateSpec added in v0.1.1

type JupyterKernelTemplateSpec struct {
	Template *v1.PodTemplateSpec `json:"template,omitempty"`
}

JupyterKernelTemplateSpec defines the desired state of JupyterKernelTemplate

func (*JupyterKernelTemplateSpec) DeepCopy added in v0.1.1

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

func (*JupyterKernelTemplateSpec) DeepCopyInto added in v0.1.1

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

type JupyterKernelTemplateStatus added in v0.1.1

type JupyterKernelTemplateStatus struct {
}

JupyterKernelTemplateStatus defines the observed state of JupyterKernelTemplate

func (*JupyterKernelTemplateStatus) DeepCopy added in v0.1.1

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

func (*JupyterKernelTemplateStatus) DeepCopyInto added in v0.1.1

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

type JupyterNotebook

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

	Spec   JupyterNotebookSpec   `json:"spec,omitempty"`
	Status JupyterNotebookStatus `json:"status,omitempty"`
}

JupyterNotebook is the Schema for the jupyternotebooks API

func (*JupyterNotebook) DeepCopy

func (in *JupyterNotebook) DeepCopy() *JupyterNotebook

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

func (*JupyterNotebook) DeepCopyInto

func (in *JupyterNotebook) DeepCopyInto(out *JupyterNotebook)

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

func (*JupyterNotebook) DeepCopyObject

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

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

type JupyterNotebookList

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

JupyterNotebookList contains a list of JupyterNotebook

func (*JupyterNotebookList) DeepCopy

func (in *JupyterNotebookList) DeepCopy() *JupyterNotebookList

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

func (*JupyterNotebookList) DeepCopyInto

func (in *JupyterNotebookList) DeepCopyInto(out *JupyterNotebookList)

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

func (*JupyterNotebookList) DeepCopyObject

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

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

type JupyterNotebookSpec

type JupyterNotebookSpec struct {
	Gateway *v1.ObjectReference `json:"gateway,omitempty"`
	Auth    *JupyterAuth        `json:"auth,omitempty"`

	Template *v1.PodTemplateSpec `json:"template,omitempty"`
}

JupyterNotebookSpec defines the desired state of JupyterNotebook

func (*JupyterNotebookSpec) DeepCopy

func (in *JupyterNotebookSpec) DeepCopy() *JupyterNotebookSpec

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

func (*JupyterNotebookSpec) DeepCopyInto

func (in *JupyterNotebookSpec) DeepCopyInto(out *JupyterNotebookSpec)

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

type JupyterNotebookStatus

type JupyterNotebookStatus struct {
}

JupyterNotebookStatus defines the observed state of JupyterNotebook

func (*JupyterNotebookStatus) DeepCopy

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

func (*JupyterNotebookStatus) DeepCopyInto

func (in *JupyterNotebookStatus) DeepCopyInto(out *JupyterNotebookStatus)

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

type LogLevel added in v0.2.0

type LogLevel string

type ModeJupyterAuth added in v0.2.0

type ModeJupyterAuth string
const (
	ModeJupyterAuthEnable ModeJupyterAuth = "enable"
	// ModeJupyterAuthDisable disables authentication altogether by setting the token
	// and password to empty strings, but this is NOT RECOMMENDED, unless authentication
	// or access restrictions are handled at a different layer in your web application
	ModeJupyterAuthDisable ModeJupyterAuth = "disable"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL