App
Apps in the platform 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.
App example​
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
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 ​
If true, this reference points to the managing controller.
controller
required boolean ​blockOwnerDeletion
required boolean ​
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 ​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 should be displayed in the UI
displayName
required string ​description
required string ​
Description describes an app
description
required string ​owner
required object ​
Owner holds the owner of this object
owner
required object ​clusters
required string[] ​
Clusters are the clusters this app can be installed in.
clusters
required string[] ​recommendedApp
required string[] ​
RecommendedApp specifies where this app should show up as recommended app
recommendedApp
required string[] ​defaultNamespace
required string ​
DefaultNamespace is the default namespace this app should installed
in.
defaultNamespace
required string ​readme
required string ​
Readme is a longer markdown string that describes the app.
readme
required string ​icon
required string ​
Icon holds an URL to the app icon
icon
required string ​config
required object ​
Config is the helm config to use to deploy the helm release
config
required object ​chart
required object ​
Chart holds information about a chart that should get deployed
chart
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 ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​manifests
required string ​
Manifests holds kube manifests that will be deployed as a chart
manifests
required string ​bash
required object ​
Bash holds the bash script to execute in a container in the target
bash
required object ​script
required string ​
Script is the script to execute.
script
required string ​image
required string ​
Image is the image to use for this app
image
required string ​clusterRole
required string ​
ClusterRole is the cluster role to use for this job
clusterRole
required string ​podSecurityContext
required object ​
PodSecurityContext for the bash pod.
podSecurityContext
required object ​seLinuxOptions
required object ​
The SELinux context to be applied to all containers.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in SecurityContext. If set in
both SecurityContext and PodSecurityContext, the value specified in SecurityContext
takes precedence for that container.
Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
The Windows specific settings applied to all containers.
If unspecified, the options within a container's SecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUserName
required string ​hostProcess
required boolean ​
HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.
hostProcess
required boolean ​runAsUser
required integer ​
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsUser
required integer ​runAsGroup
required integer ​
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
required boolean ​supplementalGroups
required integer[] ​
A list of groups applied to the first process run in each container, in
addition to the container's primary GID and fsGroup (if specified). If
the SupplementalGroupsPolicy feature is enabled, the
supplementalGroupsPolicy field determines whether these are in addition
to or instead of any group memberships defined in the container image.
If unspecified, no additional groups are added, though group memberships
defined in the container image may still be used, depending on the
supplementalGroupsPolicy field.
Note that this field cannot be set when spec.os.name is windows.
supplementalGroups
required integer[] ​supplementalGroupsPolicy
required string ​
Defines how supplemental groups of the first container processes are calculated.
Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
and the container runtime must implement support for this feature.
Note that this field cannot be set when spec.os.name is windows.
TODO: update the default value to "Merge" when spec.os.name is not windows in v1.34
supplementalGroupsPolicy
required string ​fsGroup
required integer ​
A special supplemental group that applies to all containers in a pod.
Some volume types allow the Kubelet to change the ownership of that volume
to be owned by the pod:
- The owning GID will be the FSGroup
- The setgid bit is set (new files created in the volume will be owned by FSGroup)
- The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume.
Note that this field cannot be set when spec.os.name is windows.
fsGroup
required integer ​sysctls
required object[] ​
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Note that this field cannot be set when spec.os.name is windows.
sysctls
required object[] ​fsGroupChangePolicy
required string ​
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
before being exposed inside Pod. This field will only apply to
volume types which support fsGroup based ownership(and permissions).
It will have no effect on ephemeral volume types such as: secret, configmaps
and emptydir.
Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
Note that this field cannot be set when spec.os.name is windows.
fsGroupChangePolicy
required string ​seccompProfile
required object ​
The seccomp options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
seccompProfile
required object ​type
required string ​
type indicates which kind of seccomp profile will be applied.
Valid options are:
Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.
localhostProfile
required string ​appArmorProfile
required object ​
appArmorProfile is the AppArmor options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
appArmorProfile
required object ​type
required string ​
type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".
localhostProfile
required string ​seLinuxChangePolicy
required string ​
seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime.
This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with -o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
Note that this field cannot be set when spec.os.name is windows.
seLinuxChangePolicy
required string ​-o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.securityContext
required object ​
SecurityContext for the bash container.
securityContext
required object ​capabilities
required object ​
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.
capabilities
required object ​privileged
required boolean ​
Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows.
privileged
required boolean ​seLinuxOptions
required object ​
The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUserName
required string ​hostProcess
required boolean ​
HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.
hostProcess
required boolean ​runAsUser
required integer ​
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
runAsUser
required integer ​runAsGroup
required integer ​
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
required boolean ​readOnlyRootFilesystem
required boolean ​
Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows.
readOnlyRootFilesystem
required boolean ​allowPrivilegeEscalation
required boolean ​
AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
- run as Privileged
- has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
allowPrivilegeEscalation
required boolean ​procMount
required string ​
procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows.
procMount
required string ​seccompProfile
required object ​
The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.
seccompProfile
required object ​type
required string ​
type indicates which kind of seccomp profile will be applied.
Valid options are:
Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.
localhostProfile
required string ​appArmorProfile
required object ​
appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.
appArmorProfile
required object ​type
required string ​
type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".
localhostProfile
required string ​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.
values
required string ​parameters
required string ​
Parameters are additional helm chart values that will get merged
with config and are then used to deploy the helm chart.
parameters
required string ​annotations
required object ​
Annotations are extra annotations for this helm release
annotations
required object ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
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, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
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 ​
Required specifies if this parameter is required
required
required boolean ​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 ​streamContainer
required object ​
DEPRECATED: Use config.bash instead
StreamContainer can be used to stream a containers logs instead of the helm output.
streamContainer
required object ​selector
required object ​
Label selector for pods. The newest matching pod will be used to stream logs from
selector
required object ​matchLabels
required object ​
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 ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​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.
values
required string[] ​container
required string ​
Container is the container name to use
container
required string ​versions
required object[] ​
Versions are different app versions that can be referenced
versions
required object[] ​defaultNamespace
required string ​
DefaultNamespace is the default namespace this app should installed
in.
defaultNamespace
required string ​readme
required string ​
Readme is a longer markdown string that describes the app.
readme
required string ​icon
required string ​
Icon holds an URL to the app icon
icon
required string ​config
required object ​
Config is the helm config to use to deploy the helm release
config
required object ​chart
required object ​
Chart holds information about a chart that should get deployed
chart
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 ​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean ​manifests
required string ​
Manifests holds kube manifests that will be deployed as a chart
manifests
required string ​bash
required object ​
Bash holds the bash script to execute in a container in the target
bash
required object ​script
required string ​
Script is the script to execute.
script
required string ​image
required string ​
Image is the image to use for this app
image
required string ​clusterRole
required string ​
ClusterRole is the cluster role to use for this job
clusterRole
required string ​podSecurityContext
required object ​
PodSecurityContext for the bash pod.
podSecurityContext
required object ​seLinuxOptions
required object ​
The SELinux context to be applied to all containers.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in SecurityContext. If set in
both SecurityContext and PodSecurityContext, the value specified in SecurityContext
takes precedence for that container.
Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
The Windows specific settings applied to all containers.
If unspecified, the options within a container's SecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUserName
required string ​hostProcess
required boolean ​
HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.
hostProcess
required boolean ​runAsUser
required integer ​
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsUser
required integer ​runAsGroup
required integer ​
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
required boolean ​supplementalGroups
required integer[] ​
A list of groups applied to the first process run in each container, in
addition to the container's primary GID and fsGroup (if specified). If
the SupplementalGroupsPolicy feature is enabled, the
supplementalGroupsPolicy field determines whether these are in addition
to or instead of any group memberships defined in the container image.
If unspecified, no additional groups are added, though group memberships
defined in the container image may still be used, depending on the
supplementalGroupsPolicy field.
Note that this field cannot be set when spec.os.name is windows.
supplementalGroups
required integer[] ​supplementalGroupsPolicy
required string ​
Defines how supplemental groups of the first container processes are calculated.
Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
and the container runtime must implement support for this feature.
Note that this field cannot be set when spec.os.name is windows.
TODO: update the default value to "Merge" when spec.os.name is not windows in v1.34
supplementalGroupsPolicy
required string ​fsGroup
required integer ​
A special supplemental group that applies to all containers in a pod.
Some volume types allow the Kubelet to change the ownership of that volume
to be owned by the pod:
- The owning GID will be the FSGroup
- The setgid bit is set (new files created in the volume will be owned by FSGroup)
- The permission bits are OR'd with rw-rw----
If unset, the Kubelet will not modify the ownership and permissions of any volume.
Note that this field cannot be set when spec.os.name is windows.
fsGroup
required integer ​sysctls
required object[] ​
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Note that this field cannot be set when spec.os.name is windows.
sysctls
required object[] ​fsGroupChangePolicy
required string ​
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
before being exposed inside Pod. This field will only apply to
volume types which support fsGroup based ownership(and permissions).
It will have no effect on ephemeral volume types such as: secret, configmaps
and emptydir.
Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
Note that this field cannot be set when spec.os.name is windows.
fsGroupChangePolicy
required string ​seccompProfile
required object ​
The seccomp options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
seccompProfile
required object ​type
required string ​
type indicates which kind of seccomp profile will be applied.
Valid options are:
Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.
localhostProfile
required string ​appArmorProfile
required object ​
appArmorProfile is the AppArmor options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
appArmorProfile
required object ​type
required string ​
type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".
localhostProfile
required string ​seLinuxChangePolicy
required string ​
seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
Valid values are "MountOption" and "Recursive".
"Recursive" means relabeling of all files on all Pod volumes by the container runtime.
This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
"MountOption" mounts all eligible Pod volumes with -o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.
If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
and "Recursive" for all other volumes.
This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
Note that this field cannot be set when spec.os.name is windows.
seLinuxChangePolicy
required string ​-o context
mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.securityContext
required object ​
SecurityContext for the bash container.
securityContext
required object ​capabilities
required object ​
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.
capabilities
required object ​privileged
required boolean ​
Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows.
privileged
required boolean ​seLinuxOptions
required object ​
The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container. May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
seLinuxOptions
required object ​user
required string ​
User is a SELinux user label that applies to the container.
user
required string ​role
required string ​
Role is a SELinux role label that applies to the container.
role
required string ​type
required string ​
Type is a SELinux type label that applies to the container.
type
required string ​level
required string ​
Level is SELinux level label that applies to the container.
level
required string ​windowsOptions
required object ​
The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
windowsOptions
required object ​gmsaCredentialSpecName
required string ​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string ​gmsaCredentialSpec
required string ​
GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.
gmsaCredentialSpec
required string ​runAsUserName
required string ​
The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUserName
required string ​hostProcess
required boolean ​
HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.
hostProcess
required boolean ​runAsUser
required integer ​
The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
runAsUser
required integer ​runAsGroup
required integer ​
The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
runAsGroup
required integer ​runAsNonRoot
required boolean ​
Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
required boolean ​readOnlyRootFilesystem
required boolean ​
Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows.
readOnlyRootFilesystem
required boolean ​allowPrivilegeEscalation
required boolean ​
AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
- run as Privileged
- has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
allowPrivilegeEscalation
required boolean ​procMount
required string ​
procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows.
procMount
required string ​seccompProfile
required object ​
The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.
seccompProfile
required object ​type
required string ​
type indicates which kind of seccomp profile will be applied.
Valid options are:
Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.
localhostProfile
required string ​appArmorProfile
required object ​
appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.
appArmorProfile
required object ​type
required string ​
type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
type
required string ​localhostProfile
required string ​
localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".
localhostProfile
required string ​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.
values
required string ​parameters
required string ​
Parameters are additional helm chart values that will get merged
with config and are then used to deploy the helm chart.
parameters
required string ​annotations
required object ​
Annotations are extra annotations for this helm release
annotations
required object ​wait
required boolean ​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean ​timeout
required string ​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
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, number and password
type
required string ​options
required string[] ​
Options is a slice of strings, where each string represents a mutually exclusive choice.
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 ​
Required specifies if this parameter is required
required
required boolean ​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 ​streamContainer
required object ​
DEPRECATED: Use config.bash instead
StreamContainer can be used to stream a containers logs instead of the helm output.
streamContainer
required object ​selector
required object ​
Label selector for pods. The newest matching pod will be used to stream logs from
selector
required object ​matchLabels
required object ​
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 ​matchExpressions
required object[] ​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] ​key
required string ​
key is the label key that the selector applies to.
key
required string ​operator
required string ​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string ​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.
values
required string[] ​container
required string ​
Container is the container name to use
container
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[] ​manifests
required string ​
DEPRECATED: Use config instead
manifest represents kubernetes resources that will be deployed into the target namespace
manifests
required string ​helm
required object ​
DEPRECATED: Use config instead
helm defines the configuration for a helm deployment
helm
required object ​name
required string ​
Name of the chart to deploy
name
required string ​values
required string ​
The additional helm values to use. Expected block string
values
required string ​version
required string ​
Version is the version of the chart to deploy
version
required string ​repoUrl
required string ​
The repo url to use
repoUrl
required string ​username
required string ​
The username to use for the selected repository
username
required string ​password
required string ​
The password to use for the selected repository
password
required string ​insecure
required boolean ​
Determines if the remote location uses an insecure
TLS certificate.
insecure
required boolean ​status
required object ​
status
required object ​Retrieve: Apps​
You can either use curl or kubectl to retrieve Apps.
- kubectl
- curl
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
Retrieve a list of Apps​
Run the following curl command to list all Apps:
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/apps" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Get a single App by name​
Run the following curl command to get App my-app
:
# Exchange my-app in the url below with the name of the App
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/apps/my-app" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Create: App​
You can either use curl or kubectl to create a new App.
- kubectl
- curl
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
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: {}
Run the following curl command to create a new App my-app
:
curl -s -X POST --insecure \
"https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/apps" \
--data-binary "$(cat object.yaml)" \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY"
Update: App​
You can either use curl or kubectl to update Apps.
- kubectl
- curl
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"}]'
Update App​
First retrieve the current object into a file object.yaml
. This could look like:
apiVersion: management.loft.sh/v1
kind: App
metadata:
creationTimestamp: "2023-04-03T00:00:00Z"
generation: 12
name: my-app
resourceVersion: "66325905"
uid: af5f9f0f-8ab9-4b4b-a595-a95a5921f3c2
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: {}
Run the following curl command to update a single App my-app
:
# Replace the my-app in the url below with the name of the App you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/apps/my-app" \
-X PUT --insecure \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data-binary "$(cat object.yaml)"
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 curl command to add a new annotation my-annotation: my-value
to the App my-app
via a patch:
# Replace the my-app in the url below with the name of the App you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/apps/my-app" \
-X PATCH --insecure \
-H "Content-Type: application/json-patch+json" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'
Delete: App​
You can either use curl or kubectl to delete Apps.
- kubectl
- curl
Run the following command to delete App my-app
:
kubectl delete apps.management.loft.sh my-app
Run the following curl command to delete App my-app
:
# Replace the my-app in the url below with the name of the App you want to delete
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/apps/my-app" \
-X DELETE --insecure \
-H "Authorization: Bearer $ACCESS_KEY"