-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[DOCS-14295] Add configuring Agent integrations to Fleet Automation docs #37105
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
Draft
evazorro
wants to merge
5
commits into
master
Choose a base branch
from
eva/DOCS-14295-FA-configure-agent-integrations
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
db96b41
First draft of the procedure and background info
evazorro 03dd7ea
Add Configure Agent Integrations to nav and clean up draft
evazorro 57a0881
Tweak intro and Preview banner
evazorro 8e77355
Apply suggestions from code review
evazorro 03bd1eb
Merge branch 'master' into eva/DOCS-14295-FA-configure-agent-integrat…
evazorro File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
content/en/agent/fleet_automation/configure_integrations.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| title: Configure Agent Integrations | ||
| description: "Remotely configure Datadog Agent integrations at scale with Fleet Automation." | ||
| further_reading: | ||
| - link: "/agent/fleet_automation/" | ||
| tag: "Documentation" | ||
| text: "Fleet Automation" | ||
| - link: "/agent/fleet_automation/configure_agents/" | ||
| tag: "Documentation" | ||
| text: "Configure Agents" | ||
| - link: "/api/latest/fleet-automation/" | ||
| tag: "Documentation" | ||
| text: "Fleet Automation API" | ||
| --- | ||
|
|
||
| {{< callout btn_hidden="true" header="Join the Preview!" >}} | ||
| Remote integration configuration is in Preview. | ||
| {{< /callout >}} | ||
|
|
||
| Fleet Automation can deploy, update, and remove [integration][1] configuration files (`conf.d`) on your Agents remotely. Select target Agents by host or tag, choose an integration, and Fleet Automation pushes the configuration change across your fleet. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Remote Configuration][2] enabled for your organization | ||
| - Agent version 7.76 or later | ||
| - Linux VMs (installed with the install script or the Ansible Datadog Role) or Windows VMs | ||
|
|
||
| <div class="alert alert-info"> | ||
| Configuring integrations on Agents in containerized workloads is not supported. | ||
| </div> | ||
|
|
||
| ## Compatibility | ||
|
|
||
| Fleet Automation supports configuring out-of-the-box integrations that have a `conf.d` configuration file, such as Redis, MySQL, and Windows Certificate Store. | ||
|
|
||
| Custom checks are **not** supported. | ||
|
|
||
| ## Configure integrations across multiple Agents | ||
|
|
||
| 1. In Fleet Automation, open the [{{< ui >}}Configuration{{< /ui >}}][3] tab and click {{< ui >}}Configure Agents{{< /ui >}}. | ||
| 1. Scope the configuration to the target Agents. Filter by host information or tags to target a specific group. | ||
| 1. Choose {{< ui >}}Agent integrations{{< /ui >}}. | ||
| 1. Select the integration to configure. | ||
|
|
||
| <div class="alert alert-info">Fleet Automation can detect unconfigured integrations on your hosts. If a process is running on a host that has an available Datadog integration but no active configuration, it appears in the list of <strong>Unconfigured integrations detected on your hosts</strong>. Use this to identify monitoring gaps across your fleet.</div> | ||
|
|
||
| 1. Select an operation (see [How configuration changes are applied](#how-configuration-changes-are-applied) for more information about each operation): | ||
|
|
||
| - {{< ui >}}Add New{{< /ui >}}. Specify the filename for the new configuration file, and fill in the configuration as prompted. | ||
| - {{< ui >}}Edit & Replace{{< /ui >}}. Click {{< ui >}}Select a file{{< /ui >}} and choose the configuration file you want to replace, then fill in the new configuration as prompted. | ||
| - {{< ui >}}Delete{{< /ui >}}. Click {{< ui >}}Select a File to Delete{{< /ui >}} and (tk). | ||
|
|
||
| <div class="alert alert-tip">Toggle between <strong>Visual</strong> and <strong>YAML</strong> mode when filling out the integration configuration. Use <strong>YAML</strong> mode to paste in YAML directly.</div> | ||
|
|
||
| 1. Review the deployment plan. Fleet Automation generates a configuration diff for each affected Agent so you can verify the exact changes. | ||
| 1. Click {{< ui >}}Deploy Configuration{{< /ui >}} to start the deployment. Track progress from the [Deployments page][4]. | ||
|
|
||
| ## How configuration changes are applied | ||
|
|
||
| Each operation applies changes to the integration's `conf.d` configuration file differently: | ||
|
|
||
| - {{< ui >}}Add New{{< /ui >}}: Deploys a new integration configuration file. If a configuration file already exists, it is replaced entirely and the YAML you provide becomes the complete new configuration for that integration on the target Agents. | ||
|
|
||
| - {{< ui >}}Edit & Replace{{< /ui >}}: Applies a targeted change using JSON Merge Patch ([RFC 7386][5]). Only the fields you specify are modified; unmentioned fields remain unchanged. | ||
|
|
||
| <div class="alert alert-warning"> | ||
| Array fields (such as <code>tags</code>) are fully replaced during an Edit & Replace, not merged. Include all desired values in your update. Any values you omit are removed. | ||
| </div> | ||
|
|
||
| - {{< ui >}}Delete{{< /ui >}}: Removes the integration configuration file from the target Agents. | ||
|
|
||
|
|
||
| ## Further Reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: /integrations/ | ||
| [2]: /agent/guide/setup_remote_config | ||
| [3]: https://app.datadoghq.com/fleet/agent-management | ||
| [4]: https://app.datadoghq.com/fleet/deployments | ||
| [5]: https://www.rfc-editor.org/rfc/rfc7386 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue: This step contains an unresolved
(tk)placeholder, leaving the Delete operation instructions incomplete. Users would not know what to do after clicking Select a File to Delete. Please fill in the actual UI steps before publishing.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Waiting on confirmation from PM