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 ¶
- Variables
- type JupyterGateway
- type JupyterGatewayList
- type JupyterGatewaySpec
- type JupyterGatewayStatus
- type JupyterKernelSpec
- type JupyterKernelSpecList
- type JupyterKernelSpecSpec
- type JupyterKernelSpecStatus
- type JupyterNotebook
- type JupyterNotebookList
- type JupyterNotebookSpec
- type JupyterNotebookStatus
Constants ¶
This section is empty.
Variables ¶
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 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"` // 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"` 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 ¶
func (in *JupyterGatewayStatus) DeepCopy() *JupyterGatewayStatus
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 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 ¶
func (in *JupyterKernelSpecList) DeepCopy() *JupyterKernelSpecList
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"` }
JupyterKernelSpecSpec defines the desired state of JupyterKernelSpec
func (*JupyterKernelSpecSpec) DeepCopy ¶
func (in *JupyterKernelSpecSpec) DeepCopy() *JupyterKernelSpecSpec
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 ¶
func (in *JupyterKernelSpecStatus) DeepCopy() *JupyterKernelSpecStatus
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 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"` 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 ¶
func (in *JupyterNotebookStatus) DeepCopy() *JupyterNotebookStatus
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.