Add k8s resource location annotation #33840
Conversation
Preview links (active after the
|
janine-c
left a comment
janine-c
left a comment
There was a problem hiding this comment.
Looks great, thanks for applying my suggestions! It made it easier to do a more thorough review.
For the Helm tab, what would you think of removing the format and just putting the entire code sample in each expander, so the user doesn't have to scroll between the format and the specific values, and can look at the format and what they have to plug into it at the same time? I found while I was editing that it would probably be easier if we did the legwork. I can do this; just wanted to get your thoughts first :)
| Datadog's Source Code and resource mapping allow you to connect cluster resources to the source code | ||
| that was used to deploy them, using Kubernetes annotations. | ||
|
|
||
| `origin.datadoghq.com/location` contains different content depending on how the resources were deployed. |
There was a problem hiding this comment.
| `origin.datadoghq.com/location` contains different content depending on how the resources were deployed. | |
| All commands use a similar structure, but contain different content depending on how the resources were deployed. |
There was a problem hiding this comment.
So here, structure depends not on the command per se, but the way of deployment. There are:
- kubectl (which is cli tool to run, which fits "the command")
- helm (cli tool to run, which fits "the command")
- Flux (GitOps system, working on supporting that now, but for now out of scope of this doc, doesn't fit "the command")
- ArgoCD (GitOps system, working on supporting that now, but for now out of scope of this doc, doesn't fit "the command")
This is why i'm reluctant to accept this suggestion. I think we need something generic here. wdyt?
There was a problem hiding this comment.
Sorry, that's fair! I was trying to think of a more high-level way to put it, since I worried it would be a distraction for users if they felt they had to look specifically for origin.datadoghq.com/location if they didn't already have context for what it is. If there's no way to describe this in a more conceptual way, that's fine, but I do think it would be less distracting if we can think of one.
janine-c
left a comment
janine-c
left a comment
There was a problem hiding this comment.
Looks great, thanks for applying my suggestions! It made it easier to do a more thorough review.
For the Helm tab, what would you think of removing the format and just putting the entire code sample in each expander, so the user doesn't have to scroll between the format and the specific values, and can look at the format and what they have to plug into it at the same time? I found while I was editing that it would probably be easier if we did the legwork. I can do this; just wanted to get your thoughts first :)
I applied it, please take a look. |
janine-c
left a comment
janine-c
left a comment
There was a problem hiding this comment.
Looks great, thanks! Separating out the code samples makes it a lot easier for me to understand all the moving parts. These are mostly suggestions around formatting the code samples, but once this is done we should be good to go. Thanks for your patience with this one!
bitomaxsp
force-pushed
the
dmitry.ponomarev/res-ann
branch
from
fd845b3 to
fb59557
Compare
janine-c
left a comment
janine-c
left a comment
There was a problem hiding this comment.
Great, thank you for working through all those edits with me! Feel free to squash and merge whenever you're ready :)
#33793
What does this PR do? What is the motivation?
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.
Additional notes