Unified Service Tagging cleanup for KSM, global env, version#36678
Unified Service Tagging cleanup for KSM, global env, version#36678JacksonDavenport wants to merge 5 commits into
Conversation
Preview links (active after the
|
janine-c
left a comment
There was a problem hiding this comment.
Looks great! Just some minor writing feedback and some questions about some things I thought we might want to clarify. Let me know if you have any questions or want to chat about any of my comments!
| To get the full range of unified service tagging when using Kubernetes, add environment variables to both the deployment object level and the pod template spec level: | ||
| To get the full range of unified service tagging when using Kubernetes, add the labels to both the parent workload level and the pod template level. | ||
|
|
||
| The `DD_ENV`, `DD_SERVICE`, and `DD_VERSION` environment variables are used by APM enabled applications. These environment variables can be set manually or by the [Kubernetes's downward API][2] as seen below. If you are using the Cluster Agent's [Admission Controller][1] to mutate your pods, those three environment variables are automatically injected to match your labels. |
There was a problem hiding this comment.
| The `DD_ENV`, `DD_SERVICE`, and `DD_VERSION` environment variables are used by APM enabled applications. These environment variables can be set manually or by the [Kubernetes's downward API][2] as seen below. If you are using the Cluster Agent's [Admission Controller][1] to mutate your pods, those three environment variables are automatically injected to match your labels. | |
| The `DD_ENV`, `DD_SERVICE`, and `DD_VERSION` environment variables are used by APM-enabled applications. You can set these environment variables manually or using [Kubernetes's downward API][2] as seen below. If you are using the Cluster Agent's [Admission Controller][1] to mutate your pods, those three environment variables are automatically injected to match your labels. |
This is a bit of a long page; can we add some links when we refer to things below, so we can help users get to the relevant information?
There was a problem hiding this comment.
Added your suggested changes separately for this, but wasn't quite sure if you were looking for something else regarding the links. Those two should resolve to the
- https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#capabilities-of-the-downward-api
- https://docs.datadoghq.com/containers/cluster_agent/admission_controller/?tab=datadogoperator#configure-apm-and-dogstatsd-communication-mode
Otherwise ready for re-review
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
janine-c
left a comment
There was a problem hiding this comment.
Excellent, thanks for the quick edit! One last thing I want to figure out and then we're good to go!
| ##### Full configuration | ||
|
|
||
| To get the full range of unified service tagging when using Kubernetes, add environment variables to both the deployment object level and the pod template spec level: | ||
| To get the full range of unified service tagging in Kubernetes, add the following labels to both the parent workload and the pod template. |
There was a problem hiding this comment.
I find the use of "following" here confusing, because we don't list the labels; we talk about environment variables instead. Can we clarify the relationship between them?
| To get the full range of unified service tagging when using Kubernetes, add environment variables to both the deployment object level and the pod template spec level: | ||
| To get the full range of unified service tagging in Kubernetes, add the following labels to both the parent workload and the pod template. | ||
|
|
||
| The `DD_ENV`, `DD_SERVICE`, and `DD_VERSION` environment variables are used by APM-enabled applications. You can set these environment variables manually or using the [Kubernetes's downward API][2] as seen below. If you are using the Cluster Agent's [Admission Controller][1] to mutate your pods, those three environment variables are automatically injected to match your labels. |
There was a problem hiding this comment.
| The `DD_ENV`, `DD_SERVICE`, and `DD_VERSION` environment variables are used by APM-enabled applications. You can set these environment variables manually or using the [Kubernetes's downward API][2] as seen below. If you are using the Cluster Agent's [Admission Controller][1] to mutate your pods, those three environment variables are automatically injected to match your labels. | |
| The `DD_ENV`, `DD_SERVICE`, and `DD_VERSION` environment variables are used by APM-enabled applications. You can set these environment variables manually or using the [Kubernetes's downward API][2]. If you are using the Cluster Agent's [Admission Controller][1] to mutate your pods, those three environment variables are automatically injected to match your labels. |
Think we're good to remove this reference to "below" if we have a link!
What does this PR do? What is the motivation?
https://datadoghq.atlassian.net/browse/TEEP-6589
Three main changes to this doc relative to each commit:
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
AI assistance
Additional notes
May look at further changes to UST in the SSI doc in the near future, but good to do this first pass of this doc. To make those future changes easier.