Commit graph

75 commits

Author SHA1 Message Date
shainaraskas
ae3db6042a
[8.x] [DOCS] Concept cleanup 2 - ES settings (#119373) (#119642) 2025-01-10 10:31:16 -05:00
Stef Nestor
05060f8413
(Doc+) Link Gateway Settings to Full Restart (#110902)
* (Doc+) Link Gateway Settings to Full Restart

---------

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-07-25 09:10:19 -06:00
Yannick Welsch
46b386be16
Docs for snapshots as simple archives (#86261)
Adds documentation for the new snapshots as archive feature.

Relates #81210
2022-05-30 13:23:53 +02:00
David Turner
e70dc48220
Permit removal of archived index settings (#86107)
Today you cannot remove archived index settings by applying a setting
update `{"archived.*":null}` because `IndexSettings#same` incorrectly
treats such an update as a no-op. This commit fixes that.
2022-04-26 08:27:16 +01:00
James Rodewig
2a1d666024
[DOCS] Remove unused upgrade doc files (#83617)
* Removes several unused asciidoc files for upgrade docs
* Fixes a redirect for "Rolling upgrade"
* Adds redirects for "Reindex before upgrading," "Reindex in place," and "Reindex from a remote cluster"

Relates to https://github.com/elastic/elasticsearch/pull/83489 and
https://github.com/elastic/docs/pull/2312
2022-02-08 11:14:28 -05:00
James Rodewig
47d45d0a14
[DOCS] Archived settings block config updates (#82069)
**Changes:**

* Notes that archived cluster settings block cluster setting updates. Previously, the docs stated that ES ignored archived cluster settings.
* Notes that archived index settings can block index settings updates. For example, it blocks `index.hidden` but not `number_of_replicas`. Previously, the docs stated that you could safely ignore archived index settings.

Relates #78351

Closes #61175
2022-01-26 12:21:46 -05:00
James Rodewig
03afcf1a88
[DOCS] Clarify rolling upgrade support for minor versions (#81444)
We only support rolling upgrades between minor versions of the same
major.

It also adds some tags to reuse duplicated content.
2021-12-09 09:04:10 -05:00
Leaf-Lin
9edfed81cb
[DOCS] Clarifying tiers order in rolling_upgrade (#79617)
* Update rolling_upgrade.asciidoc

adding node attributes comment in the upgrade order

* Update docs/reference/upgrade/rolling_upgrade.asciidoc

Co-authored-by: David Turner <david.turner@elastic.co>

* Update docs/reference/upgrade/rolling_upgrade.asciidoc

Co-authored-by: David Turner <david.turner@elastic.co>

* Apply suggestions from code review

adding retrieval of the tier list

* Update docs/reference/upgrade/rolling_upgrade.asciidoc

* format to 80 width wide

* Remove paragraph break

* Update rolling_upgrade.asciidoc

* Update rolling_upgrade.asciidoc

* Update docs/reference/upgrade/rolling_upgrade.asciidoc

Co-authored-by: David Turner <david.turner@elastic.co>

* Update docs/reference/upgrade/rolling_upgrade.asciidoc

Co-authored-by: David Turner <david.turner@elastic.co>

Co-authored-by: David Turner <david.turner@elastic.co>
2021-12-08 21:24:26 +11:00
James Rodewig
f56a0f4b66
[DOCS] Remove testenv annotations from doc snippet tests (#80023)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
2021-11-05 18:38:50 -04:00
James Rodewig
f4bfdee5db [DOCS] Fix cluster get settings API refs 2021-11-05 17:20:17 -04:00
Leaf-Lin
72dcdb1ea9
Adding upgrade by tier in rolling_upgrade doc (#77491)
* Update rolling_upgrade.asciidoc

As discussed in https://github.com/elastic/elasticsearch/issues/77007#issuecomment-909087934, it was decided that documentation on rolling upgrade should explicitly mention upgrading by tiers.

* Update docs/reference/upgrade/rolling_upgrade.asciidoc

Co-authored-by: Henning Andersen <33268011+henningandersen@users.noreply.github.com>

Co-authored-by: Henning Andersen <33268011+henningandersen@users.noreply.github.com>
2021-10-21 21:56:45 +11:00
James Rodewig
58abbe941f
[DOCS] Fix cluster update settings refs (#79580)
The API is named 'cluster update settings,' not 'update cluster settings.'
2021-10-20 13:16:35 -04:00
James Rodewig
12019a89fd
[DOCS] Document archived settings (#78351)
Documents `archived.*` persistent cluster settings and index settings.
These settings are commonly produced during a major version upgrade.

Closes #28027
2021-09-30 09:27:53 -04:00
James Rodewig
1304e648c8
[DOCS] Fix upgrade version logic for -alpha and -beta releases (#76727) 2021-08-20 08:29:35 -04:00
James Rodewig
3c88fbea75
[DOCS] Note remote reindex does not support slicing (#73959)
A reindex from a remote cluster doesn't support automatic or manual slicing.
This reuses a related note from the reindex docs in the upgrade docs.

Closes #54243.
2021-06-22 09:00:37 -04:00
David Turner
e027ce977c
Extend version barrier to all upgrades (#73358)
Today when upgrading to the next major version we have a so-called
_major version barrier_: once the cluster comprises nodes of the new
major version then nodes of the previous major version are prevented
from joining the cluster. This means we can be certain that
`clusterState.nodes().getMinNodeVersion().major` will never decrease, so
we can implement upgrade logic that relies on the cluster remaining in
its wholly-upgraded state.

This commit generalises this behaviour to apply to all upgrades, so that
we can be certain that `clusterState.nodes().getMinNodeVersion()` will
never decrease in a running cluster.

Closes #72911
2021-06-01 09:07:23 +01:00
James Rodewig
39a0314d30
[DOCS] Update alias xrefs (#73380)
Updates several internal 'alias' xrefs to point to the aliases guide rather than
API docs.
2021-05-25 16:19:00 -04:00
James Rodewig
97054d6570
[DOCS] Replace 'log into' with 'log in to' (#72324) 2021-04-27 15:27:22 -04:00
Henning Andersen
6fbd2601df
[DOCS] Disable shard allocation - data nodes only (#72265)
When doing a rolling restart we recommend disabling shard allocation to
avoid unnecessary recoveries. However, this advise is unnecessary or
even harmful when restarting nodes that do not carry any data like a
pure ML node.
2021-04-27 11:19:03 +02:00
James Rodewig
693807a6d3
[DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
James Rodewig
cb3e0051e0
[DOCS] Make cat API verbose query param explicit (#67300) 2021-01-11 17:19:23 -05:00
Dimitris Athanasiou
d1485eb3b1
[DOCS] Add missing "with" in remote reindex doc (#65532) 2020-11-30 08:32:18 -05:00
James Rodewig
fc0997a939
[DOCS] Note remote reindex is not fwd compatible (#60425) 2020-07-30 09:08:59 -04:00
James Rodewig
f3323b9e55
[DOCS] Clarify compatibility for upgrade via reindex (#60045) (#60207)
Co-authored-by: Inbar Shimshon <inbar.shimshon@elastic.co>
2020-07-27 09:38:30 -04:00
James Rodewig
2774cd6938
[DOCS] Swap [float] for [discrete] (#60124)
Changes instances of `[float]` in our docs for `[discrete]`.

Asciidoctor prefers the `[discrete]` tag for floating headings:
https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 11:48:22 -04:00
James Rodewig
7c449319a1
[DOCS] Relocate shard allocation module content (#56535) 2020-05-12 08:55:57 -04:00
James Rodewig
0adf082033
[DOCS] Add maintenance releases to upgrade table (#55012)
Updates the supported upgrade path table in [Upgrade Elasticsearch][0]
to include a new row for maintenance releases. For example, this row
covers upgrading from 7.6.0 to 7.6.2.

The new table row only displays for releases greater than n.x.0. For
example, the new row will display for the 7.7.1 release but not the
7.7.0 release.

[0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/setup-upgrade.html
2020-04-14 11:29:35 -04:00
Glen Smith
1eb0047f4f [DOCS] Clarify cluster health status during rolling upgrade (#40757)
Remove mention of the `yellow` and `red` starting
health status from the rolling upgrade docs.

Instead, we should emphasize that users wait 
for the node to recover with a health status of
`green` rather than the starting status.

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-03-31 14:14:52 -04:00
David Turner
898012028e
Clarify futher the order for a rolling upgrade (#52964)
Expands the "master-ineligible then master-eligible" sentence into a list and
specifies that within these subsets the order doesn't matter.
2020-03-05 15:27:56 +00:00
Nhat Nguyen
09b46c8646
Goodbye and thank you synced flush! (#50882)
Synced flush was a brilliant idea. It supports instant recoveries with a 
quite small implementation. However, with the presence of sequence
numbers and retention leases, it is no longer needed. This change
removes it from 8.0.

Relates #5077
2020-01-16 09:43:07 -05:00
Nhat Nguyen
08b8450b62 Deprecate synced flush (#50835)
A normal flush has the same effect as a synced flush on Elasticsearch
7.6 or later. It's deprecated in 7.6 and will be removed in 8.0.

Relates #50776
2020-01-13 19:54:23 -05:00
Nhat Nguyen
9e46bbd306
Replace synced-flush with flush in rolling upgrade to 8.0 (#50524)
This change recommends using a regular flush instead of synced-flush in 
a rolling upgrade from 7.x to 8.0. We can perform noop recoveries with a
regular flush
2019-12-30 11:30:30 -05:00
Orhan Toy
48342740c5 [DOCS] Fixes "enables you to" typos (#50225) 2019-12-23 14:38:37 -05:00
Lisa Cawley
362ce41eaf
[DOCS] Updates ML links (#50387) 2019-12-19 14:47:28 -08:00
David Turner
69e0b1a0f4
Drop snapshot instructions for autobootstrap fix (#49755)
The "Restore any snapshots as required" step is a trap: it's somewhere between
tricky and impossible to restore multiple clusters into a single one.

Also add a note about configuring discovery during a rolling upgrade to
proscribe any rare cases where you might accidentally autobootstrap during the
upgrade.
2019-12-02 12:43:18 +00:00
Marios Trivyzas
8ca11f54cd
[Docs] Enhance rolling upgrade guide (#49686)
Add a couple of pointers for the user to check the
overall cluster health and the version of ES running
on every node.

Fixes: #49670
2019-11-28 17:00:41 +01:00
Lisa Cawley
d2578f834b
[DOCS] Merges duplicate pages for file realms (#49200) 2019-11-18 11:51:02 -08:00
David Turner
fcf6c17db5
Clarify that you cannot abort an upgrade (#47342)
We do mention that rolling back an upgrade requires a restore from a snapshot,
but it's hidden at the bottom of the "preparing to upgrade" instructions on a
different page from the actual upgrade instructions. This commit duplicates the
preparatory instructions onto the pages containing the actual upgrade
instructions and rewords the point about rollbacks a bit.
2019-10-02 09:27:17 +01:00
Robin Clarke
44d4cf79ac Clearer language around upgrade sequence (#47422) 2019-10-02 09:25:42 +01:00
David Turner
776d87b438
Clarify rolling-upgrade docs (#47279)
Note to upgrade the master-eligible nodes last, and note that
`cluster.initial_master_nodes` should not be set.
2019-09-30 16:58:55 +01:00
James Rodewig
45f8c970ef
[DOCS] Reformat flush API docs (#46875) 2019-09-27 11:42:55 -04:00
James Rodewig
f5827ba0ae
[DOCS] Replace "// CONSOLE" comments with [source,console] (#46159) 2019-09-04 12:51:02 -04:00
Ryan Ernst
8a337ce35c
Remove plugins dir reference from docs (#46047)
While the plugin installation directory used to be settable, it has not
been so for several major versions. This commit removes a lingering
reference to the plugins directory in upgrade docs.

closes #45889
2019-08-28 10:48:41 -07:00
James Rodewig
ea1adb61c2
[DOCS] Update anchors and links for Elasticsearch API relocation (#44500) 2019-07-19 09:16:35 -04:00
Alexander Reelsen
d52972e9e2
Update docs to refer to 6.8 instead of 6.7 (#43685)
A few places in the documentation had mentioned 6.7 as the version to
upgrade from, when doing an upgrade to 7.0. While this is technically
possible, this commit will replace all those mentions to 6.8, as this is
the latest version with the latest bugfixes, deprecation checks and
ugprade assistant features - which should be the one used for upgrades.

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-07-02 09:06:14 +02:00
David Turner
f3dbfdb444
Clarify rolling upgrade fallback to restart upgrade (#42161)
Adds a note that restarting half-or-more of the master-eligible nodes means
you're no longer doing a rolling upgrade, and may need to upgrade all the
things before the cluster returns to health.
2019-05-16 13:36:09 -04:00
James Rodewig
4ab9e88cf7
[DOCS] Fix delimited blocks for Asciidoctor migration (#41583) 2019-04-26 11:41:19 -04:00
Nik Everett
d880960584
Docs: Rework close ml section (#41435)
Reworks the close ml section to work properly in Asciidoctor. It
renders a little funny in AsciiDoc but AsciiDoc is on its way out
anyway....
2019-04-23 10:57:17 -04:00
DeDe Morton
c8031decea
[Docs] Change example to show col headers (#40822)
Command needs `?v` so user can see the column headers. Otherwise the instructions in the note about checking the init and relo columns don't make sense
2019-04-05 11:55:21 -07:00
Boaz Leskes
35fa582494 Only recommend disabling allocation of replicas in a rolling upgrade (#40299)
The current documentation recommends disabling allocations of all shards. This prevents shards of
new indices from being allocated as well. That means that during a rolling upgrade, operations like
roll over and index shrinking will operate correctly. This, in turn, can cause issues for data ingestion
and ILM.
2019-03-27 14:19:14 +01:00