You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2021/03/15 13:50:57 UTC

[GitHub] [ignite] Mmuzaf opened a new pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Mmuzaf opened a new pull request #8878:
URL: https://github.com/apache/ignite/pull/8878


   Thank you for submitting the pull request to the Apache Ignite.
   
   In order to streamline the review of the contribution 
   we ask you to ensure the following steps have been taken:
   
   ### The Contribution Checklist
   - [ ] There is a single JIRA ticket related to the pull request. 
   - [ ] The web-link to the pull request is attached to the JIRA ticket.
   - [ ] The JIRA ticket has the _Patch Available_ state.
   - [ ] The pull request body describes changes that have been made. 
   The description explains _WHAT_ and _WHY_ was made instead of _HOW_.
   - [ ] The pull request title is treated as the final commit message. 
   The following pattern must be used: `IGNITE-XXXX Change summary` where `XXXX` - number of JIRA issue.
   - [ ] A reviewer has been mentioned through the JIRA comments 
   (see [the Maintainers list](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute#HowtoContribute-ReviewProcessandMaintainers)) 
   - [ ] The pull request has been checked by the Teamcity Bot and 
   the `green visa` attached to the JIRA ticket (see [TC.Bot: Check PR](https://mtcga.gridgain.com/prs.html))
   
   ### Notes
   - [How to Contribute](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute)
   - [Coding abbreviation rules](https://cwiki.apache.org/confluence/display/IGNITE/Abbreviation+Rules)
   - [Coding Guidelines](https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines)
   - [Apache Ignite Teamcity Bot](https://cwiki.apache.org/confluence/display/IGNITE/Apache+Ignite+Teamcity+Bot)
   
   If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com _#ignite_ channel.
   


----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Mmuzaf commented on pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Mmuzaf commented on pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#issuecomment-799437395


   @Nikita-tech-writer Hello, can you review my changes?


----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595287326



##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,25 @@ validate_indexes has finished with errors (listed above).
 Like `idle_verify`, index validation tool works correctly only if updates are stopped. Otherwise, there may be a race between the checker thread and the thread that updates the entry/index, which can result in a false positive error report.
 ====
 
+=== Checking Snapshot Consistency
+
+The checking snapshot consistency command working the same way as the `idle_verify` command does. It compares hashes between
+a primary partition and a corresponding backup partitions and prints a report any differences occurs.
+Differences may be the result of inconsistencies in some data on the cluster from which the snapshot was taken. It is
+recommended to perform the `idle_verify` procedure on the cluster if this case occurs.
+
+This procedure doesn't require the cluster to be in the `idle` state.
+
+[tabs]
+--
+tab:Shell[]
+[source,shell]
+----
+# Checks partitions of all snapshot caches have correct checksums and primary/backup actually contain the same data.

Review comment:
       ```suggestion
   # Checks that partitions of all snapshot caches have the correct checksums and primary/backup ones actually contain the same data.
   ```




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Mmuzaf commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Mmuzaf commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595451573



##########
File path: docs/_docs/persistence/snapshot-directory.adoc
##########
@@ -0,0 +1,39 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+= Snapshot Directory
+
+== Configuring Snapshot Directory
+
+By default, a segment of the snapshot is stored in the work directory of a respective Ignite node and uses the same storage
+media where Ignite Persistence keeps data, index, WAL, and other files. Since the snapshot can consume as much space as

Review comment:
       Fixed.




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595257217



##########
File path: docs/_docs/persistence/snapshot-directory.adoc
##########
@@ -0,0 +1,39 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+= Snapshot Directory
+
+== Configuring Snapshot Directory
+
+By default, a segment of the snapshot is stored in the work directory of a respective Ignite node and uses the same storage
+media where Ignite Persistence keeps data, index, WAL, and other files. Since the snapshot can consume as much space as

Review comment:
       How about splitting this long sentence into two short ones (it would be easier for readers to catch the idea): **By default, a segment of the snapshot is stored in the work directory of a respective Ignite node. This segment uses the same storage media where Ignite Persistence keeps data, index, WAL, and other files.**




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Mmuzaf commented on pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Mmuzaf commented on pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#issuecomment-800518175


   @Nikita-tech-writer I've fixed all your comments. Can I proceed?


----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595269184



##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,25 @@ validate_indexes has finished with errors (listed above).
 Like `idle_verify`, index validation tool works correctly only if updates are stopped. Otherwise, there may be a race between the checker thread and the thread that updates the entry/index, which can result in a false positive error report.
 ====
 
+=== Checking Snapshot Consistency
+
+The checking snapshot consistency command working the same way as the `idle_verify` command does. It compares hashes between
+a primary partition and a corresponding backup partitions and prints a report any differences occurs.

Review comment:
       ```suggestion
   a primary partition and a corresponding backup partitions and prints a report if any differences are found.
   ```




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595266112



##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -145,6 +131,20 @@ include::{javaCodeDir}/Snapshots.java[tags=create, indent=0]
 ----
 --
 
+== Checking Snapshot Consistency
+
+Usually all the cluster nodes are running on different machines and having the snapshot data spread across the cluster.
+Each node stores its own snapshot segment, so in some cases it may be necessary to check the snapshot for completeness
+of data and for data consistency across the cluster before restoring from the snapshot.
+
+For such cases, the Apache Ignite ships with the built-in snapshot consistency check commands that enable you to verify

Review comment:
       ```suggestion
   For such cases, Apache Ignite is delivered with built-in snapshot consistency check commands that enable you to verify
   ```




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595270051



##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,25 @@ validate_indexes has finished with errors (listed above).
 Like `idle_verify`, index validation tool works correctly only if updates are stopped. Otherwise, there may be a race between the checker thread and the thread that updates the entry/index, which can result in a false positive error report.
 ====
 
+=== Checking Snapshot Consistency
+
+The checking snapshot consistency command working the same way as the `idle_verify` command does. It compares hashes between
+a primary partition and a corresponding backup partitions and prints a report any differences occurs.
+Differences may be the result of inconsistencies in some data on the cluster from which the snapshot was taken. It is
+recommended to perform the `idle_verify` procedure on the cluster if this case occurs.
+
+This procedure doesn't require the cluster to be in the `idle` state.

Review comment:
       ```suggestion
   This procedure does not require the cluster to be in the `idle` state.
   ```




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595268062



##########
File path: docs/_docs/tools/control-script.adoc
##########
@@ -521,6 +521,25 @@ validate_indexes has finished with errors (listed above).
 Like `idle_verify`, index validation tool works correctly only if updates are stopped. Otherwise, there may be a race between the checker thread and the thread that updates the entry/index, which can result in a false positive error report.
 ====
 
+=== Checking Snapshot Consistency
+
+The checking snapshot consistency command working the same way as the `idle_verify` command does. It compares hashes between

Review comment:
       ```suggestion
   The checking snapshot consistency command works the same way as the `idle_verify` command does. It compares hashes between
   ```




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Mmuzaf merged pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Mmuzaf merged pull request #8878:
URL: https://github.com/apache/ignite/pull/8878


   


----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595267017



##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -145,6 +131,20 @@ include::{javaCodeDir}/Snapshots.java[tags=create, indent=0]
 ----
 --
 
+== Checking Snapshot Consistency
+
+Usually all the cluster nodes are running on different machines and having the snapshot data spread across the cluster.
+Each node stores its own snapshot segment, so in some cases it may be necessary to check the snapshot for completeness
+of data and for data consistency across the cluster before restoring from the snapshot.
+
+For such cases, the Apache Ignite ships with the built-in snapshot consistency check commands that enable you to verify
+internal data consistency, calculate data partitions hashes and pages checksums, and printing out the result if a

Review comment:
       ```suggestion
   internal data consistency, calculate data partitions hashes and pages checksums, and print out the result if a
   ```




----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#issuecomment-800372894


   @Mmuzaf Please see my comments above.


----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#issuecomment-800520205


   > @Nikita-tech-writer I've fixed all your comments. Can I proceed?
   
   @Mmuzaf Absolutely!


----------------------------------------------------------------
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:
users@infra.apache.org

[GitHub] [ignite] Nikita-tech-writer commented on a change in pull request #8878: IGNITE-14247 Add snapshot page, add checking snapshot commands

Posted by GitBox <gi...@apache.org>.
Nikita-tech-writer commented on a change in pull request #8878:
URL: https://github.com/apache/ignite/pull/8878#discussion_r595260336



##########
File path: docs/_docs/snapshots/snapshots.adoc
##########
@@ -145,6 +131,20 @@ include::{javaCodeDir}/Snapshots.java[tags=create, indent=0]
 ----
 --
 
+== Checking Snapshot Consistency
+
+Usually all the cluster nodes are running on different machines and having the snapshot data spread across the cluster.

Review comment:
       ```suggestion
   Usually all the cluster nodes run on different machines and have the snapshot data spread across the cluster.
   ```




----------------------------------------------------------------
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:
users@infra.apache.org