Skip to content

Commit 0973404

Browse files
committed
7.0 upgrade (#242)
* [DOCS] First pass at 7.0 upgrade update. * [DOCS] Fixed formatting issues & flagged the Upgrade Assistant as xpack. * Update docs/en/install-upgrade/upgrading-stack.asciidoc Co-Authored-By: debadair <[email protected]> * [DOCS] Incorporated feedback from lcawl. * [DOCS] Fixes broken link * [DOCS] Removed tip about temporary superuser when upgrading the security index.
1 parent 9a7d9fd commit 0973404

File tree

1 file changed

+66
-222
lines changed

1 file changed

+66
-222
lines changed

docs/en/install-upgrade/upgrading-stack.asciidoc

Lines changed: 66 additions & 222 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,13 @@
11
[[upgrading-elastic-stack]]
22
== Upgrading the Elastic Stack
33

4-
When upgrading to a new version of Elasticsearch, you need to upgrade
5-
each of the products in your Elastic Stack. Beats and Logstash 5.6 are
6-
compatible with Elasticsearch {version} to give you flexibility in scheduling the
7-
upgrade.
4+
When upgrading to a new version of {es}, you need to upgrade
5+
each of the products in your Elastic Stack. Beats and Logstash 7.n are
6+
compatible with {es} {version} to give you flexibility in scheduling
7+
the upgrade.
88

9-
****
10-
The steps you need to take to upgrade differ depending on which products you
11-
are using. Want a list that's tailored to your stack? Try out our
12-
{upgrade_guide}[Interactive Upgrade Guide].
13-
****
14-
15-
If you are running a pre-6.0 version, we recommend upgrading to the most
16-
recent 5.6 before upgrading to {version}. {xpack} 5.6
17-
provides a free Upgrade Assistant that identifies issues you need to address
18-
before upgrading and simplifies migrating indices that need to be reindexed
19-
before you upgrade. The Upgrade Assistant is enabled with both Trial and
20-
Basic licenses. You can install {xpack} solely for the purpose of upgrading.
21-
22-
Rolling upgrades are supported when upgrading from Elasticsearch 5.6 and
23-
Elasticsearch 6.0-6.2 to {version}. Upgrading from any
24-
version prior to 5.6 requires a full cluster restart.
9+
{es} supports rolling upgrades between minor versions, from {es} 5.6 to 6.7,
10+
from 6.7 to 7.x, and from 7.n to {version}.
2511

2612
IMPORTANT: 6.x and older indices are not compatible with {version}. You must
2713
remove or reindex them on your 7.x cluster before upgrading to {version}. The internal
@@ -32,241 +18,99 @@ also need to be updated to work with {version}.
3218

3319
Before upgrading the Elastic Stack to {version}:
3420

35-
. Back up your data. You **cannot roll back** to an earlier version unless
36-
you have a backup of your data. For information about creating snapshots, see
37-
{ref}/modules-snapshots.html[Snapshot and Restore].
38-
39-
. Check the Elasticsearch {ref}/settings.html[deprecation log] to see if
40-
you're using any deprecated features and update your code accordingly.
41-
By default, deprecation log messages are enabled at the `WARN` level.
42-
43-
. Review the breaking changes for each product you use
44-
and make the necessary changes so your code is compatible with {version}. See
45-
<<elastic-stack-breaking-changes>>.
21+
. Check the {es} {ref}/logging.html#deprecation-logging[deprecation log]
22+
to see if you're using any deprecated features and update your code accordingly.
23+
By default, deprecation warnings are logged when the log level is set to `WARN`.
4624

47-
. {ref}/docs-reindex.html[Reindex] or delete any indices created on 2.n. We recommend
48-
upgrading to the most recent 5.6 and using the {xpack} Reindex Helper to reindex 2.n indices.
25+
. Review the <<elastic-stack-breaking-changes>> and upgrade your code to work
26+
with {version}.
4927

50-
. If Kibana and {xpack} are part of your stack, upgrade the internal Kibana
51-
and {xpack} indices. We recommend using the {xpack} 5.6 Reindex Helper to
52-
upgrade the internal indices. If you're performing a full cluster restart upgrade
53-
from an earlier version, you can also
54-
<<upgrade-internal-indices,use the `_migration/upgrade` API>> directly to
55-
upgrade the internal indices after you install Elasticsearch {version}.
56-
57-
. If you use {stack} {security-features} to secure your cluster:
58-
.. Make sure TLS is enabled to encrypt communications between nodes. TLS must
59-
be enabled to upgrade to {version}. For more information, see
60-
{stack-ov}/encrypting-communications.html[Encrypting communications].
28+
. Upgrade to 6.7 and use the {kibana-ref}/upgrade-assistant.html[{kib} Upgrade Assistant] to {ref}/docs-reindex.html[reindex]
29+
any indices that are not compatible with {version}.
6130
+
62-
NOTE: Enabling TLS requires a full cluster restart. Nodes that have TLS
63-
enabled cannot communicate with nodes that do not have TLS enabled. You must
64-
restart all nodes to maintain communication across the cluster.
65-
66-
.. Make sure real passwords are configured for the built-in `elasticsearch`,
67-
`kibana`, and `logstash_system` users. They cannot use the 5.n default
68-
password (`changeme`). For more information, see
69-
{stack-ov}/built-in-users.html[Built-in users].
70-
71-
. Consider closing {ml} jobs before you start the upgrade process. It is not
72-
required, but there are pros and cons to leaving the jobs running. These
73-
considerations are described in the steps related to
74-
{ref}/setup-upgrade.html[upgrading {es}].
31+
[role="xpack"]
32+
.Upgrade Assistant
33+
******
34+
The Upgrade Assistant and migration APIs are enabled with both the Basic and
35+
Trial licenses. You can install the default distribution of 6.7 to use the
36+
Upgrade Assistant to prepare to upgrade even if you are upgrading to the OSS
37+
distribution of {version}.
38+
******
7539

76-
IMPORTANT: Test upgrades in a dev environment before upgrading your
77-
production cluster.
40+
. Use the Upgrade Assistant to identify any changes you need to make to your
41+
cluster configuration.
7842

7943
[[upgrade-order-elastic-stack]]
80-
=== Upgrade order
81-
82-
Upgrade the Elastic Stack products you use in the following order:
44+
=== Upgrade process
8345

84-
. Elasticsearch Hadoop: {hadoop-ref}/install.html[install instructions]
85-
. Elasticsearch: {ref}/setup-upgrade.html[upgrade instructions]
86-
. Kibana: {kibana-ref}/upgrade.html[upgrade instructions]
87-
. Logstash: {logstash-ref}/upgrading-logstash.html[upgrade instructions]
88-
. Beats: {beats-ref}/upgrading.html[upgrade instructions]
89-
. APM Server: {apm-server-ref}/upgrading.html[upgrade instructions]
90-
91-
NOTE: Logstash 5.6 and 6.n and Beats 5.6 and 6.n are compatible with all 6.n versions of
92-
Elasticsearch. This provides flexibility in when you schedule the upgrades
93-
for your Logstash instances and Beats agents. We recommend upgrading Logstash
94-
and Beats as soon as possible to take advantage of performance improvements
95-
and other enhancements.
96-
97-
=== Upgrading to 6.3
98-
Starting in 6.3, the default distributions of {es}, {ls}, and {kib}
99-
include {xpack} and a free Basic license that never expires.
100-
101-
You can perform rolling upgrades to 6.3 from OSS-only clusters running 5.6
102-
or 6.0-6.2. Basic features are operational once the cluster is fully
103-
upgraded. If you are already using {xpack}, your settings are preserved when
104-
you upgrade.
105-
106-
IMPORTANT: If you use {xpack} you must explicitly remove the old {xpack} plugin
107-
before restarting: `bin/elasticsearch-plugin remove x-pack`. The node will fail
108-
to start if the {xpack} plugin is present.
109-
110-
You must explicitly enable data collection after the upgrade to use monitoring.
111-
Set `xpack.monitoring.collection.enabled` to `true` with the `_cluster/settings`
112-
API:
113-
114-
[source,json]
115-
----------------------------------------------------------
116-
PUT /_cluster/settings
117-
{
118-
"persistent" : {
119-
"xpack.monitoring.collection.enabled" : "true"
120-
}
121-
}
122-
----------------------------------------------------------
123-
// CONSOLE
124-
125-
To take more of the {stack} features for a spin, you can start a 30-day trial
126-
from Kibana or with the Start Trial API:
127-
128-
[source,json]
129-
----------------------------------------------------------
130-
POST _license/start_trial
131-
----------------------------------------------------------
132-
// CONSOLE
133-
134-
The 30-day trial enables you to try out the full set of platinum features,
135-
including security, machine learning, alerting, graph capabilities, and more.
136-
137-
[role="xpack"]
138-
[[xpack-stack-upgrade]]
139-
=== Upgrading from 5.6
46+
When you've made the necessary changes and are ready to upgrade from 6.7 to
47+
{version}:
14048

141-
{xpack} 5.6 provides migration and upgrade APIs for Elasticsearch and a
142-
Upgrade Assistant UI for Kibana. These tools are included with the trial
143-
license and the free basic license.
144-
145-
To upgrade to {version} from 5.6:
49+
. Test the upgrade in a dev environment *before* upgrading your
50+
production cluster.
14651

147-
. {ref}/setup-upgrade.html[Upgrade Elasticsearch] to the most recent 5.6 and
148-
install {xpack} on all nodes in your cluster. If you are upgrading from an
149-
earlier 5.x release, you can perform a rolling upgrade. To upgrade from older
150-
versions you must perform a full cluster restart.
151-
+
152-
If your trial license expires,
153-
https://register.elastic.co/[register for a free Basic license]. To apply the
154-
license, upload the license file with the `license` API:
155-
+
156-
[source,json]
157-
----------------------------------------------------------
158-
license -d @license.json
159-
----------------------------------------------------------
52+
. Back up your data. You **cannot roll back** to an earlier version unless
53+
you have a snapshot of your data. For information about creating snapshots, see
54+
{ref}/modules-snapshots.html[Snapshot and Restore].
16055

161-
. If {xpack} **IS NOT** normally a part of your {stack}, disable the
162-
{es} {security-features} in `elasticsearch.yml`:
163-
+
164-
[source,yaml]
165-
----------------------------------------------------------
166-
xpack.security.enabled: false
167-
----------------------------------------------------------
56+
. Consider closing {ml} jobs before you start the upgrade process. While {ml}
57+
jobs can continue to run during a rolling upgrade, it increases the overhead
58+
on the cluster during the upgrade process. For more information, see
59+
{ref}/rolling-upgrades.html[Rolling upgrades].
16860

169-
. Upgrade {kib} to the most recent 5.6 and install {xpack}.
61+
. Upgrade the components of your Elastic Stack in the following order:
17062

171-
. If you disabled the {es} {security-features}, also disable the {kib}
172-
{security-features} in `kibana.yml`:
173-
+
174-
[source,yaml]
175-
----------------------------------------------------------
176-
xpack.security.enabled: false
177-
----------------------------------------------------------
63+
.. {es} Hadoop: {hadoop-ref}/install.html[install instructions]
64+
.. {es}: {ref}/setup-upgrade.html[upgrade instructions]
65+
.. Kibana: {kibana-ref}/upgrade.html[upgrade instructions]
66+
.. Logstash: {logstash-ref}/upgrading-logstash.html[upgrade instructions]
67+
.. Beats: {beats-ref}/upgrading.html[upgrade instructions]
68+
.. APM Server: {apm-server-ref}/upgrading.html[upgrade instructions]
17869

179-
. Use the Upgrade Assistant in Kibana to
180-
view incompatibilities that you need to fix, identify any 2.x indices that
181-
need to be migrated or deleted, and upgrade the internal indices to the
182-
{major-version} index format.
183-
+
184-
You can also call the Elasticsearch migration APIs directly:
185-
+
186-
`/_xpack/migration/deprecations`:: Retrieves information about cluster-, node-,
187-
and index-level settings that use deprecated features.
188-
+
189-
`/_xpack/migration/assistance`:: deprecated[6.7.0] Returns a list of indices
190-
that need to be reindexed before you can upgrade to {version}.
191-
+
192-
`/_xpack/migration/upgrade`:: deprecated[6.7.0] Upgrades the indices for the
193-
{watcher} and {security-features} to a single-type format compatible with
194-
Elasticsearch 6.x.
195-
196-
. Once you've resolved all of the migration issues, perform
197-
a {ref}/rolling-upgrades.html[rolling upgrade] from Elasticsearch 5.6 to {version}.
70+
NOTE: Logstash 6.7 and Beats 6.7 are compatible with all 7.x versions of
71+
{es}. This provides flexibility in when you schedule the upgrades
72+
for your Logstash instances and Beats agents, but we recommend upgrading as
73+
soon as possible to take advantage of performance improvements
74+
and other enhancements.
19875

19976
[[oss-stack-upgrade]]
200-
=== Upgrading from a pre-5.6 installation
201-
202-
It is possible to upgrade directly to {major-version} from a pre-5.6 installation,
203-
but it requires a {ref}/restart-upgrade.html[full cluster restart] and you must
204-
manually reindex any 2.x indices you need to carry forward to {major-version}.
205-
206-
IMPORTANT: If you use Kibana or {xpack}, you also need to upgrade the
207-
internal Kibana and {xpack} indices. For information about upgrading them
208-
after you install Elasticsearch {version}, see
209-
<<upgrade-internal-indices, Upgrading internal indices>>.
210-
211-
To manually reindex a 2.x index:
212-
213-
. Create an index with 6.x compatible mappings.
214-
. Use the {ref}/docs-reindex.html[reindex API] to copy documents from the
215-
2.x index into the new index. You can use a script to perform any necessary
216-
modifications to the document data and metadata during reindexing.
217-
. Use the {ref}/indices-aliases.html[_aliases] API to add the name of the 2.x
218-
index as alias for the new index and delete the 2.x index.
219-
220-
[[upgrade-internal-indices]]
221-
==== Upgrading internal indices for {major-version}
222-
223-
The format used for the internal indices used by Kibana and {xpack} has
224-
changed in {major-version}. Before you can run Kibana and {xpack} in {version},
225-
these indices must be upgraded to the new format. If you are upgrading from a
226-
version prior to 5.6, you must upgrade them after after installing
227-
Elasticsearch {version}.
228-
229-
To get a list of the indices that need to be upgraded, use the
230-
{ref}/migration-api-deprecation.html[deprecation info API]:
231-
232-
[source,json]
233-
----------------------------------------------------------
234-
GET /_xpack/migration/deprecations
235-
----------------------------------------------------------
236-
// CONSOLE
237-
238-
To upgrade the `.security` index:
77+
=== Upgrading from 6.6 or earlier
23978

240-
. On a single node, add a temporary superuser account to the `file` realm.
241-
. Use the {kib} Upgrade Assistant to upgrade the security index, submitting the
242-
request with the credentials for the temporary superuser. Alternatively, you can
243-
{ref}/reindex-upgrade.html[reindex manually].
79+
To upgrade directly to {es} {version} from versions 6.0-6.6, you must
80+
{ref}/reindex-upgrade.html[manually reindex] any 5.x indices you need to
81+
carry forward, and perform a {ref}/restart-upgrade.html[full cluster restart].
82+
This includes any internal indices created in 5.x, such as the `.kibana` and
83+
`.security*` indices.
24484

245-
. Delete the temporary superuser account from the file realm.
85+
Make sure all 5.x indices have been deleted before upgrading to {version}. {es}
86+
{version} will fail to start if any 5.x indices are present.
24687

247-
You can use your regular administration credentials to upgrade the other
248-
internal indices.
88+
If you are running a version prior to 6.0,
89+
https://www.elastic.co/guide/en/elastic-stack/6.7/upgrading-elastic-stack.html[upgrade to 6.7]
90+
and reindex your old indices or bring up a new {version} cluster and
91+
{ref}/reindex-upgrade-remote.html[reindex from remote].
24992

250-
TIP: Once you upgrade the `.kibana` index, you can run Kibana and use the
251-
{xpack} Reindex Helper UI to upgrade the other indices.
93+
The recommended path is to upgrade to 6.7 before upgrading to {version}. This
94+
makes it easier to identify the changes you need to make to upgrade and enables
95+
you to perform a rolling upgrade with no downtime.
25296

25397
[[upgrade-elastic-stack-for-elastic-cloud]]
25498
=== Upgrading on Elastic Cloud
25599

256100
A single click in the Elastic Cloud console can upgrade a cluster to a newer
257101
version, add more processing capacity, change plugins, and enable or disable
258102
high availability, all at the same time. During the upgrade process,
259-
Elasticsearch, Kibana, {xpack} and the officially included plugins are
103+
{es}, Kibana, {xpack} and the officially included plugins are
260104
upgraded simultaneously.
261105

262106
Although upgrading your Elastic Cloud clusters is easy, you still need to
263107
address breaking changes that affect your application. Minor version upgrades,
264-
upgrades from 5.6 to {major-version}, and all other cluster configuration
108+
upgrades from 6.7 to {version}, and all other cluster configuration
265109
changes can be performed with no downtime.
266110

267111
To avoid downtime when a full cluster restart is required:
268112

269-
. Provision an additional cluster with the new Elasticsearch version, reindex
113+
. Provision an additional cluster with the new {es} version, reindex
270114
your data, and send index requests to both clusters temporarily.
271115

272116
. Verify that the new cluster performs as expected, fix any problems, and then
@@ -276,7 +120,7 @@ permanently swap in the new cluster.
276120
only for the time that the new cluster runs in parallel with your old cluster.
277121
Usage is billed on an hourly basis.
278122

279-
To learn more about the upgrade process on Elastic Cloud, see
123+
To learn more about the upgrade process on Elastic Cloud, see
280124
{cloud}/ec-upgrade-cluster.html[Upgrade versions].
281125

282126
NOTE: Elastic Cloud only supports upgrades to released versions. Preview

0 commit comments

Comments
 (0)