github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

Improve docs for unknown saved object types (#125253) (#125309)

Browse source 
* Revert "Revert "Docs for preventing migrations failing for unknown saved object types""

This reverts commit 580d61d990.

* Fix links and versions for note to use UA

* Migration docs: remove content related to 6.x versions

* Upgrade docs, remove content for upgrading from v4/v5

* Link to 7.17 upgrade assistant

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>

* Update docs/setup/upgrade/upgrade-migrations.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co>
(cherry picked from commit f3b01b6751)

Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
This commit is contained in:
Kibana Machine 2022-02-10 15:56:53 -05:00 • committed by GitHub
parent 04e0a3e8b0
commit 27362eb699
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/setup/upgrade/upgrade-migrations.asciidoc
View file

@ -4,8 +4,8 @@
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 7.0.0, 6.7.0 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[*Upgrade Assistant*].
To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
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*].
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}.
@ -32,7 +32,6 @@ adds a write block to the outdated index. Table 1 lists the saved objects indice
[options="header"]
|=======================
|Upgrading from version | Outdated index (alias)
| 6.0.0 through 6.4.x | `.kibana`
`.kibana_task_manager_7.12.0_001` (`.kibana_task_manager` alias)
| 6.5.0 through 7.3.x | `.kibana_N` (`.kibana` alias)
@ -58,6 +57,28 @@ complete the upgrade migration before bringing up the remaining instances.
==== Preventing migration failures
Review the common causes of {kib} upgrade failures and how to prevent them.
[float]
====== Documents found for unknown saved object types
Migrations will fail if saved objects belong to an unknown
saved object type. Unknown saved objects are typically caused by
to the {es} index, or by disabling a plugin that had previously
created a saved object.
We recommend using the https://www.elastic.co/guide/en/kibana/7.17/upgrade-assistant.html[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:
[source,sh]
--------------------------------------------
CHECK_UNKNOWN_DOCUMENTS Upgrades will fail for 8.0+ because documents were found for unknown saved object types. To ensure that upgrades will succeed in the future, either re-enable plugins or delete these documents from the ".kibana_7.17.0_001" index after the current upgrade completes.
--------------------------------------------
If you fail to remedy this, your upgrade to 8.0+ will fail with a message like:
[source,sh]
--------------------------------------------
Unable to complete saved object migrations for the [.kibana] index: Migration failed because documents were found for unknown saved object types. To proceed with the migration, please delete these documents from the ".kibana_7.17.0_001" index.
--------------------------------------------
[float]
===== timeout_exception or receive_timeout_transport_exception
There is a known issue in 7.12.0 for users who tried the {fleet} beta.
@ -122,9 +143,6 @@ Matching index templates that specify `settings.refresh_interval` or `mappings`
To make sure the index templates won't apply to new `.kibana*` indices, narrow down the {data-sources} of any user-defined index templates.
NOTE: In {kib} 6.5.0 and earlier, {kib} creates a `kibana_index_template:.kibana` index template
and uses a `.kibana` index pattern. You do not need to change or remove the index template.
[float]
===== An unhealthy {es} cluster
Problems with your {es} cluster can prevent {kib} upgrades from succeeding. Ensure that your cluster has:

10
docs/setup/upgrade/upgrade-standard.asciidoc
View file

@ -1,8 +1,8 @@
[[upgrade-standard]]
=== Standard upgrade
NOTE: 6.7 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[Upgrade Assistant]
to help you prepare for your upgrade to 7.0. To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
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*.
[IMPORTANT]
===========================================
@ -29,12 +29,6 @@ Different versions of {kib} running against the same {es} index, such as during
. Use `rpm` or `dpkg` to install the new package. All files should be placed in
their proper locations and config files should not be overwritten.
+
[NOTE]
--
{kib} 4.x used a different config location than 5.0+, so if you're upgrading
from 4.x, you will need to copy the configurations from your old config
(`/opt/kibana/config/kibana.yml`) to your new config
(`/etc/kibana/kibana.yml`).
Make sure you remove or update any configurations
that are indicated in the <<breaking-changes-8.0.0,breaking changes>> documentation