Skip to content

Commit

Permalink
docs: explain that part-of and name annotations are concatenated (#3778)
Browse files Browse the repository at this point in the history
Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
  • Loading branch information
Garvit-77 and mowies authored Oct 29, 2024
1 parent 489f593 commit 59a19cc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/docs/components/lifecycle-operator/keptn-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,13 @@ annotation/label is populated:
(in other words, neither the `keptn.sh/app`
or `app.kubernetes.io/part-of` annotation/label is populated),
one `KeptnApp` resource is created automatically for each workload.

> **Note**: Keptn application discovery determines the name of the `KeptnWorkload`
by concatenating the values of the `app.kubernetes.io/name` (or `keptn.sh/workload`)
and `app.kubernetes.io/part-of` (or `keptn.sh/app`) annotations.
This means that when only workload and version annotations/labels are provided — without
the `keptn.sh/app` or `app.kubernetes.io/part-of` annotation — Keptn creates a `KeptnApp`
resource for each `KeptnWorkload`.
Consequently, observability traces will capture individual `KeptnWorkload`
resources, but they will not represent the combined workloads that make up the complete
deployed application.
4 changes: 4 additions & 0 deletions docs/docs/guides/integrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ annotation/label is populated:
and your observability output traces the individual `Keptnworkload` resources
but not the combined workloads that constitute your deployed application.

> **Note**: Keptn application discovery concatenates the values of the `app.kubernetes.io/name` (or
`keptn.sh/workload`) and `app.kubernetes.io/part-of` (or `keptn.sh/app`) annotation to determine the
name of the `KeptnWorkload`.

See
[Keptn Applications and Keptn Workloads](../components/lifecycle-operator/keptn-apps.md)
for architectural information about how `KeptnApp` and `KeptnWorkloads`
Expand Down

0 comments on commit 59a19cc

Please sign in to comment.