Skip to content

docs: explain that part-of and name annotations are concatenated #3778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mowies merged 9 commits into from
Oct 29, 2024
Merged

docs: explain that part-of and name annotations are concatenated #3778

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
974e000
integrate.md
Garvit-77 Oct 25, 2024
5ce0942
keptn-app.md
Garvit-77 Oct 25, 2024
fbcd247
Update docs/docs/guides/integrate.md
Garvit-77 Oct 28, 2024
598205c
Update docs/docs/components/lifecycle-operator/keptn-apps.md
Garvit-77 Oct 28, 2024
fac0ef8
Update docs/docs/components/lifecycle-operator/keptn-apps.md
Garvit-77 Oct 28, 2024
c15ba5b
Update docs/docs/components/lifecycle-operator/keptn-apps.md
Garvit-77 Oct 28, 2024
3f04f4f
Update keptn-apps.md
Garvit-77 Oct 29, 2024
728e5b3
Update integrate.md
Garvit-77 Oct 29, 2024
a735ff2
minor beautification
mowies Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/docs/components/lifecycle-operator/keptn-apps.md
View file
Open in desktop
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
View file
Open in desktop
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