generated.asciidoc

API Reference

Packages

• kubeflow.tkestack.io/v1alpha1

kubeflow.tkestack.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the kubeflow.tkestack.io v1alpha1 API group

Resource Types

• JupyterGateway

• JupyterGatewayList

• JupyterKernel

• JupyterKernelList

• JupyterKernelSpec

• JupyterKernelSpecList

• JupyterKernelTemplate

• JupyterKernelTemplateList

• JupyterNotebook

• JupyterNotebookList

Definitions

JupyterAuth

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

Appears In:

• JupyterNotebookSpec

Field	Description
mode ModeJupyterAuth	TODO(gaocegege): Is this field necessary since we make Token and Password a pointer?
token string
password string

JupyterGateway

JupyterGateway is the Schema for the jupytergateways API

Appears In:

• JupyterGatewayList

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterGateway
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec JupyterGatewaySpec
status JupyterGatewayStatus

JupyterGatewayList

JupyterGatewayList contains a list of JupyterGateway

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterGatewayList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items JupyterGateway

JupyterGatewaySpec

JupyterGatewaySpec defines the desired state of JupyterGateway

Appears In:

• JupyterGateway

Field	Description
kernels string array	Knernels defines the kernels in the gateway. We will add kernels at runtime, thus we do not make it a type.
defaultKernel string	DefaultKernel defines the default kernel in the gateway.
cullIdleTimeout integer	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
cullInterval integer	The interval (in seconds) on which to check for idle kernels exceeding the cull timeout value.
logLevel LogLevel
resources ResourceRequirements	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
image string	Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field defaults to ccr.ccs.tencentyun.com/kubeflow-oteam/enterprise-gateway:2.5.0
clusterRole string	ClusterRole for the gateway, which is used to create the kernel pods in the cluster. Defaults to enterprise-gateway-controller (created at startup).

JupyterGatewayStatus

JupyterGatewayStatus defines the observed state of JupyterGateway

Appears In:

• JupyterGateway

Field	Description
DeploymentStatus DeploymentStatus

JupyterKernel

JupyterKernel is the Schema for the jupyterkernels API

Appears In:

• JupyterKernelList

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterKernel
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec JupyterKernelCRDSpec
status JupyterKernelStatus

JupyterKernelCRDSpec

JupyterKernelSpec defines the desired state of JupyterKernel

Appears In:

• JupyterKernel

Field	Description
template PodTemplateSpec

JupyterKernelCondition

Appears In:

• JupyterKernelStatus

Field	Description
type JupyterKernelConditionType	Type of job condition.
status ConditionStatus	Status of the condition, one of True, False, Unknown.
reason string	The reason for the condition’s last transition.
message string	A human readable message indicating details about the transition.
lastUpdateTime Time	The last time this condition was updated.
lastTransitionTime Time	Last time the condition transitioned from one status to another.

JupyterKernelConditionType (string)

Appears In:

• JupyterKernelCondition

JupyterKernelList

JupyterKernelList contains a list of JupyterKernel

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterKernelList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items JupyterKernel

JupyterKernelSpec

JupyterKernelSpec is the Schema for the jupyterkernelspecs API

Appears In:

• JupyterKernelSpecList

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterKernelSpec
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec JupyterKernelSpecSpec
status JupyterKernelSpecStatus

JupyterKernelSpecList

JupyterKernelSpecList contains a list of JupyterKernelSpec

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterKernelSpecList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items JupyterKernelSpec

JupyterKernelSpecSpec

JupyterKernelSpecSpec defines the desired state of JupyterKernelSpec

Appears In:

• JupyterKernelSpec

Field	Description
language string
displayName string
image string
env EnvVar
command string array
className string
template ObjectReference

JupyterKernelStatus

JupyterKernelStatus defines the observed state of JupyterKernel

Appears In:

• JupyterKernel

Field	Description
conditions JupyterKernelCondition array	Conditions is an array of current observed job conditions.
startTime Time	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.
completionTime Time	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.
lastReconcileTime Time	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.

JupyterKernelTemplate

JupyterKernelTemplate is the Schema for the jupyterkerneltemplates API

Appears In:

• JupyterKernelTemplateList

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterKernelTemplate
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec JupyterKernelTemplateSpec
status JupyterKernelTemplateStatus

JupyterKernelTemplateList

JupyterKernelTemplateList contains a list of JupyterKernelTemplate

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterKernelTemplateList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items JupyterKernelTemplate

JupyterKernelTemplateSpec

JupyterKernelTemplateSpec defines the desired state of JupyterKernelTemplate

Appears In:

• JupyterKernelTemplate

Field	Description
template PodTemplateSpec

JupyterNotebook

JupyterNotebook is the Schema for the jupyternotebooks API

Appears In:

• JupyterNotebookList

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterNotebook
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec JupyterNotebookSpec
status JupyterNotebookStatus

JupyterNotebookList

JupyterNotebookList contains a list of JupyterNotebook

Field	Description
apiVersion string	kubeflow.tkestack.io/v1alpha1
kind string	JupyterNotebookList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items JupyterNotebook

JupyterNotebookSpec

JupyterNotebookSpec defines the desired state of JupyterNotebook

Appears In:

• JupyterNotebook

Field	Description
gateway ObjectReference
auth JupyterAuth
template PodTemplateSpec

LogLevel (string)

Appears In:

• JupyterGatewaySpec

ModeJupyterAuth (string)

Appears In:

• JupyterAuth