Skip to content

(DOCS-10466) Move Remote Config #28710

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

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

(DOCS-10466) Move Remote Config #28710

wants to merge 21 commits into from

Conversation

hestonhoffman
Copy link
Contributor

@hestonhoffman hestonhoffman commented Apr 10, 2025

What does this PR do? What is the motivation?

Rewrites and moves Remote Config to the root navigation level. Most of the file changes are links to the new page location. Here are the files with bigger changes:

content/en/remote_configuration/_index.md link

  • Small rewrite to generalize information

content/en/agent/fleet_automation/setup.md link IS NOW
content/en/agent/fleet_automation/index.md link

  • New page with information specific to remote configuration for Fleet Automation

content/en/agent/guide/_index.md link and layouts/shortcodes/header-list.html

  • New shortcode so I can link to section headers

content/en/tracing/guide/remote_config.md link

  • Moved the information for enabling remote configuration for APM here. Linked to it from a bunch of places

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in 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.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@hestonhoffman hestonhoffman added WORK IN PROGRESS No review needed, it's a wip ;) Do Not Merge Just do not merge this PR :) labels Apr 10, 2025
Copy link
Contributor

github-actions bot commented Apr 10, 2025

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

Modified Files

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Apr 10, 2025
@hestonhoffman hestonhoffman changed the title (DOCS-10466) Update Remote Config (DOCS-10466) Move Remote Config May 4, 2025
@github-actions github-actions bot added the Guide Content impacting a guide label May 5, 2025
@hestonhoffman hestonhoffman added editorial review Waiting on a more in-depth review and removed WORK IN PROGRESS No review needed, it's a wip ;) labels May 5, 2025
@hestonhoffman hestonhoffman marked this pull request as ready for review May 5, 2025 23:14
@hestonhoffman hestonhoffman requested review from a team as code owners May 5, 2025 23:14
@hestonhoffman hestonhoffman requested review from a team as code owners May 5, 2025 23:14
@iadjivon iadjivon self-assigned this May 7, 2025
- Your configuration changes submitted through the Datadog UI are signed and validated by the requesting Datadog component, verifying the integrity of the configuration.

## Enabling Remote Configuration

Copy link
Contributor

@iadjivon iadjivon May 7, 2025

Choose a reason for hiding this comment

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

I see you moved the prerequisites to links in the table... what do you think of adding the Agent version be added to the table as well to create a compatibility table of sort?

I suggest this because we haven't yet mentioned the minimum Agent version for which Remote Config works.


## Opting out of Remote Configuration

Instead of disabling Remote Configuration globally, Datadog recommends opting out for specific Datadog products. For more information, see [the documentation for the relevant product](#product-specific-configuration).
Copy link
Contributor

Choose a reason for hiding this comment

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

I can foresee clients asking support about the option to disable globally, for one reason or the other. I propose adding a bit of the previous content in this section:

Disable Remote Configuration at the organization level on the Remote Configuration page. This disables Datadog components across your organization to receive configurations from Datadog. You need the org_management permission to disable Remote Configuration at the organization level.

1. Select an existing API key or create a new API key, and enable the Remote Configuration capability on the key if it is not already enabled.

{{<img src="agent/remote_config/RC_Key_updated.png" alt="API Key properties with Remote Configuration capability Enable button." width="90%" style="center">}}
1. Restart your Agent.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is only needed if the agent API key was changed in the previous step. Unsure if it's needed if the key was not changed but Remote Config had to be enabled.


### Agent Remote Configuration status

Gain visibility into the Remote Configuration status of your Agent through the [Remote Configuration UI][3].
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't it better to send them to Fleet directly?


#### At the Organization level

Disable Remote Configuration at the organization level on the [Remote Configuration][3] page. This disables Datadog components across your organization to receive configurations from Datadog. You need the [`org_management`][1] permission to disable Remote Configuration at the organization level.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we say that doing this will also disable other Remote Config enabled products and link to the list?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I'd forgotten this paragraph was in here. We're trying to dissuade users from disabling globally, so I'll probably just remove this

---

{{< site-region region="gov" >}}
<div class="alert alert-warning">Remote Configuration is not supported for your selected <a href="/getting_started/site">Datadog site</a> ({{< region-param key="dd_site_name" >}}).</div>
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to remember to remove this when launching in Gov (planned for towards the end of the year)

text: "Centrally govern and remotely manage Datadog Agents at scale with Fleet Automation"
---

To ensure you have access to all Fleet Automation features, upgrade your Agents to version 7.47.0 or later and follow the instructions below to set up Remote Configuration for your Agents.
Copy link
Contributor

Choose a reason for hiding this comment

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

We should also add a warning here for gov

- Observability Pipeline Workers
- Private action runners and serverless container cloud services such as AWS Fargate.

Remote Configuration does not support serverless container managed apps, such as AWS App Runner, Azure Container Apps, Google Cloud Run; or functions deployed with container packaging, such as AWS Lambda, Azure Functions, and Google Cloud Functions.
Copy link
Contributor

Choose a reason for hiding this comment

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

@mellon85 is this completely accurate?

Comment on lines +67 to +70
App and API Protection (AAP)
: - 1-click AAP activation: Enable AAP in 1-click from the Datadog UI.
: - In-App attack patterns updates: Receive the newest Web Application Firewall (WAF) attack patterns automatically as Datadog releases them, following newly disclosed vulnerabilities or attack vectors.
: - Protect: Block attackers' IPs, authenticated users, and suspicious requests that are flagged in AAP Security Signals and Traces temporarily or permanently through the Datadog UI.
Copy link
Contributor

Choose a reason for hiding this comment

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

missing links to products documentation

: - Protect: Block attackers' IPs, authenticated users, and suspicious requests that are flagged in AAP Security Signals and Traces temporarily or permanently through the Datadog UI.

Application Performance Monitoring (APM)
: - Configuration at runtime (Beta): Change a service's trace sampling rate, Log Injection enablement, and HTTP header tags from within the Software Catalog UI, without having to restart the service. Read [Configuration at Runtime][22] for more information.
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
: - Configuration at runtime (Beta): Change a service's trace sampling rate, Log Injection enablement, and HTTP header tags from within the Software Catalog UI, without having to restart the service. Read [Configuration at Runtime][22] for more information.
: - Configuration at runtime (Preview): Change a service's trace sampling rate, Log Injection enablement, and HTTP header tags from within the Software Catalog UI, without having to restart the service. Read [Configuration at Runtime][22] for more information.


Application Performance Monitoring (APM)
: - Configuration at runtime (Beta): Change a service's trace sampling rate, Log Injection enablement, and HTTP header tags from within the Software Catalog UI, without having to restart the service. Read [Configuration at Runtime][22] for more information.
: - Remotely set Agent sampling rate (Public Beta): Remotely configure the Datadog Agent to change its trace sampling rates and set rules to scale your organization's trace ingestion according to your needs, without needing to restart your Datadog Agent.
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
: - Remotely set Agent sampling rate (Public Beta): Remotely configure the Datadog Agent to change its trace sampling rates and set rules to scale your organization's trace ingestion according to your needs, without needing to restart your Datadog Agent.
: - Remotely set Agent sampling rate (Preview): Remotely configure the Datadog Agent to change its trace sampling rates and set rules to scale your organization's trace ingestion according to your needs, without needing to restart your Datadog Agent.

[3]: /account_management/rbac/permissions/
[4]: /account_management/rbac/permissions#api-and-application-keys
[5]: https://app.datadoghq.com/organization-settings/remote-config
[6]: /agent/configuration/network
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
[6]: /agent/configuration/network
[6]: /agent/configuration/network
[7]: /tracing/trace_collection/runtime_config/#supported-configuration-options

Added the supported-configuration-options link here.

## Prerequisites

- [Datadog Agent][2] 7.47.0 or higher installed on your hosts or containers.
- Upgrade your tracing libraries to a Remote Configuration-compatible version. For more information, see the [Supported configuration options](#supported-configuration-options) section.
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
- Upgrade your tracing libraries to a Remote Configuration-compatible version. For more information, see the [Supported configuration options](#supported-configuration-options) section.
- Upgrade your tracing libraries to a Remote Configuration-compatible version. For more information, see the [Supported configuration options][7] section.

The (#supported-configuration-options) section is no longer part of this page. Should it be linked to this page?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Do Not Merge Just do not merge this PR :) editorial review Waiting on a more in-depth review Guide Content impacting a guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants