Alauda AI

Workspace [kubeflow.org/v1beta1]

kubeflow.org group

Workspace is the Schema for the Workspaces API

v1beta1 version
spec object

WorkspaceSpec defines the desired state of Workspace

deferUpdates boolean

if true, pending updates are NOT applied when the Workspace is paused if false, pending updates are applied when the Workspace is paused

kind string required

the WorkspaceKind to use

paused boolean

if the workspace is paused (no pods running)

podTemplate object required

options for "podTemplate"-type WorkspaceKinds

options object required

the selected podTemplate options

imageConfig string required

the id of an imageConfig option

  • options are defined in WorkspaceKind under spec.podTemplate.options.imageConfig.values[]
podConfig string required

the id of a podConfig option

  • options are defined in WorkspaceKind under spec.podTemplate.options.podConfig.values[]
podMetadata object

metadata to be applied to the Pod resource

annotations object

annotations to be applied to the Pod resource

labels object

labels to be applied to the Pod resource

volumes object required

volume configs

data []object
mountPath string required

the mount path for the PVC

pvcName string required

the name of the PVC to mount

readOnly boolean

if the PVC should be mounted as ReadOnly

home string

the name of the PVC to mount as the home volume

  • this PVC must already exist in the Namespace
  • this PVC must be RWX (ReadWriteMany, ReadWriteOnce)
  • the mount path is defined in the WorkspaceKind under spec.podTemplate.volumeMounts.home
status object

WorkspaceStatus defines the observed state of Workspace

activity object required

activity information for the Workspace, used to determine when to cull

lastActivity integer required

the last time activity was observed on the Workspace (UNIX epoch)

lastUpdate integer required

the last time we checked for activity on the Workspace (UNIX epoch)

pauseTime integer required

the time when the Workspace was paused (UNIX epoch)

  • set to 0 when the Workspace is NOT paused
pendingRestart boolean required

if the current Pod does not reflect the current "desired" state

  • true if any spec.podTemplate.options have a redirect and so will be patched on the next restart
  • true if the WorkspaceKind has changed one of its common podTemplate fields like podMetadata, probes, extraEnv, or containerSecurityContext
podTemplateOptions object required

information about the current podTemplate options (only set for WorkspaceKind of podTemplate kind)

imageConfig object required

info about the current imageConfig option

desired string

the option id which will take effect after the next restart

redirectChain []object
source string required

the source option id

target string required

the target option id

podConfig object required

info about the current podConfig option

desired string

the option id which will take effect after the next restart

redirectChain []object
source string required

the source option id

target string required

the target option id

podTemplatePod object required

information about the Pod managed by this Workspace (only set for WorkspaceKind of podTemplate kind)

containers []object
name string required

the name of the container

initContainers []object
name string required

the name of the container

name string required

the name of the Pod resource

state string required

the current state of the Workspace

stateMessage string required

a human-readable message about the state of the Workspace

  • WARNING: this field is NOT FOR MACHINE USE, subject to change without notice