diff --git a/docs/management/upgrade-assistant.asciidoc b/docs/management/upgrade-assistant.asciidoc new file mode 100644 index 00000000000000..a44afa4474a7b6 --- /dev/null +++ b/docs/management/upgrade-assistant.asciidoc @@ -0,0 +1,29 @@ +[[upgrade-assistant]] +== Upgrade Assistant + +The Upgrade Assistant helps you prepare for your upgrade +to the next version of the {stack}. +To access the assistant, go to *{stack-manage-app} > Upgrade Assistant*. + +The assistant identifies deprecated settings in your configuration +and guides you through the process of resolving issues if any deprecated features are enabled. + +[discrete] +=== Required permissions + +The `manage` cluster privilege is required to access the *Upgrade assistant*. +Additional privileges may be needed to perform certain actions. + +[discrete] +=== Feature set +Some features of the Upgrade assistant are only needed when upgrading to a new major version. The feature set enabled by default are those for the very next version from the one Kibana currently runs on. + +[discrete] +=== Deprecations +The Upgrade assistant pulls information about deprecations from the following sources: + +* Elasticsearch Deprecation Info API +* Elasticsearch deprecation logs +* Kibana deprecations API + +For more information about the API's the Upgraed assistant provides, refer to <>. diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index a0193baaa0ab06..02f57f5789d770 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -396,11 +396,6 @@ This content has moved. Refer to <>. This content has moved. Refer to {stack-ref}/upgrading-kibana.html[Upgrade Kibana]. -[role="exclude",id="upgrade-assistant"] -== Upgrade Assistant - -This content has moved. Refer to {kibana-ref-all}/7.17/upgrade-assistant.html[Upgrade Assistant]. - [role="exclude",id="brew"] == Install {kib} on macOS with Homebrew @@ -424,4 +419,4 @@ This page has been deleted. Refer to <>. [role="exclude",id="managing-alerts-and-actions"] == Alerts and Actions -This page has been deleted. Refer to <>. \ No newline at end of file +This page has been deleted. Refer to <>. diff --git a/docs/setup/upgrade/resolving-migration-failures.asciidoc b/docs/setup/upgrade/resolving-migration-failures.asciidoc index 6de91d9a58db53..63264cb4f0963b 100644 --- a/docs/setup/upgrade/resolving-migration-failures.asciidoc +++ b/docs/setup/upgrade/resolving-migration-failures.asciidoc @@ -133,7 +133,7 @@ Migrations will fail if saved objects belong to an unknown saved object type. Unknown saved objects are typically caused by performing manual modifications to the {es} index (no longer allowed in 8.x), or by disabling a plugin that had previously created a saved object. -We recommend using the {kibana-ref-all}/7.17/upgrade-assistant.html[Upgrade Assistant] +We recommend using the <> to discover and remedy any unknown saved object types. {kib} version 7.17.0 deployments containing unknown saved object types will also log the following warning message: diff --git a/docs/setup/upgrade/saved-objects-migration.asciidoc b/docs/setup/upgrade/saved-objects-migration.asciidoc index 5d84ece1c3c9fc..3dac6a02c96efb 100644 --- a/docs/setup/upgrade/saved-objects-migration.asciidoc +++ b/docs/setup/upgrade/saved-objects-migration.asciidoc @@ -3,7 +3,7 @@ Each time you upgrade {kib}, an upgrade migration is performed to ensure that all <> are compatible with the new version. -NOTE: To help you prepare for the upgrade to 8.0.0, 7.17.0 includes an https://www.elastic.co/guide/en/kibana/7.17/upgrade-assistant.html[*Upgrade Assistant*]. +NOTE: {kib} includes an <> to help you prepare for an upgrade. To access the assistant, go to *Stack Management > Upgrade Assistant*. WARNING: {kib} 7.12.0 and later uses a new migration process and index naming scheme. Before you upgrade, read the documentation for your version of {kib}. diff --git a/docs/setup/upgrade/upgrade-standard.asciidoc b/docs/setup/upgrade/upgrade-standard.asciidoc index 8bed39c311d465..e19e6533a7c203 100644 --- a/docs/setup/upgrade/upgrade-standard.asciidoc +++ b/docs/setup/upgrade/upgrade-standard.asciidoc @@ -1,8 +1,7 @@ [[upgrade-standard]] === Standard upgrade -NOTE: 7.17 includes an https://www.elastic.co/guide/en/kibana/7.17/upgrade-assistant.html[Upgrade Assistant] -to help you prepare for your upgrade to 8.0. To access the assistant, go to *Stack Management > Upgrade Assistant*. +NOTE: {kib} includes an <> to help you prepare for an upgrade. To access the assistant, go to *{stack-manage-app} > Upgrade Assistant*. [IMPORTANT] =========================================== diff --git a/docs/user/management.asciidoc b/docs/user/management.asciidoc index 67ccadf696411f..5c78d911838614 100644 --- a/docs/user/management.asciidoc +++ b/docs/user/management.asciidoc @@ -200,6 +200,8 @@ include::{kib-repo-dir}/management/advanced-options.asciidoc[] include::{kib-repo-dir}/management/managing-tags.asciidoc[] +include::{kib-repo-dir}/management/upgrade-assistant.asciidoc[] + include::{kib-repo-dir}/management/watcher-ui/index.asciidoc[]