Document upgrade assistant about stack-docs HOT 2 CLOSED

The Upgrade Assistant is a plugin released in X-Pack Kibana 5.6. It surfaces deprecated settings and lets users reindex old indices in preparation for upgrading the Elastic stack to version 6.0. Here's how it works.

Under the Management app in Kibana, you will see a link to Upgrade Assistant in the Elasticsearch section. This takes you to an overview which explains the tools available in the Upgrade Assistant plugin.

The first tool you should use is the Cluster Checkup. Upon navigating to this tab, it runs a series of checks against your cluster settings, node settings, and indices and displays any issues found in each of them. Each issue raised has a level of severity. Only critical level issues need to be resolved before you can safely upgrade the stack to version 6.

For any indices that need to be reindexed or upgraded, a deprecation issue will appear in the Cluster Checkup. You can manually reindex these indices, or you can use the next tool, the Reindex Helper, which will manage the reindex process for you. When you arrive at the Reindex Helper, a list of indices appears with a button to perform the action that the index requires. All internal indices, i.e., indices created and managed by X-Pack and Kibana, will show up with an upgrade button. The term upgrade here refers to the API we use to process internal indices to be 6.0-compatible. If you were to process this index manually, you would make a call to the _xpack/migration/upgrade API. This upgrade endpoint actually does a reindex under the hood, so essentially all indices in the list are getting reindexed. This is why we collectively refer to this tool as the Reindex Helper. All other indices, which are not internally managed by X-Pack or Kibana, and which were created prior to version 5, will appear in the list with a reindex button. If you were to process these indices manually, you would call the _reindex API.

You can start any number of reindex and upgrade processes at a time. Each process kicks off a reindex task that can be canceled from the UI via a cancel button. If any step in the reindex or upgrade process fails, the index can be reset via a reset button. Then refreshing the indices by clicking the refresh indices button will restore the index to a state where it can be processed again.

While processing several indices at a time, some processes will finish before others. You can still update the Ui via the refresh indices button or by reloading the page. This will clean up indices that have been processed so you can focus on those that are in progress or not started. The indices that are in progress will still appear with information about the running task, with the cancel button enabled.

from stack-docs.

Closed by https://github.com/elastic/x-pack-kibana/pull/2452

from stack-docs.