API Reference¶
Packages¶
tensorstack.dev/v1beta1¶
Package v1beta1 contains API Schema definitions for the v1beta1 API group
Resource Types¶
Notebook¶
Notebook is the Schema for the notebooks API
Appears in: - NotebookList
| Field | Description |
|---|---|
apiVersion string |
tensorstack.dev/v1beta1 |
kind string |
Notebook |
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
spec NotebookSpec |
|
status NotebookStatus |
NotebookCondition¶
NotebookCondition defines the observed condition of notebook
Appears in: - NotebookStatus
| Field | Description |
|---|---|
type NotebookConditionType |
Type is the type of the condition. Possible values are Idle, etc |
status ConditionStatus |
Status is the status of the condition type. Possible values of type Idle are True|False|Unknown |
message string |
Message is a human-readable message for the reason of the status. |
lastTransitionTime Time |
LastTransitionTime is the last time the status was changed. |
lastProbeTime Time |
LastProbeTime is the last time the condition was probed. |
NotebookConditionType¶
Underlying type: string
Appears in: - NotebookCondition
NotebookList¶
NotebookList contains a list of Notebook
| Field | Description |
|---|---|
apiVersion string |
tensorstack.dev/v1beta1 |
kind string |
NotebookList |
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata. |
items Notebook array |
NotebookPhase¶
Underlying type: string
Appears in: - NotebookStatus
NotebookRunMode¶
Underlying type: string
Appears in: - NotebookSpec
NotebookSSHSpec¶
NotebookSSHSpec defines the ssh template spec of Notebook
Appears in: - NotebookSpec
| Field | Description |
|---|---|
enabled boolean |
If true, SSH service will be started for this Notebook instance. |
serviceType ServiceType |
|
authorized_keys string array |
A list of names of v1.Secret containing SSH public keys authorized for access to this SSH service. |
NotebookSSHStatus¶
NotebookSSHStatus defines the observed state of the SSH service associated with the Notebook.
Appears in: - NotebookStatus
| Field | Description |
|---|---|
serviceName string |
The v1.Service name of the SSH service. |
port integer |
The port number of the SSH server daemon. |
clusterIp string |
|
nodePort integer |
|
protocol Protocol |
|
lastSshClientActivity Time |
LastSshClientActivity is the last time an SSH client is active. |
NotebookSpec¶
NotebookSpec defines the desired state of a Notebook.
Appears in: - Notebook
| Field | Description |
|---|---|
template NotebookTemplateSpec |
|
scheduler SchedulePolicy |
|
ssh NotebookSSHSpec |
|
type NotebookType |
|
runMode NotebookRunMode |
NotebookStatus¶
NotebookStatus defines the observed state of a Notebook.
Appears in: - Notebook
| Field | Description |
|---|---|
phase NotebookPhase |
|
pod PodStatus |
|
ssh NotebookSSHStatus |
|
conditions NotebookCondition array |
Conditions is an array of current conditions |
url string |
The URL to Web UI of the notebook |
NotebookTemplateSpec¶
NotebookTemplateSpec defines the pod template to run a Notebook.
Appears in: - NotebookSpec
| Field | Description |
|---|---|
spec PodSpec |
NotebookType¶
Underlying type: string
Appears in: - NotebookSpec
PodReference¶
PodReference references a K8s v1.Pod.
Appears in: - PodStatus
| Field | Description |
|---|---|
name string |
Name of the Pod. |
uid string |
UID of the Pod. |
PodStatus¶
Pod defines the observed state of the Pod running the notebook.
Appears in: - NotebookStatus
| Field | Description |
|---|---|
reference PodReference |
References to the subordinate v1.Pod. |
phase PodPhase |
Replicated from the corresponding field in the subordinate v1.Pod. |
SchedulePolicy¶
SchedulePolicy specifies the preferred scheduler responsible for handling resource allocation requests.
Appears in: - NotebookSpec
| Field | Description |
|---|---|
t9kScheduler T9kScheduler |
T9kScheduler¶
Appears in: - SchedulePolicy
| Field | Description |
|---|---|
queue string |
Name of the queue to use with the T9kScheduler. |