Silberfuchs1 commented on a change in pull request #9162:
URL: https://github.com/apache/ignite/pull/9162#discussion_r657677354
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -146,9 +146,9 @@ 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,
Review comment:
Delete an extra line 151. The sentence will then look like this: "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."
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
+* Cache groups to be restored from the snapshot must not present in the
cluster, if they present, they must be destroyed by the user before starting
this operation.
+* Restore to a smaller topology is not supported. Those. restore is possible
only if all parts of the snapshot are present in the cluster.
+* Concurrent restore operations are not allowed. Those. if one restore
operation has been started, the other can only be started after the first is
completed.
Review comment:
Thus, if one operation...
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
+* Cache groups to be restored from the snapshot must not present in the
cluster, if they present, they must be destroyed by the user before starting
this operation.
+* Restore to a smaller topology is not supported. Those. restore is possible
only if all parts of the snapshot are present in the cluster.
+* Concurrent restore operations are not allowed. Those. if one restore
operation has been started, the other can only be started after the first is
completed.
+
+==== Restoring cache group from the snapshot
+The following code snippet demonstrates how to restore an individual cache
group from a snapshot.
+
+[tabs]
+--
+tab:Java[]
+
+[source, java]
+----
+include::{javaCodeDir}/Snapshots.java[tags=restore, indent=0]
+----
+
+tab:CLI[]
+[source,shell]
+----
+# Restore cache group "snapshot-cache" from the snapshot "snapshot_02092020".
+control.(sh|bat) --snapshot restore --start snapshot_02092020 snapshot-cache
+----
+--
+
+==== Using CLI to control restore operation
+The `control.sh|bat` script provides the ability to start, stop, and get the
status of the restore operation.
+
Review comment:
Add a code block
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
+* Cache groups to be restored from the snapshot must not present in the
cluster, if they present, they must be destroyed by the user before starting
this operation.
+* Restore to a smaller topology is not supported. Those. restore is possible
only if all parts of the snapshot are present in the cluster.
+* Concurrent restore operations are not allowed. Those. if one restore
operation has been started, the other can only be started after the first is
completed.
+
+==== Restoring cache group from the snapshot
+The following code snippet demonstrates how to restore an individual cache
group from a snapshot.
+
+[tabs]
+--
+tab:Java[]
+
+[source, java]
+----
+include::{javaCodeDir}/Snapshots.java[tags=restore, indent=0]
+----
+
+tab:CLI[]
+[source,shell]
+----
+# Restore cache group "snapshot-cache" from the snapshot "snapshot_02092020".
+control.(sh|bat) --snapshot restore --start snapshot_02092020 snapshot-cache
+----
+--
+
+==== Using CLI to control restore operation
+The `control.sh|bat` script provides the ability to start, stop, and get the
status of the restore operation.
+
+[source,shell]
+----
+# Start restore all public cache groups from the snapshot "snapshot_09062021".
+control.(sh|bat) --snapshot restore --start snapshot_09062021
+
+# Get the status of the restore operation for "snapshot_09062021".
+control.(sh|bat) --snapshot restore --status snapshot_09062021
+
+# Cancel the restore operation for "snapshot_09062021".
+control.(sh|bat) --snapshot restore --stop snapshot_09062021
+----
+
== Consistency Guarantees
All snapshots are fully consistent in terms of concurrent cluster-wide
operations as well as ongoing changes with Ignite
Review comment:
All snapshots are fully consistent in terms of concurrent cluster-wide
operations as well as ongoing changes with Ignite.
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
+* Cache groups to be restored from the snapshot must not present in the
cluster, if they present, they must be destroyed by the user before starting
this operation.
+* Restore to a smaller topology is not supported. Those. restore is possible
only if all parts of the snapshot are present in the cluster.
Review comment:
Restoring to a smaller topology...
Thus, restoring is possible only...
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
+* Cache groups to be restored from the snapshot must not present in the
cluster, if they present, they must be destroyed by the user before starting
this operation.
+* Restore to a smaller topology is not supported. Those. restore is possible
only if all parts of the snapshot are present in the cluster.
+* Concurrent restore operations are not allowed. Those. if one restore
operation has been started, the other can only be started after the first is
completed.
+
+==== Restoring cache group from the snapshot
Review comment:
Add an extra line between heading and the text body.
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
Review comment:
The restore procedure can be applied only to public cache groups.
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -146,9 +146,9 @@ 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:
Review comment:
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 extra lines
Remove the files and sub-directories related to the `{nodeId}` under your
`$IGNITE_HOME/work/db` directory. Clean the
Clean what?
The table
below explains what options are supported:
Delete an extra line. The sentence will then look like this: "The table
below explains what options are supported:"
````
[cols="1,1",opts="header"]
|===
|Condition | Description
@@ -178,6 +178,51 @@
|N > M | Unsupported.
|===
````
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
+* Cache groups to be restored from the snapshot must not present in the
cluster, if they present, they must be destroyed by the user before starting
this operation.
Review comment:
Cache groups to be restored from the snapshot must not be present in the
cluster. If they are present, they must be destroyed by the user before
starting this operation.
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ 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 group(s) from
a snapshot on an active cluster using the Java API or Command Language
Interface (CLI).
+
+Currently, this procedure has a number of limitations:
+
+* The restore procedure applies only to public cache groups.
+* Cache groups to be restored from the snapshot must not present in the
cluster, if they present, they must be destroyed by the user before starting
this operation.
+* Restore to a smaller topology is not supported. Those. restore is possible
only if all parts of the snapshot are present in the cluster.
+* Concurrent restore operations are not allowed. Those. if one restore
operation has been started, the other can only be started after the first is
completed.
+
+==== Restoring cache group from the snapshot
+The following code snippet demonstrates how to restore an individual cache
group from a snapshot.
+
Review comment:
add a code block with a language, like this:
````lava
[code]
````
##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -178,6 +178,51 @@ the topology and wait while the data gets rebalanced and
indexes are rebuilt.
|N > M | Unsupported.
|===
+=== Automatic snapshot restore procedure
Review comment:
Add a line between body and heading
--
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.
For queries about this service, please contact Infrastructure at:
[email protected]
