Apps in Loft

Apps in Loft allow you to package applications and scripts to share them with other members of your organization.

Working with Apps

Creating Apps

Loft lets you create 3 types of apps:

kubectl Apps

1. Go to the Apps view using the menu on the left
2. Click on the button
3. Use the field Display Name to define the name of this app
4. Use App Definition, ensure that the kubectl tab is selected
5. Use the Kubernetes Manifests textarea to specify Kubernetes YAML Manifests... for this app
6. OPTIONAL: Expand the Parameters section to specify parameters that you can use as placeholders in your Kubernetes manifests (previous step) and users will be asked to fill when deploying this app
7. OPTIONAL: Expand the Display Options section to specify how users will see this app in Loft UI, e.g. specify an icon for the app, define if Loft should mark this app as recommended app, and/or provide a Readme for this app
8. Click on the button at the very bottom

helm Apps

1. Go to the Apps view using the menu on the left
2. Click on the button
3. Use the field Display Name to define the name of this app
4. Use App Definition, ensure that the helm tab is selected
5. Use the Chart Name field to specify the Chart Name
6. Use the Chart Version field to specify the x.x.x version of the chart
7. Use the Chart Repository field to specify the https://chart.repo.url where Loft can find the chart you specified above and specify a username and password below if the chart repository URL is password protected
8. OPTIONAL: Use the Chart Values field to specify the yaml: values for this chart
9. OPTIONAL: Expand the Parameters section to specify parameters that you can use as placeholders in your Kubernetes manifests (previous step) and users will be asked to fill when deploying this app
10. OPTIONAL: Expand the Display Options section to specify how users will see this app in Loft UI, e.g. specify an icon for the app, define if Loft should mark this app as recommended app, and/or provide a Readme for this app
11. Click on the button at the very bottom

bash Apps

1. Go to the Apps view using the menu on the left
2. Click on the button
3. Use the field Display Name to define the name of this app
4. Use App Definition, ensure that the bash tab is selected
5. Use the Kubernetes Manifests textarea to specify Kubernetes YAML Manifests... for this app
6. OPTIONAL: Expand the Parameters section to specify parameters that you can use as placeholders in your Kubernetes manifests (previous step) and users will be asked to fill when deploying this app
7. OPTIONAL: Expand the Display Options section to specify how users will see this app in Loft UI, e.g. specify an icon for the app, define if Loft should mark this app as recommended app, and/or provide a Readme for this app
8. Click on the button at the very bottom

Deploying Apps

Loft users can deploy apps directly to spaces and virtual clusters, or they can use them in templates for spaces and virtual clusters.

Deploy Apps to Spaces

1. Go to the Spaces view using the menu on the left
2. Click on the Space Name to navigate into the namespace
3. Switch to the Apps tab
4. Click on the Install App button
5. In the drawer that appears on the right, use the field Select an App to search for and then select the App you want to deploy (general Helm charts from Artifact Hub or your private Helm repos may be shown here as well)
6. Optional: Specify additional options and parameters for the app as they appear for the respective app (e.g. Helm values)
7. Click on the button at the very bottom

Deploy Apps to Virtual Clusters

1. Go to the Virtual Clusters view using the menu on the left
2. Click on the Virtual Cluster Name to navigate into the virtual cluster
3. Switch to the Apps tab
4. Click on the Install App button
5. In the drawer that appears on the right, use the field Select an App to search for and then select the App you want to deploy (general Helm charts from Artifact Hub or your private Helm repos may be shown here as well)
6. Optional: Specify additional options and parameters for the app as they appear for the respective app (e.g. Helm values)
7. Click on the button at the very bottom

Add Apps to Space Templates

1. Go to the Spaces view using the menu on the left
2. Switch to the Space Templates tab
3. Click the button to create a new space template
4. In the drawer that appears on the right, use the field Display Name to specify a Name for your space template
5. Specify sleep mode settings as well as enforced labels and annotations for the spaces that will be created from this template
6. Expand the Deploy Apps section to specify which apps should be deployed as part of this template
7. On the very bottom, click on the button to create this space template

Add Apps to Virtual Cluster Templates

1. Go to the Virtual Clusters view using the menu on the left
2. Switch to the Virtual Cluster Templates tab
3. Click the button to create a new virtual cluster template
4. In the drawer that appears on the right, use the field Display Name to specify a Name for your virtual cluster template
5. Specify any of these options: labels, annotations, virtual cluster version, helm values and apps to deployed
6. Expand the Space Template section to specify which Space Template should be applied for the underlying host namespace if being created as part of the virtual clusters creation process
7. On the very bottom, click on the button to create this virtual cluster template

Control Access To Apps

Loft makes it easy for users to configure who can instantiate, view, or edit an app.

1. In the Apps view, hover over the app that you want to give someone access to
2. While hovering over the row, you will see buttons appear on the right in the Actions column
3. Click on the button to Edit the app
4. In the drawer that appears on the right, expand the Access To This App section
5. If the user or team is not listed under Users & Teams yet, click the + Rule button to add another row for a new user or team
6. Use the Users & Teams field to select the Users and/or Teams who should get access to this app
7. Use the Permissions field to specify if a user is allows to view, update, ... this app definition
8. On the very bottom, click on the button to save the changes

Configuration

Metadata

Display Name

JSONPath in App CRD:

 spec.displayName (type: string)

Kubernetes Name

JSONPath in App CRD:

 metadata.name (type: string)

Description

JSONPath in App CRD:

 spec.description (type: string)

Labels

JSONPath in App CRD:

 metadata.labels (type: map[string]string)

Annotations

JSONPath in App CRD:

 metadata.annotations (type: map[string]string)

App Definition

Kubectl Manifests

JSONPath in App CRD:

 spec.config.manifests (type: map[string]string)

Helm Charts

Chart Name

JSONPath in App CRD:

 spec.config.chart.name (type: string)

Chart Version

JSONPath in App CRD:

 spec.config.chart.version (type: string)

Chart Repository

JSONPath in App CRD:

 spec.config.chart.repoURL (type: string)

Chart Repository Username

JSONPath in App CRD:

 spec.config.chart.username (type: string)

Chart Repository Password

JSONPath in App CRD:

 spec.config.chart.password (type: string)

Chart Values

JSONPath in App CRD:

 spec.config.values (type: string)

Skip TLS Checks

JSONPath in App CRD:

 spec.config.chart.insecureSkipTlsVerify (type: boolean)

Bash Scripts

JSONPath in App CRD:

 spec.config.manifests (type: string)

Wait

JSONPath in App CRD:

 spec.wait (type: boolean)

Parameters

JSONPath in App CRD:

 spec.parameters (type: AppParameter[])

Display Options

App Icon

JSONPath in App CRD:

 spec.icon (type: string)

Recommended App

JSONPath in App CRD:

 spec.recommendedApp (type: string[])

Readme

JSONPath in App CRD:

 spec.readme (type: string)

Access To App

JSONPath in App CRD:

 spec.access (type: Access[])

CRDs

App

apiVersion	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
kind	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
	object (io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
	object (com.github.loft-sh.api.pkg.apis.management.v1.AppSpec) AppSpec holds the specification
status	object (com.github.loft-sh.api.pkg.apis.management.v1.AppStatus) AppStatus holds the status

{

• "apiVersion": "string",
• "kind": "string",
• "metadata": {

  • "annotations": {

    • "property1": "string",
    • "property2": "string"

    },
  • "clusterName": "string",
  • "creationTimestamp": "2019-08-24T14:15:22Z",
  • "deletionGracePeriodSeconds": 0,
  • "deletionTimestamp": "2019-08-24T14:15:22Z",
  • "finalizers": [

    • "string"

    ],
  • "generateName": "string",
  • "generation": 0,
  • "labels": {

    • "property1": "string",
    • "property2": "string"

    },
  • "managedFields": [

    • {

      • "apiVersion": "string",
      • "fieldsType": "string",
      • "fieldsV1": { },
      • "manager": "string",
      • "operation": "string",
      • "time": "2019-08-24T14:15:22Z"

      }

    ],
  • "name": "string",
  • "namespace": "string",
  • "ownerReferences": [

    • {

      • "apiVersion": "string",
      • "blockOwnerDeletion": true,
      • "controller": true,
      • "kind": "string",
      • "name": "string",
      • "uid": "string"

      }

    ],
  • "resourceVersion": "string",
  • "selfLink": "string",
  • "uid": "string"

  },
• "spec": {

  • "access": [

    • {

      • "subresources": [

        • "string"

        ],
      • "teams": [

        • "string"

        ],
      • "users": [

        • "string"

        ],
      • "verbs": [

        • "string"

        ]

      }

    ],
  • "config": {

    • "annotations": {

      • "property1": "string",
      • "property2": "string"

      },
    • "chart": {

      • "insecureSkipTlsVerify": true,
      • "name": "string",
      • "password": "string",
      • "repoURL": "string",
      • "username": "string",
      • "version": "string"

      },
    • "manifests": "string",
    • "parameters": "string",
    • "values": "string"

    },
  • "description": "string",
  • "displayName": "string",
  • "helm": {

    • "insecure": true,
    • "name": "string",
    • "password": "string",
    • "repoUrl": "string",
    • "username": "string",
    • "values": "string",
    • "version": "string"

    },
  • "icon": "string",
  • "manifests": "string",
  • "owner": {

    • "team": "string",
    • "user": "string"

    },
  • "parameters": [

    • {

      • "defaultValue": "string",
      • "description": "string",
      • "invalidation": "string",
      • "label": "string",
      • "max": 0,
      • "min": 0,
      • "options": [

        • "string"

        ],
      • "placeholder": "string",
      • "required": true,
      • "section": "string",
      • "type": "string",
      • "validation": "string",
      • "variable": "string"

      }

    ],
  • "readme": "string",
  • "recommendedApp": [

    • "string"

    ],
  • "releaseName": "string",
  • "streamContainer": {

    • "container": "string",
    • "selector": {

      • "matchExpressions": [

        • {

          • "key": "string",
          • "operator": "string",
          • "values": [

            • "string"

            ]

          }

        ],
      • "matchLabels": {

        • "property1": "string",
        • "property2": "string"

        }

      }

    },
  • "timeout": "string",
  • "wait": true

  },
• "status": { }

}