Skip to content

Commit d648e99

Browse files
Mmuzaftimoninmaxim
authored andcommitted
IGNITE-16517 Fix documentation for snapshot restore procedure (#9812)
1 parent 9895ff8 commit d648e99

1 file changed

Lines changed: 11 additions & 15 deletions

File tree

docs/_docs/snapshots/snapshots.adoc

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ are not added into the snapshot as long as those are not required for the curren
7373
The previous example shows the snapshot created for the cluster running on the same physical machine. Thus, the whole
7474
snapshot is located in a single place. While in practice, all the nodes will be running on different machines having the
7575
snapshot data spread across the cluster. Each node keeps a segment of the snapshot with the data belonging to this particular node.
76-
The link:persistence/snapshots#restoring-from-snapshot[restore procedure] explains how to tether together all the segments during recovery.
76+
The link:snapshots/snapshots#restoring-from-snapshot[restore procedure] explains how to tether together all the segments during recovery.
7777
====
7878

7979
== Configuration
@@ -155,10 +155,18 @@ See the link:tools/control-script#checking-snapshot-consistency[Control Script]
155155
commands.
156156

157157
== Restoring From Snapshot
158-
A snapshot can be restored either manually on a stopped cluster or automatically on an active cluster. Both procedures are described below.
158+
159+
A snapshot can be restored either manually on a stopped cluster or automatically on an active cluster.
160+
Both procedures are described below, however, it is preferable to use the restore command from Control Script only.
159161

160162
=== Manual Snapshot Restore Procedure
161-
Stop the cluster, then replace persistence data and other files with the data from the snapshot, and restart the nodes.
163+
164+
The snapshot structure is similar to the layout of the Ignite Native Persistence, so for the manual snapshot restore you must
165+
do a snapshot restore only on the same cluster with the same node `consistentId` and on the same topology on which a snapshot
166+
was taken. If you need to restore a snapshot on a different cluster or on a different cluster topology use the
167+
link:snapshots/snapshots#automatic-snapshot-restore-procedure[Automatic Snapshot Restore Procedure].
168+
169+
In general, stop the cluster, then replace persistence data and other files with the data from the snapshot, and restart the nodes.
162170

163171
The detailed procedure looks as follows:
164172

@@ -171,18 +179,6 @@ The detailed procedure looks as follows:
171179
- Copy the files belonging to a node with the `{node_id}` from the snapshot into the `$IGNITE_HOME/work/` directory. If the `db/{node_id}` directory is not located under the Ignite `work` dir then you need to copy data files there.
172180
. Restart the cluster
173181

174-
*Restore On Cluster of Different Topology*
175-
176-
You may want to create a snapshot of an N-node cluster and use it to restore on an M-node cluster. The table below explains what options are supported:
177-
[cols="1,1",opts="header"]
178-
|===
179-
|Condition | Description
180-
|N == M | The *recommended* case. Create and use the snapshot on clusters of a similar topology.
181-
|N < M | Start the first N nodes of the M-node cluster and apply the snapshot. Add the rest of the M-cluster nodes to
182-
the topology and wait while the data gets rebalanced and indexes are rebuilt.
183-
|N > M | Unsupported.
184-
|===
185-
186182
=== Automatic Snapshot Restore Procedure
187183

188184
The automatic restore procedure allows the user to restore cache groups from a snapshot on an active cluster by using the Java API or link:tools/control-script[command line script].

0 commit comments

Comments
 (0)