Skip to content

Commit 59a19cc

Browse files
Garvit-77mowies
andauthored
docs: explain that part-of and name annotations are concatenated (#3778)
Co-authored-by: Moritz Wiesinger <[email protected]>
1 parent 489f593 commit 59a19cc

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/docs/components/lifecycle-operator/keptn-apps.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,3 +137,13 @@ annotation/label is populated:
137137
(in other words, neither the `keptn.sh/app`
138138
or `app.kubernetes.io/part-of` annotation/label is populated),
139139
one `KeptnApp` resource is created automatically for each workload.
140+
141+
> **Note**: Keptn application discovery determines the name of the `KeptnWorkload`
142+
by concatenating the values of the `app.kubernetes.io/name` (or `keptn.sh/workload`)
143+
and `app.kubernetes.io/part-of` (or `keptn.sh/app`) annotations.
144+
This means that when only workload and version annotations/labels are provided — without
145+
the `keptn.sh/app` or `app.kubernetes.io/part-of` annotation — Keptn creates a `KeptnApp`
146+
resource for each `KeptnWorkload`.
147+
Consequently, observability traces will capture individual `KeptnWorkload`
148+
resources, but they will not represent the combined workloads that make up the complete
149+
deployed application.

docs/docs/guides/integrate.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ annotation/label is populated:
135135
and your observability output traces the individual `Keptnworkload` resources
136136
but not the combined workloads that constitute your deployed application.
137137

138+
> **Note**: Keptn application discovery concatenates the values of the `app.kubernetes.io/name` (or
139+
`keptn.sh/workload`) and `app.kubernetes.io/part-of` (or `keptn.sh/app`) annotation to determine the
140+
name of the `KeptnWorkload`.
141+
138142
See
139143
[Keptn Applications and Keptn Workloads](../components/lifecycle-operator/keptn-apps.md)
140144
for architectural information about how `KeptnApp` and `KeptnWorkloads`

0 commit comments

Comments
 (0)