Skip to main content
Version: master

DevPod Workspace Instance

A DevPod workspace.

Example DevPodWorkspaceInstance​

An example DevPodWorkspaceInstance:

apiVersion: management.loft.sh/v1
kind: DevPodWorkspaceInstance
metadata:
  creationTimestamp: null
  name: my-devpod-workspace
  namespace: loft-p-my-project
spec:
  displayName: my-display-name
  owner:
    user: my-user
  parameters: 'my-parameter: my-value'
  runnerRef: {}
  templateRef:
    name: my-devpod-workspace-template
status: {}

DevPodWorkspaceInstance Reference​

kind required 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

apiVersion required 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

metadata required object ​

name required string ​

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

generateName required string ​

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

namespace required string ​

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid required string ​

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

resourceVersion required string ​

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

generation required integer ​

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

creationTimestamp required object ​

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionTimestamp required object ​

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds required integer ​

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

labels required object ​

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

annotations required object ​

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

ownerReferences required object[] ​

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

apiVersion required string ​

API version of the referent.

kind required string ​

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name required string ​

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

uid required string ​

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

controller required boolean false ​

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean false ​

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

finalizers required string[] ​

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

managedFields required object[] ​

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

manager required string ​

Manager is an identifier of the workflow managing these fields.

operation required string ​

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

apiVersion required string ​

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

time required object ​

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

fieldsType required string ​

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1 required object ​

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

subresource required string ​

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

spec required object ​

displayName required string ​

DisplayName is the name that should be displayed in the UI

description required string ​

Description describes a DevPod machine instance

owner required object ​

Owner holds the owner of this object

user required string ​

User specifies a Loft user.

team required string ​

Team specifies a Loft team.

templateRef required object ​

TemplateRef holds the DevPod machine template reference

name required string ​

Name holds the name of the template to reference.

version required string ​

Version holds the template version to use. Version is expected to be in semantic versioning format. Alternatively, you can also exchange major, minor or patch with an 'x' to tell Loft to automatically select the latest major, minor or patch version.

syncOnce required boolean false ​

SyncOnce tells the controller to sync the instance once with the template. This is useful if you want to sync an instance after a template was changed. To automatically sync an instance with a template, use 'x.x.x' as version instead.

template required object ​

Template is the inline template to use for DevPod machine creation. This is mutually exclusive with templateRef.

provider required object ​

Provider holds the DevPod provider configuration

name required string ​

Name is the name of the provider. This can also be an url.

options required object ​

Options are the provider option values

env required object ​

Env are environment options to set when using the provider.

spaceTemplate required object ​

SpaceTemplate is the space that should get created for this DevPod. If this is specified, the Kubernetes provider will be selected automatically.

name required string ​

Name holds the name of the template to reference.

version required string ​

Version holds the template version to use. Version is expected to be in semantic versioning format. Alternatively, you can also exchange major, minor or patch with an 'x' to tell Loft to automatically select the latest major, minor or patch version.

syncOnce required boolean false ​

SyncOnce tells the controller to sync the instance once with the template. This is useful if you want to sync an instance after a template was changed. To automatically sync an instance with a template, use 'x.x.x' as version instead.

virtualClusterTemplate required object ​

VirtualClusterTemplate is the virtual cluster that should get created for this DevPod. If this is specified, the Kubernetes provider will be selected automatically.

name required string ​

Name holds the name of the template to reference.

version required string ​

Version holds the template version to use. Version is expected to be in semantic versioning format. Alternatively, you can also exchange major, minor or patch with an 'x' to tell Loft to automatically select the latest major, minor or patch version.

syncOnce required boolean false ​

SyncOnce tells the controller to sync the instance once with the template. This is useful if you want to sync an instance after a template was changed. To automatically sync an instance with a template, use 'x.x.x' as version instead.

workspaceEnv required object ​

WorkspaceEnv are environment variables that should be available within the created workspace.

runnerRef required object ​

RunnerRef is the reference to the connected runner holding this workspace

runner required string ​

Runner is the connected runner the workspace will be created in

parameters required string ​

Parameters are values to pass to the template. The values should be encoded as YAML string where each parameter is represented as a top-level field key.

access required object[] ​

Access to the DevPod machine instance object itself

name required string ​

Name is an optional name that is used for this access rule

verbs required string[] ​

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

subresources required string[] ​

Subresources defines the sub resources that are allowed by this access rule

users required string[] ​

Users specifies which users should be able to access this secret with the aforementioned verbs

teams required string[] ​

Teams specifies which teams should be able to access this secret with the aforementioned verbs

status required object ​

lastWorkspaceStatus required string ​

LastWorkspaceStatus is the last workspace status reported by the runner.

phase required string ​

Phase describes the current phase the DevPod machine instance is in

reason required string ​

Reason describes the reason in machine-readable form why the cluster is in the current phase

message required string ​

Message describes the reason in human-readable form why the DevPod machine is in the current phase

conditions required object ​

Conditions holds several conditions the DevPod machine might be in

instance required object ​

Instance is the template rendered with all the parameters

provider required object ​

Provider holds the DevPod provider configuration

name required string ​

Name is the name of the provider. This can also be an url.

options required object ​

Options are the provider option values

env required object ​

Env are environment options to set when using the provider.

spaceTemplate required object ​

SpaceTemplate is the space that should get created for this DevPod. If this is specified, the Kubernetes provider will be selected automatically.

name required string ​

Name holds the name of the template to reference.

version required string ​

Version holds the template version to use. Version is expected to be in semantic versioning format. Alternatively, you can also exchange major, minor or patch with an 'x' to tell Loft to automatically select the latest major, minor or patch version.

syncOnce required boolean false ​

SyncOnce tells the controller to sync the instance once with the template. This is useful if you want to sync an instance after a template was changed. To automatically sync an instance with a template, use 'x.x.x' as version instead.

virtualClusterTemplate required object ​

VirtualClusterTemplate is the virtual cluster that should get created for this DevPod. If this is specified, the Kubernetes provider will be selected automatically.

name required string ​

Name holds the name of the template to reference.

version required string ​

Version holds the template version to use. Version is expected to be in semantic versioning format. Alternatively, you can also exchange major, minor or patch with an 'x' to tell Loft to automatically select the latest major, minor or patch version.

syncOnce required boolean false ​

SyncOnce tells the controller to sync the instance once with the template. This is useful if you want to sync an instance after a template was changed. To automatically sync an instance with a template, use 'x.x.x' as version instead.

workspaceEnv required object ​

WorkspaceEnv are environment variables that should be available within the created workspace.

ignoreReconciliation required boolean false ​

IgnoreReconciliation ignores reconciliation for this object

sleepModeConfig required object ​

SleepModeConfig is the sleep mode config of the workspace. This will only be shown in the front end.

kind required 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

apiVersion required 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

metadata required object ​

name required string ​

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

generateName required string ​

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

namespace required string ​

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid required string ​

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

resourceVersion required string ​

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

generation required integer ​

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

creationTimestamp required object ​

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionTimestamp required object ​

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds required integer ​

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

labels required object ​

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

annotations required object ​

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

ownerReferences required object[] ​

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

apiVersion required string ​

API version of the referent.

kind required string ​

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name required string ​

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

uid required string ​

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

controller required boolean false ​

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean false ​

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

finalizers required string[] ​

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

managedFields required object[] ​

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

manager required string ​

Manager is an identifier of the workflow managing these fields.

operation required string ​

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

apiVersion required string ​

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

time required object ​

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

fieldsType required string ​

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1 required object ​

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

subresource required string ​

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

spec required object ​

forceSleep required boolean false ​

If force sleep is true the space will sleep

forceSleepDuration required integer ​

If force sleep duration is set, this will force the space to sleep for the given duration. It also implies that forceSleep is true. During this period loft will also block certain requests to that space. If this is set to 0, it means the space will sleep until it is manually woken up via the cli or ui.

deleteAfter required integer ​

DeleteAfter specifies after how many seconds of inactivity the space should be deleted

sleepAfter required integer ​

SleepAfter specifies after how many seconds of inactivity the space should sleep

sleepSchedule required string ​

SleepSchedule specifies scheduled space sleep in Cron format, see https://en.wikipedia.org/wiki/Cron. Note: timezone defined in the schedule string will be ignored. Use ".Spec.Timezone" field instead.

wakeupSchedule required string ​

WakeupSchedule specifies scheduled wakeup from sleep in Cron format, see https://en.wikipedia.org/wiki/Cron. Note: timezone defined in the schedule string will be ignored. Use ".Spec.Timezone" field instead.

timezone required string ​

Timezone specifies time zone used for scheduled space operations. Defaults to UTC. Accepts the same format as time.LoadLocation() in Go (https://pkg.go.dev/time#LoadLocation). The value should be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York".

ignoreActiveConnections required boolean false ​

IgnoreActiveConnections ignores active connections on the namespace

ignoreAll required boolean false ​

IgnoreAll ignores all requests

ignoreIngresses required boolean false ​

IgnoreIngresses ignores all ingresses

ignoreVClusters required boolean false ​

IgnoreVClusters ignores vcluster requests

ignoreGroups required string ​

IgnoreGroups are ignored user groups

ignoreVerbs required string ​

IgnoreVerbs are ignored request verbs

ignoreResources required string ​

IgnoreResources are ignored request resources

ignoreResourceVerbs required string ​

IgnoreResourceVerbs are ignored resource verbs

ignoreResourceNames required string ​

IgnoreResourceNames are ignored resources and names

ignoreUserAgents required string ​

IgnoreUseragents are ignored user agents with trailing wildcards '*' allowed. comma separated

status required object ​

lastActivity required integer ​

LastActivity indicates the last activity in the namespace

lastActivityInfo required object ​

LastActivityInfo holds information about the last activity within this space

subject required string ​

Subject is the user or team where this activity was recorded

host required string ​

Host is the host where this activity was recorded

verb required string ​

Verb is the verb that was used for the request

apiGroup required string ​

APIGroup is the api group that was used for the request

resource required string ​

Resource is the resource of the request

subresource required string ​

Subresource is the subresource of the request

name required string ​

Name is the name of the resource

virtualCluster required string ​

VirtualCluster is the virtual cluster this activity happened in

sleepingSince required integer ​

SleepingSince specifies since when the space is sleeping (if this is not specified, loft assumes the space is not sleeping)

currentEpoch required object ​

Optional info that indicates how long the space was sleeping in the current epoch

start required integer ​

Timestamp when the epoch has started

slept required integer ​

Amount of milliseconds the space has slept in the epoch

lastEpoch required object ​

Optional info that indicates how long the space was sleeping in the current epoch

start required integer ​

Timestamp when the epoch has started

slept required integer ​

Amount of milliseconds the space has slept in the epoch

sleptLastThirtyDays required number ​

This is a calculated field that will be returned but not saved and describes the percentage since the space was created or the last 30 days the space has slept

sleptLastSevenDays required number ​

This is a calculated field that will be returned but not saved and describes the percentage since the space was created or the last 7 days the space has slept

scheduledSleep required integer ​

Indicates time of the next scheduled sleep based on .Spec.SleepSchedule and .Spec.ScheduleTimeZone The time is a Unix time, the number of seconds elapsed since January 1, 1970 UTC

scheduledWakeup required integer ​

Indicates time of the next scheduled wakeup based on .Spec.WakeupSchedule and .Spec.ScheduleTimeZone The time is a Unix time, the number of seconds elapsed since January 1, 1970 UTC

sleepType required string ​

SleepType specifies a type of sleep, which has effect on which actions will cause the space to wake up.

Retrieve: DevPodWorkspaceInstances​

You can either use curl or kubectl to retrieve DevPodWorkspaceInstances.

Retrieve a list of DevPodWorkspaceInstances​

Run the following command to list all DevPodWorkspaceInstances in project my-project:

kubectl get devpodworkspaceinstances.management.loft.sh -n loft-p-my-project -o yaml

Retrieve a single DevPodWorkspaceInstance by name​

Run the following kubectl command to get DevPodWorkspaceInstance my-devpod-workspace in project my-project:

kubectl get devpodworkspaceinstances.management.loft.sh my-devpod-workspace -n loft-p-my-project -o yaml

Create: DevPodWorkspaceInstance​

You can either use curl or kubectl to create a new DevPodWorkspaceInstance. Make sure to set the project in the metadata.namespace field you want to create the DevPodWorkspaceInstance in. If your project has the id my-project, the corresponding namespace would be loft-p-my-project.

Create a file object.yaml with the following contents:

apiVersion: management.loft.sh/v1
kind: DevPodWorkspaceInstance
metadata:
  creationTimestamp: null
  name: my-devpod-workspace
  namespace: loft-p-my-project
spec:
  displayName: my-display-name
  owner:
    user: my-user
  parameters: 'my-parameter: my-value'
  runnerRef: {}
  templateRef:
    name: my-devpod-workspace-template
status: {}

Then create the DevPodWorkspaceInstance my-devpod-workspace in project my-project with:

kubectl create -f object.yaml -n loft-p-my-project

Update: DevPodWorkspaceInstance​

You can either use curl or kubectl to update DevPodWorkspaceInstances.

Update DevPodWorkspaceInstance​

Run the following command to update DevPodWorkspaceInstance my-devpod-workspace in project my-project:

kubectl edit devpodworkspaceinstances.management.loft.sh my-devpod-workspace -n loft-p-my-project

Then edit the object and upon save, kubectl will update the resource.

Patch DevPodWorkspaceInstance​

Patching a resource is useful if you want to generically exchange only a small portion of the object instead of retrieving the whole object first and then modifying it. To learn more about patches in Kubernetes, please take a look at the official docs.

Run the following kubectl command to add a new annotation my-annotation: my-value to the DevPodWorkspaceInstance my-devpod-workspace in project my-project via a patch:

kubectl patch devpodworkspaceinstances.management.loft.sh my-devpod-workspace -n loft-p-my-project \
        --type json \
        -p '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'

Delete: DevPodWorkspaceInstance​

You can either use curl or kubectl to delete DevPodWorkspaceInstances.

Run the following command to delete DevPodWorkspaceInstance my-devpod-workspace in project my-project:

kubectl delete devpodworkspaceinstances.management.loft.sh my-devpod-workspace -n loft-p-my-project