IgGusev commented on a change in pull request #9162:
URL: https://github.com/apache/ignite/pull/9162#discussion_r659694977
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -146,29 +146,23 @@ See the
link:tools/control-script#checking-snapshot-consistency[Control Script]
commands.
== Restoring From Snapshot
-
-Currently, the data restore procedure has to be performed manually. In a
nutshell, you need to stop the cluster,
-replace persistence data and other files with the data from the snapshot, and
restart the nodes.
+=== Manual snapshot restore procedure
+In a nutshell, you need to stop the cluster, replace persistence data and
other files with the data from the snapshot, and restart the nodes.
The detailed procedure looks as follows:
. Stop the cluster you intend to restore
. Remove all files from the checkpoint `$IGNITE_HOME/work/cp` directory
-. Do the following on each node. Clean the
-link:link:persistence/native-persistence#configuring-persistent-storage-directory[`db/{node_id}`]
directory separately if
-it's not located under the Ignite `work` dir:
- - Remove the files related to the `{nodeId}` from the
`$IGNITE_HOME/work/db/binary_meta` directory
- - Remove the files related to the `{nodeId}` from the
`$IGNITE_HOME/work/db/marshaller` directory
- - Remove the files and sub-directories related to the `{nodeId}` under
your `$IGNITE_HOME/work/db` directory. Clean the
- - 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.
+. Do the following on each node. Clean the
link:link:persistence/native-persistence#configuring-persistent-storage-directory[`db/{node_id}`]
directory separately if it's not located under the Ignite `work` dir:
Review comment:
We should not have many things to do in one item, lets split it a bit.
Otherwise people will skip over after reading the first sentence.
For example:
. On each node:
- If the
link:link:persistence/native-persistence#configuring-persistent-storage-directory[`db/{node_id}`]
directory is not located under the Ignite `work` dir, clean it.
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,9 +172,59 @@ the topology and wait while the data gets rebalanced and
indexes are rebuilt.
|N > M | Unsupported.
|===
+=== Automatic snapshot restore procedure
+
+The automatic restore procedure allows the user to restore cache groups from a
snapshot on an active cluster using the Java API or
link:tools/control-script[command line script].
+
+Currently, this procedure has a number of limitations:
+
+* Restoring is possible only if all parts of the snapshot are present in the
cluster. Each node looks a local data snapshot in the configured snapshot path
by the given snapshot name and consistent node ID.
+* The restore procedure can be applied only to cache groups created by the
user.
+* Cache groups to be restored from the snapshot must not be present in the
cluster. If they are present, they must be
link:key-value-api/basic-cache-operations#destroying-caches[destroyed] by the
user before starting this operation.
+* Concurrent restore operations are not allowed. Thus, if one operation has
been started, the other can only be started after the first is completed.
+
+==== Restoring cache group from the snapshot
Review comment:
Capitalize headers. (not articles or prepositions in headers through)
Restoring Cache Group from the Snapshot
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,9 +172,59 @@ the topology and wait while the data gets rebalanced and
indexes are rebuilt.
|N > M | Unsupported.
|===
+=== Automatic snapshot restore procedure
+
+The automatic restore procedure allows the user to restore cache groups from a
snapshot on an active cluster using the Java API or
link:tools/control-script[command line script].
Review comment:
Avoid "using" in docs, favor "that uses" or "by using" to avoid
confusion.
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].
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -146,29 +146,23 @@ See the
link:tools/control-script#checking-snapshot-consistency[Control Script]
commands.
== Restoring From Snapshot
-
-Currently, the data restore procedure has to be performed manually. In a
nutshell, you need to stop the cluster,
-replace persistence data and other files with the data from the snapshot, and
restart the nodes.
+=== Manual snapshot restore procedure
+In a nutshell, you need to stop the cluster, replace persistence data and
other files with the data from the snapshot, and restart the nodes.
The detailed procedure looks as follows:
. Stop the cluster you intend to restore
. Remove all files from the checkpoint `$IGNITE_HOME/work/cp` directory
-. Do the following on each node. Clean the
-link:link:persistence/native-persistence#configuring-persistent-storage-directory[`db/{node_id}`]
directory separately if
-it's not located under the Ignite `work` dir:
- - Remove the files related to the `{nodeId}` from the
`$IGNITE_HOME/work/db/binary_meta` directory
- - Remove the files related to the `{nodeId}` from the
`$IGNITE_HOME/work/db/marshaller` directory
- - Remove the files and sub-directories related to the `{nodeId}` under
your `$IGNITE_HOME/work/db` directory. Clean the
- - 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.
+. Do the following on each node. Clean the
link:link:persistence/native-persistence#configuring-persistent-storage-directory[`db/{node_id}`]
directory separately if it's not located under the Ignite `work` dir:
+ - Remove the files related to the `{nodeId}` from the
`$IGNITE_HOME/work/db/binary_meta` directory.
+ - Remove the files related to the `{nodeId}` from the
`$IGNITE_HOME/work/db/marshaller` directory.
+ - Remove the files and sub-directories related to the `{nodeId}` under
your `$IGNITE_HOME/work/db` directory.
+ - 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.
. Restart the cluster
*Restore On Cluster of Different Topology*
-Sometimes you might 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:
-
+Sometimes you might 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:
Review comment:
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:
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,9 +172,59 @@ the topology and wait while the data gets rebalanced and
indexes are rebuilt.
|N > M | Unsupported.
|===
+=== Automatic snapshot restore procedure
Review comment:
Headers should be capitalized.
Automatic Snapshot Restore Procedure
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -146,29 +146,23 @@ See the
link:tools/control-script#checking-snapshot-consistency[Control Script]
commands.
== Restoring From Snapshot
-
-Currently, the data restore procedure has to be performed manually. In a
nutshell, you need to stop the cluster,
-replace persistence data and other files with the data from the snapshot, and
restart the nodes.
+=== Manual snapshot restore procedure
+In a nutshell, you need to stop the cluster, replace persistence data and
other files with the data from the snapshot, and restart the nodes.
Review comment:
In a nutshell carries no meaning, and is not needed in docs.
"Stop the cluster, then replace persistence data and other files with the
data from the snapshot, and restart the nodes."
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -146,29 +146,23 @@ See the
link:tools/control-script#checking-snapshot-consistency[Control Script]
commands.
== Restoring From Snapshot
-
-Currently, the data restore procedure has to be performed manually. In a
nutshell, you need to stop the cluster,
-replace persistence data and other files with the data from the snapshot, and
restart the nodes.
+=== Manual snapshot restore procedure
Review comment:
Having 2 headers in a row is generally bad for readability. Please add a
small section between them to explain whats in the section.
Additionally, headers should be capitalised.
Manual Snapshot Restore Procedure
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,9 +172,59 @@ the topology and wait while the data gets rebalanced and
indexes are rebuilt.
|N > M | Unsupported.
|===
+=== Automatic snapshot restore procedure
+
+The automatic restore procedure allows the user to restore cache groups from a
snapshot on an active cluster using the Java API or
link:tools/control-script[command line script].
+
+Currently, this procedure has a number of limitations:
Review comment:
Unless these limitations are getting removed in a known time frame, just
list them:
This procedure has some limitations:
Otherwise, specify that they will be resolved.
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,9 +172,59 @@ the topology and wait while the data gets rebalanced and
indexes are rebuilt.
|N > M | Unsupported.
|===
+=== Automatic snapshot restore procedure
+
+The automatic restore procedure allows the user to restore cache groups from a
snapshot on an active cluster using the Java API or
link:tools/control-script[command line script].
+
+Currently, this procedure has a number of limitations:
+
+* Restoring is possible only if all parts of the snapshot are present in the
cluster. Each node looks a local data snapshot in the configured snapshot path
by the given snapshot name and consistent node ID.
Review comment:
Each node looks a local data snapshot > Maybe add for? I am not sure
what this sentence is supposed to mean.
consistent node ID > do we need to write about this in docs? I assume it
happens on all nodes.
Each node looks for a local data snapshot in the configured snapshot path.
It uses the provided snapshot name.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
