Retrieve Project Templates

This API can be used to retrieve all allowed templates of this project.

Example Project Templates

An example Project Templates:

apiVersion: management.loft.sh/v1
defaultSpaceTemplate: my-default-space-template
defaultVirtualClusterTemplate: my-default-vcluster-template
kind: ProjectTemplates
metadata:
  creationTimestamp: null
spaceTemplates:
- apiVersion: management.loft.sh/v1
  kind: SpaceTemplate
  metadata:
    creationTimestamp: null
    name: my-default-space-template
  spec:
    template:
      instanceTemplate:
        metadata: {}
      metadata: {}
  status: {}
virtualClusterTemplates:
- apiVersion: management.loft.sh/v1
  kind: VirtualClusterTemplate
  metadata:
    creationTimestamp: null
    name: my-default-vcluster-template
  spec:
    template:
      accessPoint:
        ingress: {}
      helmRelease:
        chart: {}
      instanceTemplate:
        metadata: {}
      metadata: {}
      pro: {}
      spaceTemplate:
        metadata: {}
  status: {}

Project Templates Reference

defaultVirtualClusterTemplate required string pro

DefaultVirtualClusterTemplate is the default template for the project

virtualClusterTemplates required object[] pro

VirtualClusterTemplates holds all the allowed virtual cluster templates

kind required string pro

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 pro

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 pro

name required string pro

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 pro

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 pro

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

selfLink required string pro

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

uid required string pro

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 pro

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 pro

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

creationTimestamp required object pro

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 pro

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 pro

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 pro

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 pro

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[] pro

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 pro

API version of the referent.

kind required string pro

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

name required string pro

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

uid required string pro

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

controller required boolean pro

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean pro

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[] pro

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[] pro

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 pro

Manager is an identifier of the workflow managing these fields.

operation required string pro

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 pro

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 pro

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 pro

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

fieldsV1 required object pro

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

subresource required string pro

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 pro

displayName required string pro

DisplayName is the name that is shown in the UI

description required string pro

Description describes the virtual cluster template

owner required object pro

Owner holds the owner of this object

user required string pro

User specifies a Loft user.

team required string pro

Team specifies a Loft team.

template required object pro

Template holds the virtual cluster template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

instanceTemplate required object pro

InstanceTemplate holds the virtual cluster instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster

access required object pro

Access defines the access of users and teams to the virtual cluster.

defaultClusterRole required string pro

Specifies which cluster role should get applied to users or teams that do not match a rule below.

rules required object[] pro

Rules defines which users and teams should have which access to the virtual cluster. If no rule matches an authenticated incoming user, the user will get cluster admin access.

users required string[] pro

Users this rule matches. * means all users.

teams required string[] pro

Teams that this rule matches.

clusterRole required string pro

ClusterRole is the cluster role that should be assigned to the

pro required object pro

Pro defines the pro settings for the virtual cluster

enabled required boolean pro

Enabled defines if the virtual cluster is a pro cluster or not

helmRelease required object pro

HelmRelease is the helm release configuration for the virtual cluster.

chart required object pro

infos about what chart to deploy

name required string pro

the name of the helm chart

repo required string pro

the repo of the helm chart

username required string pro

The username that is required for this repository

password required string pro

The password that is required for this repository

version required string pro

the version of the helm chart to use

values required string pro

the values for the given chart

accessPoint required object pro

AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than through the (default) Loft proxy

ingress required object pro

Ingress defines virtual cluster access via ingress

enabled required boolean pro

Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires the connected cluster to have the loft.sh/ingress-suffix annotation set to define the domain name suffix used for the ingress.

forwardToken required boolean pro

ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes api server and do a TokenReview there.

spaceTemplate required object pro

SpaceTemplate holds the space template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

parameters required object[] pro

Parameters define additional app parameters that will set helm values

variable required string pro

Variable is the path of the variable. Can be foo or foo.bar for nested objects.

label required string pro

Label is the label to show for this parameter

description required string pro

Description is the description to show for this parameter

type required string pro

Type of the parameter. Can be one of: string, multiline, boolean, number and password

options required string[] pro

Options is a slice of strings, where each string represents a mutually exclusive choice.

min required integer pro

Min is the minimum number if type is number

max required integer pro

Max is the maximum number if type is number

required required boolean pro

Required specifies if this parameter is required

defaultValue required string pro

DefaultValue is the default value if none is specified

placeholder required string pro

Placeholder shown in the UI

invalidation required string pro

Invalidation regex that if matched will reject the input

validation required string pro

Validation regex that if matched will allow the input

section required string pro

Section where this app should be displayed. Apps with the same section name will be grouped together

versions required object[] pro

Versions are different versions of the template that can be referenced as well

template required object pro

Template holds the space template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

instanceTemplate required object pro

InstanceTemplate holds the virtual cluster instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster

access required object pro

Access defines the access of users and teams to the virtual cluster.

defaultClusterRole required string pro

Specifies which cluster role should get applied to users or teams that do not match a rule below.

rules required object[] pro

Rules defines which users and teams should have which access to the virtual cluster. If no rule matches an authenticated incoming user, the user will get cluster admin access.

users required string[] pro

Users this rule matches. * means all users.

teams required string[] pro

Teams that this rule matches.

clusterRole required string pro

ClusterRole is the cluster role that should be assigned to the

pro required object pro

Pro defines the pro settings for the virtual cluster

enabled required boolean pro

Enabled defines if the virtual cluster is a pro cluster or not

helmRelease required object pro

HelmRelease is the helm release configuration for the virtual cluster.

chart required object pro

infos about what chart to deploy

name required string pro

the name of the helm chart

repo required string pro

the repo of the helm chart

username required string pro

The username that is required for this repository

password required string pro

The password that is required for this repository

version required string pro

the version of the helm chart to use

values required string pro

the values for the given chart

accessPoint required object pro

AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than through the (default) Loft proxy

ingress required object pro

Ingress defines virtual cluster access via ingress

enabled required boolean pro

Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires the connected cluster to have the loft.sh/ingress-suffix annotation set to define the domain name suffix used for the ingress.

forwardToken required boolean pro

ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes api server and do a TokenReview there.

spaceTemplate required object pro

SpaceTemplate holds the space template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

parameters required object[] pro

Parameters define additional app parameters that will set helm values

variable required string pro

Variable is the path of the variable. Can be foo or foo.bar for nested objects.

label required string pro

Label is the label to show for this parameter

description required string pro

Description is the description to show for this parameter

type required string pro

Type of the parameter. Can be one of: string, multiline, boolean, number and password

options required string[] pro

Options is a slice of strings, where each string represents a mutually exclusive choice.

min required integer pro

Min is the minimum number if type is number

max required integer pro

Max is the maximum number if type is number

required required boolean pro

Required specifies if this parameter is required

defaultValue required string pro

DefaultValue is the default value if none is specified

placeholder required string pro

Placeholder shown in the UI

invalidation required string pro

Invalidation regex that if matched will reject the input

validation required string pro

Validation regex that if matched will allow the input

section required string pro

Section where this app should be displayed. Apps with the same section name will be grouped together

version required string pro

Version is the version. Needs to be in X.X.X format.

access required object[] pro

Access holds the access rights for users and teams

name required string pro

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

verbs required string[] pro

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[] pro

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

users required string[] pro

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

teams required string[] pro

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

spaceTemplateRef required object pro

DEPRECATED: SpaceTemplate to use to create the virtual cluster space if it does not exist

name required string pro

Name of the space template

status required object pro

apps required object[] pro

name required string pro

Name is the kubernetes name of the object

displayName required string pro

The display name shown in the UI

icon required string pro

Icon is the icon of the user / team

username required string pro

The username that is used to login

email required string pro

The users email address

subject required string pro

The user subject

defaultSpaceTemplate required string pro

DefaultSpaceTemplate

spaceTemplates required object[] pro

SpaceTemplates holds all the allowed space templates

kind required string pro

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 pro

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 pro

name required string pro

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 pro

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 pro

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

selfLink required string pro

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

uid required string pro

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 pro

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 pro

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

creationTimestamp required object pro

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 pro

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 pro

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 pro

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 pro

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[] pro

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 pro

API version of the referent.

kind required string pro

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

name required string pro

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

uid required string pro

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

controller required boolean pro

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean pro

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[] pro

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[] pro

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 pro

Manager is an identifier of the workflow managing these fields.

operation required string pro

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 pro

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 pro

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 pro

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

fieldsV1 required object pro

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

subresource required string pro

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 pro

displayName required string pro

DisplayName is the name that is shown in the UI

description required string pro

Description describes the space template

owner required object pro

Owner holds the owner of this object

user required string pro

User specifies a Loft user.

team required string pro

Team specifies a Loft team.

template required object pro

Template holds the space template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

instanceTemplate required object pro

InstanceTemplate holds the space instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

access required object pro

The space access

defaultClusterRole required string pro

Specifies which cluster role should get applied to users or teams that do not match a rule below.

rules required object[] pro

Rules defines which users and teams should have which access to the virtual cluster. If no rule matches an authenticated incoming user, the user will get cluster admin access.

users required string[] pro

Users this rule matches. * means all users.

teams required string[] pro

Teams that this rule matches.

clusterRole required string pro

ClusterRole is the cluster role that should be assigned to the

parameters required object[] pro

Parameters define additional app parameters that will set helm values

variable required string pro

Variable is the path of the variable. Can be foo or foo.bar for nested objects.

label required string pro

Label is the label to show for this parameter

description required string pro

Description is the description to show for this parameter

type required string pro

Type of the parameter. Can be one of: string, multiline, boolean, number and password

options required string[] pro

Options is a slice of strings, where each string represents a mutually exclusive choice.

min required integer pro

Min is the minimum number if type is number

max required integer pro

Max is the maximum number if type is number

required required boolean pro

Required specifies if this parameter is required

defaultValue required string pro

DefaultValue is the default value if none is specified

placeholder required string pro

Placeholder shown in the UI

invalidation required string pro

Invalidation regex that if matched will reject the input

validation required string pro

Validation regex that if matched will allow the input

section required string pro

Section where this app should be displayed. Apps with the same section name will be grouped together

versions required object[] pro

Versions are different space template versions that can be referenced as well

template required object pro

Template holds the space template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

instanceTemplate required object pro

InstanceTemplate holds the space instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

access required object pro

The space access

defaultClusterRole required string pro

Specifies which cluster role should get applied to users or teams that do not match a rule below.

rules required object[] pro

Rules defines which users and teams should have which access to the virtual cluster. If no rule matches an authenticated incoming user, the user will get cluster admin access.

users required string[] pro

Users this rule matches. * means all users.

teams required string[] pro

Teams that this rule matches.

clusterRole required string pro

ClusterRole is the cluster role that should be assigned to the

parameters required object[] pro

Parameters define additional app parameters that will set helm values

variable required string pro

Variable is the path of the variable. Can be foo or foo.bar for nested objects.

label required string pro

Label is the label to show for this parameter

description required string pro

Description is the description to show for this parameter

type required string pro

Type of the parameter. Can be one of: string, multiline, boolean, number and password

options required string[] pro

Options is a slice of strings, where each string represents a mutually exclusive choice.

min required integer pro

Min is the minimum number if type is number

max required integer pro

Max is the maximum number if type is number

required required boolean pro

Required specifies if this parameter is required

defaultValue required string pro

DefaultValue is the default value if none is specified

placeholder required string pro

Placeholder shown in the UI

invalidation required string pro

Invalidation regex that if matched will reject the input

validation required string pro

Validation regex that if matched will allow the input

section required string pro

Section where this app should be displayed. Apps with the same section name will be grouped together

version required string pro

Version is the version. Needs to be in X.X.X format.

access required object[] pro

Access holds the access rights for users and teams

name required string pro

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

verbs required string[] pro

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[] pro

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

users required string[] pro

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

teams required string[] pro

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

status required object pro

apps required object[] pro

name required string pro

Name is the kubernetes name of the object

displayName required string pro

The display name shown in the UI

icon required string pro

Icon is the icon of the user / team

username required string pro

The username that is used to login

email required string pro

The users email address

subject required string pro

The user subject

defaultDevPodWorkspaceTemplate required string pro

DefaultDevPodWorkspaceTemplate

devPodWorkspaceTemplates required object[] pro

DevPodWorkspaceTemplates holds all the allowed space templates

kind required string pro

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 pro

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 pro

name required string pro

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 pro

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 pro

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

selfLink required string pro

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

uid required string pro

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 pro

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 pro

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

creationTimestamp required object pro

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 pro

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 pro

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 pro

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 pro

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[] pro

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 pro

API version of the referent.

kind required string pro

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

name required string pro

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

uid required string pro

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

controller required boolean pro

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean pro

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[] pro

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[] pro

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 pro

Manager is an identifier of the workflow managing these fields.

operation required string pro

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 pro

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 pro

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 pro

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

fieldsV1 required object pro

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

subresource required string pro

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 pro

displayName required string pro

DisplayName is the name that is shown in the UI

description required string pro

Description describes the virtual cluster template

owner required object pro

Owner holds the owner of this object

user required string pro

User specifies a Loft user.

team required string pro

Team specifies a Loft team.

parameters required object[] pro

Parameters define additional app parameters that will set provider values

variable required string pro

Variable is the path of the variable. Can be foo or foo.bar for nested objects.

label required string pro

Label is the label to show for this parameter

description required string pro

Description is the description to show for this parameter

type required string pro

Type of the parameter. Can be one of: string, multiline, boolean, number and password

options required string[] pro

Options is a slice of strings, where each string represents a mutually exclusive choice.

min required integer pro

Min is the minimum number if type is number

max required integer pro

Max is the maximum number if type is number

required required boolean pro

Required specifies if this parameter is required

defaultValue required string pro

DefaultValue is the default value if none is specified

placeholder required string pro

Placeholder shown in the UI

invalidation required string pro

Invalidation regex that if matched will reject the input

validation required string pro

Validation regex that if matched will allow the input

section required string pro

Section where this app should be displayed. Apps with the same section name will be grouped together

template required object pro

Template holds the DevPod workspace template

provider required object pro

Provider holds the DevPod provider configuration

name required string pro

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

options required object pro

Options are the provider option values

env required object pro

Env are environment options to set when using the provider.

spaceTemplateRef required object pro

SpaceTemplateRef is a reference to the space that should get created for this DevPod. If this is specified, the kubernetes provider will be selected automatically.

name required string pro

Name holds the name of the template to reference.

version required string pro

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 pro

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.

spaceTemplate required object pro

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

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

instanceTemplate required object pro

InstanceTemplate holds the space instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

access required object pro

The space access

defaultClusterRole required string pro

Specifies which cluster role should get applied to users or teams that do not match a rule below.

rules required object[] pro

Rules defines which users and teams should have which access to the virtual cluster. If no rule matches an authenticated incoming user, the user will get cluster admin access.

users required string[] pro

Users this rule matches. * means all users.

teams required string[] pro

Teams that this rule matches.

clusterRole required string pro

ClusterRole is the cluster role that should be assigned to the

workspaceEnv required object pro

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

initEnv required object pro

InitEnv are environment variables that should be available during the initialization phase of the created workspace.

instanceTemplate required object pro

InstanceTemplate holds the workspace instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

useProjectGitCredentials required boolean pro

UseProjectGitCredentials specifies if the project git credentials should be used instead of local ones for this workspace

useProjectSSHCredentials required boolean pro

UseProjectSSHCredentials specifies if the project ssh credentials should be used instead of local ones for this workspace

gitCloneStrategy required string pro

GitCloneStrategy specifies how git based workspace are being cloned. Can be "" (full, default), treeless, blobless or shallow

versions required object[] pro

Versions are different versions of the template that can be referenced as well

template required object pro

Template holds the DevPod template

provider required object pro

Provider holds the DevPod provider configuration

name required string pro

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

options required object pro

Options are the provider option values

env required object pro

Env are environment options to set when using the provider.

spaceTemplateRef required object pro

SpaceTemplateRef is a reference to the space that should get created for this DevPod. If this is specified, the kubernetes provider will be selected automatically.

name required string pro

Name holds the name of the template to reference.

version required string pro

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 pro

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.

spaceTemplate required object pro

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

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

instanceTemplate required object pro

InstanceTemplate holds the space instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

objects required string pro

Objects are Kubernetes style yamls that should get deployed into the virtual cluster

charts required object[] pro

Charts are helm charts that should get deployed

name required string pro

Name is the chart name in the repository

version required string pro

Version is the chart version in the repository

repoURL required string pro

RepoURL is the repo url where the chart can be found

username required string pro

The username that is required for this repository

usernameRef required object pro

The username that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

password required string pro

The password that is required for this repository

passwordRef required object pro

The password that is required for this repository

projectSecretRef required object pro

ProjectSecretRef holds the reference to a project secret

project required string pro

Project is the project name where the secret is located in.

name required string pro

Name of the project secret to use.

key required string pro

Key of the project secret to use.

insecureSkipTlsVerify required boolean pro

If tls certificate checks for the chart download should be skipped

releaseName required string pro

ReleaseName is the preferred release name of the app

releaseNamespace required string pro

ReleaseNamespace is the preferred release namespace of the app

values required string pro

Values are the values that should get passed to the chart

wait required boolean pro

Wait determines if Loft should wait during deploy for the app to become ready

timeout required string pro

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)

apps required object[] pro

Apps specifies the apps that should get deployed by this template

name required string pro

Name of the target app

namespace required string pro

Namespace specifies in which target namespace the app should get deployed in

releaseName required string pro

ReleaseName is the name of the app release

version required string pro

Version of the app

parameters required string pro

Parameters to use for the app

access required object pro

The space access

defaultClusterRole required string pro

Specifies which cluster role should get applied to users or teams that do not match a rule below.

rules required object[] pro

Rules defines which users and teams should have which access to the virtual cluster. If no rule matches an authenticated incoming user, the user will get cluster admin access.

users required string[] pro

Users this rule matches. * means all users.

teams required string[] pro

Teams that this rule matches.

clusterRole required string pro

ClusterRole is the cluster role that should be assigned to the

workspaceEnv required object pro

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

initEnv required object pro

InitEnv are environment variables that should be available during the initialization phase of the created workspace.

instanceTemplate required object pro

InstanceTemplate holds the workspace instance template

metadata required object pro

labels required object pro

Labels are labels on the object

annotations required object pro

Annotations are annotations on the object

useProjectGitCredentials required boolean pro

UseProjectGitCredentials specifies if the project git credentials should be used instead of local ones for this workspace

useProjectSSHCredentials required boolean pro

UseProjectSSHCredentials specifies if the project ssh credentials should be used instead of local ones for this workspace

gitCloneStrategy required string pro

GitCloneStrategy specifies how git based workspace are being cloned. Can be "" (full, default), treeless, blobless or shallow

parameters required object[] pro

Parameters define additional app parameters that will set provider values

variable required string pro

Variable is the path of the variable. Can be foo or foo.bar for nested objects.

label required string pro

Label is the label to show for this parameter

description required string pro

Description is the description to show for this parameter

type required string pro

Type of the parameter. Can be one of: string, multiline, boolean, number and password

options required string[] pro

Options is a slice of strings, where each string represents a mutually exclusive choice.

min required integer pro

Min is the minimum number if type is number

max required integer pro

Max is the maximum number if type is number

required required boolean pro

Required specifies if this parameter is required

defaultValue required string pro

DefaultValue is the default value if none is specified

placeholder required string pro

Placeholder shown in the UI

invalidation required string pro

Invalidation regex that if matched will reject the input

validation required string pro

Validation regex that if matched will allow the input

section required string pro

Section where this app should be displayed. Apps with the same section name will be grouped together

version required string pro

Version is the version. Needs to be in X.X.X format.

access required object[] pro

Access holds the access rights for users and teams

name required string pro

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

verbs required string[] pro

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[] pro

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

users required string[] pro

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

teams required string[] pro

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

status required object pro

Project Templates (Get)

You can retrieve all allowed templates through this API.

kubectl

Run the following command:

# Exchange my-object in the url below with the name of the Project Templates
kubectl get --raw "/kubernetes/management/apis/management.loft.sh/v1/projects/my-object/templates"

curl

Run the following curl command:

# Exchange my-object in the url below with the name of the Project Templates
curl -s -X GET --insecure \
     "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects/my-object/templates" \
     -H "Authorization: Bearer $ACCESS_KEY"