Skip to content

Commit 98dfe14

Browse files
vishaangelovajuliaElastickarenzone
authored
Add documentation for the integration rollback feature in Fleet (#3850)
Add documentation for the integration rollback feature in Fleet (GA in 9.3, but already available in Serverless). Resolves elastic/ingest-docs#1868 --------- Co-authored-by: Julia Bardi <90178898+juliaElastic@users.noreply.github.com> Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
1 parent 363aaea commit 98dfe14

File tree

4 files changed

+84
-1
lines changed

4 files changed

+84
-1
lines changed

reference/fleet/manage-integrations.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ You can perform a variety of actions in the **Integrations** app in {{kib}}. Som
4343
| [Install and uninstall integration assets](/reference/fleet/install-uninstall-integration-assets.md) | Install, uninstall, and reinstall integration assets in {{kib}}. |
4444
| [View integration assets](/reference/fleet/view-integration-assets.md) | View the {{kib}} assets installed for a specific integration. |
4545
| [Upgrade an integration](/reference/fleet/upgrade-integration.md) | Upgrade an integration to the latest version. |
46+
| [Roll back an integration](/reference/fleet/roll-back-integration.md) {applies_to}`stack: ga 9.3` | Roll back an integration to the previously installed version if issues occur after an upgrade. |
4647

4748
## Customize integrations [customize-integrations]
4849

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
navigation_title: Roll back an integration
3+
description: Roll back an Elastic Agent integration to the previously installed version, restoring the integration policies and configurations of the previous version.
4+
applies_to:
5+
stack: ga 9.3
6+
serverless: ga
7+
products:
8+
- id: fleet
9+
- id: elastic-agent
10+
---
11+
12+
# Roll back an {{agent}} integration
13+
14+
::::{note}
15+
This feature is available only for certain subscription levels. For more information, refer to [Elastic subscriptions]({{subscriptions}}).
16+
::::
17+
18+
If you encounter issues after upgrading an integration, you can roll back the integration to the version installed before the upgrade. During the rollback action, the integration package and all associated integration policies and their configurations are automatically restored to the previously installed version.
19+
20+
Consider rolling back an integration if:
21+
22+
- The upgraded integration introduces breaking changes that affect your data collection.
23+
- The new version causes unexpected behavior or errors in your environment.
24+
- You need to revert to a previous version for compatibility reasons.
25+
26+
:::{note}
27+
By default, the rollback action is available for 7 days following the integration upgrade. After the rollback window expires, you can no longer roll back the integration to the previously installed version.
28+
29+
You can [configure the rollback time-to-live (TTL)](#configure-rollback-ttl) in {{ech}} or self-managed deployments.
30+
:::
31+
32+
## Requirements
33+
34+
To successfully roll back an integration, you must have access to all of its integration policies across **all spaces**. If you don't have access to the related spaces, the rollback action will not succeed.
35+
36+
## Roll back an integration
37+
38+
1. In {{kib}}, go to **Integrations** > **Installed integrations**.
39+
2. Select the integration you want to roll back, then open the integration's **Settings** tab.
40+
3. Click **Rollback <integration>**.
41+
42+
If the button is disabled for an integration, this may indicate:
43+
- The 7-day rollback window has expired.
44+
- You don't have access to all integration policies across all spaces.
45+
- No previous version is available to roll back to.
46+
- The integration was never upgraded.
47+
- The integration is not installed from the {{package-registry}}.
48+
49+
4. In the confirmation window, click **Rollback integration**. A confirmation appears if the rollback is successful.
50+
51+
After the rollback of the integration is complete, the associated integration policies, their configurations and related assets are restored to the integration's previous version.
52+
53+
::::{tip}
54+
You can also roll back an integration from **Integrations** > **Installed integrations**:
55+
56+
1. Click the actions button at the end of the integration's row.
57+
2. Select **Rollback integration**, then confirm the action.
58+
::::
59+
60+
:::{note}
61+
The automatic upgrade of rolled back integrations is disabled until the integrations are manually upgraded.
62+
:::
63+
64+
## Configure the rollback TTL [configure-rollback-ttl]
65+
66+
The default duration of the rollback window is 7 days. To configure the rollback TTL duration, add the `xpack.fleet.integrationRollbackTTL` setting in the user settings of your {{ech}} deployment or in the `kibana.yml` configuration file of your self-managed deployment.
67+
68+
For example, to extend the rollback window to 14 days, set:
69+
70+
```yml
71+
xpack.fleet.integrationRollbackTTL: 14d
72+
```
73+
74+
For more information, refer to [{{fleet}} settings in {{kib}}](kibana://reference/configuration-reference/fleet-settings.md).

reference/fleet/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ toc:
147147
- file: view-integration-assets.md
148148
- file: integration-level-outputs.md
149149
- file: upgrade-integration.md
150+
- file: roll-back-integration.md
150151
- file: managed-integrations-content.md
151152
- file: integrations-assets-best-practices.md
152153
- file: otel-integrations.md
@@ -209,4 +210,4 @@ toc:
209210
- file: timestamp-processor.md
210211
- file: translate_sid-processor.md
211212
- file: truncate_fields-processor.md
212-
- file: urldecode-processor.md
213+
- file: urldecode-processor.md

reference/fleet/upgrade-integration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
navigation_title: Upgrade an integration
33
mapped_pages:
44
- https://www.elastic.co/guide/en/fleet/current/upgrade-integration.html
5+
applies_to:
6+
stack: ga
7+
serverless: ga
58
products:
69
- id: fleet
710
- id: elastic-agent
@@ -48,6 +51,10 @@ In larger deployments, you should test integration upgrades on a sample {{agent}
4851
You must upgrade standalone agents separately. If you used {{kib}} to create and download your standalone agent policy, see [Upgrade standalone agent policies after upgrading an integration](/reference/fleet/create-standalone-agent-policy.md#update-standalone-policies).
4952
::::
5053

54+
::::{tip}
55+
:applies_to: stack: ga 9.3
56+
If you encounter issues after upgrading an integration and your [Elastic subscription level](https://www.elastic.co/subscriptions) supports **integration rollback**, you can [roll back the integration to the previously installed version](/reference/fleet/roll-back-integration.md).
57+
::::
5158

5259

5360
## Keep integration policies up to date automatically [upgrade-integration-policies-automatically]

0 commit comments

Comments
 (0)