Skip to main content

App

Apps in vCluster.Pro 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 ​

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion required string ​

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata required object ​

name required string ​

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

generateName required string ​

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

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

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

namespace required string ​

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

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

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

uid required string ​

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

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

resourceVersion required string ​

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

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

generation required integer ​

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

creationTimestamp required object ​

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

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

deletionTimestamp required object ​

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

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

deletionGracePeriodSeconds required integer ​

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

labels required <label_name>:string ​

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

annotations required <annotation_name>:string ​

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

ownerReferences required object[] ​

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

apiVersion required string ​

API version of the referent.

kind required string ​

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

name required string ​

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

uid required string ​

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

controller required boolean false ​

If true, this reference points to the managing controller.

blockOwnerDeletion required boolean false ​

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

finalizers required string[] ​

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

managedFields required object[] ​

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

manager required string ​

Manager is an identifier of the workflow managing these fields.

operation required string ​

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

apiVersion required string ​

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

time required object ​

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

fieldsType required string ​

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

fieldsV1 required object ​

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

subresource required string ​

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

spec required object ​

displayName required string ​

DisplayName is the name that should be displayed in the UI

description required string ​

Description describes an app

owner required object ​

Owner holds the owner of this object

user required string ​

User specifies a Loft user.

team required string ​

Team specifies a Loft team.

clusters required string[] ​

Clusters are the clusters this app can be installed in.

recommendedApp required string[] ​

RecommendedApp specifies where this app should show up as recommended app

defaultNamespace required string ​

DefaultNamespace is the default namespace this app should installed in.

readme required string ​

Readme is a longer markdown string that describes the app.

icon required string ​

Icon holds an URL to the app icon

config required object ​

Config is the helm config to use to deploy the helm release

chart required object ​

Chart holds information about a chart that should get deployed

name required string ​

Name is the chart name in the repository

version required string ​

Version is the chart version in the repository

repoURL required string ​

RepoURL is the repo url where the chart can be found

username required string ​

The username that is required for this repository

password required string ​

The password that is required for this repository

insecureSkipTlsVerify required boolean false ​

If tls certificate checks for the chart download should be skipped

manifests required string ​

Manifests holds kube manifests that will be deployed as a chart

bash required object ​

Bash holds the bash script to execute in a container in the target

script required string ​

Script is the script to execute.

image required string ​

Image is the image to use for this app

clusterRole required string ​

ClusterRole is the cluster role to use for this job

values required string ​

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.

parameters required string ​

Parameters are additional helm chart values that will get merged with config and are then used to deploy the helm chart.

annotations required <annotation_name>:string ​

Annotations are extra annotations for this helm release

wait required boolean false ​

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

timeout required string ​

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

parameters required object[] ​

Parameters define additional app parameters that will set helm values

variable required string ​

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

label required string ​

Label is the label to show for this parameter

description required string ​

Description is the description to show for this parameter

type required string ​

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

options required string[] ​

Options are the options if type is enum

min required integer ​

Min is the minimum number if type is number

max required integer ​

Max is the maximum number if type is number

required required boolean false ​

Required specifies if this parameter is required

defaultValue required string ​

DefaultValue is the default value if none is specified

placeholder required string ​

Placeholder shown in the UI

invalidation required string ​

Invalidation regex that if matched will reject the input

validation required string ​

Validation regex that if matched will allow the input

section required string ​

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

streamContainer required object ​

DEPRECATED: Use config.bash instead StreamContainer can be used to stream a containers logs instead of the helm output.

selector required object ​

Label selector for pods. The newest matching pod will be used to stream logs from

matchLabels required <matchLabel_name>:string ​

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.

matchExpressions required object[] ​

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key required string ​

key is the label key that the selector applies to.

operator required string ​

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values required string[] ​

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.

container required string ​

Container is the container name to use

versions required object[] ​

Versions are different app versions that can be referenced

defaultNamespace required string ​

DefaultNamespace is the default namespace this app should installed in.

readme required string ​

Readme is a longer markdown string that describes the app.

icon required string ​

Icon holds an URL to the app icon

config required object ​

Config is the helm config to use to deploy the helm release

chart required object ​

Chart holds information about a chart that should get deployed

name required string ​

Name is the chart name in the repository

version required string ​

Version is the chart version in the repository

repoURL required string ​

RepoURL is the repo url where the chart can be found

username required string ​

The username that is required for this repository

password required string ​

The password that is required for this repository

insecureSkipTlsVerify required boolean false ​

If tls certificate checks for the chart download should be skipped

manifests required string ​

Manifests holds kube manifests that will be deployed as a chart

bash required object ​

Bash holds the bash script to execute in a container in the target

script required string ​

Script is the script to execute.

image required string ​

Image is the image to use for this app

clusterRole required string ​

ClusterRole is the cluster role to use for this job

values required string ​

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.

parameters required string ​

Parameters are additional helm chart values that will get merged with config and are then used to deploy the helm chart.

annotations required <annotation_name>:string ​

Annotations are extra annotations for this helm release

wait required boolean false ​

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

timeout required string ​

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

parameters required object[] ​

Parameters define additional app parameters that will set helm values

variable required string ​

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

label required string ​

Label is the label to show for this parameter

description required string ​

Description is the description to show for this parameter

type required string ​

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

options required string[] ​

Options are the options if type is enum

min required integer ​

Min is the minimum number if type is number

max required integer ​

Max is the maximum number if type is number

required required boolean false ​

Required specifies if this parameter is required

defaultValue required string ​

DefaultValue is the default value if none is specified

placeholder required string ​

Placeholder shown in the UI

invalidation required string ​

Invalidation regex that if matched will reject the input

validation required string ​

Validation regex that if matched will allow the input

section required string ​

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

streamContainer required object ​

DEPRECATED: Use config.bash instead StreamContainer can be used to stream a containers logs instead of the helm output.

selector required object ​

Label selector for pods. The newest matching pod will be used to stream logs from

matchLabels required <matchLabel_name>:string ​

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.

matchExpressions required object[] ​

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key required string ​

key is the label key that the selector applies to.

operator required string ​

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values required string[] ​

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.

container required string ​

Container is the container name to use

version required string ​

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

access required object[] ​

Access holds the access rights for users and teams

name required string ​

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

verbs required string[] ​

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

subresources required string[] ​

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

users required string[] ​

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

teams required string[] ​

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

manifests required string ​

DEPRECATED: Use config instead manifest represents kubernetes resources that will be deployed into the target namespace

helm required object ​

DEPRECATED: Use config instead helm defines the configuration for a helm deployment

name required string ​

Name of the chart to deploy

values required string ​

The additional helm values to use. Expected block string

version required string ​

Version is the version of the chart to deploy

repoUrl required string ​

The repo url to use

username required string ​

The username to use for the selected repository

password required string ​

The password to use for the selected repository

insecure required boolean false ​

Determines if the remote location uses an insecure TLS certificate.

status required object ​

Retrieve: Apps​

You can either use curl or kubectl to retrieve Apps.

Retrieve a list of Apps​

Run the following command to list all Apps:

kubectl get apps.management.loft.sh  -o yaml

Retrieve a single App by name​

Run the following kubectl command to get App my-app:

kubectl get apps.management.loft.sh my-app  -o yaml

Create: App​

You can either use curl or kubectl to create a new App.

Create a file object.yaml with the following contents:

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: {}

Then create the App my-app with:

kubectl create -f object.yaml

Update: App​

You can either use curl or kubectl to update Apps.

Update App​

Run the following command to update App my-app:

kubectl edit apps.management.loft.sh my-app

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

Patch App​

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

Run the following kubectl command to add a new annotation my-annotation: my-value to the App my-app via a patch:

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

Delete: App​

You can either use curl or kubectl to delete Apps.

Run the following command to delete App my-app:

kubectl delete apps.management.loft.sh my-app
Last updated on