Workspace [kubeflow.org/v1beta1]

Description: Workspace is the Schema for the Workspaces API
Type: object

Specification

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	WorkspaceSpec defines the desired state of Workspace
`status`	`object`	WorkspaceStatus defines the observed state of Workspace

.spec

Description: WorkspaceSpec defines the desired state of Workspace
Type: object
Required: kindpodTemplate

Property	Type	Description
`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`	the WorkspaceKind to use
`paused`	`boolean`	if the workspace is paused (no pods running)
`podTemplate`	`object`	options for "podTemplate"-type WorkspaceKinds

.spec.podTemplate

Description: options for "podTemplate"-type WorkspaceKinds
Type: object
Required: optionsvolumes

Property	Type	Description
`options`	`object`	the selected podTemplate options
`podMetadata`	`object`	metadata to be applied to the Pod resource
`volumes`	`object`	volume configs

.spec.podTemplate.options

Description: the selected podTemplate options
Type: object
Required: imageConfigpodConfig

Property Type Description

Property	Type	Description
`imageConfig`	`string`	the id of an imageConfig option options are defined in WorkspaceKind under `spec.podTemplate.options.imageConfig.values[]`
`podConfig`	`string`	the id of a podConfig option options are defined in WorkspaceKind under `spec.podTemplate.options.podConfig.values[]`

imageConfig

string

the id of an imageConfig option

options are defined in WorkspaceKind under spec.podTemplate.options.imageConfig.values[]

podConfig

string

the id of a podConfig option

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

.spec.podTemplate.podMetadata

Description: metadata to be applied to the Pod resource
Type: object

Property	Type	Description
`annotations`	`object`	annotations to be applied to the Pod resource
`labels`	`object`	labels to be applied to the Pod resource

.spec.podTemplate.podMetadata.annotations

Description: annotations to be applied to the Pod resource
Type: object

.spec.podTemplate.podMetadata.labels

Description: labels to be applied to the Pod resource
Type: object

.spec.podTemplate.volumes

Description: volume configs
Type: object

Property Type Description

Property	Type	Description
`data`	`array`	additional PVCs to mount these PVC must already exist in the Namespace the same PVC can be mounted multiple times with different `mountPaths` if `readOnly` is false, the PVC must be RWX (ReadWriteMany, ReadWriteOnce) if `readOnly` is true, the PVC must be ReadOnlyMany
`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`

data

array

additional PVCs to mount

these PVC must already exist in the Namespace
the same PVC can be mounted multiple times with different mountPaths
if readOnly is false, the PVC must be RWX (ReadWriteMany, ReadWriteOnce)
if readOnly is true, the PVC must be ReadOnlyMany

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

.spec.podTemplate.volumes.data

Description: additional PVCs to mount - these PVC must already exist in the Namespace - the same PVC can be mounted multiple times with different `mountPaths` - if `readOnly` is false, the PVC must be RWX (ReadWriteMany, ReadWriteOnce) - if `readOnly` is true, the PVC must be ReadOnlyMany
Type: array

.spec.podTemplate.volumes.data[]

Type: object
Required: mountPathpvcName

Property	Type	Description
`mountPath`	`string`	the mount path for the PVC
`pvcName`	`string`	the name of the PVC to mount
`readOnly`	`boolean`	if the PVC should be mounted as ReadOnly

.status

Description: WorkspaceStatus defines the observed state of Workspace
Type: object
Required: activitypauseTimependingRestartpodTemplateOptionspodTemplatePodstatestateMessage

Property	Type	Description
`activity`	`object`	activity information for the Workspace, used to determine when to cull
`pauseTime`	`integer`	the time when the Workspace was paused (UNIX epoch) set to 0 when the Workspace is NOT paused
`pendingRestart`	`boolean`	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`	information about the current podTemplate options (only set for WorkspaceKind of podTemplate kind)
`podTemplatePod`	`object`	information about the Pod managed by this Workspace (only set for WorkspaceKind of podTemplate kind)
`state`	`string`	the current state of the Workspace
`stateMessage`	`string`	a human-readable message about the state of the Workspace WARNING: this field is NOT FOR MACHINE USE, subject to change without notice

.status.activity

Description: activity information for the Workspace, used to determine when to cull
Type: object
Required: lastActivitylastUpdate

Property	Type	Description
`lastActivity`	`integer`	the last time activity was observed on the Workspace (UNIX epoch)
`lastUpdate`	`integer`	the last time we checked for activity on the Workspace (UNIX epoch)

.status.podTemplateOptions

Description: information about the current podTemplate options (only set for WorkspaceKind of podTemplate kind)
Type: object
Required: imageConfigpodConfig

Property	Type	Description
`imageConfig`	`object`	info about the current imageConfig option
`podConfig`	`object`	info about the current podConfig option

.status.podTemplateOptions.imageConfig

Description: info about the current imageConfig option
Type: object

Property	Type	Description
`desired`	`string`	the option id which will take effect after the next restart
`redirectChain`	`array`	the chain from the current option to the desired option

.status.podTemplateOptions.imageConfig.redirectChain

Description: the chain from the current option to the desired option
Type: array

.status.podTemplateOptions.imageConfig.redirectChain[]

Type: object
Required: sourcetarget

Property	Type	Description
`source`	`string`	the source option id
`target`	`string`	the target option id

.status.podTemplateOptions.podConfig

Description: info about the current podConfig option
Type: object

Property	Type	Description
`desired`	`string`	the option id which will take effect after the next restart
`redirectChain`	`array`	the chain from the current option to the desired option

.status.podTemplateOptions.podConfig.redirectChain

Description: the chain from the current option to the desired option
Type: array

.status.podTemplateOptions.podConfig.redirectChain[]

Type: object
Required: sourcetarget

Property	Type	Description
`source`	`string`	the source option id
`target`	`string`	the target option id

.status.podTemplatePod

Description: information about the Pod managed by this Workspace (only set for WorkspaceKind of podTemplate kind)
Type: object
Required: name

Property	Type	Description
`containers`	`array`	information about the Pod's containers
`initContainers`	`array`	information about the Pod's initContainers
`name`	`string`	the name of the Pod resource

.status.podTemplatePod.containers

Description: information about the Pod's containers
Type: array

.status.podTemplatePod.containers[]

Type: object
Required: name

Property	Type	Description
`name`	`string`	the name of the container

.status.podTemplatePod.initContainers

Description: information about the Pod's initContainers
Type: array

.status.podTemplatePod.initContainers[]

Type: object
Required: name

Property	Type	Description
`name`	`string`	the name of the container

API Endpoints

The following API endpoints are available:

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces
- DELETE: delete collection of Workspace
- GET: list objects of kind Workspace
- POST: create a new Workspace
/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}
- DELETE: delete the specified Workspace
- GET: read the specified Workspace
- PATCH: partially update the specified Workspace
- PUT: replace the specified Workspace
/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}/status
- GET: read status of the specified Workspace
- PATCH: partially update status of the specified Workspace
- PUT: replace status of the specified Workspace

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces

HTTP method: DELETE
Description: delete collection of Workspace
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind Workspace
HTTP responses

HTTP code	Response body
200 - OK	`WorkspaceList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new Workspace

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`Workspace` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`Workspace` schema
201 - Created	`Workspace` schema
202 - Accepted	`Workspace` schema
401 - Unauthorized	Empty

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}

HTTP method: DELETE
Description: delete the specified Workspace

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified Workspace
HTTP responses

HTTP code	Response body
200 - OK	`Workspace` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified Workspace

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Response body
200 - OK	`Workspace` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified Workspace

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`Workspace` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`Workspace` schema
201 - Created	`Workspace` schema
401 - Unauthorized	Empty

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}/status

HTTP method: GET
Description: read status of the specified Workspace
HTTP responses

HTTP code	Response body
200 - OK	`Workspace` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified Workspace

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Response body
200 - OK	`Workspace` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified Workspace

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`Workspace` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`Workspace` schema
201 - Created	`Workspace` schema
401 - Unauthorized	Empty

#Workspace [kubeflow.org/v1beta1]

Specification#

.spec#

.spec.podTemplate#

.spec.podTemplate.options#

.spec.podTemplate.podMetadata#

.spec.podTemplate.podMetadata.annotations#

.spec.podTemplate.podMetadata.labels#

.spec.podTemplate.volumes#

.spec.podTemplate.volumes.data#

.spec.podTemplate.volumes.data[]#

.status#

.status.activity#

.status.podTemplateOptions#

.status.podTemplateOptions.imageConfig#

.status.podTemplateOptions.imageConfig.redirectChain#

.status.podTemplateOptions.imageConfig.redirectChain[]#

.status.podTemplateOptions.podConfig#

.status.podTemplateOptions.podConfig.redirectChain#

.status.podTemplateOptions.podConfig.redirectChain[]#

.status.podTemplatePod#

.status.podTemplatePod.containers#

.status.podTemplatePod.containers[]#

.status.podTemplatePod.initContainers#

.status.podTemplatePod.initContainers[]#

API Endpoints#

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces#

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}#

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}/status#

Workspace [kubeflow.org/v1beta1]

Specification

.spec

.spec.podTemplate

.spec.podTemplate.options

.spec.podTemplate.podMetadata

.spec.podTemplate.podMetadata.annotations

.spec.podTemplate.podMetadata.labels

.spec.podTemplate.volumes

.spec.podTemplate.volumes.data

.spec.podTemplate.volumes.data[]

.status

.status.activity

.status.podTemplateOptions

.status.podTemplateOptions.imageConfig

.status.podTemplateOptions.imageConfig.redirectChain

.status.podTemplateOptions.imageConfig.redirectChain[]

.status.podTemplateOptions.podConfig

.status.podTemplateOptions.podConfig.redirectChain

.status.podTemplateOptions.podConfig.redirectChain[]

.status.podTemplatePod

.status.podTemplatePod.containers

.status.podTemplatePod.containers[]

.status.podTemplatePod.initContainers

.status.podTemplatePod.initContainers[]

API Endpoints

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}

/apis/kubeflow.org/v1beta1/namespaces/{namespace}/workspaces/{name}/status