From 1a3247941c62ebd9c3b01e69de5f70d5e7861e4d Mon Sep 17 00:00:00 2001 From: Venky Shankar Date: Wed, 6 May 2015 16:26:03 +0530 Subject: doc/admin-guide: BitRot command line usage Change-Id: Ic3c9da566673f4d9b1d0974c5aa15121da087fba BUG: 1219024 Signed-off-by: Venky Shankar Reviewed-on: http://review.gluster.org/10607 Reviewed-on: http://review.gluster.org/10608 Tested-by: Gluster Build System Reviewed-by: Humble Devassy Chirammal --- .../en-US/markdown/admin_managing_volumes.md | 58 ++++++++++++++++++++++ 1 file changed, 58 insertions(+) (limited to 'doc/admin-guide/en-US') diff --git a/doc/admin-guide/en-US/markdown/admin_managing_volumes.md b/doc/admin-guide/en-US/markdown/admin_managing_volumes.md index de77dac944b..f45567a1141 100644 --- a/doc/admin-guide/en-US/markdown/admin_managing_volumes.md +++ b/doc/admin-guide/en-US/markdown/admin_managing_volumes.md @@ -710,3 +710,61 @@ The NUFA scheduler also exists, for use with the Unify translator; see below. - subvolumes This option lists the subvolumes that are part of this 'cluster/nufa' volume. This translator requires more than one subvolume. + + +##BitRot Detection + +With BitRot detection in Gluster, it's possible to identify "insidious" type of disk +errors where data is silently corrupted with no indication from the disk to the storage +software layer than an error has occured. This also helps in catching "backend" tinkering +of bricks (where data is directly manipulated on the bricks without going through FUSE, +NFS or any other access protocol(s). + +BitRot detection is disbled by default and needs to be enabled to make use of other +sub-commands. + +1. To enable bitrot detection for a given volume : + + `# gluster volume bitrot enable` + + and similarly to disable bitrot use: + + `# gluster volume bitrot disable` + +NOTE: Enabling bitrot spanws the Signer & Scrubber daemon per node. Signer is responsible + for signing (calculating checksum for each file) an object and scrubber verifies the + calculated checksum against the objects data. + +2. Scrubber daemon has three (3) throttling modes that adjusts the rate at which objects + are verified. + + `# volume bitrot scrub-throttle lazy` + + `# volume bitrot scrub-throttle normal` + + `# volume bitrot scrub-throttle aggressive` + +3. By default scrubber scrubs the filesystem biweekly. It's possible to tune it to scrub + based on predefined frequency such as monthly, etc. This can be done as shown below: + + `# volume bitrot scrub-frequency daily` + + `# volume bitrot scrub-frequency weekly` + + `# volume bitrot scrub-frequency biweekly` + + `# volume bitrot scrub-frequency monthly` + +NOTE: Daily scrubbing would not be available with GA release. + +4. Scrubber daemon can be paused and later resumed when required. This can be done as + shown below: + + `# volume bitrot scrub pause` + +and to resume scrubbing + + `# volume bitrot scrub resume` + +NOTE: Signing cannot be paused (and resumed) and would always be active as long as + bitrot is enabled for that particular volume. -- cgit