Whamcloud - gitweb
doc/manual.git
7 years agoLUDOC-326 mxlnd: Remove references to mxlnd 59/27359/2
Cory Spitz [Wed, 31 May 2017 21:39:02 +0000 (16:39 -0500)]
LUDOC-326 mxlnd: Remove references to mxlnd

LU-6209 (resolved for 2.8.0) removed the mxlnd from the source
tree.  References to the mxlnd should have been removed from the
manual at that time.

Signed-off-by: Cory Spitz <spitzcor@cray.com>
Change-Id: I1348e0aea58f2240ba307d072fa86c754d0b6d2e
Reviewed-on: https://review.whamcloud.com/27359
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
7 years agoLUDOC-235 ptllnd: Remove references to ptllnd 39/27339/3
Cory Spitz [Tue, 30 May 2017 22:18:37 +0000 (17:18 -0500)]
LUDOC-235 ptllnd: Remove references to ptllnd

LU-1422 (resolved for 2.6.0) removed the ptllnd from the source
tree.  References to the ptllnd should have been removed from the
manual at that time.

Signed-off-by: Cory Spitz <spitzcor@cray.com>
Change-Id: I99d0d472c63993307eecc3306f8b7d75bd808647
Reviewed-on: https://review.whamcloud.com/27339
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-361 pfl: add pfl section to lustre manual 39/26939/8
Emoly Liu [Fri, 12 May 2017 02:15:08 +0000 (10:15 +0800)]
LUDOC-361 pfl: add pfl section to lustre manual

Convert the PFL user guide to Docbook

Change-Id: Ice045a874cfef7881031e40186681fafe438a7a6
Signed-off-by: Emoly Liu <emoly.liu@intel.com>
Reviewed-on: https://review.whamcloud.com/26939
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
7 years agoLUDOC-285 dne: use rm_entry for remote dir on unavailable MDT 74/27074/3
Joseph Gmitter [Thu, 11 May 2017 16:33:31 +0000 (12:33 -0400)]
LUDOC-285 dne: use rm_entry for remote dir on unavailable MDT

Correct the instruction to remove a remote directory from an
unavailable MDT by using 'lfs rm_entry'.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: Ifdb3595c3373a3788bda2dab1180c80b34ff39d6
Reviewed-on: https://review.whamcloud.com/27074
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
7 years agoLUDOC-376 build: add condition 'l2A' for 2.10 55/27055/4
Andreas Dilger [Wed, 10 May 2017 23:35:24 +0000 (17:35 -0600)]
LUDOC-376 build: add condition 'l2A' for 2.10

Add support for annotating content with "condition='l2A'" to indicate
new content for Lustre 2.10.  Also add "condition='l2B'" for 2.11 in
advance.

Remove support for "condition='l21'" which was never used in the
manual. Remove markers for "condition='l22'" which is now very old,
and fix the content to indicate this is "normal" behaviour.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I1daa97cbfe58247cda912b300f1cea31c1dc2e7c
Reviewed-on: https://review.whamcloud.com/27055
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
Tested-by: Jenkins
7 years agoLU-9348 proc: describe brw_size limits better 26/26726/2
Andreas Dilger [Wed, 19 Apr 2017 02:11:40 +0000 (20:11 -0600)]
LU-9348 proc: describe brw_size limits better

Add a description of the brw_size limits (minimum and maximum values).

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I03ea6bfedd971a510d2861deae8dafaa6fbe4f82
Reviewed-on: https://review.whamcloud.com/26726
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-11 utils: improve mount.lustre.8 option description 80/25680/4
Andreas Dilger [Wed, 1 Mar 2017 10:16:12 +0000 (03:16 -0700)]
LUDOC-11 utils: improve mount.lustre.8 option description

Add the "mgssec=<flavor>" mount option for SSK and Kerberos.
Add the "skpath=pathname" mount option for SSK.
Add the "lazystatfs" and "nolazystatfs" mount options.
Add a description of mount-by-label and mount-by-UUID, with caveats.
Improve the description of the "mgsnode" parameter.
Improve the description of the "flock" and "noflock" options.
Move the "acl" and "noacl" mount options from the client to the
server section, since they've been long deprecated on the client.
Fix whitespace.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I2343df49270ff1f18b7bed20042eafff893ebbe5
Reviewed-on: https://review.whamcloud.com/25680
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-369 osd-ldiskfs: update file-level backup/restore 26/26026/3
Fan Yong [Sat, 5 Nov 2016 21:04:26 +0000 (05:04 +0800)]
LUDOC-369 osd-ldiskfs: update file-level backup/restore

We need to remove the old oi.16* files to avoid stale OI mappings
left in the new rebuilt OI. In addition, removing the CATALOGS
can avoid recovery failure causing mount trouble.

Signed-off-by: Fan Yong <fan.yong@intel.com>
Change-Id: Id768550aae43a986a9c06ebdfc10656f167a2a89
Reviewed-on: https://review.whamcloud.com/26026
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-145 lfsck: enable FID-in-dirent before namespace LFSCK 25/26025/3
Fan Yong [Sat, 5 Nov 2016 18:54:39 +0000 (02:54 +0800)]
LUDOC-145 lfsck: enable FID-in-dirent before namespace LFSCK

If the MDT is upgraded from Lustre software release 1.8, you
need to enable FID-in-dirent manually by "tune2fs -O dirdata".
Otherwise, the namespace LFSCK (since Lustre-2.4) will not
generate FID-in-dirent for the existing files.

Signed-off-by: Fan Yong <fan.yong@intel.com>
Change-Id: Ie562ce8aa2b336bf3afcdcea8f3ccdf396cb7502
Reviewed-on: https://review.whamcloud.com/26025
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-259 lfsck: add the missed lfsck command and option 28/26028/6
Fan Yong [Tue, 8 Nov 2016 17:45:36 +0000 (01:45 +0800)]
LUDOC-259 lfsck: add the missed lfsck command and option

Including the miss lfsck_query command:
lfsck_query [-M | --device MDT_device] [-h | --help]
            [-t | --type lfsck_type[,lfsck_type...]]
            [-w | --wait]

The missed lfsck_start option:
[-d | --delay_create_ostobj]

Signed-off-by: Fan Yong <fan.yong@intel.com>
Change-Id: I1f14fb508ec1379d250176cf646156c786b92a06
Reviewed-on: https://review.whamcloud.com/26028
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-11 config: improve ZFS MDT space calculations 13/25713/6
Andreas Dilger [Thu, 2 Mar 2017 01:03:14 +0000 (18:03 -0700)]
LUDOC-11 config: improve ZFS MDT space calculations

Improve the description of inode space consumption for ZFS MDTs,
as well as ZFS reserved space.

Add a note that "lfs df -i" on a newly formatted MDT or OST will
report a very low estimate for the total number of inodes in the
filesystem until some regular files have been created on the MDT.

Remove a duplicate note about Lustre 2.4 being able to expand the
number of inodes by adding DNE MDTs to an existing filesystem.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Ic035e1a44b4db35dfa1bf9d7b2ed1b2fb0434739
Reviewed-on: https://review.whamcloud.com/25713
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-365 misc: correct spelling mistake in qos_threshold_rr 00/25800/3
Joseph Gmitter [Fri, 3 Mar 2017 22:35:13 +0000 (17:35 -0500)]
LUDOC-365 misc: correct spelling mistake in qos_threshold_rr

Trivial patch to correct a spelling mistake for the
qos_threshold_rr term in a single location.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: Ia9fb9254ca41da742e55507a6e2e1b3852a92e0b
Reviewed-on: https://review.whamcloud.com/25800
Tested-by: Jenkins
7 years agoLUDOC-359 lnet: Update to correct Lnet routings config file 45/25145/2
Joseph Gmitter [Fri, 27 Jan 2017 20:22:10 +0000 (15:22 -0500)]
LUDOC-359 lnet:  Update to correct Lnet routings config file

Updated section 15.5 of the manual to use the correct name
for the LNet routing config file.  /etc/sysconfig/lnet_routes.conf
is correct, where *lustre*_routes.conf had been incorrectly
specified.

I also updated this section to adhere to max line width.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I63541395241ab8f01548bb3431bc4b9dfeffcb7c
Reviewed-on: https://review.whamcloud.com/25145
Tested-by: Jenkins
Reviewed-by: Amir Shehata <amir.shehata@intel.com>
7 years agoLUDOC-11 misc: cleanup formatting of TBF examples 04/24804/5
Andreas Dilger [Tue, 10 Jan 2017 22:49:12 +0000 (15:49 -0700)]
LUDOC-11 misc: cleanup formatting of TBF examples

Minor cleanups of examples for NRS TBF and other misc cleanups.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I4717ac50e68e0cc5635f4702c818314c8f9532c5
Reviewed-on: https://review.whamcloud.com/24804
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-300 misc: cleanup references and obsolete text 44/23944/5
Andreas Dilger [Thu, 24 Nov 2016 21:08:01 +0000 (14:08 -0700)]
LUDOC-300 misc: cleanup references and obsolete text

Remove references to specific Lustre release versions and supported
Linux distros, since these are very version dependent and are better
described in the release notes for each version.

Fix up packages needed on the client and server.

Remove obsolete LNDs from the supported list.

Fix table and figure references to be on the table/figure itself
and not on the title.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I0bf3788f0ee8c32021b61386c6b69e0c47e64ade
Reviewed-on: https://review.whamcloud.com/23944
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-11 misc: update Intel Copyright for 2017 06/24806/2
Andreas Dilger [Tue, 10 Jan 2017 23:04:23 +0000 (16:04 -0700)]
LUDOC-11 misc: update Intel Copyright for 2017

Update Intel Copyright to 2017, since it hadn't been updated for
some years already.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Ie7de5544ad0a58570041e547a3b53a41e785c147
Reviewed-on: https://review.whamcloud.com/24806
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-197 sk: Shared-Secret Key Security 73/23673/5 2.9.0
Nathan Lavender [Wed, 9 Nov 2016 16:30:40 +0000 (11:30 -0500)]
LUDOC-197 sk: Shared-Secret Key Security

This patchset adds documention to the manual for the
Shared-Secret Key Security feature.

Signed-off-by: Nathan Lavender <nblavend@iu.edu>
Change-Id: I4d821a44ec7debe0aa0d26813ee372caaf1fd9e7
Reviewed-on: https://review.whamcloud.com/23673
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-356 rpc: Add documentation for large bulk IO 45/24245/4
Joseph Gmitter [Thu, 8 Dec 2016 17:54:59 +0000 (12:54 -0500)]
LUDOC-356 rpc: Add documentation for large bulk IO

Add basic documentation for large bulk IO (16MB RPC).

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: Iaba6782316b8bf17142dda4b023f394dcb4a78d5
Reviewed-on: https://review.whamcloud.com/24245
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Jinshan Xiong <jinshan.xiong@intel.com>
7 years agoLUDOC-324 lnet: Rename LNET xml files to LNet 72/24472/3
Joseph Gmitter [Wed, 21 Dec 2016 16:17:59 +0000 (11:17 -0500)]
LUDOC-324 lnet: Rename LNET xml files to LNet

As part of the changes to change LNET to LNet in the documentation,
we also need to rename the files with *LNET* to *LNet*.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I64aff87edd557ba3fcdcb5bd61ec160645f8a0d4
Reviewed-on: https://review.whamcloud.com/24472
Tested-by: Jenkins
7 years agoLUDOC-324 lnet: Change LNET to LNet across the entire manual 98/24198/3
Joseph Gmitter [Wed, 7 Dec 2016 15:52:02 +0000 (10:52 -0500)]
LUDOC-324 lnet: Change LNET to LNet across the entire manual

Change the abbreviation for Lustre Networking from LNET to LNet
across the manual.  LNet was chosen as the proper abbreviation
as all caps typically indicates an acronym.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I2677184789314316a75dc4bc66fb66a4c34c5d28
Reviewed-on: https://review.whamcloud.com/24198
Tested-by: Jenkins
7 years agoLUDOC-292 fix: Update formatting error in file path 00/24200/2
Joseph Gmitter [Wed, 7 Dec 2016 16:19:50 +0000 (11:19 -0500)]
LUDOC-292 fix: Update formatting error in file path

At some point the following line was changed in the
Visualizing Results section of the benchmarking section of
the manual:

/proc/fs/lustre/obdfilter/*/brw_stats

was accidentally changed to:

/proc/fs/lustre/obdfilter/

Also, "*/brw_stats" appeared in a <screen> tag, which was not
the intent.

The patch also updates these 3 paragraph for 80 character max
per line.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I10f2a40cd06ee2403c8cb1545302e4c3da03a3b2
Reviewed-on: https://review.whamcloud.com/24200
Tested-by: Jenkins
7 years agoLUDOC-11 lnet: fix typos in XML formatting 82/24182/2
Andreas Dilger [Tue, 6 Dec 2016 20:30:34 +0000 (13:30 -0700)]
LUDOC-11 lnet: fix typos in XML formatting

Fix spacing around XML tags and add <literal> for "network"
keyword.
Wrap at 80 columns.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I4e2a1d1ef835c14414d5f4c73563d1d813cab4cd
Reviewed-on: https://review.whamcloud.com/24182
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-337 fix: flock example should mount using mgs not mds 58/22658/4
Joseph Gmitter [Wed, 21 Sep 2016 14:22:58 +0000 (10:22 -0400)]
LUDOC-337 fix:  flock example should mount using mgs not mds

The mount command example should mount using mgs@tcp instead
of mds@tcp.  Also, a minor style issue is fixed with the example.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I01d94aad640adebd239005ef14d18e6de8a25a8a
Reviewed-on: https://review.whamcloud.com/22658
Tested-by: Jenkins
7 years agoLUDOC-327 ladvise: Add ladvise documentation. 76/23576/4
Joseph Gmitter [Fri, 4 Nov 2016 05:09:56 +0000 (01:09 -0400)]
LUDOC-327 ladvise: Add ladvise documentation.

Add the llapi_ladvise and lfs ladvise documentation to
the manual.  The material was extracted from the
manual patches that were landed for the feature.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I3f0775dd2ceeac3e1a20c28da0c75cfff53e3091
Reviewed-on: https://review.whamcloud.com/23576
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: James Nunez <james.a.nunez@intel.com>
7 years agoLUDOC-300 intro: update Lustre production usage numbers 59/22759/5
Andreas Dilger [Tue, 27 Sep 2016 17:32:27 +0000 (11:32 -0600)]
LUDOC-300 intro: update Lustre production usage numbers

Update the Lustre production usage numbers based on more recent
system configurations.

Link to the file and filesystem size limits from the introduction.
Fix table reference links to reference the table and not the title.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Ie1be90b021a335d43160b05870ae37c631e157cb
Reviewed-on: http://review.whamcloud.com/22759
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
7 years agoLUDOC-342 maintenance: fix error activating an OSC 33/21733/4
Andreas Dilger [Thu, 4 Aug 2016 23:17:54 +0000 (17:17 -0600)]
LUDOC-342 maintenance: fix error activating an OSC

Fix error in reactivating a temporarily-deactivated OSC.  It
incorrectly used "active=0" instead of "active=1" when reactivating
the OSC device.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I127db4fcb5ccc2bd8dba84ba53e0d8d47a256cad
Reviewed-on: http://review.whamcloud.com/21733
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
8 years agoLUDOC-11 misc: Trivial updates to correct spelling errors 80/23580/2
Joseph Gmitter [Fri, 4 Nov 2016 14:18:18 +0000 (10:18 -0400)]
LUDOC-11 misc:  Trivial updates to correct spelling errors

Trivial updates that correct spelling errors found while
reviewing a rendered version of the manual (some errors
are created by running an xml tag into the next word
without a space).

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: Id7709e4fcc776b659213c1298693972e7a0dc8de
Reviewed-on: http://review.whamcloud.com/23580
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-319 fileset: add fileset doc 01/17701/8
Wang Shilong [Tue, 22 Dec 2015 13:21:15 +0000 (08:21 -0500)]
LUDOC-319 fileset: add fileset doc

LU-28 introduce fileset feature, this patch try
to explain how to use Fileset feature for mount utility.

Lustre-change: http://review.whamcloud.com/#/c/5007/

Signed-off-by: Wang Shilong <wshilong@ddn.com>
Change-Id: I872a3bfea3d6c7a2cc9050ede0a576d72993d9df
Reviewed-on: http://review.whamcloud.com/17701
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-11 tuning: improve description of CPT config 41/22741/2
Andreas Dilger [Mon, 26 Sep 2016 20:23:15 +0000 (14:23 -0600)]
LUDOC-11 tuning: improve description of CPT config

Improve the description of CPT configuration tunables, such as module
parameters and /proc file output for various potential uses.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I7d7df85091cc099c22f811c1285433a57da0c4ae
Reviewed-on: http://review.whamcloud.com/22741
Tested-by: Jenkins
Reviewed-by: Amir Shehata <amir.shehata@intel.com>
8 years agoLUDOC-11 changelog: describe changelog space usage 97/23097/2
Andreas Dilger [Wed, 12 Oct 2016 06:12:11 +0000 (00:12 -0600)]
LUDOC-11 changelog: describe changelog space usage

Clarify under changelog registration that this consumes space on the
MDT, and if there is no changelog user that this can fill all space
on the MDT eventually.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I4f216a77a66e2f4b17d2c2378112f57dfd7e5f2d
Reviewed-on: http://review.whamcloud.com/23097
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
8 years agoLUDOC-355 dne: Correction to DNE config for remote sub-dirs 65/22965/3
Joseph Gmitter [Wed, 5 Oct 2016 18:06:40 +0000 (14:06 -0400)]
LUDOC-355 dne: Correction to DNE config for remote sub-dirs

The patch will update the dne configuration instructions
pertaining to remote subdirecty creation.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I36458151da69a57c605926885d380a5e6e1c7284
Reviewed-on: http://review.whamcloud.com/22965
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-317 proc: OST reserved size 60/17560/6
Alexander Boyko [Fri, 11 Dec 2015 11:31:56 +0000 (14:31 +0300)]
LUDOC-317 proc: OST reserved size

Clarify how a MDT use a OST for object allocation base on
reserved space. LU-6910 adds configurable values
reserved_mb_{low|high}. And this patch adds desciption for them.

Signed-off-by: Alexander Boyko <alexander.boyko@seagate.com>
Change-Id: I3e7787781b30c6c6df0dde9661e369254242fc5b
Reviewed-on: http://review.whamcloud.com/17560
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-22 fix: lfs getstripe option and example fixes 08/22408/3
Joseph Gmitter [Fri, 9 Sep 2016 16:16:09 +0000 (12:16 -0400)]
LUDOC-22 fix: lfs getstripe option and example fixes

This patch corrects the documentation of the lfs getstripe options
that have been depricated:
--count => --stripe-count
--index => --stripe-index
--size => --stripe-size
--offset => removed, deprecated by stripe-index

The following options were added::
--mdt-index (previously only -M was documented)
--layout (previously missing)

A few example output areas were also updated to reflect the current
output from the command.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: Id1875afc7a724a8f495018cb9ddea215e94b8954
Reviewed-on: http://review.whamcloud.com/22408
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-314 nodemap: first commit of nodemap documentation 34/17634/9
Chris Hanna [Fri, 12 Aug 2016 15:24:23 +0000 (11:24 -0400)]
LUDOC-314 nodemap: first commit of nodemap documentation

This patchset adds documentation to the manual for the nodemap
feature, specifically adding a Lustre Nodemap section to Part III,
Lustre Administration.

Author: Chris Hanna <hannac@iu.edu>
Change-Id: I51ae5f74fd56300735aeab0589deda0351bce9a2
Signed-off-by: Chris Hanna <hannac@iu.edu>
Reviewed-on: http://review.whamcloud.com/17634
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-351 fix: Correction for lctl get_param version typo 76/22276/3
Joseph Gmitter [Thu, 1 Sep 2016 20:49:04 +0000 (16:49 -0400)]
LUDOC-351 fix:  Correction for lctl get_param version typo

This patch will correct the typo for lctl get_param version.
The manual incorrectly had "lfs" instead of "lcdl" when directing
the user to check the Lustre version.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I0d88b147cd099a5767ce7e258f0cd3fa324e9408
Reviewed-on: http://review.whamcloud.com/22276
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-11 backup: recommend MDT device-level backup 26/21726/3
Andreas Dilger [Thu, 4 Aug 2016 22:06:39 +0000 (16:06 -0600)]
LUDOC-11 backup: recommend MDT device-level backup

Add some text recommending to keep a full MDT device-level backup
for all filesystems.  This is a small amount of storage, but it
can save a lot of grief if the MDT fails for some reason.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I28748111ae366ca180ac2125230b23063057ae8e
Reviewed-on: http://review.whamcloud.com/21726
Tested-by: Jenkins
Reviewed-by: Zhiqi Tao <zhiqi.tao@intel.com>
8 years agoLUDOC-340 pools: fix maximum pool name length to 15 27/21727/2
Andreas Dilger [Thu, 4 Aug 2016 22:13:53 +0000 (16:13 -0600)]
LUDOC-340 pools: fix maximum pool name length to 15

Change the maximum pool name length to 15, from 16, due to changes
in the code to sanity check the maximum pool name length in patch
http://review.whamcloud.com/10306 "LU-5054 llite: enforce pool name
length limit".

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Ic73b09481d70ac11a2b7e02c3cb444de3f68d30e
Reviewed-on: http://review.whamcloud.com/21727
Tested-by: Jenkins
Reviewed-by: Li Xi <lixi@ddn.com>
8 years agoLUDOC-353 Makefile: Added Makefile support for Mac Brew packages 49/22149/2
Bobi Jam [Fri, 26 Aug 2016 05:12:06 +0000 (23:12 -0600)]
LUDOC-353 Makefile: Added Makefile support for Mac Brew packages

Added makefile variables to point to the location of docbookxi.rng
and docbook-xsl of brew packages.

Change-Id: I6f65f5b235dfe8ba116c0b274ded30b306d9bcc3
Signed-off-by: Bobi Jam <bobijam.xu@intel.com>
Reviewed-on: http://review.whamcloud.com/22149
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-349 utils: remove loadgen documentation 31/21731/3
Andreas Dilger [Thu, 4 Aug 2016 23:06:30 +0000 (17:06 -0600)]
LUDOC-349 utils: remove loadgen documentation

The loadgen tool was removed by http://review.whamcloud.com/12395
"LU-2675 utils: remove loadgen" and should not be in the manual.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Ia05ec8180fbf4c3b74f511962835a46c419b4338
Reviewed-on: http://review.whamcloud.com/21731
Tested-by: Jenkins
8 years agoLUDOC-338 proc: use lctl {get,set}_param 30/21730/2
Andreas Dilger [Thu, 4 Aug 2016 22:51:53 +0000 (16:51 -0600)]
LUDOC-338 proc: use lctl {get,set}_param

Document the use of "lctl {get,set}_param" instead of "cat" for
accessing /proc tunables and stats, since these may have been
moved to /sys or /sys/kernel/debug in newer kernels, and scripts
using "cat" will break.

Fix some places where "mdt" should be used instead of "mds" since 2.x.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I3c97d18f5397a38ff01b431cf765b3b40d8bea4b
Reviewed-on: http://review.whamcloud.com/21730
Tested-by: Jenkins
Reviewed-by: James Simmons <uja.ornl@yahoo.com>
8 years agoLUDOC-341 utils: document "lfs pool_list" correctly 34/21734/2
Andreas Dilger [Thu, 4 Aug 2016 23:24:12 +0000 (17:24 -0600)]
LUDOC-341 utils: document "lfs pool_list" correctly

With the landing of http://review.whamcloud.com/2734 there is
no longer any mention of "lfs poollist" in the Lustre code or
man pages.  Fix this in the user manual as well.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I699e9094a9d9d779c84fb0a6cbdacad04edbefbd
Reviewed-on: http://review.whamcloud.com/21734
Reviewed-by: Bob Glossman <bob.glossman@intel.com>
Tested-by: Jenkins
8 years agoLUDOC-331 setup: improve ldiskfs formatting options 62/21262/3
Andreas Dilger [Tue, 12 Jul 2016 19:26:11 +0000 (13:26 -0600)]
LUDOC-331 setup: improve ldiskfs formatting options

Improve the description of the ldiskfs formatting options.
Add limit for the maximum number of objects per ldiskfs OST.
Improve related cross-reference section names.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I96eac773362327d303153d3409dbc740723ebbe5
Reviewed-on: http://review.whamcloud.com/21262
Tested-by: Jenkins
Reviewed-by: Nathaniel Clark <nathaniel.l.clark@intel.com>
8 years agoLUDOC-331 setup: explain ldiskfs inode size/ratio better 86/19786/3
Andreas Dilger [Mon, 18 Apr 2016 05:53:41 +0000 (23:53 -0600)]
LUDOC-331 setup: explain ldiskfs inode size/ratio better

Improve the description of the ldiskfs inode size and inode ratio.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I96eac773362327d303153d3409dbc740713ebbe5
Reviewed-on: http://review.whamcloud.com/19786
Tested-by: Jenkins
Reviewed-by: Nathaniel Clark <nathaniel.l.clark@intel.com>
8 years agoLUDOC-239 benchmark: remove mention of PIOS and Solaris 30/19130/2
Andreas Dilger [Thu, 24 Mar 2016 19:07:42 +0000 (13:07 -0600)]
LUDOC-239 benchmark: remove mention of PIOS and Solaris

Remove stale mention of PIOS and Solaris, since these are not
supported any more.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I47c67badcffcecabdd2f11f0f2027df22fb28bda
Reviewed-on: http://review.whamcloud.com/19130
Tested-by: Jenkins
8 years agoLUDOC-306 dne: add more description for DNE usage 77/19177/4
Andreas Dilger [Mon, 28 Mar 2016 21:35:16 +0000 (15:35 -0600)]
LUDOC-306 dne: add more description for DNE usage

Add some more references to "DNE" in the text, instead of only in the
glossary, so that it is more easily found when searching the manual.

Add some more examples and explanation of how and when to use multiple
MDTs and striped vs. remote directories.  Definitely more could be
written on this topic, but it is a start.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Iaec344afe2d909ece0a1935eb33d8a58ad992370
Reviewed-on: http://review.whamcloud.com/19177
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
8 years agoLUDOC-11 intro: describe prompt usage better 27/19027/2
Andreas Dilger [Sat, 19 Mar 2016 01:01:13 +0000 (19:01 -0600)]
LUDOC-11 intro: describe prompt usage better

None of the examples are using csh or ksh, only sh or bash, so this
is not a useful distinction to be made.  Instead, describe that the
client, OSS, MDS, MGS name may be used in the prompt.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I66af5408c8e8eb3f1745a3c5d9a415202cf0ec37
Reviewed-on: http://review.whamcloud.com/19027
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
8 years agoLUDOC-304 fix: improvements related to multiple modify RPCs 79/19079/3
Gregoire Pichon [Wed, 23 Mar 2016 07:38:18 +0000 (08:38 +0100)]
LUDOC-304 fix: improvements related to multiple modify RPCs

Address several minor improvements detected during review:
wrap text at 80 columns, fix typo, ...

Signed-off-by: Gregoire Pichon <gregoire.pichon@bull.net>
Change-Id: I1813ac6911a3309f2b99d4f60bacb25a0cba1dfc
Reviewed-on: http://review.whamcloud.com/19079
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
8 years agoLUDOC-120 webhelp: transform manual to webhelp. 64/18364/7
Richard Henwood [Tue, 9 Feb 2016 16:48:48 +0000 (10:48 -0600)]
LUDOC-120 webhelp: transform manual to webhelp.

Webhelp transform included navigation and content indexing. This
change adds support for webhelp including the Lustre Operations
Manual specific decorations for release specific features.

Change-Id: Ic32d8a76a53b3f744df7796288fa898c8c2bbc53
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/18364
Tested-by: Jenkins
8 years agoLUDOC-120 presentation: build bits for webhelp. 87/18087/7
Richard Henwood [Thu, 21 Jan 2016 20:51:54 +0000 (14:51 -0600)]
LUDOC-120 presentation: build bits for webhelp.

Webhelp is available in Docbook >1.76. Add in the necessary
bits to support building webhelp - provided that the platform has
a suitably recent Docbook version installed.

Change-Id: I3026782a905c8d66b48e9fd6b9832977fccc4ecf
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/18087
Tested-by: Jenkins
8 years agoLUDOC-316 fix: correct lfs usage documentation. 31/17531/4
Richard Henwood [Wed, 9 Dec 2015 20:35:30 +0000 (14:35 -0600)]
LUDOC-316 fix: correct lfs usage documentation.

Make lfs setstripe instructions the same as the man page.

Change-Id: I44a980df079fca78e2ebf1cdfb6eeb6e6c0b8d75
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17531
Tested-by: Jenkins
8 years agoLUDOC-263 wrap: wrap lines for review convenience. 30/17530/4
Richard Henwood [Wed, 9 Dec 2015 18:47:13 +0000 (12:47 -0600)]
LUDOC-263 wrap: wrap lines for review convenience.

As subject.

Change-Id: I1f92f65bdd1bb45f80f9c621de1b131be60ce5f1
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17530
Tested-by: Jenkins
8 years agoLUDOC-306 dne2: update with new command for DNE2 94/17394/10 2.8.0
Richard Henwood [Mon, 30 Nov 2015 18:55:53 +0000 (12:55 -0600)]
LUDOC-306 dne2: update with new command for DNE2

Distributed metadata phase 2 (DNE2) introduces the concept of
a the metadata contents of a given directory striped across
multiple MDTs.

Update the manual to ensure the operation of this new feature is
documented. Include description of migration tool.

See also: LU-3531

Change-Id: I96f7012638358b9985480ec67539cf72adf3ced5
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17394
Tested-by: Jenkins
8 years agoLUDOC-263 wrap: wrap lines for review convenience. 93/17393/7
Richard Henwood [Mon, 30 Nov 2015 18:52:05 +0000 (12:52 -0600)]
LUDOC-263 wrap: wrap lines for review convenience.

As subject.

Change-Id: Ib5b0ba11b154be11e62626dba47653b98b72a20c
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17393
Tested-by: Jenkins
8 years agoLUDOC-304 tuning: support multiple modify RPCs in parallel 29/16429/4
Gregoire Pichon [Tue, 15 Sep 2015 14:48:31 +0000 (16:48 +0200)]
LUDOC-304 tuning: support multiple modify RPCs in parallel

Update the Lustre manual to reflect the support of multiple modify
metadata RPCs in parallel, LU-5319:
https://jira.hpdd.intel.com/browse/LU-5319.

The following sections are added or modified:
- Tuning the Client Metadata RPC Stream
- Reply Reconstruction
- lr_reader debugging utility

Signed-off-by: Gregoire Pichon <gregoire.pichon@bull.net>
Change-Id: I3b4199424b2ca43b94e26ee715ae7cc9d5770080
Reviewed-on: http://review.whamcloud.com/16429
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Jenkins
8 years agoLUDOC-247 mount: Clarify recovery_time_{soft,hard} defaults 85/11885/3
Ryan Haasken [Mon, 7 Jul 2014 15:40:16 +0000 (10:40 -0500)]
LUDOC-247 mount: Clarify recovery_time_{soft,hard} defaults

It was not clear that the recovery_time_{soft,hard} default values
depended on the RPC timeout value at mount time.  The descriptions of
the default values of these recovery times were clarified.  Links were
added from the recovery_time_{soft,hard} descriptions to the section
which describes the RPC timeout.

Signed-off-by: Ryan Haasken <haasken@cray.com>
Change-Id: Iecf2814fb62e7bedff79873bbd802fc27277aafa
Reviewed-on: http://review.whamcloud.com/11885
Tested-by: Jenkins
Reviewed-by: Chris Horn <hornc@cray.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
8 years agoLUDOC-261 lfsck: Describe phases of namespace/layout LFSCK 76/12676/3
Ryan Haasken [Tue, 9 Feb 2016 19:41:32 +0000 (13:41 -0600)]
LUDOC-261 lfsck: Describe phases of namespace/layout LFSCK

Add a short explanation of the phases of namespace and layout LFSCK so
that the user can understand the output of the namespace and layout
LFSCK status interfaces.

Signed-off-by: Ryan Haasken <haasken@cray.com>
Change-Id: Id8042375a12a6ccaf47da5647ba274eafde746b9
Reviewed-on: http://review.whamcloud.com/12676
Tested-by: Jenkins
Reviewed-by: Fan Yong <fan.yong@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
8 years agoLUDOC-224 build: remove redundant build instructions. 59/9259/5
Richard Henwood [Wed, 16 Dec 2015 16:32:31 +0000 (10:32 -0600)]
LUDOC-224 build: remove redundant build instructions.

Building Lustre is much better dealt with by external resources. Remove
the redundant, out-of-date build instructions from the operations
manual.

Change-Id: I00171bc73874570d08c72a4378694fa6c8945d84
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/9259
Tested-by: Jenkins
8 years agoLUDOC-307 example: example output for obdfilter-survey. 47/16647/3
Richard Henwood [Fri, 25 Sep 2015 22:07:35 +0000 (17:07 -0500)]
LUDOC-307 example: example output for obdfilter-survey.

Explain example output from obdfilter-survey.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I4c98a5c3b1c4f395a297a94de8167a5141ef9833
Reviewed-on: http://review.whamcloud.com/16647
Tested-by: Jenkins
8 years agoLUDOC-321 style: ensure ID attributes are unique. 07/18007/3
Richard Henwood [Thu, 14 Jan 2016 18:21:14 +0000 (12:21 -0600)]
LUDOC-321 style: ensure ID attributes are unique.

Fix the case where multiple chapters get the same ID in the
intermediary fop file. Allow multiple chapters to have conditional
decorations.

Change-Id: Ib73f46706d0d7142f6d8effa2fe5b129de60400c
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/18007
Tested-by: Jenkins
Reviewed-by: Chris Hanna <hannac@iu.edu>
8 years agoLUDOC-313 cleanup: Remove ambiguity in quota documentation. 99/17399/10
Richard Henwood [Mon, 30 Nov 2015 21:28:09 +0000 (15:28 -0600)]
LUDOC-313 cleanup: Remove ambiguity in quota documentation.

Explain how to detect which version is running.

Clarify which server type you need to execute which commands
on.

Clarify which commands need to be executed on a client.

Improve readability.

Change-Id: I707c5dace26369d161cfd1a08276edf7fbada06b
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17399
Tested-by: Jenkins
Reviewed-by: John Fuchs-Chesney <john.fuchs-chesney@intel.com>
8 years agoLUDOC-263 wrap: wrap lines for review convenience. 98/17398/3
Richard Henwood [Mon, 30 Nov 2015 21:20:11 +0000 (15:20 -0600)]
LUDOC-263 wrap: wrap lines for review convenience.

As subject.

Change-Id: I5c7bf1373b8e4f0207539193a2de4118391df34d
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17398
Tested-by: Jenkins
8 years agoLUDOC-254 lfsck: clarify commands. 92/14692/6
Richard Henwood [Wed, 6 May 2015 17:39:42 +0000 (12:39 -0500)]
LUDOC-254 lfsck: clarify commands.

Clarify the starting of LFSCK with -A. Device is an ambigious term,
remove it and use 'target' instead. Fix up some other small issues.

Change-Id: I1b77da753b60bf405936539d626eecb33f5717f9
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/14692
Tested-by: Jenkins
8 years agoLUDOC-206 install: correct rpm names. 86/17486/2
Richard Henwood [Fri, 4 Dec 2015 22:27:56 +0000 (16:27 -0600)]
LUDOC-206 install: correct rpm names.

Update to reflect that "lustre-ldiskfs" package moved to
"lustre-osd-ldiskfs". Also add that there is a similar zfs
rpm.

Change-Id: I369e64cbdf1671ab9b8763ac833e5ed3fb79cf75
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17486
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-263 wrap: wrap lines for review convenience. 85/17485/2
Richard Henwood [Fri, 4 Dec 2015 22:23:15 +0000 (16:23 -0600)]
LUDOC-263 wrap: wrap lines for review convenience.

As subject.

Change-Id: Idd2196effb2f90c5d2ba7ac7de3e4cca6bf13b71
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17485
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
8 years agoLUDOC-256 typo: fixed typos with mod config. 38/11938/8
Richard Henwood [Tue, 1 Dec 2015 17:15:08 +0000 (11:15 -0600)]
LUDOC-256 typo: fixed typos with mod config.

Add l23 specific tags to relevant sections.

Fix error in module options and correct path to partition table.

Change-Id: I51de61a20fbe0d3082b722fe6d6b460373bc6e2f
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/11938
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
8 years agoLUDOC-263 wrap: wrap lines for review convenience. 10/17410/2
Richard Henwood [Tue, 1 Dec 2015 16:53:47 +0000 (10:53 -0600)]
LUDOC-263 wrap: wrap lines for review convenience.

As subject.

Change-Id: Ie0fe0ac9215db6e95a2e72e43edf8fe132775640
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/17410
Tested-by: Jenkins
9 years agoLUDOC-204 lnet: Dynamic LNET Configuration Documentation 63/8263/11
Amir Shehata [Thu, 14 Nov 2013 04:17:42 +0000 (20:17 -0800)]
LUDOC-204 lnet: Dynamic LNET Configuration Documentation

Added a section in the Lustre Manual for the DLC project:
LU-2456.  The section gives an overview of how DLC works,
a detailed explanation of all the DLC C-APIs introduced,
a detailed explanation of the YAML Interface, the LNET
configuration utility and the new command line
infrastructure.

Signed-off-by: Amir Shehata <amir.shehata@intel.com>
Change-Id: I777e50d47d848671bee85b89376f2bd17bbeee2c
Reviewed-on: http://review.whamcloud.com/8263
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
9 years agoLUDOC-249 defrag: lfs_migrate can be used to defrag. 19/11119/6
Richard Henwood [Wed, 16 Jul 2014 18:53:16 +0000 (13:53 -0500)]
LUDOC-249 defrag: lfs_migrate can be used to defrag.

Alert the audience that lfs_migrate can be used to defragment
a file, provided there is suffecient unfragmented free space
available. Wrap lines for sane reading.

Change-Id: I3f88debdd2a125a9216a9b2d8b4169426a2a99da
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/11119
Tested-by: Jenkins
9 years agoLUDOC-284 misc: update known filesystem limits 06/15106/3
Andreas Dilger [Tue, 2 Jun 2015 18:13:10 +0000 (12:13 -0600)]
LUDOC-284 misc: update known filesystem limits

Update known limits from production systems.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I2b69712789ce42d2b906b79c337816ca81ecab07
Reviewed-on: http://review.whamcloud.com/15106
Tested-by: Jenkins
9 years agoLUDOC-221 nrs: Add tbf policy document 02/11302/6
Wu Libin [Fri, 1 Aug 2014 02:24:41 +0000 (10:24 +0800)]
LUDOC-221 nrs: Add tbf policy document

tbf is a new policy in nrs, this patch describe how to use it.

Signed-off-by: Li Xi <lixi@ddn.com>
Signed-off-by: Wu Libin <lwu@ddn.com>
Change-Id: I3f0fecc8d10d67a5326db3678a9db0663b7ae9e7
Reviewed-on: http://review.whamcloud.com/11302
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
9 years agoLUDOC-273 tune: update tunefs.lustre 81/14481/4
Richard Henwood [Mon, 20 Apr 2015 18:13:05 +0000 (13:13 -0500)]
LUDOC-273 tune: update tunefs.lustre

Consistent mountfsoptions line. mballoc,extents are redundant
options since Lustre version ~2.5.

Change-Id: Ib328f11f4ce3978a0a7e6325facebf9f8e201dc9
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/14481
Tested-by: Jenkins
Reviewed-by: Chris Hunter <chris.hunter@yale.edu>
Reviewed-by: Alex Zhuravlev <alexey.zhuravlev@intel.com>
9 years agoLUDOC-260 monitoring: clarify enable/disable jobstats 74/13274/5
Olaf Faaland [Tue, 6 Jan 2015 23:33:33 +0000 (15:33 -0800)]
LUDOC-260 monitoring: clarify enable/disable jobstats

State where lctl commands must be run, to enable or disable collection
of jobstats.  Improve the description of JobID usage, and describe the
possibility of using separate jobid_var on different nodes.

Update jobstat examples to show output from multiple targets.

Fix a defect in the example for how to clear a single job stat.

Signed-off-by: Olaf Faaland <faaland1@llnl.gov>
Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I1866b1bff291fd3741ee751d60c7a5aae56c6084
Reviewed-on: http://review.whamcloud.com/13274
Tested-by: Jenkins
Reviewed-by: Niu Yawei <yawei.niu@intel.com>
9 years agoLUDOC-11 typo: Fix minor spelling error in Failover 87/14287/2 2.7.0
Nathaniel Clark [Tue, 31 Mar 2015 17:20:53 +0000 (13:20 -0400)]
LUDOC-11 typo: Fix minor spelling error in Failover

In section "Preparing a Lustre File System for
Failover", fix spelling of "can".

Signed-off-by: Nathaniel Clark <nathaniel.l.clark@intel.com>
Change-Id: Ia25d461245b58da061c0bbe38c16cdde0832af3c
Reviewed-on: http://review.whamcloud.com/14287
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
9 years agoLUDOC-263 lfsck: review and update LFSCK documentation. 66/12966/5
Richard Henwood [Fri, 5 Dec 2014 20:20:37 +0000 (14:20 -0600)]
LUDOC-263 lfsck: review and update LFSCK documentation.

LFSCK is functionally complete for release 2.7. Update the
documentation to reflect this. Wrap files for readability.

Change-Id: I16462cc2a27b14e4652e19378642af4c306a165b
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/12966
Tested-by: Jenkins
Reviewed-by: Fan Yong <fan.yong@intel.com>
9 years agoLUDOC-11 proc: fix incorrect example 58/13358/2
Andreas Dilger [Tue, 13 Jan 2015 00:03:20 +0000 (17:03 -0700)]
LUDOC-11 proc: fix incorrect example

Fix incorrect example for writethrough_cache_enable.  It was using
"lctl set_param" instead of "lctl get_param" to check the current
value.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Ia07d3c7e1ad4d13adf24c0c7f798c1e0cf756a6f
Reviewed-on: http://review.whamcloud.com/13358
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
9 years agoLUDOC-249 filefrag: update to match current output 33/11833/3
Andreas Dilger [Tue, 9 Sep 2014 16:38:14 +0000 (10:38 -0600)]
LUDOC-249 filefrag: update to match current output

Update the filefrag example to match the current output format.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I3047791dfff42dce0f349a4a41219785bf3ff3e8
Reviewed-on: http://review.whamcloud.com/11833
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-244 lfsck: Update lfsck documentation 86/11886/3
Ryan Haasken [Mon, 7 Jul 2014 15:09:10 +0000 (10:09 -0500)]
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 <haasken@cray.com>
Change-Id: Ie947f8b268af299a0f583b98bb559f9d3313c0bf
Reviewed-on: http://review.whamcloud.com/11886
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-254 lfsck: update Lustre manual for LFSCK 3 77/12277/5
Fan Yong [Thu, 4 Sep 2014 00:10:10 +0000 (08:10 +0800)]
LUDOC-254 lfsck: update Lustre manual for LFSCK 3

Include LFSCK command lines and proc interfaces changes.

Signed-off-by: Fan Yong <fan.yong@intel.com>
Change-Id: Id568699b7eb5694a21a1c7db4f05e59b71605386
Reviewed-on: http://review.whamcloud.com/12277
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Ryan Haasken <haasken@cray.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-11 cleanup: Update examples and fix typos 76/11976/2
James Nunez [Thu, 18 Sep 2014 16:47:14 +0000 (10:47 -0600)]
LUDOC-11 cleanup: Update examples and fix typos

Cleanup of examples and text in the Benchmaking Tests
section of the manual. The sample output for ost-survey
was updated and the command line flags were corrected.

For obdfilter-survey, the input parameter "target"
was changed to "targets".

Change-Id: Ib7f36ae860b6999b2a87b7e05ab8be8b0dee36ed
Signed-off-by: James Nunez <james.a.nunez@intel.com>
Reviewed-on: http://review.whamcloud.com/11976
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-253 lnet: Update and correct routerstat info 50/11350/3 2.6.0
James Nunez [Wed, 6 Aug 2014 17:45:03 +0000 (11:45 -0600)]
LUDOC-253 lnet: Update and correct routerstat info

Correct the description of routerstat output values,
add a description of additional lines printed when
providing an interval value, and add an example of
routerstat output.

Signed-off-by: James Nunez <james.a.nunez@intel.com>
Change-Id: I36ee7a12b5b4e32e8b70a7cab491cd9e9addfcee
Reviewed-on: http://review.whamcloud.com/11350
Tested-by: Jenkins
Reviewed-by: Amir Shehata <amir.shehata@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-251 hsm: Fix typos and wording in HSM section 23/11223/2
Ryan Haasken [Thu, 24 Jul 2014 20:52:07 +0000 (15:52 -0500)]
LUDOC-251 hsm: Fix typos and wording in HSM section

Fixed the HSM event names in section 22.7.  They now match the enum
hsm_event in the Lustre source, and their names now match their
descriptions.

Also fixed minor English usage mistakes in an effort to make the
HSM chapter more readable.

Signed-off-by: Ryan Haasken <haasken@cray.com>
Change-Id: Ib331fce9a7789a8ee51f8063c5d0ddf9dd696887
Reviewed-on: http://review.whamcloud.com/11223
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-248 warning: don't put client on MDS or OSS 82/11082/2
Richard Henwood [Sat, 12 Jul 2014 00:45:55 +0000 (19:45 -0500)]
LUDOC-248 warning: don't put client on MDS or OSS

Highlight that you shouldn't put a client on an MDS or OSS.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I14af08619bebf0c40b9d7cd7603ff47c6331697c
Reviewed-on: http://review.whamcloud.com/11082
Reviewed-by: John L. Hammond <john.hammond@intel.com>
Tested-by: Jenkins
10 years agoLUDOC-246 style: annotations in ToC of pdf 03/10803/3
Richard Henwood [Tue, 24 Jun 2014 16:21:58 +0000 (11:21 -0500)]
LUDOC-246 style: annotations in ToC of pdf

Fix the missing annotations for Lustre >2.5 in the table of
contents of the pdf output.

Change-Id: I785ef3f4be6e994854b77639219404922c10cf77
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/10803
Tested-by: Jenkins
10 years agoLUDOC-243 style: Improve formatting of version tags (html) 07/10707/2
Ryan Haasken [Thu, 12 Jun 2014 23:01:40 +0000 (18:01 -0500)]
LUDOC-243 style: Improve formatting of version tags (html)

Improved the xsl templates and the manual.css stylesheet so that the
Lustre version tags would not overlap the text.

- Created a versionbox div class for the div which puts a box around
  version-specific content.
- Created a versioncontent span class for the actual content.
- Put the xsl:apply-templates element inside of a versioncontent span.
- Gave the versioncontent class a margin-left of 15px to move the text
  to the right of the versionlabel.
- Capitalized "Introduced" in the version labels.

Signed-off-by: Ryan Haasken <haasken@cray.com>
Change-Id: I4dbacc082211116626298caf8629e942803725e0
Reviewed-on: http://review.whamcloud.com/10707
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-56 zfs: discuss ZFS in parts of the manual 40/9740/4
Andreas Dilger [Fri, 21 Mar 2014 00:24:38 +0000 (18:24 -0600)]
LUDOC-56 zfs: discuss ZFS in parts of the manual

Added ZFS filesystem limits in the Lustre limits tables, since they
are significantly different from ldiskfs filesystem limits.

Include mention of ZFS in a few key places.  This definitely is
just a starting point, since a full discussion of formatting and
maintaining ZFS is needed in the manual.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Icaea5657e43ec58466f4ea8047fbec65b2805701
Reviewed-on: http://review.whamcloud.com/9740
Tested-by: Jenkins
10 years agoLUDOC-11: Fix the changelog_register command example. 50/10350/2
Ashley Pittman [Fri, 16 May 2014 14:50:16 +0000 (15:50 +0100)]
LUDOC-11: Fix the changelog_register command example.

Change-Id: I17da3e6b93e5db1fa41d101f22e19c3076f28849
Signed-off-by: Ashley Pittman <apittman@ddn.com>
Reviewed-on: http://review.whamcloud.com/10350
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-236 config: fixed config instructions. 84/10284/2
Richard Henwood [Tue, 8 Apr 2014 21:12:56 +0000 (17:12 -0400)]
LUDOC-236 config: fixed config instructions.

Config instructions for lnet were wrong. Fixed.

Change-Id: I61593f2c0f1ddfb521045956f399abe0a26f4ea7
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/10284
Tested-by: Jenkins
Reviewed-by: Isaac Huang <he.huang@intel.com>
10 years agoLUDOC-232 lfsck: remove mention of old lfsck 41/9741/4
Andreas Dilger [Fri, 21 Mar 2014 00:57:08 +0000 (18:57 -0600)]
LUDOC-232 lfsck: remove mention of old lfsck

The old e2fsprogs lfsck has been completely replaced by the new
in-kernel online LFSCK.  Since the old lfsck is uncommonly used,
and is no longer usable on new filesystems, it is removed from
the manual completely instead of keeping both in the manual.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I828be37acbc7972aa8798b9852598737d897a911
Reviewed-on: http://review.whamcloud.com/9741
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Fan Yong <fan.yong@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-229 debugging: Add console message rate limiting section 66/9566/4
Ryan Haasken [Mon, 10 Mar 2014 18:21:37 +0000 (13:21 -0500)]
LUDOC-229 debugging: Add console message rate limiting section

Added a section under section 29.2 "Lustre Debugging Procedures" which
covers the libcfs module parameters which can be used to control
Lustre console message rate limiting.  The new section covers
disabling the rate limiting entirely as well as modifying the minimum
and maximum message delays.

Signed-off-by: Ryan Haasken <haasken@cray.com>
Change-Id: If9bcb7fa7bdfd40fce37aa3c36358ed21bcaf138
Reviewed-on: http://review.whamcloud.com/9566
Reviewed-by: John L. Hammond <john.hammond@intel.com>
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-222 mount: Fix some issue with mount documentation 28/9128/3
Matt Ezell [Wed, 5 Feb 2014 05:23:26 +0000 (00:23 -0500)]
LUDOC-222 mount: Fix some issue with mount documentation

In 33.5:
- Missing 'localflock'
- Missing 'nomgs'
- Missing (no)user_fid2path
- Missing (no)acl, but left out because it's marked as deprecated
In 37.15.3:
- Added user_fid2path and nouser_fid2path entries were added
- 'nosvc' 'nomgs' and 'exclude' are listed twice
- The 'nomgs' was misspelled as 'nomsgs'

Signed-off-by: Matt Ezell <ezellma@ornl.gov>
Change-Id: I0fdf197f5c5fd5c8c4c8f82e390cd8dd945bff2b
Reviewed-on: http://review.whamcloud.com/9128
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-155 lfsck: LFSCK Phase II Additions 68/9068/11
James Nunez [Thu, 30 Jan 2014 23:39:44 +0000 (16:39 -0700)]
LUDOC-155 lfsck: LFSCK Phase II Additions

Added information about MDT-OST file layout consistency
checking, LFSCK phase II, to the manual section about
LFSCK.

Also cleanup up a few typos, table column issues and
minor corrections (including LUDOC-182).

Signed-off-by: James Nunez <james.a.nunez@intel.com>
Change-Id: I2333b383168c30e4ee54b6f2bb7f300df45c0f28
Reviewed-on: http://review.whamcloud.com/9068
Tested-by: Jenkins
Reviewed-by: Fan Yong <fan.yong@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-208 compat: build works on SLES 11 sp2 and RHEL 6 16/9216/2
Richard Henwood [Tue, 11 Feb 2014 02:27:31 +0000 (20:27 -0600)]
LUDOC-208 compat: build works on SLES 11 sp2 and RHEL 6

Fix to remain buildable on SLES 11 SP2 and RHEL 6.

Change-Id: I0db114df27d0b7e53e975c107797eae1c3eac283
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/9216
Tested-by: Jenkins
Reviewed-by: Matt Ezell <ezellma@ornl.gov>
10 years agoLUDOC-11 typos: Fix references to unknown lustre versions 26/9126/2
Matt Ezell [Wed, 5 Feb 2014 04:20:30 +0000 (23:20 -0500)]
LUDOC-11 typos: Fix references to unknown lustre versions

Replace the character '1' with 'l' to avoid the message:
unrecognised Lustre version

Signed-off-by: Matt Ezell <ezellma@ornl.gov>
Change-Id: Icc0d71c7c73bd53bce79032ba79f97480fd2a56d
Reviewed-on: http://review.whamcloud.com/9126
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-104 meta: revision section updated. 80/8880/2
Richard Henwood [Thu, 9 Jan 2014 17:25:22 +0000 (11:25 -0600)]
LUDOC-104 meta: revision section updated.

The revision section now correctly reflects that the manual is
continuously built. It also briefly describes the lustre specific
annotations.

Change-Id: Id1e82e1f91eeaf97ab11f9c0a9710e601115eb02
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/8880
Tested-by: Jenkins
10 years agoLUDOC-104 meta: support lustre versions thru 2.9. 53/9053/2
Richard Henwood [Wed, 29 Jan 2014 17:39:20 +0000 (11:39 -0600)]
LUDOC-104 meta: support lustre versions thru 2.9.

Decoration for lustre version through to version 2.9 is now supported.

Change-Id: Iaf801fc561a74f29e68b64161dadf36ce71e70ed
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-on: http://review.whamcloud.com/9053
Tested-by: Jenkins
10 years agoLUDOC-193 ea_inode: Added index entries and info on ea_inode 97/8297/3
James Nunez [Fri, 15 Nov 2013 21:01:27 +0000 (14:01 -0700)]
LUDOC-193 ea_inode: Added index entries and info on ea_inode

In order to turn on or off the wide striping option, you can
specify large_xattr or ea_inode. Both parameters will enable
the wide striping feature. Using either parameter in tune2fs
or mkfs.lustre will result in "ea_inode" listed in the file
system features using dumpe2fs. Since there is some potential
confusion around these feature parameters, this patch hopes
to address this.

Added index entries to Section 5.3.3 "Setting up Lustre File System"
and Section 16.2 "Upgrading Lustre" to make information about the
wide striping (ea_inode) option to tune2fs and mkfs.lustre easier
to find.

Signed-off-by: James Nunez <james.a.nunez@intel.com>
Change-Id: Ice054cd1720ac3174889bd27eb22f19472597041
Reviewed-on: http://review.whamcloud.com/8297
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-210 jobstats: Clarify jobstats section and add ALPS 77/8577/2
Ryan Haasken [Sat, 14 Dec 2013 00:46:36 +0000 (18:46 -0600)]
LUDOC-210 jobstats: Clarify jobstats section and add ALPS

Clarified the jobstats section of the documentation by separating the
environment variable values for jobid_var from the special values for
jobid_var.  The special values are now explained in paragraphs with
examples following the table.  The table's columns were swapped
because it is really the job scheduler which determines the value of
jobid_var.  The description preceding the table was clarified.  A
run-on sentence was split up at the beginning of section 12.2.1, and
the article "a" was added before client.

Signed-off-by: Ryan Haasken <haasken@cray.com>
Change-Id: I9f92891ad44ab3e86d81042d0978d32d9603ecfd
Reviewed-on: http://review.whamcloud.com/8577
Tested-by: Jenkins
Reviewed-by: Patrick Farrell <paf@cray.com>
Reviewed-by: Chris Horn <hornc@cray.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-211 Makefile: Added Makefile support for SLED 11 SP2 93/8493/3
Ryan Haasken [Thu, 5 Dec 2013 21:01:51 +0000 (15:01 -0600)]
LUDOC-211 Makefile: Added Makefile support for SLED 11 SP2

Added a variable XSL_SLE to the makefile which points at the location
of the docbook.xsl files in SLE distributions.  Added the check on
whether that directory exists in the XSL variable assignment.

Tested that "make html" works on a SLED 11 SP2 machine.

Signed-off-by: Ryan Haasken <haasken@cray.com>
Change-Id: I82f0407ea98904c2060090d3d205a36f16d2b153
Reviewed-on: http://review.whamcloud.com/8493
Tested-by: Jenkins
Reviewed-by: Ann Koehler <amk@cray.com>
Reviewed-by: Patrick Farrell <paf@cray.com>
Reviewed-by: Chris Horn <hornc@cray.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-209 quota: update manual for 'lfs quota' changes 99/8399/2
Niu Yawei [Tue, 26 Nov 2013 03:09:39 +0000 (22:09 -0500)]
LUDOC-209 quota: update manual for 'lfs quota' changes

'-h' option is added to 'lfs quota' and total allocated inode/block
limit is showed when '-v' is specifided.

Signed-off-by: Niu Yawei <yawei.niu@intel.com>
Change-Id: I7ef26a7bf15edf2d3a03489ed0bdf8e7386495f4
Reviewed-on: http://review.whamcloud.com/8399
Tested-by: Jenkins
Reviewed-by: Johann Lombardi <johann.lombardi@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-173 trademarks: Completed second pass of Intel trademark compliance review. 24/8124/4 2.5.0
Linda Bebernes [Thu, 31 Oct 2013 19:45:56 +0000 (12:45 -0700)]
LUDOC-173 trademarks:  Completed second pass of Intel trademark compliance review.

[patch set 4] - Updates Chapters 2, 9, and 26 with all changes to date.

Lustre third party trademark is now compliant with guideline to always
use a trademark as an adjective of a proper noun throughout manual
except in chapters where major changes have been made to address
failover ticket (LUDOC-69), including 3,11,13,14,20,36. Lustre trademark
compliance is addressed in these chapter in LUDOC-69.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I8031b9a6c52ac42e1d31d0bb5f8a9624bc96adea
Reviewed-on: http://review.whamcloud.com/8124
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>