Skip to content

Conversation

olivielpeau
Copy link
Member

What does this PR do? What is the motivation?

For Remote Config: I re-used and simplified the enablement instructions documented for APM tracing's RC setup: https://docs.datadoghq.com/tracing/guide/remote_config/

Merge instructions

Merge readiness:

  • Ready for merge

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

@olivielpeau olivielpeau requested a review from a team as a code owner October 9, 2025 17:53
@github-actions github-actions bot added the Guide Content impacting a guide label Oct 9, 2025
Copy link
Contributor

github-actions bot commented Oct 9, 2025

Preview links (active after the build_preview check completes)

Modified Files

Copy link
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

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

Left a few suggestions. Let me know if you have any Qs, and hit me up for re-review when ready!

Comment on lines +38 to +39
- Ensure that your RBAC permissions include [`org_management`][2] and that [Remote Configuration][3] is enabled for your organization.
- Ensure that your RBAC permissions include [`api_keys_write`][4] and that the [Remote Configuration capability is enabled on the API keys][5] used by your Agents. After enabling Remote Configuration on an API key, an Agent restart is required for Remote Configuration enablement to take effect.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Ensure that your RBAC permissions include [`org_management`][2] and that [Remote Configuration][3] is enabled for your organization.
- Ensure that your RBAC permissions include [`api_keys_write`][4] and that the [Remote Configuration capability is enabled on the API keys][5] used by your Agents. After enabling Remote Configuration on an API key, an Agent restart is required for Remote Configuration enablement to take effect.
- Ensure that your RBAC permissions include [`org_management`][2] and [`api_keys_write`][4].
- Enable [Remote Configuration][3] for your organization.
- Enable the Remote Configuration capability on the API keys][5] used by your Agents. After enabling Remote Configuration on an API key, an Agent restart is required for Remote Configuration enablement to take effect.

Copy link
Member Author

Choose a reason for hiding this comment

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

What I mean to communicate with this structure is that, respectively:

  • the org_management permission is only needed to validate that Remote Configuration is enabled for the org (and if not, to enable it)
  • the api_keys_write permission is only needed to validate that the API keys have Remote Configuration enabled (and if not, enable it on them)

but that these permissions are not needed to use the feature, they're only needed during the initial setup.

I'm under the impression that your proposed changes would make this less clear. But I'm also open to suggestions on how to make this more explicit/clear. WDYT?

Copy link

@dmallon1 dmallon1 left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Guide Content impacting a guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants