---
title: "Create workspace kind"
method: POST
path: "/workspacekinds"
tags: ["workspacekinds"]
---

# Create workspace kind

`POST /workspacekinds`

Creates a new workspace kind.

## Response `201`

WorkspaceKind created successfully

- ApiWorkspaceKindCreateEnvelope
  - `data` WorkspacekindsWorkspaceKindCreate, required
    - `name` string, required
    - `podTemplate` V1beta1WorkspaceKindPodTemplate, required
      - `containerSecurityContext` V1SecurityContext
        - `allowPrivilegeEscalation` boolean — AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. +optional
        - `appArmorProfile` V1AppArmorProfile
          - `localhostProfile` string — localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". +optional
          - `type` 'Unconfined' | 'RuntimeDefault' | 'Localhost', required
        - `capabilities` V1Capabilities
          - `add` string[] — Added capabilities +optional +listType=atomic
          - `drop` string[] — Removed capabilities +optional +listType=atomic
        - `privileged` boolean — Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. +optional
        - `procMount` 'Default' | 'Unmasked'
        - `readOnlyRootFilesystem` boolean — Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. +optional
        - `runAsGroup` integer — The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional
        - `runAsNonRoot` boolean — Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
        - `runAsUser` integer — The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. +optional
        - `seLinuxOptions` V1SELinuxOptions
          - `level` string — Level is SELinux level label that applies to the container. +optional
          - `role` string — Role is a SELinux role label that applies to the container. +optional
          - `type` string — Type is a SELinux type label that applies to the container. +optional
          - `user` string — User is a SELinux user label that applies to the container. +optional
        - `seccompProfile` V1SeccompProfile
          - `localhostProfile` string — localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. +optional
          - `type` 'Unconfined' | 'RuntimeDefault' | 'Localhost', required
        - `windowsOptions` V1WindowsSecurityContextOptions
          - `gmsaCredentialSpec` string — GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +optional
          - `gmsaCredentialSpecName` string — GMSACredentialSpecName is the name of the GMSA credential spec to use. +optional
          - `hostProcess` boolean — HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +optional
          - `runAsUserName` string — The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
      - `culling` V1beta1WorkspaceKindCullingConfig
        - `activityProbe` V1beta1ActivityProbe, required
          - `exec` V1beta1ActivityProbeExec
            - `command` string[], required — the command to run +kubebuilder:validation:MinItems:=1 +kubebuilder:example={"bash", "-c", "exit 0"}
          - `jupyter` V1beta1ActivityProbeJupyter
            - `lastActivity` boolean, required — if the Jupyter-specific probe is enabled +kubebuilder:example=true
        - `enabled` boolean — if the culling feature is enabled +kubebuilder:validation:Optional +kubebuilder:default=true
        - `maxInactiveSeconds` integer — the maximum number of seconds a Workspace can be inactive +kubebuilder:validation:Optional +kubebuilder:validation:Minimum:=60 +kubebuilder:default=86400
      - `extraEnv` V1EnvVar[] — environment variables for Workspace Pods (MUTABLE) - the following go template functions are available: - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port +kubebuilder:validation:Optional +kubebuilder:example:={ "NB_PREFIX": "{{ httpPathPrefix 'jupyterlab' }}" } +listType:="map" +listMapKey:="name"
        - `name` string, required — Name of the environment variable. May consist of any printable ASCII characters except '='.
        - `value` string — Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". +optional
        - `valueFrom` V1EnvVarSource
          - `configMapKeyRef` V1ConfigMapKeySelector
            - `key` string, required — The key to select.
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
            - `optional` boolean — Specify whether the ConfigMap or its key must be defined +optional
          - `fieldRef` V1ObjectFieldSelector
            - `apiVersion` string — Version of the schema the FieldPath is written in terms of, defaults to "v1". +optional
            - `fieldPath` string, required — Path of the field to select in the specified API version.
          - `fileKeyRef` V1FileKeySelector
            - `key` string, required — The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. +required
            - `optional` boolean — Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the environment variable will not be set in the Pod's containers. If optional is set to false and the specified key does not exist, an error will be returned during Pod creation. +optional +default=false
            - `path` string, required — The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'. +required
            - `volumeName` string, required — The name of the volume mount containing the env file. +required
          - `resourceFieldRef` V1ResourceFieldSelector
            - `containerName` string — Container name: required for volumes, optional for env vars +optional
            - `divisor` ResourceQuantity
              - …
            - `resource` string, required — Required: resource to select
          - `secretKeyRef` V1SecretKeySelector
            - `key` string, required — The key of the secret to select from. Must be a valid secret key.
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
            - `optional` boolean — Specify whether the Secret or its key must be defined +optional
      - `extraVolumeMounts` V1VolumeMount[] — extra volume mounts for Workspace Pods (MUTABLE) +kubebuilder:validation:Optional +listType:="map" +listMapKey:="mountPath"
        - `mountPath` string, required — Path within the container at which the volume should be mounted. Must not contain ':'.
        - `mountPropagation` 'None' | 'HostToContainer' | 'Bidirectional'
        - `name` string, required — This must match the Name of a Volume.
        - `readOnly` boolean — Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional
        - `recursiveReadOnly` 'Disabled' | 'IfPossible' | 'Enabled'
        - `subPath` string — Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). +optional
        - `subPathExpr` string — Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. +optional
      - `extraVolumes` V1Volume[] — extra volumes for Workspace Pods (MUTABLE) +kubebuilder:validation:Optional +listType:="map" +listMapKey:="name"
        - `awsElasticBlockStore` V1AWSElasticBlockStoreVolumeSource
          - `fsType` string — fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine +optional
          - `partition` integer — partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). +optional
          - `readOnly` boolean — readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +optional
          - `volumeID` string, required — volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
        - `azureDisk` V1AzureDiskVolumeSource
          - `cachingMode` 'None' | 'ReadOnly' | 'ReadWrite'
          - `diskName` string, required — diskName is the Name of the data disk in the blob storage
          - `diskURI` string, required — diskURI is the URI of data disk in the blob storage
          - `fsType` string — fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional +default="ext4"
          - `kind` 'Shared' | 'Dedicated' | 'Managed'
          - `readOnly` boolean — readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional +default=false
        - `azureFile` V1AzureFileVolumeSource
          - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
          - `secretName` string, required — secretName is the name of secret that contains Azure Storage Account Name and Key
          - `shareName` string, required — shareName is the azure share Name
        - `cephfs` V1CephFSVolumeSource
          - `monitors` string[], required — monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +listType=atomic
          - `path` string — path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / +optional
          - `readOnly` boolean — readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional
          - `secretFile` string — secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional
          - `secretRef` V1LocalObjectReference
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `user` string — user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it +optional
        - `cinder` V1CinderVolumeSource
          - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional
          - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional
          - `secretRef` V1LocalObjectReference
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `volumeID` string, required — volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
        - `configMap` V1ConfigMapVolumeSource
          - `defaultMode` integer — defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional
          - `items` V1KeyToPath[] — items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional +listType=atomic
            - `key` string, required — key is the key to project.
            - `mode` integer — mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional
            - `path` string, required — path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
          - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `optional` boolean — optional specify whether the ConfigMap or its keys must be defined +optional
        - `csi` V1CSIVolumeSource
          - `driver` string, required — driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
          - `fsType` string — fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. +optional
          - `nodePublishSecretRef` V1LocalObjectReference
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `readOnly` boolean — readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). +optional
          - `volumeAttributes` object — volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. +optional
        - `downwardAPI` V1DownwardAPIVolumeSource
          - `defaultMode` integer — Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional
          - `items` V1DownwardAPIVolumeFile[] — Items is a list of downward API volume file +optional +listType=atomic
            - `fieldRef` V1ObjectFieldSelector
              - …
            - `mode` integer — Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional
            - `path` string, required — Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
            - `resourceFieldRef` V1ResourceFieldSelector
              - …
        - `emptyDir` V1EmptyDirVolumeSource
          - `medium` '' | 'Memory' | 'HugePages' | 'HugePages-'
          - `sizeLimit` ResourceQuantity
            - `Format` 'DecimalExponent' | 'BinarySI' | 'DecimalSI'
        - `ephemeral` V1EphemeralVolumeSource
          - `volumeClaimTemplate` V1PersistentVolumeClaimTemplate
            - `metadata` V1ObjectMeta
              - …
            - `spec` V1PersistentVolumeClaimSpec, required
              - …
        - `fc` V1FCVolumeSource
          - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine +optional
          - `lun` integer — lun is Optional: FC target lun number +optional
          - `readOnly` boolean — readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
          - `targetWWNs` string[] — targetWWNs is Optional: FC target worldwide names (WWNs) +optional +listType=atomic
          - `wwids` string[] — wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. +optional +listType=atomic
        - `flexVolume` V1FlexVolumeSource
          - `driver` string, required — driver is the name of the driver to use for this volume.
          - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. +optional
          - `options` object — options is Optional: this field holds extra command options if any. +optional
          - `readOnly` boolean — readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
          - `secretRef` V1LocalObjectReference
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
        - `flocker` V1FlockerVolumeSource
          - `datasetName` string — datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated +optional
          - `datasetUUID` string — datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset +optional
        - `gcePersistentDisk` V1GCEPersistentDiskVolumeSource
          - `fsType` string — fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine +optional
          - `partition` integer — partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional
          - `pdName` string, required — pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
          - `readOnly` boolean — readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional
        - `gitRepo` V1GitRepoVolumeSource
          - `directory` string — directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. +optional
          - `repository` string, required — repository is the URL
          - `revision` string — revision is the commit hash for the specified revision. +optional
        - `glusterfs` V1GlusterfsVolumeSource
          - `endpoints` string, required — endpoints is the endpoint name that details Glusterfs topology.
          - `path` string, required — path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
          - `readOnly` boolean — readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +optional
        - `hostPath` V1HostPathVolumeSource
          - `path` string, required — path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
          - `type` '' | 'DirectoryOrCreate' | 'Directory' | 'FileOrCreate' | 'File' | 'Socket' | 'CharDevice' | 'BlockDevice'
        - `image` V1ImageVolumeSource
          - `pullPolicy` 'Always' | 'Never' | 'IfNotPresent'
          - `reference` string — Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. +optional
        - `iscsi` V1ISCSIVolumeSource
          - `chapAuthDiscovery` boolean — chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication +optional
          - `chapAuthSession` boolean — chapAuthSession defines whether support iSCSI Session CHAP authentication +optional
          - `fsType` string — fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine +optional
          - `initiatorName` string — initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. +optional
          - `iqn` string, required — iqn is the target iSCSI Qualified Name.
          - `iscsiInterface` string — iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). +optional +default="default"
          - `lun` integer, required — lun represents iSCSI Target Lun number.
          - `portals` string[] — portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). +optional +listType=atomic
          - `readOnly` boolean — readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. +optional
          - `secretRef` V1LocalObjectReference
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `targetPortal` string, required — targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
        - `name` string, required — name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
        - `nfs` V1NFSVolumeSource
          - `path` string, required — path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
          - `readOnly` boolean — readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional
          - `server` string, required — server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
        - `persistentVolumeClaim` V1PersistentVolumeClaimVolumeSource
          - `claimName` string, required — claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
          - `readOnly` boolean — readOnly Will force the ReadOnly setting in VolumeMounts. Default false. +optional
        - `photonPersistentDisk` V1PhotonPersistentDiskVolumeSource
          - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
          - `pdID` string, required — pdID is the ID that identifies Photon Controller persistent disk
        - `portworxVolume` V1PortworxVolumeSource
          - `fsType` string — fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
          - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
          - `volumeID` string, required — volumeID uniquely identifies a Portworx volume
        - `projected` V1ProjectedVolumeSource
          - `defaultMode` integer — defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional
          - `sources` V1VolumeProjection[], required — sources is the list of volume projections. Each entry in this list handles one source. +optional +listType=atomic
            - `clusterTrustBundle` V1ClusterTrustBundleProjection
              - …
            - `configMap` V1ConfigMapProjection
              - …
            - `downwardAPI` V1DownwardAPIProjection
              - …
            - `podCertificate` V1PodCertificateProjection
              - …
            - `secret` V1SecretProjection
              - …
            - `serviceAccountToken` V1ServiceAccountTokenProjection
              - …
        - `quobyte` V1QuobyteVolumeSource
          - `group` string — group to map volume access to Default is no group +optional
          - `readOnly` boolean — readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. +optional
          - `registry` string, required — registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
          - `tenant` string — tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin +optional
          - `user` string — user to map volume access to Defaults to serivceaccount user +optional
          - `volume` string, required — volume is a string that references an already created Quobyte volume by name.
        - `rbd` V1RBDVolumeSource
          - `fsType` string — fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine +optional
          - `image` string, required — image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
          - `keyring` string — keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional +default="/etc/ceph/keyring"
          - `monitors` string[], required — monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +listType=atomic
          - `pool` string — pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional +default="rbd"
          - `readOnly` boolean — readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
          - `secretRef` V1LocalObjectReference
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `user` string — user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional +default="admin"
        - `scaleIO` V1ScaleIOVolumeSource
          - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". +optional +default="xfs"
          - `gateway` string, required — gateway is the host address of the ScaleIO API Gateway.
          - `protectionDomain` string — protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. +optional
          - `readOnly` boolean — readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
          - `secretRef` V1LocalObjectReference, required
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `sslEnabled` boolean — sslEnabled Flag enable/disable SSL communication with Gateway, default false +optional
          - `storageMode` string — storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional +default="ThinProvisioned"
          - `storagePool` string — storagePool is the ScaleIO Storage Pool associated with the protection domain. +optional
          - `system` string, required — system is the name of the storage system as configured in ScaleIO.
          - `volumeName` string — volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
        - `secret` V1SecretVolumeSource
          - `defaultMode` integer — defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional
          - `items` V1KeyToPath[] — items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. +optional +listType=atomic
            - `key` string, required — key is the key to project.
            - `mode` integer — mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. +optional
            - `path` string, required — path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
          - `optional` boolean — optional field specify whether the Secret or its keys must be defined +optional
          - `secretName` string — secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional
        - `storageos` V1StorageOSVolumeSource
          - `fsType` string — fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional
          - `readOnly` boolean — readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
          - `secretRef` V1LocalObjectReference
            - `name` string — Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional +default="" +kubebuilder:default="" TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
          - `volumeName` string — volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
          - `volumeNamespace` string — volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. +optional
        - `vsphereVolume` V1VsphereVirtualDiskVolumeSource
          - `fsType` string — fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +optional
          - `storagePolicyID` string — storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. +optional
          - `storagePolicyName` string — storagePolicyName is the storage Policy Based Management (SPBM) profile name. +optional
          - `volumePath` string, required — volumePath is the path that identifies vSphere volume vmdk
      - `options` V1beta1WorkspaceKindPodOptions, required
        - `imageConfig` V1beta1ImageConfig, required
          - `spawner` V1beta1OptionsSpawnerConfig, required
            - `default` string, required — the id of the default option - this will be selected by default in the spawner ui +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=256 +kubebuilder:example="jupyterlab_scipy_190"
          - `values` V1beta1ImageConfigValue[], required — the list of image configs that are available +kubebuilder:validation:MinItems:=1 +listType:="map" +listMapKey:="id"
            - `id` string, required — the id of this image config +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=256 +kubebuilder:example:="jupyterlab_scipy_190"
            - `redirect` V1beta1OptionRedirect
              - …
            - `spawner` V1beta1OptionSpawnerInfo, required
              - …
            - `spec` V1beta1ImageConfigSpec, required
              - …
        - `podConfig` V1beta1PodConfig, required
          - `spawner` V1beta1OptionsSpawnerConfig, required
            - `default` string, required — the id of the default option - this will be selected by default in the spawner ui +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=256 +kubebuilder:example="jupyterlab_scipy_190"
          - `values` V1beta1PodConfigValue[], required — the list of pod configs that are available +kubebuilder:validation:MinItems:=1 +listType:="map" +listMapKey:="id"
            - `id` string, required — the id of this pod config +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=256 +kubebuilder:example="big_gpu"
            - `redirect` V1beta1OptionRedirect
              - …
            - `spawner` V1beta1OptionSpawnerInfo, required
              - …
            - `spec` V1beta1PodConfigSpec, required
              - …
      - `podMetadata` V1beta1WorkspaceKindPodMetadata
        - `annotations` object — annotations to be applied to the Pod resource +kubebuilder:validation:Optional
        - `labels` object — labels to be applied to the Pod resource +kubebuilder:validation:Optional
      - `ports` V1beta1WorkspaceKindPort[], required — port definitions which can be referenced in image config values - think of port definitions as the "types" of services which could be provided by a specific image - a port definition has a common id (URL path) for consistency if the listening TCP port changes - ports are referenced in image config values by their `id` and their definition here establishes their protocol type, and default display name in the UI +kubebuilder:validation:MinItems:=1 +listType:="map" +listMapKey:="id"
        - `defaultDisplayName` string, required — the default display name of the port - note, this can be overridden on a per image config value basis +kubebuilder:validation:MinLength:=2 +kubebuilder:validation:MaxLength:=64 +kubebuilder:example:="JupyterLab"
        - `httpProxy` V1beta1HTTPProxy
          - `removePathPrefix` boolean — if the path prefix is stripped from incoming HTTP requests - if true, the '/workspace/connect/{profile_name}/{workspace_name}/' path prefix is stripped from incoming requests, the application sees the request as if it was made to '/...' - this only works if the application serves RELATIVE URLs for its assets +kubebuilder:validation:Optional +kubebuilder:default:=false
          - `requestHeaders` V1beta1IstioHeaderOperations
            - `add` object — append the given values to the headers specified by keys (will create a comma-separated list of values) - the following go template functions are available in the values: - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port +kubebuilder:validation:Optional +kubebuilder:example:={ "My-Header": "value-to-append" }
            - `remove` string[] — remove the specified headers +kubebuilder:validation:Optional +kubebuilder:example:={"Header-To-Remove"}
            - `set` object — overwrite the headers specified by key with the given values - the following go template functions are available in the values: - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port +kubebuilder:validation:Optional +kubebuilder:example:={ "X-RStudio-Root-Path": "{{ httpPathPrefix 'rstudio' }}" }
        - `id` string, required — the id of the port - identifier for the port in `imageconfig` ports.[].id +kubebuilder:example="jupyterlab"
        - `protocol` 'HTTP', required
      - `probes` V1beta1WorkspaceKindProbes
        - `livenessProbe` V1Probe
          - `exec` V1ExecAction
            - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
          - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional
          - `grpc` V1GRPCAction
            - `port` integer, required — Port number of the gRPC service. Number must be in the range 1 to 65535.
            - `service` string, required — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default=""
          - `httpGet` V1HTTPGetAction
            - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
            - `httpHeaders` V1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
              - …
            - `path` string — Path to access on the HTTP server. +optional
            - `port` IntstrIntOrString, required
              - …
            - `scheme` 'HTTP' | 'HTTPS'
          - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
          - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional
          - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional
          - `tcpSocket` V1TCPSocketAction
            - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
            - `port` IntstrIntOrString, required
              - …
          - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional
          - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
        - `readinessProbe` V1Probe
          - `exec` V1ExecAction
            - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
          - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional
          - `grpc` V1GRPCAction
            - `port` integer, required — Port number of the gRPC service. Number must be in the range 1 to 65535.
            - `service` string, required — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default=""
          - `httpGet` V1HTTPGetAction
            - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
            - `httpHeaders` V1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
              - …
            - `path` string — Path to access on the HTTP server. +optional
            - `port` IntstrIntOrString, required
              - …
            - `scheme` 'HTTP' | 'HTTPS'
          - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
          - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional
          - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional
          - `tcpSocket` V1TCPSocketAction
            - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
            - `port` IntstrIntOrString, required
              - …
          - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional
          - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
        - `startupProbe` V1Probe
          - `exec` V1ExecAction
            - `command` string[] — Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. +optional +listType=atomic
          - `failureThreshold` integer — Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional
          - `grpc` V1GRPCAction
            - `port` integer, required — Port number of the gRPC service. Number must be in the range 1 to 65535.
            - `service` string, required — Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. +optional +default=""
          - `httpGet` V1HTTPGetAction
            - `host` string — Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. +optional
            - `httpHeaders` V1HTTPHeader[] — Custom headers to set in the request. HTTP allows repeated headers. +optional +listType=atomic
              - …
            - `path` string — Path to access on the HTTP server. +optional
            - `port` IntstrIntOrString, required
              - …
            - `scheme` 'HTTP' | 'HTTPS'
          - `initialDelaySeconds` integer — Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
          - `periodSeconds` integer — How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional
          - `successThreshold` integer — Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional
          - `tcpSocket` V1TCPSocketAction
            - `host` string — Optional: Host name to connect to, defaults to the pod IP. +optional
            - `port` IntstrIntOrString, required
              - …
          - `terminationGracePeriodSeconds` integer — Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional
          - `timeoutSeconds` integer — Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
      - `securityContext` V1PodSecurityContext
        - `appArmorProfile` V1AppArmorProfile
          - `localhostProfile` string — localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is "Localhost". +optional
          - `type` 'Unconfined' | 'RuntimeDefault' | 'Localhost', required
        - `fsGroup` integer — A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. +optional
        - `fsGroupChangePolicy` 'OnRootMismatch' | 'Always'
        - `runAsGroup` integer — The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. +optional
        - `runAsNonRoot` boolean — Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
        - `runAsUser` integer — The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. +optional
        - `seLinuxChangePolicy` 'Recursive' | 'MountOption'
        - `seLinuxOptions` V1SELinuxOptions
          - `level` string — Level is SELinux level label that applies to the container. +optional
          - `role` string — Role is a SELinux role label that applies to the container. +optional
          - `type` string — Type is a SELinux type label that applies to the container. +optional
          - `user` string — User is a SELinux user label that applies to the container. +optional
        - `seccompProfile` V1SeccompProfile
          - `localhostProfile` string — localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. +optional
          - `type` 'Unconfined' | 'RuntimeDefault' | 'Localhost', required
        - `supplementalGroups` integer[] — A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows. +optional +listType=atomic
        - `supplementalGroupsPolicy` 'Merge' | 'Strict'
        - `sysctls` V1Sysctl[] — Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. +optional +listType=atomic
          - `name` string, required — Name of a property to set
          - `value` string, required — Value of a property to set
        - `windowsOptions` V1WindowsSecurityContextOptions
          - `gmsaCredentialSpec` string — GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. +optional
          - `gmsaCredentialSpecName` string — GMSACredentialSpecName is the name of the GMSA credential spec to use. +optional
          - `hostProcess` boolean — HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. +optional
          - `runAsUserName` string — The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
      - `serviceAccount` V1beta1WorkspaceKindServiceAccount, required
        - `name` string, required — the name of the ServiceAccount (NOT MUTABLE) - this Service Account MUST already exist in the Namespace of the Workspace, the controller will NOT create it - we will not show this WorkspaceKind in the Spawner UI if the SA does not exist in the Namespace +kubebuilder:validation:XValidation:rule="self == oldSelf",message="ServiceAccount 'name' is immutable" +kubebuilder:example="default-editor" +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=253 +kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
      - `volumeMounts` V1beta1WorkspaceKindVolumeMounts, required
        - `home` string, required — the path to mount the home PVC (NOT MUTABLE) +kubebuilder:validation:MinLength:=2 +kubebuilder:validation:MaxLength:=4096 +kubebuilder:validation:Pattern:=^/[^/].*$ +kubebuilder:validation:XValidation:rule="self == oldSelf",message="mount path of 'home' is immutable" +kubebuilder:example:="/home/jovyan"
    - `spawner` V1beta1WorkspaceKindSpawner, required
      - `deprecated` boolean — if this WorkspaceKind is deprecated +kubebuilder:validation:Optional +kubebuilder:default:=false
      - `deprecationMessage` string — a message to show in Workspace Spawner UI when the WorkspaceKind is deprecated +kubebuilder:validation:Optional +kubebuilder:validation:MinLength:=2 +kubebuilder:validation:MaxLength:=256 +kubebuilder:example:="This WorkspaceKind will be removed on 20XX-XX-XX, please use another WorkspaceKind."
      - `description` string, required — the description of the WorkspaceKind +kubebuilder:validation:MinLength:=2 +kubebuilder:validation:MaxLength:=4096 +kubebuilder:example:="A Workspace which runs JupyterLab in a Pod"
      - `displayName` string, required — the display name of the WorkspaceKind +kubebuilder:validation:MinLength:=2 +kubebuilder:validation:MaxLength:=128 +kubebuilder:example:="JupyterLab Notebook"
      - `hidden` boolean — if this WorkspaceKind should be hidden from the Workspace Spawner UI +kubebuilder:validation:Optional +kubebuilder:default:=false
      - `icon` V1beta1WorkspaceKindAsset, required
        - `configMap` V1beta1WorkspaceKindAssetConfigMap
          - `key` string, required — the key in the ConfigMap which contains the data +kubebuilder:example="jupyterlab-logo.svg" +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=253 +kubebuilder:validation:Pattern:=^[-._a-zA-Z0-9]+$
          - `mediaType` 'image/svg+xml', required
          - `name` string, required — the name of the ConfigMap +kubebuilder:example="my-logos" +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=253 +kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
          - `namespace` string, required — the namespace of the ConfigMap +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=63 +kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ +kubebuilder:example="kubeflow"
        - `url` string — the URL of the asset +kubebuilder:validation:Optional +kubebuilder:example="https://jupyter.org/assets/favicons/apple-touch-icon-152x152.png"
      - `logo` V1beta1WorkspaceKindAsset, required
        - `configMap` V1beta1WorkspaceKindAssetConfigMap
          - `key` string, required — the key in the ConfigMap which contains the data +kubebuilder:example="jupyterlab-logo.svg" +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=253 +kubebuilder:validation:Pattern:=^[-._a-zA-Z0-9]+$
          - `mediaType` 'image/svg+xml', required
          - `name` string, required — the name of the ConfigMap +kubebuilder:example="my-logos" +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=253 +kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
          - `namespace` string, required — the namespace of the ConfigMap +kubebuilder:validation:MinLength:=1 +kubebuilder:validation:MaxLength:=63 +kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ +kubebuilder:example="kubeflow"
        - `url` string — the URL of the asset +kubebuilder:validation:Optional +kubebuilder:example="https://jupyter.org/assets/favicons/apple-touch-icon-152x152.png"

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized. Authentication is required.
- `403` — Forbidden. User does not have permission to create WorkspaceKind.
- `409` — Conflict. WorkspaceKind with the same name already exists.
- `413` — Request Entity Too Large. The request body is too large.
- `415` — Unsupported Media Type. Content-Type header is not correct.
- `422` — Unprocessable Entity. Validation error.
- `500` — Internal server error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/opendatahub-io/apis/kubeflow-notebooks-api.md) · [All operations](https://skmtc.dev/opendatahub-io/apis/kubeflow-notebooks-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/opendatahub-io/kubeflow-notebooks-api/revisions/97fe86faf733/schema)