From: Ryan Haasken Date: Mon, 7 Jul 2014 15:09:10 +0000 (-0500) Subject: LUDOC-244 lfsck: Update lfsck documentation X-Git-Tag: 2.7.0~4 X-Git-Url: https://git.whamcloud.com/?a=commitdiff_plain;h=refs%2Fchanges%2F86%2F11886%2F3;p=doc%2Fmanual.git LUDOC-244 lfsck: Update lfsck documentation Renamed 'Synopsis' sections to 'Usage' and swapped order with the 'Description' section. It makes more sense to see the description of a feature before an example of its usage. Renamed the 'Mount Options' section to 'Auto scrub' because it really describes the auto_scrub parameter and what it does. Added a reference in this section to the mount.lustre section where an explanation of the noscrub mount option was added. The relationship between the auto_scrub parameter and noscrub mount option is explained. Also put 'N' inside a replaceable tag in the Auto scrub parameters section. This is meant to represent an integer. Signed-off-by: Ryan Haasken Change-Id: Ie947f8b268af299a0f583b98bb559f9d3313c0bf Reviewed-on: http://review.whamcloud.com/11886 Tested-by: Jenkins Reviewed-by: Richard Henwood --- diff --git a/SystemConfigurationUtilities.xml b/SystemConfigurationUtilities.xml index 2dc4e0d..f6f44a5 100644 --- a/SystemConfigurationUtilities.xml +++ b/SystemConfigurationUtilities.xml @@ -2062,6 +2062,14 @@ mount.lustre The server is allowed to incrementally extend its timeout up to a hard maximum of timeout seconds. The default hard recovery timeout is set to 900 seconds (15 minutes). + + + noscrub + + + Typically the MDT will detect restoration from a file-level backup during mount. This mount option prevents the OI Scrub from starting automatically when the MDT is mounted. Manually starting LFSCK after mounting provides finer control over the starting conditions. This mount option also prevents OI scrub from occurring automatically when OI inconsistency is detected (see ) + + diff --git a/TroubleShootingRecovery.xml b/TroubleShootingRecovery.xml index f7bebcb..987228b 100644 --- a/TroubleShootingRecovery.xml +++ b/TroubleShootingRecovery.xml @@ -124,7 +124,11 @@ root# e2fsck -fp /dev/sda # fix errors with prudent answers (usually
Manually Starting LFSCK
- Synopsis + Description + LFSCK can be started after the MDT is mounted using the lctl lfsck_start command. +
+
+ Usage lctl lfsck_start -M | --device [MDT,OST]_device \ [-A | --all] \ [-c | --create_ostobj [on | off]] \ @@ -140,10 +144,6 @@ root# e2fsck -fp /dev/sda # fix errors with prudent answers (usually
- Description - This command is used by LFSCK after the MDT is mounted. -
-
Options The various lfsck_start options are listed and described below. For a complete list of available options, type lctl lfsck_start -h. @@ -268,17 +268,17 @@ root# e2fsck -fp /dev/sda # fix errors with prudent answers (usually
Manually Stopping LFSCK
- Synopsis + Description + To stop LFSCK when the MDT is mounted, use the lctl lfsck_stop command. +
+
+ Usage lctl lfsck_stop -M | --device [MDT,OST]_device \ [-A | --all] \ [-h | --help]
- Description - This command is used by LFSCK after the MDT is mounted. -
-
Options The various lfsck_stop options are listed and described below. For a complete list of available options, type lctl lfsck_stop -h. @@ -330,16 +330,16 @@ root# e2fsck -fp /dev/sda # fix errors with prudent answers (usually LFSCK status interface
LFSCK status of OI Scrub via <literal>procfs</literal> +
+ Description + For each LFSCK component there is a dedicated procfs interface to trace the corresponding LFSCK component status. For OI Scrub, the interface is the OSD layer procfs interface, named oi_scrub. To display OI Scrub status, the standard lctl get_param command is used as shown in the usage below. +
- Synopsis + Usage lctl get_param -n osd-ldiskfs.FSNAME-MDT_device.oi_scrub
- Description - For each LFSCK component there is a dedicated procfs interface to trace corresponding LFSCK component status. For OI Scrub, the interface is the OSD layer procfs interface, named oi_scrub. To display OI Scrub status, the standard lctl get_param command is used as described in the synopsis. -
-
Output @@ -412,16 +412,16 @@ root# e2fsck -fp /dev/sda # fix errors with prudent answers (usually
LFSCK status of namespace via <literal>procfs</literal> +
+ Description + The namespace component is responsible for checking and repairing FID-in-Dirent and LinkEA consistency. The procfs interface for this component is in the MDD layer, named lfsck_namespace. To show the status of this component, lctl get_param should be used as described in the usage below. +
- Synopsis + Usage lctl get_param -n mdd.FSNAME-MDT_device.lfsck_namespace
- Description - The namespace component is responsible for checking and repairing FID-in-Dirent and LinkEA consistency. The procfs interface for this component is in the MDD layer, named lfsck_namespace. To show the status of this component lctl get_param should be used as described in the synopsis. -
-
Output @@ -520,17 +520,17 @@ root# e2fsck -fp /dev/sda # fix errors with prudent answers (usually
LFSCK status of layout via <literal>procfs</literal> +
+ Description + The layout component is responsible for checking and repairing MDT-OST inconsistency. The procfs interface for this component is in the MDD layer, named lfsck_layout, and in the OBD layer, named lfsck_layout. To show the status of this component lctl get_param should be used as described in the usage below. +
- Synopsis + Usage lctl get_param -n mdd.FSNAME-MDT_device.lfsck_layout lctl get_param -n obdfilter.FSNAME-OST_device.lfsck_layout
- Description - The layout component is responsible for checking and repairing MDT-OST inconsistency. The procfs interface for this component is in the MDD layer, named lfsck_layout, and in the OBD layer, named lfsck_layout. To show the status of this component lctl get_param should be used as described in the synopsis. -
-
Output @@ -611,13 +611,13 @@ lctl get_param -n obdfilter.FSNAME-OST_d
Rate control
- Synopsis - lctl set_param mdd.${FSNAME}-${MDT_device}.lfsck_speed_limit=N -lctl set_param obdfilter.${FSNAME}-${OST_device}.lfsck_speed_limit=N + Description + The LFSCK upper speed limit can be changed using lctl set_param as shown in the usage below.
- Description - Change the LFSCK upper speed limit. + Usage + lctl set_param mdd.${FSNAME}-${MDT_device}.lfsck_speed_limit=N +lctl set_param obdfilter.${FSNAME}-${OST_device}.lfsck_speed_limit=N
Values @@ -647,16 +647,18 @@ lctl set_param obdfilter.${FSNAME}-${OST_device}.lfsck_speed_limit=N
-
- Mount options +
+ Auto scrub
- Synopsis - lctl set_param osd_ldiskfs.${FSNAME}-${MDT_device}.auto_scrub=N - + Description + The auto_scrub parameter controls whether OI scrub will be triggered when an inconsistency is detected during OI lookup. It can be set as described in the usage and values sections below. + There is also a noscrub mount option (see ) which can be used to disable automatic OI scrub upon detection of a file-level backup at mount time. If the noscrub mount option is specified, auto_scrub will also be disabled, so OI scrub will not be triggered when an OI inconsistency is detected. Auto scrub can be renabled after the mount using the command shown in the usage. Manually starting LFSCK after mounting provides finer control over the starting conditions.
- Description - Typically, the MDT will detect restoration from a file-level backup during mount. For convenience an mount option noscrub is provided for MDTs. noscrub prevents the OI Scrub starting automatically when the MDT is mounted. The administrator can start LFSCK manually after the MDT is mounted with lctl. Manually starting LFSCK after mounting provides finer control over the starting conditions. + Usage + lctl set_param osd_ldiskfs.${FSNAME}-${MDT_device}.auto_scrub=N + + where N is an integer as described below.
Values @@ -678,7 +680,7 @@ lctl set_param obdfilter.${FSNAME}-${OST_device}.lfsck_speed_limit=N positive integer - Manually start OI Scrub if needed. + Automatically start OI Scrub if inconsistency is detected during OI lookup.