Skip to content
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.

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

Create doc for ec2_imdsv2_transition_payload_enabled #27666

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

louis-cqrl
Copy link
Contributor

What does this PR do? What is the motivation?

Create doc for ec2_imdsv2_transition_payload_enabled (related to: DataDog/datadog-agent#33861)

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@louis-cqrl louis-cqrl requested a review from a team as a code owner February 17, 2025 15:11
@github-actions github-actions bot added the FAQ Content impacting a FAQ label Feb 17, 2025
@louis-cqrl louis-cqrl requested review from sgnn7 and vignesh February 17, 2025 15:12
@cswatt
Copy link
Contributor

cswatt commented Feb 18, 2025

I made some edits for compliance with our docs styleguide. I also removed the "What's New" section, because this is a page about IMDSv2 enablement by default—not the new Agent version.

I hope the description of what happens to displayed hostname is clearer now. Let me know if you're ready to merge.

Copy link
Contributor

@sgnn7 sgnn7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@louis-cqrl Left some comments. Mainly we need to refocus to the appropriate target audience for this page and add more details about the possible effects that they may notice.

@github-actions github-actions bot added the Guide Content impacting a guide label Feb 28, 2025
Copy link
Contributor

@cswatt cswatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some styleguide edits. After these are resolved, this should be ready.

### Canonical Hostname

The hostname picked to tag metrics is named the `canonical hostname`, this hostname is the unique ID used to identify your host. Even if your hostname change after upgrading to v7.64.0+, the `canonical hostname` of your host will not change, you can continue to refer to the previous one as before.
Nonetheless you can force the update of your `canonical hostnames` with the `sobotka_allow_override_canonical_name` feature flag.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we sure we want to document this publicly? I haven't really seen us talk about feature flags in the documentation before.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may also lean that we only provide this if necessary. We want to track the hosts with instance IDs where possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

### Canonical Hostname

The hostname picked to tag metrics is named the `canonical hostname`, this hostname is the unique ID used to identify your host. Even if your hostname change after upgrading to v7.64.0+, the `canonical hostname` of your host will not change, you can continue to refer to the previous one as before.
Nonetheless you can force the update of your `canonical hostnames` with the `sobotka_allow_override_canonical_name` feature flag.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may also lean that we only provide this if necessary. We want to track the hosts with instance IDs where possible.

@louis-cqrl louis-cqrl force-pushed the louis-cqrl/add-imdsv2-transition-doc branch from a5334c5 to d1cffa7 Compare March 4, 2025 10:10
@louis-cqrl louis-cqrl requested a review from sgnn7 March 4, 2025 10:11
@vignesh
Copy link
Contributor

vignesh commented Mar 4, 2025

@louis-cqrl thanks for sharing.

Couple minor comments:

  1. Not sure I follow this sentence "Datadog ensures that displayed hostnames refer to instance IDs rather than other detected hostnames in Fleet Automation and on the Infrastructure list." Are we trying to say by in-app we will reference to instance ids or "other hostnames"
  2. If possible can we also provide an example canonical hostname like how it may look?
  3. Can we make sure to update this page as needed, https://docs.datadoghq.com/integrations/guide/aws-integration-troubleshooting/. We seem to heavily reference IMDSv2 in here.

@louis-cqrl
Copy link
Contributor Author

Thx @vignesh for taking a look 🙇🏻

  1. Not sure I follow this sentence "Datadog ensures that displayed hostnames refer to instance IDs rather than other detected hostnames in Fleet Automation and on the Infrastructure list." Are we trying to say by in-app we will reference to instance ids or "other hostnames"

The idea is to tell to customers is that their host will now be shown with their instance ID in the app

  1. If possible can we also provide an example canonical hostname like how it may look?

I do not really know how to express it in a general way since according to various Agent and instance configurations we might fall in very various different hostname shapes (for example for aws linux instances with the hostname OS provider we can either have something as ip-11-11-11-11.ec2.internal or ip-11-11-11-11 or ip-11-11-11-11.us-west-2.compute.internal).
Moreover it might need to enter in very detailed specs that would fall under developer persona detail level that @sgnn7 wanted to avoid in this doc

Maybe adding a more detailed guide on that would more fit in docs.datadoghq.com/integrations/guide/aws-integration-troubleshooting like a section Find your canonical hostname with subsection test if your hostname is your canonical hostname? Any opinion on that ?

  1. Can we make sure to update this page as needed, docs.datadoghq.com/integrations/guide/aws-integration-troubleshooting. We seem to heavily reference IMDSv2 in here.

Sure

@vignesh
Copy link
Contributor

vignesh commented Mar 5, 2025

Thanks LGTM, with one minor edit to:

Let's update to mention that "Datadog ensures that displayed hostnames will refer to instance IDs rather than other detected hostnames in Fleet Automation and on the Infrastructure list." TO "Datadog ensures that displayed hostnames will refer to instance IDs"

Copy link
Contributor

@cswatt cswatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I directly committed some formatting/grammar fixes as well as Vignesh's suggestion. Approving again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FAQ Content impacting a FAQ Guide Content impacting a guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants