App
Apps in Loft are a way for admins to package applications and scripts in consumable packages. These Apps can then be deployed into clusters, spaces, or virtual clusters.
Example App​
An example App:
apiVersion: management.loft.sh/v1
kind: App
metadata:
creationTimestamp: null
name: my-app
spec:
access:
- users:
- '*'
verbs:
- get
config:
chart:
name: argo-cd
repoURL: https://argoproj.github.io/argo-helm
description: Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes
displayName: ArgoCD
icon: https://argo-cd.readthedocs.io/en/stable/assets/logo.png
recommendedApp:
- cluster
status: {}
App Reference​
kind
required string pro​
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string pro​apiVersion
required string pro​
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion
required string pro​metadata
required object pro​
metadata
required object pro​name
required string pro​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string pro​generateName
required string pro​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string pro​namespace
required string pro​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string pro​selfLink
required string pro​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string pro​uid
required string pro​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string pro​resourceVersion
required string pro​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string pro​generation
required integer pro​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer pro​creationTimestamp
required object pro​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object pro​deletionTimestamp
required object pro​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object pro​deletionGracePeriodSeconds
required integer pro​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer pro​labels
required object pro​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object pro​annotations
required object pro​
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object pro​ownerReferences
required object[] pro​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] pro​apiVersion
required string pro​
API version of the referent.
apiVersion
required string pro​kind
required string pro​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string pro​name
required string pro​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string pro​uid
required string pro​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string pro​controller
required boolean pro​
If true, this reference points to the managing controller.
controller
required boolean pro​blockOwnerDeletion
required boolean pro​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean pro​finalizers
required string[] pro​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] pro​managedFields
required object[] pro​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] pro​manager
required string pro​
Manager is an identifier of the workflow managing these fields.
manager
required string pro​operation
required string pro​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string pro​apiVersion
required string pro​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string pro​time
required object pro​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object pro​fieldsType
required string pro​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string pro​fieldsV1
required object pro​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object pro​subresource
required string pro​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string pro​spec
required object pro​
spec
required object pro​displayName
required string pro​
DisplayName is the name that should be displayed in the UI
displayName
required string pro​description
required string pro​
Description describes an app
description
required string pro​owner
required object pro​
Owner holds the owner of this object
owner
required object pro​clusters
required string[] pro​
Clusters are the clusters this app can be installed in.
clusters
required string[] pro​recommendedApp
required string[] pro​
RecommendedApp specifies where this app should show up as recommended app
recommendedApp
required string[] pro​defaultNamespace
required string pro​
DefaultNamespace is the default namespace this app should installed
in.
defaultNamespace
required string pro​readme
required string pro​
Readme is a longer markdown string that describes the app.
readme
required string pro​icon
required string pro​
Icon holds an URL to the app icon
icon
required string pro​config
required object pro​
Config is the helm config to use to deploy the helm release
config
required object pro​chart
required object pro​
Chart holds information about a chart that should get deployed
chart
required object pro​name
required string pro​
Name is the chart name in the repository
name
required string pro​version
required string pro​
Version is the chart version in the repository
version
required string pro​repoURL
required string pro​
RepoURL is the repo url where the chart can be found
repoURL
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​usernameRef
required object pro​
The username that is required for this repository
usernameRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​password
required string pro​
The password that is required for this repository
password
required string pro​passwordRef
required object pro​
The password that is required for this repository
passwordRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​insecureSkipTlsVerify
required boolean pro​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean pro​manifests
required string pro​
Manifests holds kube manifests that will be deployed as a chart
manifests
required string pro​bash
required object pro​
Bash holds the bash script to execute in a container in the target
bash
required object pro​values
required string pro​
Values is the set of extra Values added to the chart.
These values merge with the default values inside of the chart.
You can use golang templating in here with values from parameters.
values
required string pro​parameters
required string pro​
Parameters are additional helm chart values that will get merged
with config and are then used to deploy the helm chart.
parameters
required string pro​annotations
required object pro​
Annotations are extra annotations for this helm release
annotations
required object pro​wait
required boolean pro​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean pro​timeout
required string pro​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string pro​parameters
required object[] pro​
Parameters define additional app parameters that will set helm values
parameters
required object[] pro​variable
required string pro​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string pro​label
required string pro​
Label is the label to show for this parameter
label
required string pro​description
required string pro​
Description is the description to show for this parameter
description
required string pro​type
required string pro​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string pro​options
required string[] pro​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] pro​min
required integer pro​
Min is the minimum number if type is number
min
required integer pro​max
required integer pro​
Max is the maximum number if type is number
max
required integer pro​required
required boolean pro​
Required specifies if this parameter is required
required
required boolean pro​defaultValue
required string pro​
DefaultValue is the default value if none is specified
defaultValue
required string pro​placeholder
required string pro​
Placeholder shown in the UI
placeholder
required string pro​invalidation
required string pro​
Invalidation regex that if matched will reject the input
invalidation
required string pro​validation
required string pro​
Validation regex that if matched will allow the input
validation
required string pro​section
required string pro​
Section where this app should be displayed. Apps with the same section name will be grouped together
section
required string pro​streamContainer
required object pro​
DEPRECATED: Use config.bash instead
StreamContainer can be used to stream a containers logs instead of the helm output.
streamContainer
required object pro​selector
required object pro​
Label selector for pods. The newest matching pod will be used to stream logs from
selector
required object pro​matchLabels
required object pro​
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
values
required string[] pro​container
required string pro​
Container is the container name to use
container
required string pro​versions
required object[] pro​
Versions are different app versions that can be referenced
versions
required object[] pro​defaultNamespace
required string pro​
DefaultNamespace is the default namespace this app should installed
in.
defaultNamespace
required string pro​readme
required string pro​
Readme is a longer markdown string that describes the app.
readme
required string pro​icon
required string pro​
Icon holds an URL to the app icon
icon
required string pro​config
required object pro​
Config is the helm config to use to deploy the helm release
config
required object pro​chart
required object pro​
Chart holds information about a chart that should get deployed
chart
required object pro​name
required string pro​
Name is the chart name in the repository
name
required string pro​version
required string pro​
Version is the chart version in the repository
version
required string pro​repoURL
required string pro​
RepoURL is the repo url where the chart can be found
repoURL
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​usernameRef
required object pro​
The username that is required for this repository
usernameRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​password
required string pro​
The password that is required for this repository
password
required string pro​passwordRef
required object pro​
The password that is required for this repository
passwordRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​insecureSkipTlsVerify
required boolean pro​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean pro​manifests
required string pro​
Manifests holds kube manifests that will be deployed as a chart
manifests
required string pro​bash
required object pro​
Bash holds the bash script to execute in a container in the target
bash
required object pro​values
required string pro​
Values is the set of extra Values added to the chart.
These values merge with the default values inside of the chart.
You can use golang templating in here with values from parameters.
values
required string pro​parameters
required string pro​
Parameters are additional helm chart values that will get merged
with config and are then used to deploy the helm chart.
parameters
required string pro​annotations
required object pro​
Annotations are extra annotations for this helm release
annotations
required object pro​wait
required boolean pro​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean pro​timeout
required string pro​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string pro​parameters
required object[] pro​
Parameters define additional app parameters that will set helm values
parameters
required object[] pro​variable
required string pro​
Variable is the path of the variable. Can be foo or foo.bar for nested objects.
variable
required string pro​label
required string pro​
Label is the label to show for this parameter
label
required string pro​description
required string pro​
Description is the description to show for this parameter
description
required string pro​type
required string pro​
Type of the parameter. Can be one of:
string, multiline, boolean, number and password
type
required string pro​options
required string[] pro​
Options is a slice of strings, where each string represents a mutually exclusive choice.
options
required string[] pro​min
required integer pro​
Min is the minimum number if type is number
min
required integer pro​max
required integer pro​
Max is the maximum number if type is number
max
required integer pro​required
required boolean pro​
Required specifies if this parameter is required
required
required boolean pro​defaultValue
required string pro​
DefaultValue is the default value if none is specified
defaultValue
required string pro​placeholder
required string pro​
Placeholder shown in the UI
placeholder
required string pro​invalidation
required string pro​
Invalidation regex that if matched will reject the input
invalidation
required string pro​