Deprecate Migration Assistance and Upgrade APIs #40072
Conversation
The Migration Assistance API has been functionally replaced with the Deprecation Info API, and the Migration Upgrade API is not in use for the 6.x to 7.x upgrade, and may not be used for the 7.x to 8.x upgrade. It is currently only useful for repairing clusters which were not properly prepared for the 5.x to 6.x upgrade. Therefore, these APIs are deprecated.
|
Pinging @elastic/es-core-features |
|
|
| @@ -6,8 +6,13 @@ | |||
| <titleabbrev>Migration assistance</titleabbrev> | |||
| ++++ | |||
|
|
|||
| The Migration Assistance API analyzes existing indices in the cluster and | |||
| returns the information about indices that require some changes before the | |||
| IMPORTANT: The Migration Assistance API is deprecated, use the | |||
There was a problem hiding this comment.
If someone uses this API in 6.7, will it return correct information ?
There was a problem hiding this comment.
I've made a tweak to this to make sure the behavior aligns, but as of this PR, if used in 6.7, this API will correctly identify which indices need to be reindexed, including internal indices. It will only say that indices need to be "upgraded" if they were not properly upgraded before upgrading the cluster to 6 and need to be fixed using the Migration Upgrade API.
| deprecated[6.7, Use the {kibana-ref}/upgrade-assistant.html[{kib} Upgrade | ||
| Assistant] or <<reindex-upgrade,Reindex manually>> before upgrading.] The | ||
| Migration Upgrade API performs the upgrade of internal indices to make them | ||
| compatible with version 6 of Elasticsearch. |
There was a problem hiding this comment.
If someone uses this API in 6.7 will it work correctly ?
There was a problem hiding this comment.
I've made a tweak to this to make sure the behavior aligns, but as of this PR, if used in 6.7, the Upgrade API will only upgrade indices that need to be upgraded from their 5.x format (i.e. they were not upgraded before upgrading the cluster). Otherwise, it will just say that the index needs to be reindexed.
That is, if the .watches-6 index was created and upgraded in 5.x, the Upgrade API will refuse to upgrade it and just say that it needs to be reindexed.
Co-Authored-By: gwbrown <gordon.brown@elastic.co>
Co-Authored-By: gwbrown <gordon.brown@elastic.co>
Co-Authored-By: gwbrown <gordon.brown@elastic.co>
Co-Authored-By: gwbrown <gordon.brown@elastic.co>
|
Thanks for the corrections @lcawl! |
|
I've created the following PR to make similar changes in the Installation and Upgrade Guide: elastic/stack-docs#247 |
The Migration Assistance API has been functionally replaced with the
Deprecation Info API, and the Migration Upgrade API is not in use for
the 6.x to 7.x upgrade, and may or may not be used for the 7.x to 8.x
upgrade. It is currently only useful for repairing clusters which were not
properly prepared for the 5.x to 6.x upgrade.
Therefore, these APIs are now deprecated, and the docs are updated
to point users to the correct resources for preparing for an upgrade to 7.x.
Relates to #40014