Skip to content

Commit f9e9538

Browse files
[DOCS-14295] Add configuring Agent integrations to Fleet Automation docs (#37105)
* First draft of the procedure and background info * Add Configure Agent Integrations to nav and clean up draft * Tweak intro and Preview banner * Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Finalize delete operation * Remove blank line * Omit unnecessary detail * Add tip about configuration summary panel --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 2427a29 commit f9e9538

2 files changed

Lines changed: 89 additions & 2 deletions

File tree

config/_default/menus/main.en.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -560,16 +560,21 @@ menu:
560560
url: agent/fleet_automation/configure_agents
561561
parent: agent_fleet_automation
562562
weight: 802
563+
- name: Configure Agent Integrations
564+
identifier: configure_integrations
565+
url: agent/fleet_automation/configure_integrations
566+
parent: agent_fleet_automation
567+
weight: 803
563568
- name: Upgrade Agents
564569
identifier: upgrade_agents
565570
url: agent/fleet_automation/upgrade_agents
566571
parent: agent_fleet_automation
567-
weight: 803
572+
weight: 804
568573
- name: Upgrade SDKs
569574
identifier: upgrade_sdks
570575
url: agent/fleet_automation/upgrade_sdks
571576
parent: agent_fleet_automation
572-
weight: 804
577+
weight: 805
573578
- name: Troubleshooting
574579
url: agent/troubleshooting/
575580
parent: agent
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Configure Agent Integrations
3+
description: "Remotely configure Datadog Agent integrations at scale with Fleet Automation."
4+
further_reading:
5+
- link: "/agent/fleet_automation/"
6+
tag: "Documentation"
7+
text: "Fleet Automation"
8+
- link: "/agent/fleet_automation/configure_agents/"
9+
tag: "Documentation"
10+
text: "Configure Agents"
11+
- link: "/api/latest/fleet-automation/"
12+
tag: "Documentation"
13+
text: "Fleet Automation API"
14+
---
15+
16+
{{< callout btn_hidden="true" header="Join the Preview!" >}}
17+
Remote integration configuration is in Preview.
18+
{{< /callout >}}
19+
20+
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.
21+
22+
## Prerequisites
23+
24+
- [Remote Configuration][2] enabled for your organization
25+
- Agent version 7.76 or later
26+
- Linux VMs (installed with the install script or the Ansible Datadog Role) or Windows VMs
27+
28+
<div class="alert alert-info">
29+
Configuring integrations on Agents in containerized workloads is not supported.
30+
</div>
31+
32+
## Compatibility
33+
34+
Fleet Automation supports configuring out-of-the-box integrations that have a `conf.d` configuration file, such as Redis, MySQL, and Windows Certificate Store.
35+
36+
Custom checks are **not** supported.
37+
38+
## Configure integrations across multiple Agents
39+
40+
<div class="alert alert-tip">As you step through the configuration wizard, the <strong>Configuration Summary</strong> panel shows your current selected scope of Agents. Use this to check how a change would affect an Agent by previewing configuration diffs on a specific Agent in scope.</a></div>
41+
42+
1. In Fleet Automation, open the [{{< ui >}}Configuration{{< /ui >}}][3] tab and click {{< ui >}}Configure Agents{{< /ui >}}.
43+
1. Scope the configuration to the target Agents. Filter by host information or tags to target a specific group.
44+
1. Choose {{< ui >}}Agent integrations{{< /ui >}}.
45+
1. Select the integration to configure.
46+
47+
<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>
48+
49+
1. Select an operation (see [How configuration changes are applied](#how-configuration-changes-are-applied) for more information about each operation):
50+
51+
- {{< ui >}}Add New{{< /ui >}}. Specify the filename for the new configuration file, and fill in the configuration as prompted.
52+
- {{< 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.
53+
- {{< ui >}}Delete{{< /ui >}}. Click {{< ui >}}Select a File to Delete{{< /ui >}}.
54+
55+
<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>
56+
57+
1. Review the deployment plan. Fleet Automation generates a configuration diff for each affected Agent so you can verify the exact changes.
58+
1. Click {{< ui >}}Deploy Configuration{{< /ui >}} to start the deployment. Track progress from the [Deployments page][4].
59+
60+
## How configuration changes are applied
61+
62+
Each operation applies changes to the integration's `conf.d` configuration file differently:
63+
64+
- {{< 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.
65+
66+
- {{< ui >}}Edit & Replace{{< /ui >}}: Only the fields you specify are modified; unmentioned fields remain unchanged.
67+
68+
<div class="alert alert-warning">
69+
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.
70+
</div>
71+
72+
- {{< ui >}}Delete{{< /ui >}}: Removes the integration configuration file from the target Agents.
73+
74+
## Further Reading
75+
76+
{{< partial name="whats-next/whats-next.html" >}}
77+
78+
[1]: /integrations/
79+
[2]: /agent/guide/setup_remote_config
80+
[3]: https://app.datadoghq.com/fleet/agent-management
81+
[4]: https://app.datadoghq.com/fleet/deployments
82+
[5]: https://www.rfc-editor.org/rfc/rfc7386

0 commit comments

Comments
 (0)