Skip to content

Commit

Permalink
[8.10] [DOCS] Adds more information how to handle a breaking change i…
Browse files Browse the repository at this point in the history
…n 8.10.0 - SLOs (#174901) (#174941)

# Backport

This will backport the following commits from `main` to `8.10`:
- [[DOCS] Adds more information how to handle a breaking change in
8.10.0 - SLOs (#174901)](#174901)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"amyjtechwriter","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-01-16T16:19:33Z","message":"[DOCS]
Adds more information how to handle a breaking change in 8.10.0 - SLOs
(#174901)\n\nA breaking change was introduced in 8.10.0, which makes
SLOs created\r\nbefore migration not work. They need to be removed and
reset-up. The\r\nrelease note in 8.10.0 did not make this clear. More
information has\r\nbeen added to the release note in this PR including
steps to remove the\r\nSLOs that no longer work.\r\n\r\nCloses:
#173938","sha":"fcf59b648052cdf011c8f258779ae70b9b3afa2e","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","v8.10.0","v8.12.0","v8.13.0","v8.11.4"],"title":"[DOCS]
Adds more information how to handle a breaking change in 8.10.0 -
SLOs","number":174901,"url":"https://github.com/elastic/kibana/pull/174901","mergeCommit":{"message":"[DOCS]
Adds more information how to handle a breaking change in 8.10.0 - SLOs
(#174901)\n\nA breaking change was introduced in 8.10.0, which makes
SLOs created\r\nbefore migration not work. They need to be removed and
reset-up. The\r\nrelease note in 8.10.0 did not make this clear. More
information has\r\nbeen added to the release note in this PR including
steps to remove the\r\nSLOs that no longer work.\r\n\r\nCloses:
#173938","sha":"fcf59b648052cdf011c8f258779ae70b9b3afa2e"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.12","8.11"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.12","label":"v8.12.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/174901","number":174901,"mergeCommit":{"message":"[DOCS]
Adds more information how to handle a breaking change in 8.10.0 - SLOs
(#174901)\n\nA breaking change was introduced in 8.10.0, which makes
SLOs created\r\nbefore migration not work. They need to be removed and
reset-up. The\r\nrelease note in 8.10.0 did not make this clear. More
information has\r\nbeen added to the release note in this PR including
steps to remove the\r\nSLOs that no longer work.\r\n\r\nCloses:
#173938","sha":"fcf59b648052cdf011c8f258779ae70b9b3afa2e"}},{"branch":"8.11","label":"v8.11.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: amyjtechwriter <[email protected]>
  • Loading branch information
kibanamachine and amyjtechwriter authored Jan 16, 2024
1 parent dd211e9 commit 6a9aa48
Showing 1 changed file with 69 additions and 7 deletions.
76 changes: 69 additions & 7 deletions docs/CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -178,17 +178,80 @@ Before you upgrade to 8.10.0, review the breaking changes, then mitigate the imp

[discrete]
[[breaking-162665]]
.New summary search capabilities
.New summary search capabilities cause existing SLOs to stop working
[%collapsible]
====
*Details* +
New summary search capabilities introduce breaking changes in various places, and we have decided to not handle backward compatibility:
New summary search capabilities introduce breaking changes in various places, and we have decided not to handle backward compatibility:
* SLO find API body parameters have changed
* The index mapping used by the rollup data has changed, and we have added a summary index that becomes the new source of truth for search
* The rollup transform have been updated, but existing SLO with their transform won't be updated.
* SLO find API body parameters have changed.
* The index mapping used by the rollup data has changed, and we have added a summary index that becomes the new source of truth for search.
* The rollup transforms have been updated, but existing SLO with their transforms won't be updated.
If some SLOs have been installed in a prior version at 8.10, the user will need to remove them manually from the UI, or by deleting the Saved Object and the associated Transform.
If some SLOs have been installed in a prior version at 8.10, they won't work after migrating to 8.10. There are two approaches to handle this breaking change. The recommended route is to delete all SLOs before migrating to 8.10. The alternative is to migrate to 8.10 and manually remove the SLOs.
*Removing SLOs before migrating to 8.10*
Use the SLO UI or the SLO delete API to delete all existing SLOs. This takes care of the Saved Object, Transform and rollup data. When all SLOs have been deleted, then delete the residual rollup indices: `.slo-observability.sli-v1*`. Note that this is v1.
*Removing SLOs after migrating to 8.10*
After migrating to 8.10, the previously created SLOs won’t appear in the UI because the API is using a new index. The previously created SLOs still exist, and associated transforms are still rolling up data into the previous index `.slo-observability.sli-v1*`. The SLO delete API can't be used now, so remove the resources resources manually:
. Find all existing transforms
All SLO related transforms start with the `slo-` prefix, this request returns them all:
+
[source, bash]
----
GET _transform/slo-*
----
+
Make a note of all the transforms IDs for later.
. Stop all transforms
+
[source, bash]
----
POST _transform/slo-*/_stop?force=true
----
. Remove all transforms
+
From the list of transforms returned during the first step, now delete them one by one:
+
[source, bash]
----
DELETE _transform/{transform_id}?force=true
----
. Find the SLO saved objects
+
This request lists all the SLO saved objects. The SLO IDs and the saved object IDs are not the same.
+
[source, bash]
----
GET kbn:/api/saved_objects/_find?type=slo
----
+
Make a note of all the saved object IDs from the response.
. Remove the SLO saved objects
+
For each saved object ID, run the following:
+
[source, bash]
----
DELETE kbn:/api/saved_objects/slo/{Saved_Object_Id}
----
. Delete the rollup indices v1
+
Note that this is v1.
+
[source, bash]
----
DELETE .slo-observability.sli-v1*
----
====

[discrete]
Expand Down Expand Up @@ -299,7 +362,6 @@ Observability::

For more information about the features introduced in 8.10.0, refer to <<whats-new,What's new in 8.10>>.

[discrete]
[[enhancements-and-bug-fixes-v8.10.0-revised]]
=== Enhancements and bug fixes

Expand Down

0 comments on commit 6a9aa48

Please sign in to comment.