-
Notifications
You must be signed in to change notification settings - Fork 176
Add documentation for the integration rollback feature in Fleet #3850
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
Merged
+84
−1
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
cc611e1
Add documentation for the integration rollback feature
vishaangelova c3e1ed6
Apply suggestions from code review
vishaangelova bd55bc7
Update reference/fleet/roll-back-integration.md
vishaangelova 14bacc8
Update the steps + add a tip for the rollback action
vishaangelova f71065f
Merge branch 'main' into 1868-rollback-integration-docs
vishaangelova File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| --- | ||
| navigation_title: Roll back an integration | ||
| description: Roll back an Elastic Agent integration to the previously installed version, restoring the integration policies and configurations of the previous version. | ||
| applies_to: | ||
| stack: ga 9.3 | ||
| serverless: ga | ||
| products: | ||
| - id: fleet | ||
| - id: elastic-agent | ||
| --- | ||
|
|
||
| # Roll back an {{agent}} integration | ||
|
|
||
| ::::{note} | ||
| This feature is available only for certain subscription levels. For more information, refer to [Elastic subscriptions]({{subscriptions}}). | ||
| :::: | ||
|
|
||
| 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. | ||
|
|
||
| Consider rolling back an integration if: | ||
|
|
||
| - The upgraded integration introduces breaking changes that affect your data collection. | ||
| - The new version causes unexpected behavior or errors in your environment. | ||
| - You need to revert to a previous version for compatibility reasons. | ||
|
|
||
| :::{note} | ||
| 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. | ||
|
|
||
| You can [configure the rollback time-to-live (TTL)](#configure-rollback-ttl) in {{ech}} or self-managed deployments. | ||
| ::: | ||
|
|
||
| ## Requirements | ||
|
|
||
| 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. | ||
|
|
||
| ## Roll back an integration | ||
|
|
||
vishaangelova marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 1. In {{kib}}, go to **Integrations** > **Installed integrations**. | ||
| 2. Select the integration you want to roll back, then open the integration's **Settings** tab. | ||
| 3. Click **Rollback <integration>**. | ||
|
|
||
| If the button is disabled for an integration, this may indicate: | ||
| - The 7-day rollback window has expired. | ||
| - You don't have access to all integration policies across all spaces. | ||
| - No previous version is available to roll back to. | ||
| - The integration was never upgraded. | ||
vishaangelova marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - The integration is not installed from the {{package-registry}}. | ||
|
|
||
| 4. In the confirmation window, click **Rollback integration**. A confirmation appears if the rollback is successful. | ||
|
|
||
| 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. | ||
|
|
||
| ::::{tip} | ||
| You can also roll back an integration from **Integrations** > **Installed integrations**: | ||
|
|
||
| 1. Click the actions button at the end of the integration's row. | ||
| 2. Select **Rollback integration**, then confirm the action. | ||
| :::: | ||
|
|
||
| :::{note} | ||
| The automatic upgrade of rolled back integrations is disabled until the integrations are manually upgraded. | ||
| ::: | ||
|
|
||
| ## Configure the rollback TTL [configure-rollback-ttl] | ||
|
|
||
| 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. | ||
|
|
||
| For example, to extend the rollback window to 14 days, set: | ||
|
|
||
| ```yml | ||
| xpack.fleet.integrationRollbackTTL: 14d | ||
| ``` | ||
|
|
||
| For more information, refer to [{{fleet}} settings in {{kib}}](kibana://reference/configuration-reference/fleet-settings.md). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.