Integrate KLT with your applications

How to integrate the Keptn Lifecycle Toolkit into your Kubernetes cluster

The Keptn Lifecycle Toolkit works on top of the default scheduler for the cluster so it can trace all activities of all deployment workloads on the cluster, no matter what tool is used for the deployment. This same mechanism allows KLT to inject pre- and post-deployment checks into all deployment workloads. KLT monitors resources that have been applied into the Kubernetes cluster and reacts if it finds a workload with special annotations/labels. The Keptn Lifecycle Toolkit uses metadata to identify the workloads of interest.

To integrate KLT with your applications, you need to populate the metadata it needs with either Keptn or Kubernetes annotations and labels.

This requires two steps:

Annotate workload(s)

To annotate your Workload, you need to set annotations in your Kubernetes Deployment resource.

Note that you do not need to explicitly create a KeptnWorkload. KLT monitors your Deployments, StatefulSets, and ReplicaSets, and DaemonSets in the namespaces where KLT is enabled. If KLT finds any of hese resources and the resource has either the or the kubernetes recommended labels, it creates a KeptnWorkload resource for the version it detects.

Note: Annotations are not required if you are only using the metrics-operator component of KLT to observe Keptn metrics.

Basic annotations

The basic annotations are: myAwesomeAppName myAwesomeWorkload myAwesomeWorkloadVersion

Alternatively, you can use Kubernetes Recommended Labels to annotate your workload: myAwesomeAppName myAwesomeWorkload myAwesomeWorkloadVersion

Note the following:

  • The Keptn Annotations/Labels take precedence over the Kubernetes recommended labels.
  • If the Workload has no version annotation/labels and the pod has only one container, the Lifecycle Toolkit takes the image tag as version (if it is not “latest”).

This process is demonstrated in the Keptn Lifecycle Toolkit: Installation and KeptnTask Creation in Mintes video.

Pre- and post-deployment checks

Further annotations are necessary to run pre- and post-deployment checks: verify-infrastructure-problems slack-notification,performance-test

The value of these annotations are Keptn resources called KeptnTaskDefinitions. These resources contain re-usable “functions” that can execute before and after the deployment. In this example, before the deployment starts, a check for open problems in your infrastructure is performed. If everything is fine, the deployment continues and afterward, a slack notification is sent with the result of the deployment and a pipeline to run performance tests is invoked. Otherwise, the deployment is kept in a pending state until the infrastructure is capable of accepting deployments again.

A more comprehensive example can be found in our examples folder, where we use Podtato-Head to run some simple pre-deployment checks.

To run the example, use the following commands:

cd ./examples/podtatohead-deployment/
kubectl apply -f .

Afterward, you can monitor the status of the deployment using

kubectl get keptnworkloadinstance -n podtato-kubectl -w

The deployment for a Workload stays in a Pending state until the respective pre-deployment check is successfully completed. Afterwards, the deployment starts and when the workload is deployed, the post-deployment checks start.

Define a Keptn application

A Keptn application defines the workloads to be included in your Keptn Application. It does this by aggregating multiple workloads that belong to a logical app into a single KeptnApp resource.

You have two options:

  • Create a KeptnApp resource that references the workloads that should be included along with any KeptnTaskDefinition and KeptnEvaluationDefinition resources that you want
  • Use the Keptn automatic app discovery capability that enables the observability features provided by the Lifecycle Toolkit for existing applications, without requiring you to manually create any KeptnApp resources

Define KeptnApp manually

You can manually create a YAML file for the KeptnApp resource that references the workloads to be included along with any KeptnTaskDefinition and KeptnEvaluationDefinition resources that you want.

See the keptn-app.yaml file for an example. You see the metadata that names this KeptnApp and identifies the namespace where it lives:

  name: simpleapp
  namespace: simplenode-dev

You can also see the spec.workloads list that defines the workloads to be included and any pre-/post-deployment tasks and evaluations to be performed. In this simple example, we only have one workload and one evaluation defined but most production apps will have multiple workloads, multiple tasks, and multiple evaluations defined.

Use Keptn automatic app discovery

The Keptn Lifecycle Toolkit provides the option to automatically discover KeptnApps, based on the recommended Kubernetes labels, Because of the OpenTelemetry tracing features provided by the Keptn Lifecycle Toolkit, this enables the observability features for existing applications, without creating any Keptn-related custom resources.

To enable the automatic discovery of KeptnApps for your existing applications, the following steps are required:

  1. Enable KLT for the namespace where your application runs following the instructions above

  2. Make sure the following Kubernetes labels and/or annotations are present in the pod template specs of your Workloads (Deployments, StatefulSets, DaemonSets, and ReplicaSets) within your application:

    • Determines the name of the generated KeptnWorkload representing the Workload.

    • Determines the version of the KeptnWorkload representing the Workload.

    • Determines the name of the generated KeptnApp representing your Application.

      All Workloads that share the same value for this label are consolidated into the same KeptnApp.

As an example, consider the following application, consisting of several deployments, which is going to be deployed into a KLT-enabled namespace:

apiVersion: v1
kind: Namespace
  name: podtato-kubectl
  annotations: "enabled"

apiVersion: apps/v1
kind: Deployment
  name: podtato-head-frontend
  namespace: podtato-kubectl
      labels: podtato-head-frontend podtato-head 0.1.0
        - name: podtato-head-frontend
          image: podtato-head-frontend
apiVersion: apps/v1
kind: Deployment
  name: podtato-head-hat
  namespace: podtato-kubectl
  replicas: 1
      labels: podtato-head-hat podtato-head 0.1.1
        - name: podtato-head-hat
          image: podtato-head-hat

Applying these resources results in the creation of the following KeptnApp resource:

kind: KeptnApp
  name: podtato-head
  namespace: podtato-kubectl
  annotations: "klt"
  version: "<version string based on a hash of all containing workloads>"
  - name: podtato-head-frontend
    version: 0.1.0
  - name: podtato-head-hat
    version: 1.1.1

With the KeptnApp resource created, you get observability of your application’s deployments by using the OpenTelemetry tracing features that are provided by the Keptn Lifecycle Toolkit:

Application deployment trace

Last modified 2023-06-21: releasing documentation v0.8.0 (24f0a46)