-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[AGENT] Schedule Agent Upgrades #33035
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
base: master
Are you sure you want to change the base?
Changes from all commits
d1958c1
e187476
ba8277e
6b35f01
283d10b
24ef75a
920f098
872da33
56e2002
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,7 +39,25 @@ Users must have the [Agent Upgrade][2] within Fleet Automation for upgrades, and | |
| ### Prerequisites | ||
| * **Disk space**: Datadog suggests at least 2GB for the initial Agent install and an additional 2GB for upgrading the Agent from Fleet Automation. Specifically, the upgrade requires 1.3GB in the `/opt/datadog-packages` directory on Linux, or `C:\ProgramData\Datadog\Installer\packages` on Windows. The extra space ensures that there is enough room to maintain two Agent installs temporarily during the upgrade process in case a rollback is needed. | ||
|
|
||
| ### Upgrade process | ||
|
|
||
| Similar to a manual upgrade, expect a downtime of 5-30 seconds while the Agent restarts. The full upgrade process takes approximately 5 minutes. Around 2 minutes of this time is used for the upgrade process. The rest of the time is spent monitoring the upgrade to ensure stability and determining if a rollback is necessary. If the upgrade fails and a rollback is necessary, the Agent automatically reverts to the previously running Agent version. | ||
|
|
||
| The upgrade process primarily adds files to the following directories: | ||
|
|
||
| Linux: | ||
| - `/opt/datadog-packages` | ||
| - `/etc/datadog-agent` | ||
| - `/etc/systemd/system` | ||
|
|
||
| Windows: | ||
| - `C:\ProgramData\Datadog\Installer\packages` | ||
| - `C:\Program Files\Datadog\Datadog Agent` | ||
|
|
||
| The Agent ensures that the appropriate permissions are set for these files. No configuration files are altered during the installation process. | ||
|
|
||
| ### How to upgrade Agents remotely | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should float this higher |
||
|
|
||
| To upgrade your Agents remotely: | ||
| 1. [Enable Remote Agent Management](#enable-remote-agent-management). | ||
| 1. From the [**Upgrade Agents** tab][4], click **Start Agents Upgrade**. | ||
|
|
@@ -56,29 +74,46 @@ To upgrade your Agents remotely: | |
| 1. Use the [Deployments][10] dashboard to track the upgrade process. Clicking on an Agent in the deployments table gives you more information about the upgrade, including the duration time, progress, and the user who started the upgrade. | ||
| {{< img src="/agent/fleet_automation/deployments.png" alt="Select the Agents you want to upgrade." style="width:100%;" >}} | ||
|
|
||
| ### Upgrade process | ||
| ### How to schedule Agent upgrades | ||
|
|
||
| Similar to a manual upgrade, expect a downtime of 5-30 seconds while the Agent restarts. The full upgrade process takes approximately 5 minutes. Around 2 minutes of this time is used for the upgrade process. The rest of the time is spent monitoring the upgrade to ensure stability and determining if a rollback is necessary. If the upgrade fails and a rollback is necessary, the Agent automatically reverts to the previously running Agent version. | ||
| To schedule your Agent upgrades: | ||
| 1. [Enable Remote Agent Management](#enable-remote-agent-management). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Feels like we're repeating this step |
||
|
|
||
| The upgrade process primarily adds files to the following directories: | ||
| 1. From the [**Upgrade Agents** tab][4], click **+ Create Schedule**. | ||
|
|
||
| Linux: | ||
| * `/opt/datadog-packages` | ||
| * `/etc/datadog-agent` | ||
| * `/etc/systemd/system` | ||
| 1. On the upgrade scheduling page, add a **Schedule name**. | ||
|
|
||
| Windows: | ||
| * `C:\ProgramData\Datadog\Installer\packages` | ||
| * `C:\Program Files\Datadog\Datadog Agent` | ||
| 1. **Select the Agent version**. You have the option to upgrade the Agents to: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's make simpler:
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's make this more concise, rather than listing out the three options explicitly
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fine with not mentioning at all since screenshot mentions |
||
| - The latest version | ||
| - One version behind the latest version | ||
| - Two versions behind the latest version | ||
|
|
||
| The Agent ensures that the appropriate permissions are set for these files. No configuration files are altered during the installation process. | ||
| {{< img src="/agent/fleet_automation/agent_upgrade_select_version1.png" alt="See a list of scheduled Agent upgrades." style="width:100%;" >}} | ||
|
|
||
| 1. **Specify the Agents to be upgraded**. You can use filtering or a search query to scope the Agents by various attributes including, the Agents' environment, operation system, or hostname. You can then see the Agents that are included within your specified scope along with those that are not eligible for deployment. Adjust your filter to include all the Agents you want to upgrade. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's keep the scoping steps language consistent like the same example above: I think we're repeating this step though. |
||
|
|
||
| {{< img src="/agent/fleet_automation/agent_upgrade_select_agents.png" alt="See a list of Agent to be upgraded." style="width:100%;" >}} | ||
|
|
||
| 1. **Set the deployment window** for these upgrades. You can select the weekdays, time frame, and timezone for the upgrade. | ||
|
|
||
| {{< img src="/agent/fleet_automation/agent_upgrade_set_window.png" alt="Select the time frame for your Agent upgrades." style="width:100%;" >}} | ||
|
|
||
| 1. Optionally, click **+ Add Recipient** to set up notifications and receive updates on the deployment. You can notify individuals or communication integration channels like Slack, Teams, or PagerDuty. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's remove "Optionally...Add Recipient" to" |
||
|
|
||
| {{< img src="/agent/fleet_automation/agent_upgrade_set_notification.png" alt="Select people or channels to be notified about the progess of the upgrade." style="width:100%;" >}} | ||
|
|
||
| 1. Click **Create Schedule** to save the schedule. | ||
|
|
||
| 1. See a list of your scheduled upgrades under the [**Upgrade Agents** tab][4], in the **Upgrade Schedules** section. | ||
|
|
||
| {{< img src="/agent/fleet_automation/agent_upgrade_schedule_list2.png" alt="See a list of upgrades scheduled for your Agents." style="width:100%;" >}} | ||
|
|
||
| ### Upgrade precedence | ||
|
|
||
| For the most consistent upgrade experience, Datadog recommends managing upgrades from one source at a time. Use either Fleet Automation or a configuration management tool. If you run a configuration management tool on an Agent that has already been upgraded using Fleet Automation, the upgrade reverts the Agent to the [`DD_AGENT_MINOR_VERSION`][9] specified in your configuration. If no `DD_AGENT_MINOR_VERSION` is set, the Agent is upgraded to the latest available version. | ||
|
|
||
|
|
||
| ## Configure Agents | ||
|
|
||
| {{< callout url="https://www.datadoghq.com/product-preview/manage-agent-configurations-from-fleet-automation/" >}} | ||
| Managing Agent Configurations in Fleet Automation is in <strong>preview</strong>. To get access, complete the preview sign‑up form. | ||
| {{< /callout >}} | ||
|
|
@@ -98,13 +133,14 @@ Managing Agent Configurations in Fleet Automation is in <strong>preview</strong> | |
| When a configuration file on the host conflicts with a Fleet Automation configuration, Fleet Automation takes precedence, ensuring a single source of truth. See [Configuration Order Precedence][17]. | ||
|
|
||
| ### Edit, deploy or roll back configurations | ||
|
|
||
| From your list of configurations in the [Configure Agents][16] tab, you can | ||
| - Deploy the unused configuration to your Agents | ||
| - Edit the configuration, save a new version, and redeploy the updated configuration. | ||
| - Rollback the configuration to a previous version and redeploy. | ||
|
|
||
|
|
||
| ### Mirrors and proxies | ||
|
|
||
| You can use Remote Agent Management along with a proxy or mirrored repositories. | ||
|
|
||
| For instructions on configuring your Agent to use a proxy, see [Agent Proxy Configuration][6]. After you've configured the proxy, restart the Agent to apply the settings. | ||
|
|
||
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.
Why did we bring upgrade process up?