Skip to content

Commit

Permalink
[8.6] Updates upgrade assistant doclinks to point to current rather t…
Browse files Browse the repository at this point in the history
…han hard-coded 7.17 (#147585) (#147780)

# Backport

This will backport the following commits from `main` to `8.6`:
- [Updates upgrade assistant doclinks to point to current rather than
hard-coded 7.17
(#147585)](#147585)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Christiane (Tina)
Heiligers","email":"christiane.heiligers@elastic.co"},"sourceCommit":{"committedDate":"2022-12-19T16:19:26Z","message":"Updates
upgrade assistant doclinks to point to current rather than hard-coded
7.17 (#147585)\n\nCo-authored-by: Lisa Cawley
<lcawley@elastic.co>\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nFix
#145092
Assistant","docs","backport:prev-minor","v8.7.0"],"number":147585,"url":"#147585
upgrade assistant doclinks to point to current rather than hard-coded
7.17 (#147585)\n\nCo-authored-by: Lisa Cawley
<lcawley@elastic.co>\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nFix
#145092
upgrade assistant doclinks to point to current rather than hard-coded
7.17 (#147585)\n\nCo-authored-by: Lisa Cawley
<lcawley@elastic.co>\r\nCo-authored-by: Kibana Machine
<42973632+kibanamachine@users.noreply.github.com>\r\nFix
#145092"}}]}]
BACKPORT-->

Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
  • Loading branch information
kibanamachine and TinaHeiligers committed Dec 19, 2022
1 parent 3d1a52e commit cf147cb
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 10 deletions.
29 changes: 29 additions & 0 deletions docs/management/upgrade-assistant.asciidoc
Original file line number Diff line number Diff line change
@@ -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 <<upgrade-assistant-api, Upgrade Assistant APIs>>.
7 changes: 1 addition & 6 deletions docs/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -396,11 +396,6 @@ This content has moved. Refer to <<saved-object-migrations>>.

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

Expand All @@ -424,4 +419,4 @@ This page has been deleted. Refer to <<machine-learning-api-sync>>.
[role="exclude",id="managing-alerts-and-actions"]
== Alerts and Actions

This page has been deleted. Refer to <<alerting-getting-started>>.
This page has been deleted. Refer to <<alerting-getting-started>>.
2 changes: 1 addition & 1 deletion docs/setup/upgrade/resolving-migration-failures.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<upgrade-assistant,Upgrade Assistant>>
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:

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/upgrade/saved-objects-migration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Each time you upgrade {kib}, an upgrade migration is performed to ensure that all <<managing-saved-objects,saved objects>> 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 <<upgrade-assistant,*Upgrade Assistant*>> 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}.
Expand Down
3 changes: 1 addition & 2 deletions docs/setup/upgrade/upgrade-standard.asciidoc
Original file line number Diff line number Diff line change
@@ -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 <<upgrade-assistant,Upgrade Assistant>> to help you prepare for an upgrade. To access the assistant, go to *{stack-manage-app} > Upgrade Assistant*.

[IMPORTANT]
===========================================
Expand Down
2 changes: 2 additions & 0 deletions docs/user/management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]


0 comments on commit cf147cb

Please sign in to comment.