Skip to content

Commit 1716471

Browse files
authored
[DOCS] Corrected upgrade steps in the interactive guide & stack upgrade doc. (#82)
* [DOCS] Added note about removing X-Pack plugin & corrected enabling data collection info. * [DOCS] Removed ref to installing xpack, added removing x-pack & enabling data collection. * [DOCS] Added JS fixes. * [DOCS] Removed extraneous ref to installing X-Pack in Logstash. * [DOCS] Fixed error.
1 parent ee9f811 commit 1716471

File tree

2 files changed

+28
-9
lines changed

2 files changed

+28
-9
lines changed

docs/60_upgrade_guide.html

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,8 @@
583583

584584

585585

586+
587+
586588
</style><script role="script" id="twine-user-script" type="text/twine-javascript">postrender['radiobutton-reveal'] = function (content) {
587589
var reveal = content.querySelector('#reveal');
588590

@@ -611,6 +613,8 @@
611613

612614

613615

616+
617+
614618
</script><tw-passagedata pid="1" name="Start" tags="welcome" position="350,0">!!Planning to upgrade your Elastic Stack to 6.3?
615619
You&#x27;ve come to the right place!
616620

@@ -820,13 +824,20 @@
820824
&lt;&lt;endif&gt;&gt;\
821825
&lt;span class=&quot;pseudo-link&quot;&gt;Restart the node.&lt;/span&gt;
822826
&lt;/span&gt;\
823-
&lt;&lt;include components-56&gt;&gt;\</tw-passagedata><tw-passagedata pid="10" name="fcr-upgrade-60" tags="" position="1401,647">!!!Perform a Full Cluster Restart Upgrade to 6.3
827+
&lt;&lt;include components-56&gt;&gt;\</tw-passagedata><tw-passagedata pid="10" name="fcr-upgrade-60" tags="" position="1400,647">!!!Perform a Full Cluster Restart Upgrade to 6.3
824828
&lt;&lt;if $xpack_ml&gt;&gt;\
825829
[[Stop any running Machine Learning jobs.|https://www.elastic.co/guide/en/x-pack/current/stopping-ml.html]]
826830
&lt;&lt;endif&gt;&gt;\
827831
&lt;span class=&quot;pseudo-link&quot;&gt;Stop sending data to your cluster.&lt;/span&gt;
828832
[[Shut down your cluster and install Elasticsearch 6.3 on all nodes.|https://www.elastic.co/guide/en/elasticsearch/reference/6.3/restart-upgrade.html]]
829-
&lt;span class=&quot;list-indent&quot;&gt;X-Pack is installed automatically with the default Elasticsearch 6.3 distribution.&lt;/span&gt;
833+
&lt;&lt;if $xpack&gt;&gt;\
834+
&lt;span class=&quot;pseudo-link&quot;&gt;Remove the X-Pack plugin before restarting Elasticsearch.&lt;/span&gt;
835+
&lt;span class=&quot;list-indent&quot;&gt;Run bin/elasticsearch-plugin remove x-pack.&lt;/span&gt;\
836+
&lt;&lt;endif&gt;&gt;\
837+
&lt;&lt;if $xpack_monitoring&gt;&gt;\
838+
&lt;span class=&quot;pseudo-link&quot;&gt;Explicitly enable data collection to use monitoring.&lt;/span&gt;\
839+
&lt;span class=&quot;list-indent&quot;&gt;Set xpack.monitoring.collection.enabled to true with the _cluster/settings API.&lt;/span&gt;\
840+
&lt;&lt;endif&gt;&gt;\
830841
&lt;&lt;include enable-tls&gt;&gt;\
831842
&lt;span class=&quot;pseudo-link&quot;&gt;Restart your Elasticsearch cluster&lt;/span&gt;.
832843
&lt;&lt;include components-60&gt;&gt;</tw-passagedata><tw-passagedata pid="11" name="components-56" tags="" position="1533,221">&lt;&lt;if $kibana&gt;&gt;\
@@ -848,7 +859,7 @@
848859
&lt;&lt;endif&gt;&gt;\
849860
&lt;&lt;if $hadoop &amp;&amp; $upgrade_56 == &quot;rolling&quot;&gt;&gt;\
850861
[[Upgrade Elasticsearch for Hadoop to 5.6.|https://www.elastic.co/guide/en/elasticsearch/hadoop/5.6/install.html]]\
851-
&lt;&lt;endif&gt;&gt;\</tw-passagedata><tw-passagedata pid="12" name="rolling-upgrade-60" tags="" position="1400,476">!!!Upgrade to 6.3
862+
&lt;&lt;endif&gt;&gt;\</tw-passagedata><tw-passagedata pid="12" name="rolling-upgrade-60" tags="" position="1401,476">!!!Upgrade to 6.3
852863
&lt;&lt;if $xpack_ml&gt;&gt;\
853864
[[Stop any running Machine Learning jobs.|https://www.elastic.co/guide/en/elastic-stack-overview/6.3/stopping-ml.html]]
854865
&lt;&lt;endif&gt;&gt;\
@@ -858,6 +869,14 @@
858869
&lt;&lt;endif&gt;&gt;\
859870
[[Upgrade Elasticsearch to 6.3.|https://www.elastic.co/guide/en/elasticsearch/reference/6.3/rolling-upgrades.html]]
860871
&lt;span class=&quot;list-indent&quot;&gt;You can perform a rolling upgrade to Elasticsearch 6.3.&lt;/span&gt;\
872+
&lt;&lt;if $xpack&gt;&gt;\
873+
&lt;span class=&quot;pseudo-link&quot;&gt;Remove the X-Pack plugin before restarting Elasticsearch.&lt;/span&gt;
874+
&lt;span class=&quot;list-indent&quot;&gt;Run bin/elasticsearch-plugin remove x-pack.&lt;/span&gt;\
875+
&lt;&lt;endif&gt;&gt;\
876+
&lt;&lt;if $xpack_monitoring&gt;&gt;\
877+
&lt;span class=&quot;pseudo-link&quot;&gt;Explicitly enable data collection to use monitoring.&lt;/span&gt;\
878+
&lt;span class=&quot;list-indent&quot;&gt;Set xpack.monitoring.collection.enabled to true with the _cluster/settings API.&lt;/span&gt;\
879+
&lt;&lt;endif&gt;&gt;\
861880
&lt;&lt;if $upgrade_63 == &quot;rolling&quot;&gt;&gt;\
862881
&lt;&lt;include &quot;components-63&quot;&gt;&gt;\
863882
&lt;&lt;else&gt;&gt;\
@@ -909,9 +928,6 @@
909928
&lt;&lt;if $logstash&gt;&gt;\
910929
[[Upgrade Logstash to 6.3.|https://www.elastic.co/guide/en/logstash/5.6/upgrading-logstash.html]]
911930
&lt;span class=&quot;list-indent&quot;&gt;You can run Logstash 5.6 with Elasticsearch 6.3 until it&#x27;s convenient to upgrade.&lt;/span&gt;\
912-
&lt;&lt;if $xpack&gt;&gt;\
913-
[[Install X-Pack into Logstash.|https://www.elastic.co/guide/en/logstash/5.6/installing-xpack-log.html]]
914-
&lt;&lt;endif&gt;&gt;\
915931
&lt;&lt;endif&gt;&gt;\
916932
&lt;&lt;if $beats&gt;&gt;\
917933
[[Upgrade each beat to 6.3.|https://www.elastic.co/guide/en/beats/libbeat/6.3/upgrading-5-to-6.html#upgrading-to-5.6]]

docs/upgrading-stack.asciidoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,12 @@ or 6.0-6.2. {xpack} Basic features are operational once the cluster is fully
121121
upgraded. If you are already using {xpack}, your settings are preserved when
122122
you upgrade.
123123

124-
If you are using {xpack} for the first time, you must explicitly enable data
125-
collection after the upgrade to use monitoring. Set
126-
`xpack.monitoring.collection.enabled` to `true` with the `_cluster/settings`
124+
IMPORTANT: If you use {xpack} you must explicitly remove the old {xpack} plugin
125+
before restarting: `bin/elasticsearch-plugin remove x-pack`. The node will fail
126+
to start if the {xpack} plugin is present.
127+
128+
You must explicitly enable data collection after the upgrade to use monitoring.
129+
Set `xpack.monitoring.collection.enabled` to `true` with the `_cluster/settings`
127130
API:
128131

129132
[source,json]

0 commit comments

Comments
 (0)