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
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
kind required string 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
apiVersion required string metadata required object
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
name required string 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
generateName required string 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
namespace required string selfLink required string
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink required string 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
uid required string 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
resourceVersion required string generation required integer
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation required integer 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
creationTimestamp required object 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
deletionTimestamp required object 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.
deletionGracePeriodSeconds required integer 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
labels required object 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
annotations required object 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.
ownerReferences required object[] apiVersion required string
API version of the referent.
apiVersion required string kind required string
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind required string name required string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name required string uid required string
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid required string controller required boolean false
If true, this reference points to the managing controller.
controller required boolean false 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.
blockOwnerDeletion required boolean false 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.
finalizers required string[] 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.
managedFields required object[] manager required string
Manager is an identifier of the workflow managing these fields.
manager required string 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'.
operation required string 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.
apiVersion required string 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.
time required object fieldsType required string
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType required string fieldsV1 required object
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1 required object 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.
subresource required string defaultVirtualClusterTemplate required string
DefaultVirtualClusterTemplate is the default template for the project
defaultVirtualClusterTemplate required string virtualClusterTemplates required object[]
VirtualClusterTemplates holds all the allowed virtual cluster templates
virtualClusterTemplates required object[] 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
kind required string 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
apiVersion required string metadata required object
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
name required string 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
generateName required string 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
namespace required string selfLink required string
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink required string 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
uid required string 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
resourceVersion required string generation required integer
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation required integer 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
creationTimestamp required object 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
deletionTimestamp required object 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.
deletionGracePeriodSeconds required integer 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
labels required object 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
annotations required object 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.
ownerReferences required object[] apiVersion required string
API version of the referent.
apiVersion required string kind required string
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind required string name required string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name required string uid required string
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid required string controller required boolean false
If true, this reference points to the managing controller.
controller required boolean false 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.
blockOwnerDeletion required boolean false 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.
finalizers required string[] 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.
managedFields required object[] manager required string
Manager is an identifier of the workflow managing these fields.
manager required string 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'.
operation required string 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.
apiVersion required string 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.
time required object fieldsType required string
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType required string fieldsV1 required object
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1 required object 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.
subresource required string spec required object
spec required object displayName required string
DisplayName is the name that is shown in the UI
displayName required string description required string
Description describes the virtual cluster template
description required string owner required object
Owner holds the owner of this object
owner required object template required object
Template holds the virtual cluster template
template required object metadata required object
metadata required object instanceTemplate required object
InstanceTemplate holds the virtual cluster instance template
instanceTemplate required object apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects required string access required object
Access defines the access of users and teams to the virtual cluster.
access required object defaultClusterRole required string
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole required string rules required object[]
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.
rules required object[] pro required object
Pro defines the pro settings for the virtual cluster
pro required object enabled required boolean false
Enabled defines if the virtual cluster is a pro cluster or not
enabled required boolean false helmRelease required object
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease required object chart required object
infos about what chart to deploy
chart required object name required string
the name of the helm chart
name required string repo required string
the repo of the helm chart
repo required string username required string
The username that is required for this repository
username required string password required string
The password that is required for this repository
password required string version required string
the version of the helm chart to use
version required string values required string
the values for the given chart
values required string accessPoint required object
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint required object ingress required object
Ingress defines virtual cluster access via ingress
ingress required object enabled required boolean true
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.
enabled required boolean true loft.sh/ingress-suffix annotation set to define the domain
name suffix used for the ingress.forwardToken required boolean false
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken required boolean false spaceTemplate required object
SpaceTemplate holds the space template
spaceTemplate required object metadata required object
metadata required object objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string workloadVirtualClusterTemplate required object
WorkloadVirtualClusterTemplateDefinition holds the workload cluster specific deployment options. Needs to be non-nil
in order to deploy the virtual cluster in workload cluster mode.
workloadVirtualClusterTemplate required object metadata required object
metadata required object helmRelease required object
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease required object chart required object
infos about what chart to deploy
chart required object name required string
the name of the helm chart
name required string repo required string
the repo of the helm chart
repo required string username required string
The username that is required for this repository
username required string password required string
The password that is required for this repository
password required string version required string
the version of the helm chart to use
version required string values required string
the values for the given chart
values required string spaceTemplate required object
SpaceTemplate holds the space template
spaceTemplate required object metadata required object
metadata required object objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string parameters required object[]
Parameters define additional app parameters that will set helm values
parameters required object[] variable required string
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable required string label required string
Label is the label to show for this parameter
label required string description required string
Description is the description to show for this parameter
description required string type required string
Type of the parameter. Can be one of:
string, multiline, boolean, enum and password
type required string options required string[]
Options are the options if type is enum
options required string[] min required integer
Min is the minimum number if type is number
min required integer max required integer
Max is the maximum number if type is number
max required integer required required boolean false
Required specifies if this parameter is required
required required boolean false defaultValue required string
DefaultValue is the default value if none is specified
defaultValue required string placeholder required string
Placeholder shown in the UI
placeholder required string invalidation required string
Invalidation regex that if matched will reject the input
invalidation required string validation required string
Validation regex that if matched will allow the input
validation required string section required string
Section where this app should be displayed. Apps with the same section name will be grouped together
section required string versions required object[]
Versions are different versions of the template that can be referenced as well
versions required object[] template required object
Template holds the space template
template required object metadata required object
metadata required object instanceTemplate required object
InstanceTemplate holds the virtual cluster instance template
instanceTemplate required object apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects required string access required object
Access defines the access of users and teams to the virtual cluster.
access required object defaultClusterRole required string
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole required string rules required object[]
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.
rules required object[] pro required object
Pro defines the pro settings for the virtual cluster
pro required object enabled required boolean false
Enabled defines if the virtual cluster is a pro cluster or not
enabled required boolean false helmRelease required object
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease required object chart required object
infos about what chart to deploy
chart required object name required string
the name of the helm chart
name required string repo required string
the repo of the helm chart
repo required string username required string
The username that is required for this repository
username required string password required string
The password that is required for this repository
password required string version required string
the version of the helm chart to use
version required string values required string
the values for the given chart
values required string accessPoint required object
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint required object ingress required object
Ingress defines virtual cluster access via ingress
ingress required object enabled required boolean true
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.
enabled required boolean true loft.sh/ingress-suffix annotation set to define the domain
name suffix used for the ingress.forwardToken required boolean false
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken required boolean false spaceTemplate required object
SpaceTemplate holds the space template
spaceTemplate required object metadata required object
metadata required object objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string workloadVirtualClusterTemplate required object
WorkloadVirtualClusterTemplateDefinition holds the workload cluster specific deployment options. Needs to be non-nil
in order to deploy the virtual cluster in workload cluster mode.
workloadVirtualClusterTemplate required object metadata required object
metadata required object helmRelease required object
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease required object chart required object
infos about what chart to deploy
chart required object name required string
the name of the helm chart
name required string repo required string
the repo of the helm chart
repo required string username required string
The username that is required for this repository
username required string password required string
The password that is required for this repository
password required string version required string
the version of the helm chart to use
version required string values required string
the values for the given chart
values required string spaceTemplate required object
SpaceTemplate holds the space template
spaceTemplate required object metadata required object
metadata required object objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string parameters required object[]
Parameters define additional app parameters that will set helm values
parameters required object[] variable required string
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable required string label required string
Label is the label to show for this parameter
label required string description required string
Description is the description to show for this parameter
description required string type required string
Type of the parameter. Can be one of:
string, multiline, boolean, enum and password
type required string options required string[]
Options are the options if type is enum
options required string[] min required integer
Min is the minimum number if type is number
min required integer max required integer
Max is the maximum number if type is number
max required integer required required boolean false
Required specifies if this parameter is required
required required boolean false defaultValue required string
DefaultValue is the default value if none is specified
defaultValue required string placeholder required string
Placeholder shown in the UI
placeholder required string invalidation required string
Invalidation regex that if matched will reject the input
invalidation required string validation required string
Validation regex that if matched will allow the input
validation required string section required string
Section where this app should be displayed. Apps with the same section name will be grouped together
section required string version required string
Version is the version. Needs to be in X.X.X format.
version required string access required object[]
Access holds the access rights for users and teams
access required object[] name required string
Name is an optional name that is used for this access rule
name required string 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.
verbs required string[] subresources required string[]
Subresources defines the sub resources that are allowed by this access rule
subresources required string[] users required string[]
Users specifies which users should be able to access this secret with the aforementioned verbs
users required string[] teams required string[]
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams required string[] status required object
status required object apps required object[]
apps required object[] name required string
Name is the kubernetes name of the object
name required string displayName required string
The display name shown in the UI
displayName required string icon required string
Icon is the icon of the user / team
icon required string username required string
The username that is used to login
username required string email required string
The users email address
email required string subject required string
The user subject
subject required string defaultSpaceTemplate required string
DefaultSpaceTemplate
defaultSpaceTemplate required string spaceTemplates required object[]
SpaceTemplates holds all the allowed space templates
spaceTemplates required object[] 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
kind required string 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
apiVersion required string metadata required object
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
name required string 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
generateName required string 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
namespace required string selfLink required string
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink required string 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
uid required string 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
resourceVersion required string generation required integer
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation required integer 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
creationTimestamp required object 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
deletionTimestamp required object 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.
deletionGracePeriodSeconds required integer 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
labels required object 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
annotations required object 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.
ownerReferences required object[] apiVersion required string
API version of the referent.
apiVersion required string kind required string
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind required string name required string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name required string uid required string
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid required string controller required boolean false
If true, this reference points to the managing controller.
controller required boolean false 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.
blockOwnerDeletion required boolean false 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.
finalizers required string[] 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.
managedFields required object[] manager required string
Manager is an identifier of the workflow managing these fields.
manager required string 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'.
operation required string 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.
apiVersion required string 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.
time required object fieldsType required string
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType required string fieldsV1 required object
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1 required object 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.
subresource required string spec required object
spec required object displayName required string
DisplayName is the name that is shown in the UI
displayName required string description required string
Description describes the space template
description required string owner required object
Owner holds the owner of this object
owner required object template required object
Template holds the space template
template required object metadata required object
metadata required object instanceTemplate required object
InstanceTemplate holds the space instance template
instanceTemplate required object objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string access required object
The space access
access required object defaultClusterRole required string
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole required string rules required object[]
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.
rules required object[] parameters required object[]
Parameters define additional app parameters that will set helm values
parameters required object[] variable required string
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable required string label required string
Label is the label to show for this parameter
label required string description required string
Description is the description to show for this parameter
description required string type required string
Type of the parameter. Can be one of:
string, multiline, boolean, enum and password
type required string options required string[]
Options are the options if type is enum
options required string[] min required integer
Min is the minimum number if type is number
min required integer max required integer
Max is the maximum number if type is number
max required integer required required boolean false
Required specifies if this parameter is required
required required boolean false defaultValue required string
DefaultValue is the default value if none is specified
defaultValue required string placeholder required string
Placeholder shown in the UI
placeholder required string invalidation required string
Invalidation regex that if matched will reject the input
invalidation required string validation required string
Validation regex that if matched will allow the input
validation required string section required string
Section where this app should be displayed. Apps with the same section name will be grouped together
section required string versions required object[]
Versions are different space template versions that can be referenced as well
versions required object[] template required object
Template holds the space template
template required object metadata required object
metadata required object instanceTemplate required object
InstanceTemplate holds the space instance template
instanceTemplate required object objects required string
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects required string charts required object[]
Charts are helm charts that should get deployed
charts required object[] name required string
Name is the chart name in the repository
name required string version required string
Version is the chart version in the repository
version required string repoURL required string
RepoURL is the repo url where the chart can be found
repoURL required string username required string
The username that is required for this repository
username required string usernameRef required object
The username that is required for this repository
usernameRef required object password required string
The password that is required for this repository
password required string passwordRef required object
The password that is required for this repository
passwordRef required object insecureSkipTlsVerify required boolean false
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify required boolean false releaseName required string
ReleaseName is the preferred release name of the app
releaseName required string releaseNamespace required string
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace required string values required string
Values are the values that should get passed to the chart
values required string wait required boolean false
Wait determines if Loft should wait during deploy for the app to become ready
wait required boolean false timeout required string
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout required string apps required object[]
Apps specifies the apps that should get deployed by this template
apps required object[] name required string
Name of the target app
name required string namespace required string
Namespace specifies in which target namespace the app should
get deployed in
namespace required string releaseName required string
ReleaseName is the name of the app release
releaseName required string version required string
Version of the app
version required string parameters required string
Parameters to use for the app
parameters required string access required object
The space access
access required object defaultClusterRole required string
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole required string rules required object[]
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.
rules required object[] parameters required object[]
Parameters define additional app parameters that will set helm values
parameters required object[] variable required string
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable required string label required string
Label is the label to show for this parameter
label required string description required string
Description is the description to show for this parameter
description required string type required string
Type of the parameter. Can be one of:
string, multiline, boolean, enum and password
type required string options required string[]
Options are the options if type is enum
options required string[] min required integer
Min is the minimum number if type is number
min required integer max required integer
Max is the maximum number if type is number
max required integer required required boolean false
Required specifies if this parameter is required
required required boolean false defaultValue required string
DefaultValue is the default value if none is specified
defaultValue required string placeholder required string
Placeholder shown in the UI
placeholder required string invalidation required string
Invalidation regex that if matched will reject the input
invalidation required string validation required string
Validation regex that if matched will allow the input
validation required string section required string
Section where this app should be displayed. Apps with the same section name will be grouped together
section required string version required string
Version is the version. Needs to be in X.X.X format.
version required string access required object[]
Access holds the access rights for users and teams
access required object[] name required string
Name is an optional name that is used for this access rule
name required string 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.
verbs required string[] subresources required string[]
Subresources defines the sub resources that are allowed by this access rule
subresources required string[] users required string[]
Users specifies which users should be able to access this secret with the aforementioned verbs
users required string[] teams required string[]
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams required string[] status required object
status required object apps required object[]
apps required object[] name required string
Name is the kubernetes name of the object
name required string displayName required string
The display name shown in the UI
displayName required string icon required string
Icon is the icon of the user / team
icon required string username required string
The username that is used to login
username required string email required string
The users email address
email required string subject required string
The user subject
subject required string defaultDevPodWorkspaceTemplate required string
DefaultDevPodWorkspaceTemplate
defaultDevPodWorkspaceTemplate required string devPodWorkspaceTemplates required object[]
DevPodWorkspaceTemplates holds all the allowed space templates
devPodWorkspaceTemplates required object[] 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
kind required string 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
apiVersion required string metadata required object
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
name required string 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
generateName required string 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
namespace required string selfLink required string
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink required string 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
uid required string 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
resourceVersion required string generation required integer
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation required integer 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
creationTimestamp required object 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
deletionTimestamp required object 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.
deletionGracePeriodSeconds required integer 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
labels required object 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
annotations required object 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.
ownerReferences required object[] apiVersion required string
API version of the referent.
apiVersion required string kind required string
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind required string name required string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name required string uid required string
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid required string controller required boolean false
If true, this reference points to the managing controller.
controller required boolean false 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.
blockOwnerDeletion required boolean false 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.
finalizers required string[] 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.
managedFields required object[] manager required string
Manager is an identifier of the workflow managing these fields.
manager required string 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'.
operation required string 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.
apiVersion required string 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.
time required object fieldsType required string
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType required string fieldsV1 required object
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1 required object 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.
subresource required string spec required object
spec required object displayName required string
DisplayName is the name that is shown in the UI
displayName required string description required string
Description describes the virtual cluster template
description required string owner required object
Owner holds the owner of this object
owner required object parameters required object[]
Parameters define additional app parameters that will set provider values
parameters required object[] variable required string
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable required string label required string
Label is the label to show for this parameter
label required string description required string
Description is the description to show for this parameter
description required string type required string
Type of the parameter. Can be one of:
string, multiline, boolean, enum and password
type required string options required string[]
Options are the options if type is enum
options required string[] min required integer
Min is the minimum number if type is number
min required integer max required integer
Max is the maximum number if type is number
max required integer required required boolean false
Required specifies if this parameter is required
required required boolean false defaultValue required string
DefaultValue is the default value if none is specified
defaultValue required string placeholder required string
Placeholder shown in the UI
placeholder required string invalidation required string
Invalidation regex that if matched will reject the input
invalidation required string validation required string
Validation regex that if matched will allow the input
validation required string section required string
Section where this app should be displayed. Apps with the same section name will be grouped together
section required string template required object
Template holds the DevPod workspace template
template required object provider required object
Provider holds the DevPod provider configuration
provider required object 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.
spaceTemplate required object name required string
Name holds the name of the template to reference.
name required string 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.
version required string 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.
syncOnce required boolean false 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.
virtualClusterTemplate required object name required string
Name holds the name of the template to reference.
name required string 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.
version required string 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.
syncOnce required boolean false workspaceEnv required object
WorkspaceEnv are environment variables that should be available within the created workspace.
workspaceEnv required object versions required object[]
Versions are different versions of the template that can be referenced as well
versions required object[] template required object
Template holds the DevPod template
template required object provider required object
Provider holds the DevPod provider configuration
provider required object 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.
spaceTemplate required object name required string
Name holds the name of the template to reference.
name required string 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.
version required string 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.
syncOnce required boolean false 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.
virtualClusterTemplate required object name required string
Name holds the name of the template to reference.
name required string 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.
version required string 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.
syncOnce required boolean false workspaceEnv required object
WorkspaceEnv are environment variables that should be available within the created workspace.
workspaceEnv required object parameters required object[]
Parameters define additional app parameters that will set provider values
parameters required object[] variable required string
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable required string label required string
Label is the label to show for this parameter
label required string description required string
Description is the description to show for this parameter
description required string type required string
Type of the parameter. Can be one of:
string, multiline, boolean, enum and password
type required string options required string[]
Options are the options if type is enum
options required string[] min required integer
Min is the minimum number if type is number
min required integer max required integer
Max is the maximum number if type is number
max required integer required required boolean false
Required specifies if this parameter is required
required required boolean false defaultValue required string
DefaultValue is the default value if none is specified
defaultValue required string placeholder required string
Placeholder shown in the UI
placeholder required string invalidation required string
Invalidation regex that if matched will reject the input
invalidation required string validation required string
Validation regex that if matched will allow the input
validation required string section required string
Section where this app should be displayed. Apps with the same section name will be grouped together
section required string version required string
Version is the version. Needs to be in X.X.X format.
version required string access required object[]
Access holds the access rights for users and teams
access required object[] name required string
Name is an optional name that is used for this access rule
name required string 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.
verbs required string[] subresources required string[]
Subresources defines the sub resources that are allowed by this access rule
subresources required string[] users required string[]
Users specifies which users should be able to access this secret with the aforementioned verbs
users required string[] teams required string[]
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams required string[] status required object
status required object Project Templates (Get)
You can retrieve all allowed templates through this API.
- kubectl
- curl
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"
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"