AppDeployments

An AppDeployment is a Custom Resource created by DKP with the purpose of deploying applications (platform, DKP catalog and custom applications) in the management cluster, managed clusters, or both. Customers of both Essential and Enterprise products use AppDeployments, regardless of their setup (networked, air-gapped, etc.), and their infrastructure provider.

When installing DKP, an AppDeployment resource is created for each enabled platform application. This AppDeployment resource references a ClusterApp, which then references the repository that contains a concrete declarative and preconfigured setup of an application, usually in the form of a HelmRelease. ClusterApps are cluster-scoped so that these platform applications are deployable to all workspaces or projects.

In the case of DKP catalog and custom applications, the AppDeployment references an App instead of a ClusterApp, which also references the repository containing the installation and deployment information. Apps are namespace-scoped and are meant to only be deployable to the workspace or project in which they have been created.

For example, this is the default AppDeployment of the Kube Prometheus Stack platform application:

apiVersion: apps.kommander.d2iq.io/v1alpha2
kind: AppDeployment
metadata:
  name: kube-prometheus-stack
  namespace: ${WORKSPACE_NAMESPACE}
spec:
  appRef:
    name: kube-prometheus-stack-33.1.5
    kind: ClusterApp

Customization

Prerequisites

Set the WORKSPACE_NAMESPACE environment variable to the name of the workspace’s namespace where the cluster is attached:

export WORKSPACE_NAMESPACE=<your_workspace_namespace>

You are now able to copy the following commands without having to replace the placeholder with your workspace namespace every time you run a command.

Customize your application

If you want to customize an application, or change how a specific app is deployed, you can create a ConfigMap to change or add values to the information that is stored in the HelmRelease. Override the default configuration of an application by setting the configOverrides field on the AppDeployment to that ConfigMap.

This is an example, of how to customize the AppDeployment of Kube Prometheus Stack:

1. Provide the name of a ConfigMap with the custom configuration in the AppDeployment:

   cat <<EOF | kubectl apply -f -
   apiVersion: apps.kommander.d2iq.io/v1alpha2
   kind: AppDeployment
   metadata:
     name: kube-prometheus-stack
     namespace: ${WORKSPACE_NAMESPACE}
   spec:
     appRef:
       name: kube-prometheus-stack-33.1.5
       kind: ClusterApp
     configOverrides:
       name: kube-prometheus-stack-overrides-attached
   EOF
   

2. Create the ConfigMap with the name provided in the previous step, which provides the custom configuration on top of the default configuration:

   cat <<EOF | kubectl apply -f -
   apiVersion: v1
   kind: ConfigMap
   metadata:
     namespace: ${WORKSPACE_NAMESPACE}
     name: kube-prometheus-stack-overrides-attached
   data:
     values.yaml: |
       prometheus:
         prometheusSpec:
           storageSpec:
             volumeClaimTemplate:
               spec:
                 resources:
                   requests:
                     storage: 150Gi
   EOF
   

Deployment scope

In a single-cluster environment with an Essential license, AppDeployments enable customizing any platform application.

In a multi-cluster environment with an Enterprise license, AppDeployments enable workspace-level, and project-level deployment and customization of applications.

More information

Refer to the CLI documentation for more information on how to create, or get an AppDeployment.