From 25ec068aef928a355805f8d2f70fad423b473a76 Mon Sep 17 00:00:00 2001 From: debadair Date: Tue, 5 Dec 2017 10:58:52 -0800 Subject: [PATCH] [DOCS] Added link to upgrade guide and bumped the upgrade topic up to the top level (#27621) * [DOCS] Added link to the upgrade guide & tweaked the intro. * [DOCS] Bumped upgrade topic up to the top level of the TOC --- docs/reference/index-shared1.asciidoc | 2 ++ docs/reference/setup.asciidoc | 2 -- docs/reference/{setup => }/upgrade.asciidoc | 22 ++++++++++++++----- .../upgrade/cluster_restart.asciidoc | 2 +- .../upgrade/disable-shard-alloc.asciidoc | 0 .../upgrade/reindex_upgrade.asciidoc | 6 ++--- .../upgrade/rolling_upgrade.asciidoc | 2 +- .../upgrade/set-paths-tip.asciidoc | 0 .../upgrade/shut-down-node.asciidoc | 0 .../{setup => }/upgrade/synced-flush.asciidoc | 0 .../{setup => }/upgrade/upgrade-node.asciidoc | 0 11 files changed, 23 insertions(+), 13 deletions(-) rename docs/reference/{setup => }/upgrade.asciidoc (87%) rename docs/reference/{setup => }/upgrade/cluster_restart.asciidoc (99%) rename docs/reference/{setup => }/upgrade/disable-shard-alloc.asciidoc (100%) rename docs/reference/{setup => }/upgrade/reindex_upgrade.asciidoc (98%) rename docs/reference/{setup => }/upgrade/rolling_upgrade.asciidoc (99%) rename docs/reference/{setup => }/upgrade/set-paths-tip.asciidoc (100%) rename docs/reference/{setup => }/upgrade/shut-down-node.asciidoc (100%) rename docs/reference/{setup => }/upgrade/synced-flush.asciidoc (100%) rename docs/reference/{setup => }/upgrade/upgrade-node.asciidoc (100%) diff --git a/docs/reference/index-shared1.asciidoc b/docs/reference/index-shared1.asciidoc index 9325bd6e73e..ae208e29011 100644 --- a/docs/reference/index-shared1.asciidoc +++ b/docs/reference/index-shared1.asciidoc @@ -2,3 +2,5 @@ include::getting-started.asciidoc[] include::setup.asciidoc[] + +include::upgrade.asciidoc[] diff --git a/docs/reference/setup.asciidoc b/docs/reference/setup.asciidoc index 34ac8c0bd66..0dcafe375cf 100644 --- a/docs/reference/setup.asciidoc +++ b/docs/reference/setup.asciidoc @@ -50,6 +50,4 @@ include::setup/sysconfig.asciidoc[] include::setup/bootstrap-checks.asciidoc[] -include::setup/upgrade.asciidoc[] - include::setup/stopping.asciidoc[] diff --git a/docs/reference/setup/upgrade.asciidoc b/docs/reference/upgrade.asciidoc similarity index 87% rename from docs/reference/setup/upgrade.asciidoc rename to docs/reference/upgrade.asciidoc index 172ae13e32d..5218856d0c9 100644 --- a/docs/reference/setup/upgrade.asciidoc +++ b/docs/reference/upgrade.asciidoc @@ -1,5 +1,19 @@ [[setup-upgrade]] -== Upgrading Elasticsearch += Upgrade Elasticsearch + +[partintro] +-- +Elasticsearch can usually be upgraded using a <> +process so upgrading does not interrupt service. However, you might +need to <> indices created in older versions. +Upgrades across major versions prior to 6.0 require a <>. + +When upgrading to a new version of Elasticsearch, you need to upgrade each +of the products in your Elastic Stack. The steps you need to take to upgrade +differ depending on which products you are using. Want a list that's tailored +to your stack? Try out our {upgrade_guide}[Interactive Upgrade Guide]. For +more information about upgrading your stack, see {stack-ref}[Upgrading the +Elastic Stack]. [IMPORTANT] =========================================== @@ -17,10 +31,6 @@ your data. =========================================== -Elasticsearch can usually be upgraded using a <> -process so upgrading does not interrupt service. However, you might -need to <> indices created in older versions. -Upgrades across major versions prior to 6.0 require a <>. The following table shows when you can perform a rolling upgrade, when you need to reindex or delete old indices, and when a full cluster restart is @@ -56,7 +66,7 @@ For information about how to upgrade old indices, see <>. =============================================== - +-- include::upgrade/rolling_upgrade.asciidoc[] diff --git a/docs/reference/setup/upgrade/cluster_restart.asciidoc b/docs/reference/upgrade/cluster_restart.asciidoc similarity index 99% rename from docs/reference/setup/upgrade/cluster_restart.asciidoc rename to docs/reference/upgrade/cluster_restart.asciidoc index edb23cf7e6d..7989f14eaad 100644 --- a/docs/reference/setup/upgrade/cluster_restart.asciidoc +++ b/docs/reference/upgrade/cluster_restart.asciidoc @@ -1,5 +1,5 @@ [[restart-upgrade]] -=== Full cluster restart upgrade +== Full cluster restart upgrade A full cluster restart upgrade requires that you shut all nodes in the cluster down, upgrade them, and restart the cluster. A full cluster restart was required diff --git a/docs/reference/setup/upgrade/disable-shard-alloc.asciidoc b/docs/reference/upgrade/disable-shard-alloc.asciidoc similarity index 100% rename from docs/reference/setup/upgrade/disable-shard-alloc.asciidoc rename to docs/reference/upgrade/disable-shard-alloc.asciidoc diff --git a/docs/reference/setup/upgrade/reindex_upgrade.asciidoc b/docs/reference/upgrade/reindex_upgrade.asciidoc similarity index 98% rename from docs/reference/setup/upgrade/reindex_upgrade.asciidoc rename to docs/reference/upgrade/reindex_upgrade.asciidoc index 04ef0f18b60..dc3c72fee22 100644 --- a/docs/reference/setup/upgrade/reindex_upgrade.asciidoc +++ b/docs/reference/upgrade/reindex_upgrade.asciidoc @@ -1,5 +1,5 @@ [[reindex-upgrade]] -=== Reindex before upgrading +== Reindex before upgrading Elasticsearch can read indices created in the *previous major version*. Older indices must be reindexed or deleted. Elasticsearch 6.x @@ -56,7 +56,7 @@ been deleted. [[reindex-upgrade-inplace]] -==== Reindex in place +=== Reindex in place To manually reindex your old indices with the <>: @@ -88,7 +88,7 @@ regular part of your Elastic Stack. For more information, see ******************************************* [[reindex-upgrade-remote]] -==== Reindex from a remote cluster +=== Reindex from a remote cluster You can use <> to migrate indices from your old cluster to a new 6.x cluster. This enables you move to 6.x from a diff --git a/docs/reference/setup/upgrade/rolling_upgrade.asciidoc b/docs/reference/upgrade/rolling_upgrade.asciidoc similarity index 99% rename from docs/reference/setup/upgrade/rolling_upgrade.asciidoc rename to docs/reference/upgrade/rolling_upgrade.asciidoc index 09427ba26ad..f52f354b80b 100644 --- a/docs/reference/setup/upgrade/rolling_upgrade.asciidoc +++ b/docs/reference/upgrade/rolling_upgrade.asciidoc @@ -1,5 +1,5 @@ [[rolling-upgrades]] -=== Rolling upgrades +== Rolling upgrades A rolling upgrade allows an Elasticsearch cluster to be upgraded one node at a time so upgrading does not interrupt service. Running multiple versions of diff --git a/docs/reference/setup/upgrade/set-paths-tip.asciidoc b/docs/reference/upgrade/set-paths-tip.asciidoc similarity index 100% rename from docs/reference/setup/upgrade/set-paths-tip.asciidoc rename to docs/reference/upgrade/set-paths-tip.asciidoc diff --git a/docs/reference/setup/upgrade/shut-down-node.asciidoc b/docs/reference/upgrade/shut-down-node.asciidoc similarity index 100% rename from docs/reference/setup/upgrade/shut-down-node.asciidoc rename to docs/reference/upgrade/shut-down-node.asciidoc diff --git a/docs/reference/setup/upgrade/synced-flush.asciidoc b/docs/reference/upgrade/synced-flush.asciidoc similarity index 100% rename from docs/reference/setup/upgrade/synced-flush.asciidoc rename to docs/reference/upgrade/synced-flush.asciidoc diff --git a/docs/reference/setup/upgrade/upgrade-node.asciidoc b/docs/reference/upgrade/upgrade-node.asciidoc similarity index 100% rename from docs/reference/setup/upgrade/upgrade-node.asciidoc rename to docs/reference/upgrade/upgrade-node.asciidoc