Skip to content

Commit c103bd6

Browse files
committed
Docs: restore now fails if it encounters incompatible settings (#26933)
This change was introduced in 5.0.0, but the documentation wasn't updated to reflect it. Closes #26453
1 parent 7993de5 commit c103bd6

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/reference/modules/snapshots.asciidoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -463,16 +463,18 @@ same size or topology. However, the version of the new cluster should be the sa
463463
If the new cluster has a smaller size additional considerations should be made. First of all it's necessary to make sure
464464
that new cluster have enough capacity to store all indices in the snapshot. It's possible to change indices settings
465465
during restore to reduce the number of replicas, which can help with restoring snapshots into smaller cluster. It's also
466-
possible to select only subset of the indices using the `indices` parameter. Prior to version 1.5.0 elasticsearch
467-
didn't check restored persistent settings making it possible to accidentally restore an incompatible
468-
`discovery.zen.minimum_master_nodes` setting, and as a result disable a smaller cluster until the required number of
469-
master eligible nodes is added. Starting with version 1.5.0 incompatible settings are ignored.
466+
possible to select only subset of the indices using the `indices` parameter.
470467

471468
If indices in the original cluster were assigned to particular nodes using
472469
<<shard-allocation-filtering,shard allocation filtering>>, the same rules will be enforced in the new cluster. Therefore
473470
if the new cluster doesn't contain nodes with appropriate attributes that a restored index can be allocated on, such
474471
index will not be successfully restored unless these index allocation settings are changed during restore operation.
475472

473+
The restore operation also checks that restored persistent settings are compatible with the current cluster to avoid accidentally
474+
restoring an incompatible settings such as `discovery.zen.minimum_master_nodes` and as a result disable a smaller cluster until the
475+
required number of master eligible nodes is added. If you need to restore a snapshot with incompatible persistent settings, try
476+
restoring it without the global cluster state.
477+
476478
[float]
477479
=== Snapshot status
478480

@@ -548,7 +550,7 @@ state. Once recovery of primary shards is completed Elasticsearch is switching t
548550
creates the required number of replicas at this moment cluster switches to the `yellow` state. Once all required replicas
549551
are created, the cluster switches to the `green` states.
550552

551-
The cluster health operation provides only a high level status of the restore process. Its possible to get more
553+
The cluster health operation provides only a high level status of the restore process. It's possible to get more
552554
detailed insight into the current state of the recovery process by using <<indices-recovery, indices recovery>> and
553555
<<cat-recovery, cat recovery>> APIs.
554556

0 commit comments

Comments
 (0)