Find your Elastic Stack Upgrade Path

''Plotting to upgrade your Elastic Stack to 6.0?''

You've come to the right place!

Answer a few questions, and we'll build a customized upgrade checklist for you that links to the relevant docs for each step of the way.

Ready to get started?

[[Let's Go!->Stack]]
[[Not right now, maybe later->Don't Panic]]

<<set $version = "unknown">>\
<<set $oss_only = false>>\
<<set $xpack = false>>\
<<set $xpack_security = false>>\
<<set $xpack_tls = false>>\
<<set $kibana = false>>\
<<set $beats = false>>\
<<set $logstash = false>>\
<<set $logstash_template = false>>\
<<set $v2indices = false>>\
<<set $v1indices = false>>\
<<set $upgrade_assistant = false>>\
<<set $diy_upgrade = false>>
<<set $shield = false>>
<<set $watcher = false>>
<<set $marvel = false>>
<<set $reporting = false>>
<<set $debug = true>>
''Upgrading from 5.6 to 6.0''

From 5.6, you can perform a rolling upgrade to 6.0. We recommend using the X-Pack Upgrade Assistant to prepare for the upgrade. 

[[I'll use the X-Pack Upgrade Assistant|Upgrade assistant][$upgrade_assistant = true]]
[[No thanks, I don't want to use X-Pack|Manual upgrade][$upgrade_assistant = false]]

<<include debug>>
''Don't Panic''

We'll be here for you whenever you're ready to plan your upgrade.
''Preparing to upgrade with the X-Pack Upgrade Assistant''

Use the Upgrade Assistant to:
* View issues you need to address before upgrading to 6.0.
<<if $v2_indices == true>>\
* Reindex your 2.x indices.
<<endif>>\
<<if $kibana == true>>\
* Upgrade the internal {{{.kibana}}} index.
<<endif>>\
<<if $xpack == true>>\
* Upgrade the internal X-Pack indices. 
<<endif>>\

<<if $xpack == true>>\
[[Next|X-Pack features]]
<<else>>\
[[Next|Rolling upgrade to 6.0]]
<<endif>>

<<include debug>>
''Manually Upgrading from 5.6 to 6.0''

<<if $xpack>>\
Attempting to manually upgrade the internal X-Pack indices is not recommended. Use the X-Pack 5.6 Upgrade Assistant to automatically upgrade the internal index templates, indices, and any 2.x indices that you need to carry forward to 6.0. 
  
[[Next|Upgrade assistant]]
<<else>>\
We understand, sometimes you just need to do things for yourself! 

<<if $version != "2.x">>\
Do you have any indices that were created in 2.x that you need to be able to access in 6.0? To see the version of each index, use the GET settings API:

{{{curl -XGET 'http://localhost:9200/_settings/index.version.created}}}

If an index's version starts with 20, you must reindex it to carry it forward as you upgrade.

[[Yes, I need to reindex 2.x indices->Preparing to upgrade from 5.6][$v2_indices = true]]
[[Nope, I don't have any 2.x indices that I need to carry forward->Preparing to upgrade from 5.6][$v2_indices = false]]
<<endif>>\
<<endif>>\

<<include debug>>



''Upgrading from 5.x to 6.0''

<<if $cloud>>\
You must perform a two-step rolling upgrade: Upgrade to 5.6 ,and then perform
a rolling upgrade to 6.0.\

[[Next->Rolling upgrade to 5.6]]\
<<else>>\
You have a couple options:\

* Perform a two-step rolling upgrade: Upgrade to 5.6, and then perform a rolling upgrade to 6.0.
* Perform a full cluster restart upgrade directly to 6.0.\

If your stack includes Kibana, Logstash, Beats, or X-Pack, we recommend upgrading to 5.6 on your way to 6.0 and using the X-Pack Upgrade Assistant to update the Beats and Logstash index templates and reindex the internal Kibana and X-Pack indices.

[[I'll upgrade to 5.6 first->Rolling upgrade to 5.6]]
[[I prefer to jump straight to 6.0->FCR upgrade to 6.0]]
<<endif>>

<<include debug>>
''Let's figure out what you need to do to get from 2.x to 6.0.''

Do you have any indices that were created in 1.x? To see the version of each index, use the GET settings API:

{{{curl -XGET 'http://localhost:9200/_settings/index.version.created'}}}

If an index's version starts with 10, you must reindex it to carry it forward as you upgrade.

[[Yes, I have 1.x indices that I need to carry forward|FCR upgrade to 5.6][$v1indices = true]]
[[No, I don't have any 1.x indices I need to access from my upgraded stack|FCR upgrade to 5.6][$v1indices = false]]

<<include debug>>
''Upgrading to 5.6''
<<set $upgrade_56 = "fcr">>\
To get from 2.x to 6.0, you need to perform a full cluster restart upgrade to 5.6, and then perform a rolling upgrade to 6.0. 

When upgrading, make sure you:
* ''Back up your data'' before making any changes!
* Use the Elasticsearch Migration Plugin to identify issues you need to address before upgrading to 5.6.
* Check all of the 5.x breaking changes to determine what changes affect your application(s).
* Verify that 5.6 compatible versions are available for any custom plugins you use.
* Test the upgrade in a dev environment.

[[Next|5.6 upgrade]]

<<include debug>>
''You can perform a rolling upgrade from 5.x to 5.6.''

<<set $upgrade_56 = "rolling">>\
When upgrading, make sure you:
* ''Back up your data'' before making any changes!
* Check the 5.6 breaking changes to determine what changes affect your application(s).
* Verify that 5.6 compatible versions are available for any custom plugins you use.
* Test the upgrade in a dev environment.

[[Next|5.6 upgrade]]

<<include debug>>
<<if $cloud>>\
<<include "cloud-upgrade">>\
<<else>>\
''Your 6.0 upgrade checklist''
<<if $version == "2.x" && $upgrade_56 == "fcr">>\
<<include "56-fcr-upgrade">>
<<endif>>\
<<if $upgrade_56 == "rolling">>\
<<include "56-rolling-upgrade">>
<<endif>>\
<<if $upgrade_60 == "rolling">>\
<<include "60-prepare">>\
<<include "60-rolling-upgrade">>\
<<endif>>
<<if $upgrade_60 == "fcr">>\
<<include "60-fcr-upgrade">>
<<endif>>\
<<endif>>\

<<include debug>>
<<set $upgrade_60 = "rolling">>\
''Rolling to 6.0''
You can upgrade from 5.6 by performing a rolling upgrade. A full cluster restart is not required. (Yay!)

[[Show me my upgrade checklist->Upgrade checklist]]

<<include debug>>
''First off, we need some information about your stack.''

What version are you currently running?
<<radiobutton "$version" "2.x">> 2.x
<<radiobutton "$version" "5.0-5.5">> 5.0-5.5
<<radiobutton "$version" "5.6">> 5.6
<span id="message"> </span>\

What products are you using?
<<checkbox "$elasticsearch" false true checked>> Elasticsearch 
<<checkbox "$kibana" false true>> Kibana 
<<checkbox "$logstash" false true>> Logstash 
<<checkbox "$beats" false true>> Beats 
<<checkbox "$hadoop" false true>> Elasticsearch for Hadoop 

Are you running in Elastic Cloud?
<<radiobutton "$cloud" true>> Yes
<<radiobutton "$cloud" false checked>> No

<<link "Next">>
	<<if $version == "unknown">>
	<<replace "#message">>You must select the version you are upgrading from.   
	<</replace>>
    <<elseif $cloud>><<goto "Upgrade checklist">>\
	<<elseif $version == "2.x">><<goto "SWM">>\
	<<elseif $version == "5.0-5.5" || $version == "5.6">><<goto "X-Pack?">>
	<<endif>>
<</link>>
''Preparing to upgrade from 5.6''

<<if $v2_indices>>\
You need to reindex your 2.x indices on 5.x to carry them forward to 6.0.
<<endif>>\
<<if $kibana>>\
<<set $kibana_manual = true>>\
<<endif>>\
<<if $beats>>\
<<set $beats_template_56 = true>>\
The Beats index templates in 5.6 have been updated to a 6.0 compatible format. To ensure uninterrupted service, make sure the 5.6 Beats template is loaded before upgrading.
<<elseif $logstash>>\
<<set $logstash_template_56 = true>>\
Because the `_all` field is deprecated in 6.0 and can no longer be enabled for new indices, the Elasticsearch output template has been updated in 5.6 to ensure a seamless migration to 6.0. 

If you have a custom Elasticsearch output template that uses `_all`, update it before upgrading. 
<<endif>>\

Before upgrading, make sure you:
* ''Back up your data'' before making any changes!
* Check the 6.0 breaking changes to determine what changes affect your application(s).
* Verify that 6.0 compatible versions are available for any custom plugins you use.
* Test the upgrade in a dev environment.\

[[Next|Rolling upgrade to 6.0]]

<<include debug>>
''Which X-Pack features do you normally use?''
<<checkbox "$xpack_security" false true>> Security
<<checkbox "$xpack_ml" false true>> Machine Learning
<<checkbox "$xpack_watcher" false true>> Watcher/Alerting
<<checkbox "$xpack_monitoring" false true>> Monitoring
<<checkbox "$xpack_reporting" false true>> Reporting

[[Next|Security]]

<<include debug>>




''Jumping straight to 6.0''
<<set $upgrade_60 = "fcr">>
Rolling upgrades to 6.0 are only supported from version 5.6. To jump straight to 6.0 from an earlier version, you must perform a full cluster restart upgrade. 

Before upgrading, make sure you:
* ''Back up your data'' before making any changes!
* Check the 6.0 breaking changes to determine what changes affect your application(s).
* Verify that 6.0 compatible versions are available for any custom plugins you use.
* Test the upgrade in a dev environment.\

After upgrading to 6.0, you might need to perform additional steps
before you can restart your stack.
<<if $beats>>\
* Beats uses new index templates in 6.0. After upgrading to Beats 6.0, you must make sure the new index template is loaded for each Beat type you are using.
<<endif>>\
<<if $kibana>>\
* Kibana uses a new index format in 6.0. After upgrading and starting Elasticsearch, you must manually upgrade the {{{.kibana}}} index to the new format before you can run Kibana 6.0.
<<endif>>\
<<if $xpack>>\
* The internal X-Pack indices need to be migrated to 6.0-compatible formats. Install X-Pack into Kibana 6.0, run Kibana, and use the X-Pack Upgrade Assistant to migrate the indices. 

[[Next|X-Pack features]]
<<else>>
[[Show me my upgrade checklist |Upgrade checklist]]
<<endif>>

<<include debug>>
<<if not $xpack_security>>\
  ''Have you considered using X-Pack Security to secure your cluster?''
  
  X-Pack Security makes it easy to protect your cluster and data from 
  unauthorized access. For more information about   
  options for securing your Elasticsearch stack, see [[Protecting your  cluster|https://www.elastic.co/blog/protecting-against-attacks-that-hold-your-data-for-ransom]].
<<endif>>\
<<if $xpack_security>>\
  ''Do you have TLS enabled to require node authentication?	''
  <<link "Yes">>
    <<replace "#security_message">>Great! TLS is required in 6.0.<</replace>>
  <</link>>
  <<link "No">>
    <<replace "#security_message">>TLS is required in 6.0 to protect clusters against man-in-the-middle type attacks. You will need to enable TLS before upgrading to 6.0, which requires a full-cluster restart. <</replace>>
	<<set $enable_tls = true>>
  <</link>>
  <span id="security_message"></span>
<<endif>>
<<if $upgrade_60 == "fcr">>
[[Show me my upgrade checklist|Upgrade checklist]]
<<else>>[[Next|Rolling upgrade to 6.0]]
<<endif>>

<<include debug>>
<<if $debug>>''56-fcr-upgrade''<<endif>>\
<<if $v1indices>>\
[[Reindex your Elasticsearch 1.x indices into a 2.x index|https://www.elastic.co/guide/en/elasticsearch/reference/5.6/reindex-upgrade.html]].
You will not be able to read and reindex 1.x indices once you upgrade to 5.6.
<<endif>>\

<<if $hadoop>>\
[[Upgrade Elasticsearch for Hadoop to 5.6|https://www.elastic.co/guide/en/elasticsearch/hadoop/5.6/install.html]].
Elasticsearch Hadoop 5.6 is compatible with Elasticsearch 2.x and Elasticsearch 5.x.
<<endif>>\

[[Shut down your cluster and install Elasticsearch 5.6 on all nodes|https://www.elastic.co/guide/en/elasticsearch/reference/5.6/restart-upgrade.html]].\

<<if $xpack>>\
[[Install X-Pack on each node|https://www.elastic.co/guide/en/elasticsearch/reference/5.6/installing-xpack-es.html]].
<<endif>>\

Restart your Elasticsearch cluster.\

<<include "56-components">>
<<if $debug>>''56-rolling-upgrade''<<endif>>\
[[Perform a rolling upgrade of your cluster to 5.6|https://www.elastic.co/guide/en/elasticsearch/reference/5.6/rolling-upgrades.html]] We recommend disabling shard allocation and pausing indexing while you upgrade.

<<include 56-components>>
<<if $debug>>''60-fcr-upgrade''<<endif>>\
<<if $v2indices>>\
<<checkbox>>[[Reindex your Elasticsearch 2.x indices into a 5.x index.|https://www.elastic.co/guide/en/elasticsearch/reference/5.6/reindex-upgrade.html]] You will not be able to read and reindex 2.x indices once you upgrade to 6.x.
<<endif>>\
<<if $xpack_security && !$xpack_tls>>\
[[Enable TLS on your 5.x cluster|https://www.elastic.co/guide/en/x-pack/5.5/ssl-tls.html]]
<<endif>>\
<<if $xpack_ml>>\
[[Stop any running Machine Learning jobs.|https://www.elastic.co/guide/en/x-pack/5.6/ml-gs-job1-manage.html]]
<<endif>>\
Stop sending data to your cluster.
[[Shut down your cluster and install Elasticsearch 6.0 on all nodes.|https://www.elastic.co/guide/en/elasticsearch/reference/6.0/restart-upgrade.html]]
<<if $xpack>>\
[[Install X-Pack on each node.|https://www.elastic.co/guide/en/elasticsearch/reference/6.0/installing-xpack-es.html]]
<<endif>>\
Restart your Elasticsearch cluster.
<<include 60-components>>\
<<if $debug>>''56-components''<<endif>>\
<<if $kibana>>\
[[Upgrade Kibana to 5.6.|https://www.elastic.co/guide/en/kibana/5.6/upgrade.html]]
<<if $xpack>>\
[[Install X-Pack into Kibana.|https://www.elastic.co/guide/en/kibana/5.6/installing-xpack-kb.html]]
<<endif>>\
Restart Kibana.
<<endif>>

<<if $logstash>>\
[[Upgrade Logstash to 5.6|https://www.elastic.co/guide/en/logstash/5.6/upgrading-logstash.html]]
<<if $xpack>>\
[[Install X-Pack into Logstash.|https://www.elastic.co/guide/en/logstash/5.6/installing-xpack-log.html]]
<<endif>>\
Restart Logstash.
<<endif>>\

<<if $beats>>\
[[Upgrade each beat to 5.6 and restart them.|https://www.elastic.co/guide/en/beats/libbeat/6.0/upgrading-5-to-6.html#upgrading-to-5.6]]
<<endif>>\

<<if $hadoop && $upgrade_56 == "rolling">>\
[[Upgrade Elasticsearch for Hadoop to 5.6.|https://www.elastic.co/guide/en/elasticsearch/hadoop/5.6/install.html Elasticsearch Hadoop 5.6 is compatible with Elasticsearch 2.x and Elasticsearch 5.x.
<<endif>>\
<<if $debug>>''60-rolling-upgrade''<<endif>>\
<<if $xpack_ml>>\
[[Stop any running Machine Learning jobs.|https://www.elastic.co/guide/en/x-pack/5.6/ml-gs-job1-manage.html]]
<<endif>>\
<<if $hadoop>>\
[[Upgrade Elasticsearch for Hadoop to 6.0.|https://www.elastic.co/guide/en/elasticsearch/hadoop/6.0/install.html]] Elasticsearch Hadoop 6.0 is compatible with Elasticsearch 5.x and Elasticsearch 6.x.
<<endif>>\
[[Perform a rolling upgrade to 6.0.|https://www.elastic.co/guide/en/elasticsearch/reference/6.0/rolling-upgrades.html]] We recommend disabling shard allocation and pausing indexing while you upgrade.
<<include 60-components>>
<<if $debug>>''60-prepare''<<endif>>\
Use the [[Upgrade Assistant|https://www.elastic.co/guide/en/kibana/5.6/xpack-upgrade-assistant.html#reindex-helper]] to:\

* Upgrade the internal {{{.kibana}}} index.
<<if $xpack>>\
* Upgrade the internal X-Pack indices.
<<elseif $v2indices>>\
* Upgrade your 2.x indices.
<<endif>>\

<<if $security && !$TLS>>\
[[Enable TLS to secure cluster communications.|https://www.elastic.co/guide/en/x-pack/current/ssl-tls.html]]
<<endif>>\
<<if $debug>>''60-components''<<endif>>\
<<if $kibana>>\
[[Upgrade Kibana to 6.0.|https://www.elastic.co/guide/en/kibana/5.6/upgrade.html]]
<<if $xpack>>\
[[Install X-Pack into Kibana.|https://www.elastic.co/guide/en/kibana/5.6/installing-xpack-kb.html]]
<<if $xpack_security>>\
[[Create a temporary super user and upgrade the internal .kibana index.|https://www.elastic.co/guide/en/elastic-stack/6.0/upgrading-elastic-stack.html#upgrade-internal-indices]]
Restart Kibana.
Log in to Kibana as the temporary super user.
[[Use the Upgrade assistant to upgrade the internal X-Pack indices.|https://www.elastic.co/guide/en/kibana/6.0/xpack-upgrade-assistant.html#reindex-helper]]
[[Delete the temporary super user.|https://www.elastic.co/guide/en/elasticsearch/reference/6.0/users-command.html]]
<<else>>\
Restart Kibana.
<<endif>>\
<<endif>>\
<<endif>>\
<<if $logstash>>\
[[Upgrade Logstash to 6.0.|https://www.elastic.co/guide/en/logstash/5.6/upgrading-logstash.html]]
<<if $xpack>>\
[[Install X-Pack into Logstash.|https://www.elastic.co/guide/en/logstash/5.6/installing-xpack-log.html]]
<<endif>>\
Restart Logstash.
<<endif>>\
<<if $beats>>\
[[Upgrade each beat to 6.0. and restart them.|https://www.elastic.co/guide/en/beats/libbeat/6.0/upgrading-5-to-6.html#upgrading-to-5.6]]\
<<endif>>\
<<if $hadoop>>\
[[Upgrade Elasticsearch for Hadoop to 6.0.|https://www.elastic.co/guide/en/elasticsearch/hadoop/6.0/install.html
Elasticsearch Hadoop 6.0 is compatible with Elasticsearch 5.x and Elasticsearch 6.x.
<<endif>>\
''Upgrading to 6.0 on Elastic Cloud''

On Elastic Cloud, all major configuration changes to upgrade Elasticsearch, Kibana, and X-Pack are handled for you. When preparing to upgrade, you need to:\

* [[Reindex any 2.4 or earlier indices that you need to carry forward|https://www.elastic.co/guide/en/elasticsearch/reference/6.0/reindex-upgrade.html]].
* Address any breaking changes that affect your applications.\

<<if $version != "5.6">>\
You must upgrade to 5.6 before upgrading to 6.0. \
<<endif>>\
A full cluster restart is required when upgrading to 6.0 to enable TLS.

For more information, see [[Upgrade to Elasticsearch 6.x|https://www.elastic.co/guide/en/cloud/saas-release/ec-upgrading-v6.html]].
''Do you use X-Pack?''

<<if $version == "5.0-5.5">>\
[[Yes|5.x upgrade][$xpack = true]]
[[No|5.x upgrade][$xpack = false]]\
<<else>>\
[[Yes|5.6 upgrade][$xpack = true]]
[[No|5.6 upgrade][$xpack = false]]\
<<endif>>

<<include debug>>
''Do you use any of Elastic's licensed products?''

If so, which products do you use?

<<checkbox "$shield" false true>> Shield 
<<checkbox "$watcher" false true>> Watcher 
<<checkbox "$marvel" false true>> Marvel 
<<checkbox "$reporting" false true>> Reporting 
<<checkbox "$oss_only" false true>>None of the above

[[Next->2.x upgrade]]

<<include debug>>
<<if $debug == true>>
Upgrading from: $version
Kibana: $kibana 
Beats: $beats
Logstash $logstash 
Logstash template: $logstash_template
Upgrade assistant: $upgrade_assistant
DIY upgrade: $diy_upgrade 
<<if $version == "2.x">>\
Shield: $shield 
Watcher: $watcher
Marvel: $marvel
Reporting: $reporting 
V1 Indices: $v1indices 
<<else>>\
X-Pack enabled: $xpack
X-Pack security: $xpack_security
TLS: $xpack_tls
<<endif>>\
V2 Indices: $v2indices 
<<endif>>