Silberfuchs1 commented on a change in pull request #8128:
URL: https://github.com/apache/ignite/pull/8128#discussion_r484858407
##########
File path: docs/_docs/persistence/snapshot.adoc
##########
@@ -62,25 +69,25 @@ work
└── marshaller
----
-*Requirements.*
+=== Requirements
-You need an extra space on disk for the configured Ignite native persistence
directory up to the current size this directory.
-This space will be used for storing intermediate snapshot results and will be
freed when the snapshot operation ends.
+A configured Ignite native persistence directory requires additional disk
space (up to the current size of this directory).
+This space will be used for storing intermediate snapshot results and cleaned
up after the snapshot operation completes.
Review comment:
after the snapshot operation is completed.
It is so, because when you say ' completes', the reader will think
'completes doing what?'.
##########
File path: docs/_docs/persistence/snapshot.adoc
##########
@@ -3,33 +3,40 @@
== Overview
Apache Ignite 2.9 comes with an ability to create fully consistent
cluster-wide snapshots for deployments with
-the link:persistence/native-persistence[Ignite Native Persistence]. You can
create at runtime any number of snapshots
-of all configured persistent cache groups. The snapshot is a consistent copy
of all cache group data files (except
-structures used for crash recovery) for each baseline node in a cluster. Since
data of persistent cache groups stored
-on disk in files on each node (cache group partition files, configuration
files, binary metadata) the snapshot will
-contain a copy of the same files with keeping Ignite cluster node data
directory structure and the node consistent ids.
+the link:persistence/native-persistence[Ignite Native Persistence]. At
runtime, you can create multiple snapshots of all
+configured persistent cache groups. The snapshot is a consistent copy of all
cache group data files (except
+structures used for crash recovery) for each baseline node in a cluster. Since
data of persistent cache groups is stored
+on disk in files for each node (cache group partition files, configuration
files, binary metadata) in a cluster,
+the snapshot will contain a copy of the same files with keeping Ignite cluster
node data directory structure and node consistent IDs.
-*Snapshot Consistency.*
+=== Snapshot Consistency
-All snapshots you created are fully consistent in terms of concurrent
cluster-wide operations and all ongoing changes of
-system files on the local node. Primary and backup cache group partitions will
be also fully consistent in created
+All snapshots you've created are fully consistent in terms of concurrent
cluster-wide operations and all ongoing changes of
+system files on the local node. Primary and backup cache group partitions will
also be fully consistent in created
snapshots.
-The cluster-wide snapshot consistency achieved by triggering the
+The cluster-wide snapshot consistency is achieved by triggering the
link:https://cwiki.apache.org/confluence/display/IGNITE/%28Partition+Map%29+Exchange+-+under+the+hood[Partition-Map-Exchange]
-procedure. Doing this the cluster will eventually get a point in time when all
previously started transactions
-finished on primary and backups, and new ones are hold until a new snapshot
operation will be started.
+procedure. Doing this the cluster will eventually get a point in time when all
previously started transactions are
+finished on primary and backups, and new ones are hold until a new snapshot
operation will be initiated.
Review comment:
...is initiated
##########
File path: docs/_docs/persistence/snapshot.adoc
##########
@@ -62,25 +69,25 @@ work
└── marshaller
----
-*Requirements.*
+=== Requirements
-You need an extra space on disk for the configured Ignite native persistence
directory up to the current size this directory.
-This space will be used for storing intermediate snapshot results and will be
freed when the snapshot operation ends.
+A configured Ignite native persistence directory requires additional disk
space (up to the current size of this directory).
+This space will be used for storing intermediate snapshot results and cleaned
up after the snapshot operation completes.
-*Limitations.*
+=== Limitations
-The snapshot procedure has some limitations that you should be aware of before
using it at your production environment:
+The snapshot procedure has some limitations that you should be aware of before
using it within your production environment:
-* taking a snapshot of particular cache or cache group not supported;
-* in-memory caches will not be included into snapshot;
-* encrypted caches not supported and will be ignored;
-* only single snapshot operation can be started at once;
-* snapshot procedure will be interrupted if any baseline node leave the
cluster;
-* snapshot recovery at the same baseline topology with the same consistent
node id;
+* taking a snapshot of a particular cache or cache group is not supported;
+* in-memory caches will not be included into a snapshot;
+* encrypted caches are not supported and will be ignored;
+* only one snapshot operation at a time can be started;
Review comment:
if 'operation' than 'initiated'. Let's do so throughout the document.
----------------------------------------------------------------
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]
