Skip to content

Commit b21fa06

Browse files
committed
Add section for configuring the auto-upgrade
1 parent 15eadc8 commit b21fa06

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

reference/fleet/agent-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ See also the [recommended scaling options](#agent-policy-scale) for an {{agent}}
7171

7272

7373
## Create a policy [create-a-policy]
74-
74+
fau
7575
To manage your {{agent}}s and the data they collect, create a new policy:
7676

7777
In {{fleet}}, open the **Agent policies** tab and click **Create agent policy**.

reference/fleet/upgrade-elastic-agent.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -236,19 +236,38 @@ To configure an automatic rollout of a new minor or patch version to a percentag
236236
3. On the agent policy's details page, find **Auto-upgrade agents**, and select **Manage** next to it.
237237
4. In the **Manage auto-upgrade agents** window, click **Add target version**.
238238
5. From the **Target agent version** dropdown, select the minor or patch version to which you want to upgrade a percentage of your agents.
239-
6. In the **% of agents to upgrade** field, enter the percentage of agents you want to upgrade to this target version.
240-
241-
Note that rounding is applied, and the actual percentage of the upgraded agents may vary slightly. For example, if you want to upgrade 30% of the agents in a policy with 25 agents, this may result in the upgrade of 8 agents (32%).
239+
6. In the **% of agents to upgrade** field, enter the percentage of active agents you want to upgrade to this target version.
240+
241+
Note that:
242+
- Unenrolling, unenrolled, inactive, and uninstalled agents are not included in the count. For example, if you set the target upgrade percentage to 50% for a policy with 10 active agents and 10 inactive agents, the target is met when 5 active agents are upgraded.
243+
- Rounding is applied, and the actual percentage of the upgraded agents may vary slightly. For example, if you set the target upgrade percentage to 30% for a policy with 25 active agents, the target is met when 8 active agents are upgraded (32%).
242244

243245
7. You can then add a different target version, and specify the percentage of agents you want to be upgraded to that version. The total percentage of agents to be upgraded cannot exceed 100%.
244246
8. Click **Save**.
245247

246-
Once the configuration is saved, an asynchronous task runs every 30 minutes, gradually upgrading the agents in the policy to the specified target version. In case of any failed upgrades, the upgrades are retried with exponential backoff mechanism until the upgrade is successful.
248+
Once the configuration is saved, an asynchronous task runs every 30 minutes, gradually upgrading the agents in the policy to the specified target version.
249+
250+
In case of any failed upgrades, the upgrades are retried with exponential backoff mechanism until the upgrade is successful, or the maximum number of retries is reached. Note that the maximum number of retries is the number of [configured retry delays](#auto-upgrade-settings).
247251

248252
::::{note}
249-
Only agents enrolled in the policy are considered for the automatic upgrade. If new agents are assigned to the policy, the number of {{agents}} to be upgraded is adjusted according to the set percentages.
253+
Only active agents enrolled in the policy are considered for the automatic upgrade.
254+
255+
If new agents are assigned to the policy, the number of {{agents}} to be upgraded is adjusted according to the set percentages.
250256
::::
251257

258+
### Configure the auto-upgrade settings [auto-upgrade-settings]
259+
260+
On self-managed and cloud deployments of {{stack}}, you can configure the default task interval and the retry delays of the automatic upgrade in the {{kib}} user settings. For example:
261+
262+
```yml
263+
xpack.fleet.autoUpgrades.taskInterval: 15m <1>
264+
xpack.fleet.autoUpgrades.retryDelays: ['5m', '10m', '20m'] <2>
265+
```
266+
1. Defaults to `30m`
267+
2. Defaults to `['30m', '1h', '2h', '4h', '8h', '16h', '24h']`
268+
269+
For more information, refer to [Fleet settings in Kibana](kibana://reference/configuration-reference/fleet-settings.md).
270+
252271
### View the status of the automatic upgrade [auto-upgrade-view-status]
253272

254273
You can view the status of the automatic upgrade in the following ways:

0 commit comments

Comments
 (0)