Add Troubleshooting page

Add a new page to the KLT docs for troubleshooting common problems.

To do this, create a new markdown file in this folder. Adjust the weight parameter so it appears at the correct spot on the menu (that is left up to the PR author to decide, but I suggest somewhere near the bottom of the menu).

Here are some we can start with:

KLT is installed but KLT isn't aware of my workloads

Ensure the namespace you wish to target is annotated correctly.
Ensure the workloads (eg. Deployment manifests) have the 3 required annotation

KLT is causing my pods to be pending

The most likely reason is that you have added a pre-evaluation task to your workload. The pre-evaluation task is either failing or hasn't completed yet.

It is intended behaviour that failing pre-evaluation tasks will prevent a pod being deployed.

Tasks are created as standard Kubernetes Jobs so look at the pod logs for those jobs. For example, if your application was deploying into the prod namespace:

kubectl -n prod get pods
kubectl -n prod logs job/...

Pending Pods After Uninstallation

Note: This particularly affects clusters managed by ArgoCD

I've uninstalled Keptn Lifecycle Toolkit but now I cannot schedule new pods or delete pods.

Reason: ArgoCD does not delete various CRDs and webhooks so various resources remain.

See this issue for cleanup instructions.

I cannot see DORA metrics or OpenTelemetry traces

KLT will automatically generate DORA metrics and OTEL traces for every deployment, but by default it doesn't know where to send them. You need an OpenTelemetry collector installed and configured on the cluster.

The OpenTelemetry observability page contains more information on how to configure this.

keptn / lifecycle-toolkit