Skip to content

Commit 25ee028

Browse files
iadjivoncswatt
andauthored
Upgrading Agent Docs Changes (#29992)
* combined pages * added the remote automation bit * added the remote automation bit * final touches before review * one last change * changes from the docs * added further readings * vale edits * changes from the PM * title capitalization * capitalized FA in the title * changes made from review * changes made from review * changes made from review * Update upgrade_between_minor_versions.md --------- Co-authored-by: cecilia saixue watt <cecilia.watt@datadoghq.com>
1 parent a15828a commit 25ee028

File tree

1 file changed

+83
-17
lines changed

1 file changed

+83
-17
lines changed
Lines changed: 83 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,113 @@
11
---
2-
title: Upgrade Between Datadog Agent Minor Versions
2+
title: Upgrade your Datadog Agent
33
aliases:
44
- /agent/faq/upgrade-between-agent-minor-versions
55
- /agent/guide/upgrade-between-agent-minor-versions
66
- /agent/versions/upgrade_between_agent_minor_versions/
7+
- /agent/guide/upgrade
8+
further_reading:
9+
- link: "/agent/troubleshooting/"
10+
tag: "Documentation"
11+
text: "Agent Troubleshooting"
12+
- link: "/agent/basic_agent_usage/"
13+
tag: "Documentation"
14+
text: "Basic Agent Usage"
715
---
816

17+
## Overview
18+
Datadog recommends you update your Datadog Agent with every [minor and patch][6] release. This guide walks you through how to roll out a new Agent version across your hosts in a few clicks.
19+
20+
921
## Upgrade between minor versions of the Agent
22+
### Upgrade remotely with Fleet Automation
1023

11-
{{< tabs >}}
12-
{{% tab "Linux" %}}
24+
[Fleet Automation][8] enables you to centrally manage your fleet of Datadog Agents. Fleet Automation includes [Remote Agent Management][2], which allows you to remotely upgrade Agents across non-containerized Linux and Windows environments. See [Remote Agent Management: Upgrade your Datadog Agents][7].
1325

14-
The recommended way to upgrade between minor versions of the Agent is to use the `install_script_agent7.sh` script. The following commands work on all supported Linux distributions.
26+
### Upgrade with script or configuration management tooling
27+
Follow the [in-app instructions][4] to upgrade Datadog Agents across container, host-based, and Infrastructure as Code (IaC) tool-managed environments. The guided flow generates an Agent installation command tailored to your platform for upgrading the Agent. By default, the command installs the latest version of the Agent. To upgrade to a specific minor version, set `DD_AGENT_MINOR_VERSION=<TARGET_MINOR>` before running the script.
1528

16-
Upgrading to a given Agent minor version:
1729

18-
: `DD_AGENT_MINOR_VERSION=<target_minor> bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"`
30+
## Upgrade between major versions of the Agent
1931

20-
Upgrading to the latest Agent minor version:
32+
<div class="alert alert-info">
33+
Agent 7 only supports Python 3 custom checks. <a href="/agent/guide/python-3">Verify if your custom checks are Python 3 compatible</a> before upgrading to Agent 7.
34+
</div>
35+
36+
### Upgrade from Agent 6 to Agent 7
37+
38+
{{< tabs >}}
39+
{{% tab "Linux" %}}
2140

22-
: `bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"`
41+
Run the following Agent installation command to upgrade your Agent from version 6 to version 7:
42+
43+
The following command works on Amazon Linux, CentOS, Debian, Fedora, Red Hat, Ubuntu, and SUSE:
44+
: `DD_API_KEY="<DATADOG_API_KEY>" bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"`
2345

2446
{{% /tab %}}
2547
{{% tab "Windows" %}}
2648

27-
Download and install the specific version's installation package.
28-
29-
URL to download a specific Agent minor version
49+
1. [Download the Datadog Agent installer][1].
50+
2. Run the installer (as **Administrator**) by opening `datadog-agent-7-latest.amd64.msi`.
51+
3. Follow the prompts, accept the license agreement, and enter your [Datadog API key][2].
52+
4. When the install finishes, you are given the option to launch the Datadog Agent Manager.
3053

31-
: `https://ddagent-windows-stable.s3.amazonaws.com/ddagent-cli-7.<minor_version>.<bugfix_version>.msi`
54+
**Note**: Links to all available versions of the Windows Installer are [provided in JSON format][3].
3255

56+
[1]: https://ddagent-windows-stable.s3.amazonaws.com/datadog-agent-7-latest.amd64.msi
57+
[2]: https://app.datadoghq.com/organization-settings/api-keys
58+
[3]: https://ddagent-windows-stable.s3.amazonaws.com/installers_v2.json
3359
{{% /tab %}}
3460
{{% tab "MacOS" %}}
3561

36-
The recommended way to upgrade between minor version of the Agent is to use the `install_mac_os.sh` script. The following commands work on all supported MacOS versions.
62+
Run the Agent installation command with the environment variable `DD_AGENT_MAJOR_VERSION=7` to upgrade your Agent from version 6 to version 7:
3763

38-
Upgrading to a given Agent minor version:
64+
```shell
65+
DD_AGENT_MAJOR_VERSION=7 DD_API_KEY="<DATADOG_API_KEY>" bash -c "$(curl -L https://install.datadoghq.com/scripts/install_mac_os.sh)"
66+
```
3967

40-
: `DD_AGENT_MINOR_VERSION=<target_minor> bash -c "$(curl -L https://install.datadoghq.com/scripts/install_mac_os.sh)"`
68+
{{% /tab %}}
69+
{{< /tabs >}}
4170

42-
Upgrading to the latest Agent minor version:
71+
### Upgrade from Agent 5 to Agent 7
72+
73+
{{< tabs >}}
74+
{{% tab "Linux" %}}
4375

44-
: `bash -c "$(curl -L https://install.datadoghq.com/scripts/install_mac_os.sh)"`
76+
Run the Agent installation command with the environment variable `DD_UPGRADE="true"` to upgrade your Agent from version 5 to version 7. The Agent v7 installer can automatically convert v5 configurations during the upgrade:
77+
78+
The following command works on Amazon Linux, CentOS, Debian, Fedora, Red Hat, Ubuntu, and SUSE:
79+
: `DD_UPGRADE="true" bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"`
80+
81+
{{% /tab %}}
82+
{{% tab "Windows" %}}
83+
84+
1. Upgrade your Agent to version 6 following the [manual upgrade process][1].
85+
2. Follow the [From Agent v6 to Agent v7](#from-agent-v6-to-agent-v7) upgrade instructions.
86+
87+
[1]: /agent/versions/upgrade_to_agent_v6/?tab=windows#manual-upgrade
88+
{{% /tab %}}
89+
{{% tab "MacOS" %}}
90+
91+
Run the Agent installation command with the environment variable `DD_AGENT_MAJOR_VERSION=7` and `DD_UPGRADE="true"` to upgrade your Agent from version 5 to version 7. The Agent v7 installer can automatically convert v5 configurations during the upgrade:
92+
93+
```shell
94+
DD_UPGRADE="true" DD_AGENT_MAJOR_VERSION=7 bash -c "$(curl -L https://install.datadoghq.com/scripts/install_mac_os.sh)"
95+
```
4596

4697
{{% /tab %}}
4798
{{< /tabs >}}
99+
100+
**Note:** The upgrade process does not automatically move **custom** Agent checks. This is by design as Datadog cannot guarantee full backwards compatibility out of the box. See the [Python 3 Custom Check Migration][1] guide to discover how to migrate your custom check from Python 2 to Python 3.
101+
102+
## Further reading
103+
104+
{{< partial name="whats-next/whats-next.html" >}}
105+
106+
[1]: /agent/guide/python-3/
107+
[2]: /agent/fleet_automation/remote_management
108+
[3]: /agent/fleet_automation/remote_management/#setup
109+
[4]: https://app.datadoghq.com/fleet/agent-upgrades
110+
[5]: /agent/remote_config/?tab=configurationyamlfile#enabling-remote-configuration
111+
[6]: https://github.com/DataDog/datadog-agent/releases?page=1
112+
[7]: /agent/fleet_automation/remote_management/#upgrade-your-agents
113+
[8]: /agent/fleet_automation/

0 commit comments

Comments
 (0)