Skip to content

Commit

Permalink
docs: add info and example about metadata k/v list (keptn#3287)
Browse files Browse the repository at this point in the history
Signed-off-by: vickysomtee <[email protected]>
  • Loading branch information
mowies authored and Vickysomtee committed Apr 22, 2024
1 parent e88820e commit 8061560
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/docs/guides/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,14 @@ To enrich workload traces with custom metadata, use the
`keptn.sh/metadata` annotation in your
[Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment)
resource.
The values specified in the annotation
are added as key-value attributes to the workload trace.
The comma-separated list of key-value pairs specified in the annotation
is added as key-value attributes to the workload trace.

Modify your workload (for example your YAML file containing a Deployment)
adding an annotation with any metadata you prefer,
for instance, to add information about a stage, you could add:
`keptn.sh/metadata: "stage=dev"`.
adding an annotation with any metadata you prefer.
If you want to add multiple key-value pairs, separate them with commas.
For instance, to add information about a stage and owning team, you could add:
`keptn.sh/metadata: "stage=dev,team=my-team"`.

To see the changes Keptn must redeploy: increment the `app.kubernetes.io/version` value
(ex. if you are following our getting started guide, change the version
Expand Down

0 comments on commit 8061560

Please sign in to comment.