Whamcloud - gitweb
doc/manual.git
4 years agoLUDOC-442 dne: directory creation by space/inode 15/36615/6
Joseph Gmitter [Wed, 30 Oct 2019 14:51:03 +0000 (10:51 -0400)]
LUDOC-442 dne: directory creation by space/inode

This patch adds the feature documentation for the DNE
work landed under LU-11213 and LU-12624 in Lustre 2.13.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Signed-off-by: Lai Siyao <lai.siyao@whamcloud.com>
Change-Id: Ie76e0fae1fed92e30ebf1a4451895615d5a9c7d2
Reviewed-on: https://review.whamcloud.com/36615
Tested-by: jenkins <devops@whamcloud.com>
4 years agoLUDOC-436 sel: add self-extending layout documentation 61/36561/6
Vitaly Fertman [Wed, 23 Oct 2019 14:58:18 +0000 (10:58 -0400)]
LUDOC-436 sel: add self-extending layout documentation

This patch adds the feature documentation for the
Self-Extending Layout feature added in LU-10070.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Signed-off-by: Vitaly Fertman <c17818@cray.com>
Change-Id: I22e7fab4dfc868374c288b1034ab5cbbb6f58367
Reviewed-on: https://review.whamcloud.com/36561
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 years agoLUDOC-432 pcc: Persistent Client Cache documentation 69/34769/21
Qian Yingjin [Sat, 27 Apr 2019 16:21:35 +0000 (00:21 +0800)]
LUDOC-432 pcc: Persistent Client Cache documentation

Description of and usage information for the Persistent Client
Cache (PCC) feature.

Change-Id: Ifdddeb7b0f82937426b74360658ab3ee6ccfd15d
Signed-off-by: Qian Yingjin <qian@ddn.com>
Reviewed-on: https://review.whamcloud.com/34769
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
4 years agoLUDOC-456 misc: Update the xml ids in BenchmarkingTests.xml 47/36047/2
Joseph Gmitter [Wed, 4 Sep 2019 14:44:27 +0000 (10:44 -0400)]
LUDOC-456 misc: Update the xml ids in BenchmarkingTests.xml

This patch updates the xml:id for each section to be a meaningful
name.  Other pages using those ids were also updated accordingly.

The patch also reformats the code to adhere to the 80 cols limit.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I2c880ef7657e4bd9287a2e2596d8dbdc461f8ebe
Reviewed-on: https://review.whamcloud.com/36047
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 years agoLUDOC-11 config: discourage on-board device cache 68/36168/2
Andreas Dilger [Thu, 12 Sep 2019 09:00:13 +0000 (03:00 -0600)]
LUDOC-11 config: discourage on-board device cache

Recommend against any cache onboard internal HBA devices.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ia34e2fffb9008b360343a27d4cf599ec6f3fe0ea
Reviewed-on: https://review.whamcloud.com/36168
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-455 mdt: Document the mdt readonly parameter 12/36012/5
Joseph Gmitter [Fri, 30 Aug 2019 17:46:50 +0000 (13:46 -0400)]
LUDOC-455 mdt: Document the mdt readonly parameter

This patch adds documentation for the mdt.*.readonly
parameter added in LU-11811.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I53cc58b54e54b0a198141d3944a4970e3f992ce7
Reviewed-on: https://review.whamcloud.com/36012
Reviewed-by: James Nunez <jnunez@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
4 years agoLUDOC-11 misc: Update the xml ids in LustreMaintenance.xml 15/36015/2
Joseph Gmitter [Fri, 30 Aug 2019 18:37:35 +0000 (14:37 -0400)]
LUDOC-11 misc: Update the xml ids in LustreMaintenance.xml

This patch updates the xml:id for each section to be a meaningful
name.  Other pages using those ids were also updated accordingly.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I643500b38f213117ff29aeb8ef1270431672e38a
Reviewed-on: https://review.whamcloud.com/36015
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 years agoLUDOC-11 debug: fix went_back_in_time label 96/35996/2
Andreas Dilger [Thu, 29 Aug 2019 20:00:08 +0000 (14:00 -0600)]
LUDOC-11 debug: fix went_back_in_time label

Move the went_back_in_time label from <title> to <section> so that
it appears in the table of contents.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Id14f19a9d31643d44038446b93edd944db6ca2fc
Reviewed-on: https://review.whamcloud.com/35996
Tested-by: jenkins <devops@whamcloud.com>
4 years agoLUDOC-11 debug: add went_back_in_time label 54/35954/2
Andreas Dilger [Wed, 28 Aug 2019 20:32:35 +0000 (14:32 -0600)]
LUDOC-11 debug: add went_back_in_time label

Add a section label for the "went back in time" error message,
so that it can more easily be referenced by an error message
in the code (formerly a link to a bugzilla ticket).

Improve the description of the problem and reformat the text
to fit within 80 columns.

Signed-off-by: Andreas Dilger <adilger@dilger.ca>
Change-Id: I612cbd090cd695272009754364be53f65c3ebbe5
Reviewed-on: https://review.whamcloud.com/35954
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-450 manual: Fix typo 33/35933/2
Nathaniel Clark [Tue, 27 Aug 2019 14:13:26 +0000 (10:13 -0400)]
LUDOC-450 manual: Fix typo

Fix spelling of significant

Change-Id: I8715103eac85324ae4f65f986264b30d0ad6a5f1
Signed-off-by: Nathaniel Clark <nclark@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/35933
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-11 utilities: remove --count flag 72/35872/2
James Nunez [Thu, 22 Aug 2019 21:47:50 +0000 (15:47 -0600)]
LUDOC-11 utilities: remove --count flag

The 'lfs setstripe' utility used to allow the user to set
the file stripe count using the "--count" option.  This
option was replaced with "--stripe-count".  Make this
update in the manual.

Change-Id: I782f59222ab3b606fec328b0973ab0c39ddb42fe
Signed-off-by: James Nunez <jnunez@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/35872
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-405 quota: add default quota 20/34720/4
Hongchao Zhang [Tue, 9 Jul 2019 17:40:01 +0000 (13:40 -0400)]
LUDOC-405 quota: add default quota

Add documentation for default quota.

Change-Id: I63c3a7ea6d410e22c4d2706c294ea2cde2661fce
Signed-off-by: Hongchao Zhang <hongchao@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/34720
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: James Nunez <jnunez@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-449 misc: Use .png files instead of .svg 58/35558/2
Joseph Gmitter [Thu, 18 Jul 2019 14:26:08 +0000 (10:26 -0400)]
LUDOC-449 misc: Use .png files instead of .svg

Some browsers are not displaying figures in the manual that are
using .svg format.  Since all other images are using .png format,
this patch addresses the few svg images that are in the figures
directory:
figures/File_Write.svg:  duplicate png exists; Unused - removed
figures/HSM_copytool.svg:  Converted to png and removed
figures/MDTs_Failover.svg: duplicate png exists;  Unused - removed
figures/Metadata_File.svg: duplicate png exists;  Unused - removed
figures/TBF_policy.svg:  Converted to png and removed

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I18132933d9bb51a73c084bf42cf2f59355cbef4e
Reviewed-on: https://review.whamcloud.com/35558
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: James Nunez <jnunez@whamcloud.com>
4 years agoLUDOC-448 config: improve limits description 34/35334/4
Andreas Dilger [Thu, 27 Jun 2019 06:59:54 +0000 (00:59 -0600)]
LUDOC-448 config: improve limits description

Improve the description of number of objects per OST to reflect that
this increases with the number of MDTs in the filesystem.  Also
increase the maximum ldiskfs and ZFS filesystem sizes used today.

Increase RAM sizes for MDS and OSS nodes to reflect current usage.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Icbacfc42ca0faa0e5aeba8372f09ca48413ebbe5
Reviewed-on: https://review.whamcloud.com/35334
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
4 years agoLUDOC-11 jobid: cover newer JobID functionality 03/35503/3
Andreas Dilger [Sun, 14 Jul 2019 23:25:52 +0000 (17:25 -0600)]
LUDOC-11 jobid: cover newer JobID functionality

Describe the complex JobID format-string functionality added in
2.12, the per-node JobID added in 2.8, and the per-session JobID
added in 2.13.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I863cac0d63482fd0b3ab4e10d4ba3a6b7f3ebbe5
Reviewed-on: https://review.whamcloud.com/35503
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-11 e2fsck: fix typo in description 08/35508/2
Andreas Dilger [Sun, 14 Jul 2019 23:35:05 +0000 (17:35 -0600)]
LUDOC-11 e2fsck: fix typo in description

Fix minor typo in description of e2fsck times.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Id5dd47d60f34fe5469d887c6640e48be296b1d97
Reviewed-on: https://review.whamcloud.com/35508
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-443 stripe: Add overstriping to manual 24/35324/6
Patrick Farrell [Tue, 25 Jun 2019 21:22:46 +0000 (17:22 -0400)]
LUDOC-443 stripe: Add overstriping to manual

Add overstriping to Lustre manual.

Change-Id: If092cf0276e74400527b740dbb4e5b92a9ab489d
Signed-off-by: Patrick Farrell <pfarrell@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/35324
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
4 years agoLUDOC-382 Tag lfsck_query as lustre 2.9 19/35319/3
Nathaniel Clark [Tue, 25 Jun 2019 15:53:10 +0000 (11:53 -0400)]
LUDOC-382 Tag lfsck_query as lustre 2.9

Set condition on lfsck_query to be Lustre 2.9

Change-Id: I7240344433dfae3f11ca7a010dccec5320bdbcea
Signed-off-by: Nathaniel Clark <nclark@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/35319
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
4 years agoLUDOC-444: Fix typo "completely quite" to quiescent 16/35316/3
Nathaniel Clark [Tue, 25 Jun 2019 14:42:42 +0000 (10:42 -0400)]
LUDOC-444: Fix typo "completely quite" to quiescent

Change "completely quite" to quiescent.

Change-Id: I7ebc2e86ead4499b4dd271f2a9ca3fbd942c4857
Signed-off-by: Nathaniel Clark <nclark@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/35316
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
4 years agoLUDOC-445 fix minor typo 97/35297/2
Nathaniel Clark [Mon, 24 Jun 2019 14:26:47 +0000 (10:26 -0400)]
LUDOC-445 fix minor typo

Fix verb tense.

Change-Id: Id457f986f9f0c8b3c3e6d2590ade53c790357275
Signed-off-by: Nathaniel Clark <nclark@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/35297
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: Jenkins
4 years agoLUDOC-440 lsom: Update examples description 42/35142/2
Joseph Gmitter [Mon, 10 Jun 2019 15:13:00 +0000 (11:13 -0400)]
LUDOC-440 lsom: Update examples description

This patch updates the introductory sentence to LSoM to state that
it can be used in various vender offerings, rather than calling
out specific vendor tools.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I678c4f15ebe6781785cd8e8251cc9858358ef674
Reviewed-on: https://review.whamcloud.com/35142
Tested-by: Jenkins
Reviewed-by: Peter Jones <pjones@whamcloud.com>
5 years agoLUDOC-435 quotas: Update project quotas requirements 16/34516/4
Joseph Gmitter [Wed, 27 Mar 2019 14:08:07 +0000 (10:08 -0400)]
LUDOC-435 quotas: Update project quotas requirements

This patch adds specific notes in the project quota documentation
to explicitly state that a patched server is required and that
patchless servers do not support project quotas.

The patch also removes the quota enabling instructions for Lustre
versions older than 2.4.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: Iaaa602012b244c225605ffe458e63634a7f9e40a
Reviewed-on: https://review.whamcloud.com/34516
Tested-by: Jenkins
Reviewed-by: Wang Shilong <wshilong@ddn.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 years agoLUDOC-431 lnet: doc for asymmetrical route checking 20/34120/3
Sebastien Buisson [Mon, 28 Jan 2019 16:46:49 +0000 (17:46 +0100)]
LUDOC-431 lnet: doc for asymmetrical route checking

This patch adds documentation for the asymmetrical route checking
feature, as implemented by LU-11894.
This doc is added under the Configuring LNet via lnetctl section of
the Configuring Lustre Networking chapter.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: Ia3214528b2bd3ae3e62dc40c06ce1b3ed565e2f3
Reviewed-on: https://review.whamcloud.com/34120
Reviewed-by: Amir Shehata <ashehata@whamcloud.com>
Tested-by: Jenkins
Reviewed-by: Olaf Weber <olaf.weber@hpe.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-434 misc: fix Lustre version in few places 69/34469/2
Sebastien Buisson [Wed, 20 Mar 2019 08:43:05 +0000 (09:43 +0100)]
LUDOC-434 misc: fix Lustre version in few places

Lustre version was not properly set in a few places.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: Ib1b19da67853719627d36e8d9ecb4cd747249739
Reviewed-on: https://review.whamcloud.com/34469
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-429 sec: doc for SELinux status checking 83/34083/7
Sebastien Buisson [Tue, 22 Jan 2019 09:23:28 +0000 (10:23 +0100)]
LUDOC-429 sec: doc for SELinux status checking

This patch adds documentation for the SELinux status checking feature,
as implemented by LU-8955.
This doc is added under the Managing Security in a Lustre File System
section.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I20ef77b14ae6515fa759f4b47a36f6b16b8eb93f
Reviewed-on: https://review.whamcloud.com/34083
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLU-11874 rpc: Update command to persisently set brw_size 93/34193/2
Joseph Gmitter [Wed, 6 Feb 2019 03:34:57 +0000 (22:34 -0500)]
LU-11874 rpc: Update command to persisently set brw_size

This patch updates the large bulk IO (16MB RPC) section
to use set_param -P in persistently setting brw_size
and max_pages_per_rpc as the current conf_param command
does not work with wildcards.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I1cfec45a032b3bc4bf97c14ef6db2a3f0901194f
Reviewed-on: https://review.whamcloud.com/34193
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: James Simmons <uja.ornl@yahoo.com>
Reviewed-by: Stephan Thiell <sthiell@stanford.edu>
5 years agoLUDOC-430 nodemap: doc for 'default' nodemap 89/34089/2
Sebastien Buisson [Tue, 22 Jan 2019 13:20:27 +0000 (14:20 +0100)]
LUDOC-430 nodemap: doc for 'default' nodemap

This patch adds documentation about the 'default' nodemap.
This doc is added under the Mapping UIDs and GIDs with Nodemap
chapter.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I9ae21cc4ae321f804f950a9a05e48f1df91c9dc0
Reviewed-on: https://review.whamcloud.com/34089
Tested-by: Jenkins
Reviewed-by: James Nunez <jnunez@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-11 misc: Update custom styles with 'l2D' for 2.13 96/34096/2
Joseph Gmitter [Wed, 23 Jan 2019 17:42:04 +0000 (12:42 -0500)]
LUDOC-11 misc: Update custom styles with 'l2D' for 2.13

This patch updates the custom style sheets with 'l2D' to
be used for content added in the Lustre 2.13 release.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I288519c5231e9732b99f7b3d5f20c93979225e7c
Reviewed-on: https://review.whamcloud.com/34096
Tested-by: Jenkins
5 years agoLUDOC-428 sec: doc for Lustre isolation 62/34062/3
Sebastien Buisson [Thu, 17 Jan 2019 19:04:38 +0000 (20:04 +0100)]
LUDOC-428 sec: doc for Lustre isolation

This patch adds documentation for the Lustre isolation feature,
by using the 'fileset' parameter on nodemap as submitted for
LU-7846.
This doc is added under the Managing Security in a Lustre File System
section.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I8ed1fe754f65a7aa58a8bbc053f4c5167588b6b0
Reviewed-on: https://review.whamcloud.com/34062
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-402 lsom: Lazy Size on MDT documentation 99/33899/6 2.12.0
James Nunez [Thu, 20 Dec 2018 00:09:35 +0000 (17:09 -0700)]
LUDOC-402 lsom: Lazy Size on MDT documentation

Description of and usage information for the Lazy Size on
MDT feature.

Change-Id: Iad3d1349be871fba7dda1f92931cd8162da44886
Signed-off-by: James Nunez <jnunez@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/33899
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 years agoLUDOC-396 lnet: Add LNet Health Documentation 30/33630/9
Joseph Gmitter [Fri, 9 Nov 2018 15:18:36 +0000 (10:18 -0500)]
LUDOC-396 lnet: Add LNet Health Documentation

This patch adds the feature documentation for LNet Health,
implemented in LU-9120.

The patch also changes tabs to two spaces throughout the file.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I50fcb2ceb7f35e7b423a817bb19087763ba9906a
Reviewed-on: https://review.whamcloud.com/33630
Tested-by: Jenkins
Reviewed-by: Amir Shehata <ashehata@whamcloud.com>
Reviewed-by: Jian Yu <yujian@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 years agoLUDOC-423 misc: Add space between link end and 'repository' 51/33851/2
Joseph Gmitter [Thu, 13 Dec 2018 15:43:58 +0000 (10:43 -0500)]
LUDOC-423 misc: Add space between link end and 'repository'

This patch inserts a space between the link and the word
'repository' in several places.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: Iad039c0f202a2e7036fcad250d3042be51a75ad6
Reviewed-on: https://review.whamcloud.com/33851
Tested-by: Jenkins
5 years agoLUDOC-422 dom: Fix bad DoM link 19/33819/2
Joseph Gmitter [Mon, 10 Dec 2018 18:09:57 +0000 (13:09 -0500)]
LUDOC-422 dom: Fix bad DoM link

This patch fixes a link to the DoM section of the manual.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: Iebc608233b0d35ec011e313ce2ace2a727e2d3ea
Reviewed-on: https://review.whamcloud.com/33819
Tested-by: Jenkins
5 years agoLU-11638 admin: debug space management/missing objects 29/33629/3
Andreas Dilger [Fri, 9 Nov 2018 01:52:31 +0000 (18:52 -0700)]
LU-11638 admin: debug space management/missing objects

Improve troubleshooting section - formatting, improve incorrect
content, update to newer descriptions of how the MDS and OSS
precreate objects, and what they now do if there is a problem.

Improve the description of free space management.  Add example usage
of "open_files" and "lsof" and "lfs df" and "lfs df -i" output.

Improve Jira search description, and update the URL for the
lustre-discuss mailing list.

Fix some cross-references to be more descriptive (lots more could
be done in this area).

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I19dadb826d2fcf5e298f04a4c660c7a8857995c9
Reviewed-on: https://review.whamcloud.com/33629
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: Jenkins
5 years agoLU-8066 misc: replace /proc with "lctl get/set_param" 86/33686/2
Andreas Dilger [Tue, 20 Nov 2018 00:01:47 +0000 (17:01 -0700)]
LU-8066 misc: replace /proc with "lctl get/set_param"

Replace most remaining references to /proc or /sys with equivalent
"lctl get_param" or "lctl set_param" usage.  Discourage direct
use of /proc and /sys values from user scripts.

The description of l_getidentity and associated parameters was
duplicated in multiple places, differentiate the l_getidentity
documentation from the parameter interface for identity_upcall
and identity_info.  Add in descriptions of the identity_expire
and identity_acquire_expire parameters as well.

Add better descriptions of the debug masks, adding in missing
mask values.  Replace use of sysctl for setting and getting
the debug mask with lctl.

Rename a few section labels to give them human-readable names.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I69e27511563a948f2148d9d39480f83a0f67eca6
Reviewed-on: https://review.whamcloud.com/33686
Tested-by: Jenkins
Reviewed-by: James Simmons <uja.ornl@yahoo.com>
Reviewed-by: Ben Evans <bevans@cray.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-395 dne: striped directory migration documentation 50/33550/4
Joseph Gmitter [Thu, 1 Nov 2018 17:50:32 +0000 (13:50 -0400)]
LUDOC-395 dne: striped directory migration documentation

This patch adds documentation for the manual striped
directory supported added by LU-4684.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: Ib04f8e1860dfc8d383bd7910a44965de00b5b9b3
Reviewed-on: https://review.whamcloud.com/33550
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: Jenkins
5 years agoLUDOC-377 misc: cleanup of root squash settings 54/27954/5
Joseph Gmitter [Thu, 6 Jul 2017 17:56:25 +0000 (13:56 -0400)]
LUDOC-377 misc: cleanup of root squash settings

Specify how to retrieve root squash settings using
lctl get_param and also document the set_param option
in addition to the conf_param settings already described.

Adds a note to mention nodemaps as an alternative.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I753296f097b0006b084e8e0e7e11c369df3105ee
Reviewed-on: https://review.whamcloud.com/27954
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 years agoLUDOC-11 misc: Correct version number for condition l2C 13/33613/2
Joseph Gmitter [Wed, 7 Nov 2018 18:13:51 +0000 (13:13 -0500)]
LUDOC-11 misc: Correct version number for condition l2C

The release number for l2C is wrong in the PDF style sheet,
incorrectly having 2.11 instead of 2.12.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: Id7fce45e06d9019f76b9c204ae152ff92ed530a8
Reviewed-on: https://review.whamcloud.com/33613
Tested-by: Jenkins
5 years agoLUDOC-399 dom: improve description of inode limits 62/33562/4
Andreas Dilger [Fri, 2 Nov 2018 22:43:11 +0000 (16:43 -0600)]
LUDOC-399 dom: improve description of inode limits

Fix one typo in the MDT inode size description (current default is
2KB/inode instead of old 4KB/inode) value.

Clarify the description of DoM usage and limits.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I42259e45fdbfb2e8541745ce4f794c2b123ebbe5
Reviewed-on: https://review.whamcloud.com/33562
Tested-by: Jenkins
Reviewed-by: Stephan Thiell <sthiell@stanford.edu>
Reviewed-by: Mike Pershin <mpershin@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLU-8541 ldlm: describe lru_max_age better 06/33406/5
Andreas Dilger [Fri, 19 Oct 2018 22:45:34 +0000 (16:45 -0600)]
LU-8541 ldlm: describe lru_max_age better

Add a descripton of the LDLM lru_max_age parameter, including
the (new in 2.11) ability to specify a suffix of "s" to indicate
the units are in seconds.

Improve the description and formatting of lru_size as well.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I70d1193cb5096dd1139ba85d45ab26566209c2ff
Reviewed-on: https://review.whamcloud.com/33406
Reviewed-by: James Simmons <uja.ornl@yahoo.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: Jenkins
5 years agoLUDOC-11 misc: remove some 'l23' conditions add 'l2C' 78/33378/4
Andreas Dilger [Tue, 16 Oct 2018 04:45:13 +0000 (22:45 -0600)]
LUDOC-11 misc: remove some 'l23' conditions add 'l2C'

Remove many of the old Lustre 2.3 annotations from the manual,
since there are few, if any, users working with such old versions
of Lustre, and they can always reference an older version of the
manual.

Improve content in affected sections of the manual.

Add the 'l2C' condition for the Lustre 2.12 release.  This is needed
to document the new RPC checksum types added to the 2.12 release.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I8d10c6451899a470a12600452bc905ad0b545889
Reviewed-on: https://review.whamcloud.com/33378
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-11 osc: document tunable parameters 75/33375/6
Andreas Dilger [Mon, 15 Oct 2018 23:46:17 +0000 (17:46 -0600)]
LUDOC-11 osc: document tunable parameters

Add or improve the documentation for the OSC RPC parameters:
  osc.*.{checksums,checksum_type,max_dirty_mb,max_pages_per_rpc,
         max_rpcs_in_flight}

Add documetation for the llite readahead parameters:
  llite.*.{max_read_ahead_mb,max_read_ahead_per_file_mb,
           max_read_ahead_whole_mb}

Clean up the existing parameter sections to be more consistent.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ieaf09e175456b7a60d3fbd3a3ec5d020fb4d98e3
Reviewed-on: https://review.whamcloud.com/33375
Tested-by: Jenkins
5 years agoLUDOC-11 lfs: use a more realistic PFL layout 67/33367/2
Andreas Dilger [Sun, 14 Oct 2018 19:24:44 +0000 (13:24 -0600)]
LUDOC-11 lfs: use a more realistic PFL layout

Don't use an example for "lfs setstripe" that explicitly sets an
index of 0, since this will cause an imbalance in the OST usage,
and is not a good example for users to follow.

Create the PFL layout with a more typical configuration.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ic7ca6d1b25760d1292c7ac2cfb3c11497c2efa52
Reviewed-on: https://review.whamcloud.com/33367
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-414 utils: document the lfs data_version command 00/33200/2
Nikitas Angelinas [Wed, 19 Sep 2018 03:28:28 +0000 (20:28 -0700)]
LUDOC-414 utils: document the lfs data_version command

Update the lfs utility synopsis and table with a description of the
lfs data_version command.

Signed-off-by: Nikitas Angelinas <nangelinas@cray.com>
Change-Id: Id6c474dfdd8d8b5884b220768fbf59294a2efd86
Reviewed-on: https://review.whamcloud.com/33200
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-412 misc: Update byte prefixes to use IEC 75/33075/3
Joseph Gmitter [Fri, 24 Aug 2018 21:01:02 +0000 (17:01 -0400)]
LUDOC-412 misc: Update byte prefixes to use IEC

This patch fixes binary prefixes used when referencing
storage size to the IEC definitions:
1024    Ki  kibi
1024^2  Mi  mebi
1024^3  Gi  gibi
1024^4  Ti  tebi
1024^5  Pi  pebi
1024^6  Ei  exbi
1024^7  Zi  zebi
1024^8  Yi  yobi

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I3fac1dc28e96c34d286f9b14e8cd2b46acb87f53
Reviewed-on: https://review.whamcloud.com/33075
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 years agoLUDOC-11 config: Improve writeconf description 86/32886/4
Andreas Dilger [Wed, 25 Jul 2018 21:10:49 +0000 (15:10 -0600)]
LUDOC-11 config: Improve writeconf description

Improve the description of the "tunefs.lustre --writeconf" command.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I96df1d566b83b118ef58ea17cffd1b6fad12fc24
Reviewed-on: https://review.whamcloud.com/32886
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
Tested-by: Jenkins
5 years agoLUDOC-249 migrate: Improve lfs_migrate documentation 82/32882/3
Andreas Dilger [Thu, 26 Jul 2018 01:47:51 +0000 (19:47 -0600)]
LUDOC-249 migrate: Improve lfs_migrate documentation

List the new method of max_create_count=0 for disabling the MDS to
create new objects on OSTs during migration.  This avoids issues
when using "deactivate" where the OST objects were not being deleted
as objects are being moved off of the OST.

Separate the directory migration from the data migration more clearly.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ic8fa99271d8d543ec93ddac3917c8a7cad49973b
Reviewed-on: https://review.whamcloud.com/32882
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLU-11181 mdt: include DoM in inode ratio discussion 87/32887/3
Andreas Dilger [Thu, 26 Jul 2018 18:56:21 +0000 (12:56 -0600)]
LU-11181 mdt: include DoM in inode ratio discussion

Reference Data-on-MDT in the discussion about ldiskfs inode ratios.
We default to 2KB/inode on the MDT, but with DoM we may want to
change this to 64KB/inode or higher, depending on the average size
of small files stored on the MDT.

Also mention that "lfs df -i" and "df -i" will limit the reported
available inode count to the total number of available inodes on
the OSTs.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I53c4d35129ffb5c7732771a6ddab3aa723758872
Reviewed-on: https://review.whamcloud.com/32887
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-371 config: Add lctl 'clear_conf' documentation. 83/26083/4
Arshad Hussain [Sun, 19 Mar 2017 15:30:40 +0000 (21:00 +0530)]
LUDOC-371 config: Add lctl 'clear_conf' documentation.

The new lctl command "clear_conf" is added to allow
administartors to clear configuration files by removing
SKIP records. The old configuration files are backed up.

Signed-off-by: Arshad Hussain <arshad.hussain@seagate.com>
Signed-off-by: Vladimir Saveliev <vladimir.saveliev@seagate.com>
Change-Id: Iacc52127b0b93e736430cc13d4c9c852eac8dc2d
Seagate-bug-id: MRP-2091
Reviewed-on: https://review.whamcloud.com/26083
Tested-by: Jenkins
Reviewed-by: Arshad Hussain <arshad.super@gmail.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
5 years agoLUDOC-11 misc: URL cleanup 29/32729/6
Joseph Gmitter [Mon, 25 Jun 2018 13:35:16 +0000 (09:35 -0400)]
LUDOC-11 misc: URL cleanup

This patch cleans up all links from hpdd.intel.com to
whamcloud.com.  The patch also changes the URL for
the 'make push' target of the Makfile for those using
'make push' to push changes.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I7560b6c6397897a85ce731642709d80cd1cde20c
Reviewed-on: https://review.whamcloud.com/32729
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 years agoLUDOC-379: Ladvise Lockahead 36/32436/2 2.11.0
Patrick Farrell [Wed, 16 May 2018 15:09:45 +0000 (10:09 -0500)]
LUDOC-379: Ladvise Lockahead

Correct errors in lockahead documentation.

Change-Id: I833b782c437d5429bca365207d05df21d625eb26
Signed-off-by: Patrick Farrell <paf@cray.com>
Reviewed-on: https://review.whamcloud.com/32436
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
5 years agoLUDOC-379: Ladvise Lockahead 31/32331/4
Patrick Farrell [Wed, 16 May 2018 10:50:38 +0000 (05:50 -0500)]
LUDOC-379: Ladvise Lockahead

Add documentation for lockahead feature.

Change-Id: I40225ef8c50f9f44e41d3ddbe4d700a9b02b1994
Signed-off-by: Patrick Farrell <paf@cray.com>
Reviewed-on: https://review.whamcloud.com/32331
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
5 years agoLUDOC-403 acl: Update link for POSIX ACL paper 12/32312/2
Joseph Gmitter [Mon, 7 May 2018 18:06:09 +0000 (14:06 -0400)]
LUDOC-403 acl: Update link for POSIX ACL paper

This patch updates the link to the POSIX ACL paper by SuSe Labs.

The patch also refactors the source file to adhere to coding
standards, namely the 80 col limit and appropriate section names.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I6898eb389fb22e545ec768d0697681cfb36a7c73
Reviewed-on: https://review.whamcloud.com/32312
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
5 years agoLUDOC-385 dom: fix figure to match description 63/32263/2
Andreas Dilger [Wed, 2 May 2018 23:31:09 +0000 (17:31 -0600)]
LUDOC-385 dom: fix figure to match description

The figure describes 4MB OST stripe_size, but the diagram shows five
blocks within the "4MB" range on the OSTs, with the first 1MB block
being (correctly) sparse because of the DoM component.  Fix this to
show the proper 4MB range on the OST objects.

Also, show the MB offset of each OST stripe as "4, 8, 4N" rather than
"2, 3, N" to better explain how Lustre striping works.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I1b9487c4b19cecbdc738744381166968373ebbe5
Reviewed-on: https://review.whamcloud.com/32263
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
5 years agoLUDOC-328 tbf: add UID/GID based policy to NRS-TBF section 69/31769/5
Emoly Liu [Tue, 10 Apr 2018 06:19:39 +0000 (14:19 +0800)]
LUDOC-328 tbf: add UID/GID based policy to NRS-TBF section

Update NRS-TBF policy section to reflect UID/GID based TBF
policy:
- format: uid={uid} or gid={gid} or uid={uid}&gid={gid}
- Lustre-commit: e0cdde123c14729a340cf937cf9580be7c9dd9c1
- Lustre-change: http://review.whamcloud.com/27608

Change-Id: I49302f35bb6fae3de9410a8b84940aa8df7b0ca7
Signed-off-by: Emoly Liu <emoly.liu@intel.com>
Reviewed-on: https://review.whamcloud.com/31769
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-399 dom: Fix example and clarify 64KB alignment 69/31969/3
Joseph Gmitter [Thu, 12 Apr 2018 04:20:44 +0000 (00:20 -0400)]
LUDOC-399 dom: Fix example and clarify 64KB alignment

This patch fixes an example that incorrectly used 32KB
instead of 64KB as the dom component size.

The patch also clarifies the LFS limits for the DoM component size to
mention that the 64KB restriction is due to the minimum Lustre
stripe size.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I32c2b2f46743010387196560ead7f0f880f1dcf4
Reviewed-on: https://review.whamcloud.com/31969
Tested-by: Jenkins
Reviewed-by: Mike Pershin <mike.pershin@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
6 years agoLUDOC-11 misc: minor tweak to NFS export doc 34/31934/2
Andreas Dilger [Tue, 10 Apr 2018 17:44:51 +0000 (11:44 -0600)]
LUDOC-11 misc: minor tweak to NFS export doc

Mention that Lustre can also be exported by NFS Ganesha.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I4e22ac1223409780293dde641f982e6fd5f36f76
Reviewed-on: https://review.whamcloud.com/31934
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-161 zfs: Backup/Restore of ZFS backend filesystems 72/30172/14
Joseph Gmitter [Mon, 20 Nov 2017 16:13:09 +0000 (11:13 -0500)]
LUDOC-161 zfs: Backup/Restore of ZFS backend filesystems

This patch documents how to backup/restore ZFS backend
filesystems at the file system level using 'tar'.  The
existing section on backing up an OST or MDT at the
filesystem level was updated to capture zfs.  Also, a
section has been added to discuss migrating between ZFS
and ldiskfs backends using the filesystem level
backup/restore process.

This work has landed to master under LU-7585.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I20619e42c7313657599788a23caf4e867f714db6
Reviewed-on: https://review.whamcloud.com/30172
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Tested-by: Jenkins
6 years agoLUDOC-368 lnet: Dynamic Discovery documentation 35/31735/3
Joseph Gmitter [Thu, 22 Mar 2018 20:15:23 +0000 (16:15 -0400)]
LUDOC-368 lnet:  Dynamic Discovery documentation

This patch adds documentation for the dynamic peer discovery
feature added in Lustre 2.11.0 by LU-9480.

Documentation is added to the LNet configuration section of the
manual.

Also, this patch does some refactoring of the affected
ConfiguringLNet.xml content file to use descriptive XML
ID tags instead of random integer strings as well as
fixing numerous 80 column length style issues in the
file.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: Iba9644f5777f0930bac7d0583072e651d04a222a
Reviewed-on: https://review.whamcloud.com/31735
Reviewed-by: Amir Shehata <amir.shehata@intel.com>
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
6 years agoLUDOC-384 flr: File Level Redundancy (FLR) Documenation 57/31657/7
Joe Gmitter [Thu, 15 Mar 2018 22:52:12 +0000 (15:52 -0700)]
LUDOC-384 flr: File Level Redundancy (FLR) Documenation

This patch creates the initial documentation for the File
Level Redundancy (FLR) feature introduced by LU-9771 in the
Lustre 2.11.0 release.

The FLR feature allows for storing of the same data on
multiple OSTs for a variety of possible benefits and use
cases.

Signed-off-by: Joe Gmitter <joseph.gmitter@intel.com>
Signed-off-by: Jian Yu <jian.yu@intel.com>
Change-Id: I4c4ccb9e5c90144f4686e3853d56ebee459cee70
Reviewed-on: https://review.whamcloud.com/31657
Tested-by: Jenkins
Reviewed-by: Jinshan Xiong <jinshan.xiong@gmail.com>
Reviewed-by: James Nunez <james.a.nunez@intel.com>
6 years agoLUDOC-328 tbf: add HTC strategy to NRS-TBF section 28/31628/4
Emoly Liu [Fri, 16 Mar 2018 01:12:05 +0000 (09:12 +0800)]
LUDOC-328 tbf: add HTC strategy to NRS-TBF section

Update NRS-TBF policy section to reflect Hard Token Compensation
(HTC) strategy:
- meet realtime requirement with a new rule option "realtime=1"
- Lustre-commit: d11fa2c279593634cf6c4196b413a6d285b24e10
- Lustre-change: http://review.whamcloud.com/26087

Change-Id: I07ece7bd3022351a7f71d1ba9cfd2193d8261ccd
Signed-off-by: Emoly Liu <emoly.liu@intel.com>
Reviewed-on: https://review.whamcloud.com/31628
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-391 audit: doc for Lustre Audit with Changelogs 21/30821/5
Sebastien Buisson [Wed, 10 Jan 2018 13:41:34 +0000 (14:41 +0100)]
LUDOC-391 audit: doc for Lustre Audit with Changelogs

This patch adds the documentation for the Lustre Audit with Changelogs
feature created in LU-9727.
This doc is added under the Lustre Monitoring section, along with
the Changelogs documentation.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: Ief72f277f148d226b462f18a06efe59e832fc065
Reviewed-on: https://review.whamcloud.com/30821
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-385 dom: Initial Data on MDT (DoM) Documentation 48/30148/7
Joseph Gmitter [Fri, 17 Nov 2017 13:29:56 +0000 (08:29 -0500)]
LUDOC-385 dom: Initial Data on MDT (DoM) Documentation

This patch creates the initial Data on MDT (DoM)
documenation for the feature work added in LU-3285.
A new section in the manual is created specifally for DoM.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I79baeb5639e3399f4f5ad8837e48c8dac78c00fd
Reviewed-on: https://review.whamcloud.com/30148
Tested-by: Jenkins
Reviewed-by: James Nunez <james.a.nunez@intel.com>
6 years agoLUDOC-11 misc: update filesystem limits 06/30806/3
Andreas Dilger [Tue, 24 Oct 2017 05:04:34 +0000 (23:04 -0600)]
LUDOC-11 misc: update filesystem limits

Move Lustre filesystem limits out of "ldiskfs formatting options"
into its own section, since it also reflects limits for ZFS targets.
This change has a large amount of indent churn, but minimal content.

Other changes include:
- ldiskfs MDT journals can be up to 4GB by default
- ldiskfs OST filesystems can be at least 256TiB in size
- correct OST inode ratio table max inode count for 256TiB size
- correct OST inode ratio table to be "under 10GiB" instead of over
- increase maximum filesystem size to be "at least 1EB" for ldikfs

Clean up formatting in this section to wrap at 80 columns.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: Iae39e103e5b4d721ff987fb8c1d0b6294f07782d
Reviewed-on: https://review.whamcloud.com/30806
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-305 maintenance: handling full/failed OSTs 64/30864/5
Andreas Dilger [Sat, 13 Jan 2018 23:53:18 +0000 (16:53 -0700)]
LUDOC-305 maintenance: handling full/failed OSTs

Improve documentation related to handling full or failing OSTs.

Describe the "osp.*.max_create_count" parameter, and using it to
disable object creation on an OST, rather than deactivating the
OST completely.

Differentiate between disabling an OST for space balancing reasons
and a failing OST.  Add references to QOS space balancing and also
degraded mode for OSTs.

Use "lctl set_param osp.*.active=0" to deactivate the OST rather
than "lctl deactivate", since that is easier for users and they
are functionally equivalent.

Describe the use of "mkfs.lustre --replace" to replace failed OSTs,
rather than the need to backup/restore/binary edit OST config files.

Use proper names for affected sections and cross references, so
that the auto-generated URLs for these sections are useful.

Line-wrap modified sections of text.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I4f253966f463ca1a83d0c7c4efcb22dfc02b6e3f
Reviewed-on: https://review.whamcloud.com/30864
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-328 tbf: update TBF section to reflect the new changes 05/30705/6
Emoly Liu [Wed, 10 Jan 2018 05:58:15 +0000 (13:58 +0800)]
LUDOC-328 tbf: update TBF section to reflect the new changes

Update NRS-TBF policy section to reflect the following changes:
- change TBF command format, e.g. rate=<rate>, nid={nid},…
  - Lustre-commit: d09237044382361b289c01a9f7412818b3599e79
  - Lustre-change: http://review.whamcloud.com/19499
- specify ordering of TBF policy rules, e.g. rank=<rank>
  - Lustre-commit: aa14b0b9a1521b3deb26a07eb8f7bb28ce793001
  - Lustre-change: http://review.whamcloud.com/19476
- add opcode based TBF policy, e.g. opcode={opcode}
  - Lustre-commit: d2c403363f65337166dc745b58d0a4529a534b84
  - Lustre-change: http://review.whamcloud.com/11918
- support complex TBF rules, e.g. opcode={}&jobid={},nid={}
  - Lustre-commit: 949bc00ad1ec0786940bd00ba53479d88c23ea14
  - Lustre-change: http://review.whamcloud.com/17345
- support wildcard in JobID TBF rule, e.g. jobid={prog*.10*}
  - Lustre-commit: d5b5a07a8b07ab51a2215de593cb8bfce7e589d0
  - Lustre-change: http://review.whamcloud.com/24523

Change-Id: Iac8f735374cedf7065fdd445571fedcc01554d4c
Signed-off-by: Emoly Liu <emoly.liu@intel.com>
Reviewed-on: https://review.whamcloud.com/30705
Tested-by: Jenkins
Reviewed-by: Yingjin Qian <qian@ddn.com>
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLU-10047 backup: add --xattrs-include="trusted.*" 51/30251/3
Andreas Dilger [Mon, 27 Nov 2017 00:41:13 +0000 (17:41 -0700)]
LU-10047 backup: add --xattrs-include="trusted.*"

For RHEL7 and GNU tar 1.27 the "--xattrs-include="trusted.*" argument
is required, otherwise none of the xattrs will be restored.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I0e0db7782fccbaf91cbf39dd4c8d030582e7786a
Reviewed-on: https://review.whamcloud.com/30251
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-392 lnet: clarify lnetctl usage 23/29323/2
Amir Shehata [Wed, 4 Oct 2017 22:33:45 +0000 (15:33 -0700)]
LUDOC-392 lnet: clarify lnetctl usage

When using lnetctl to manage an LNet configured outside of
lnetctl, lnetctl lnet configure must be called first before
lnetctl can add or remove networks and interfaces.

Signed-off-by: Amir Shehata <amir.shehata@intel.com>
Change-Id: Ie61dad46bb40353701e19a28dc96c15d80a7afb7
Reviewed-on: https://review.whamcloud.com/29323
Tested-by: Jenkins
Reviewed-by: Sonia Sharma <sonia.sharma@intel.com>
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-390 misc: Document shutdown procedure 02/28902/4
Joseph Gmitter [Thu, 7 Sep 2017 20:01:39 +0000 (16:01 -0400)]
LUDOC-390 misc: Document shutdown procedure

This patch creates a short section to document how to stop
the entire Lustre filesystem.  Currently the manual only details
the startup procedure and how to shut down a specific target
by using umount /mnt/mnt_point.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I1fd9123177433a539cab72f1edc165bcdf3e39f4
Reviewed-on: https://review.whamcloud.com/28902
Tested-by: Jenkins
Reviewed-by: Saurabh Tandan <saurabh.tandan@intel.com>
Reviewed-by: James Nunez <james.a.nunez@intel.com>
6 years agoLUDOC-372 build: Fix a condition issue with the PDF build 83/28583/3
Joseph Gmitter [Thu, 17 Aug 2017 15:12:28 +0000 (11:12 -0400)]
LUDOC-372 build: Fix a condition issue with the PDF build

This patch fixes an issue with the building of the PDF
version of the manual where sections designated to use
an "Introduced in Lustre 2.X" frame were not being
processed and the entire section heading was missing.

The technical issue that was occuring during the PDF
processing is that the template in the PDF stylesheet,
style/customstyle.fo, was dropping the content passed to it.
This did not effect non-section tags, however, for section tags,
this content included the section number and heading.  It is
resolved by capturing the content passed into the condition
template and relaying it onto the textdecoration_1 template
which makes the calls to render the decoration of the text.
This fix matches what the html template uses for rendering.

This patch does not affect the build for any other
versions of the manual as a different stylesheet is used
for each format.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I7ccae3e6f74ea2501f84ea224b20a8bb56b85894
Reviewed-on: https://review.whamcloud.com/28583
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Tested-by: Jenkins
6 years agoLUDOC-388 stats: Correct extents_stats information 50/28450/3
James Nunez [Wed, 9 Aug 2017 19:57:58 +0000 (13:57 -0600)]
LUDOC-388 stats: Correct extents_stats information

The Reference section of the Lustre Manual needs
minor corrections in the sections about collecting
statistics. These corrections include setting the
extents_stats parameter to 1 to reset statistics
and specifying what can be used to activate collection
of statistics.

Change-Id: I4b3f91476427f6be581634c383daebd8b2c8acda
Signed-off-by: James Nunez <james.a.nunez@intel.com>
Reviewed-on: https://review.whamcloud.com/28450
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-387 rpc: fix typo in max_rpcs_in_flight 27/28327/2
Joseph Gmitter [Wed, 2 Aug 2017 18:01:18 +0000 (14:01 -0400)]
LUDOC-387 rpc: fix typo in max_rpcs_in_flight

This is a trivial patch that fixes the following two
lctl set_param examples:
client$ lctl set_param mdc.*.max_rpcs_in_flight=16
client$ lctl set_param mdc.*.max_mod_rpcs_in_flight=12

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: If0ac0b1a99be8f13a702d1f7f2a8e28b48ea223b
Reviewed-on: https://review.whamcloud.com/28327
Tested-by: Jenkins
6 years agoLUDOC-370 snapshots: add snapshot feature documentation 85/26985/7 2.10.0
Joseph Gmitter [Mon, 8 May 2017 14:46:02 +0000 (10:46 -0400)]
LUDOC-370 snapshots: add snapshot feature documentation

Initial ZFS snapshot feature documentation.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: I72222ce9d684cf543a079a1b8f698ff97d2ef0f0
Reviewed-on: https://review.whamcloud.com/26985
Reviewed-by: Fan Yong <fan.yong@intel.com>
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
6 years agoLUDOC-367 lnet: Initial MR Documentation 87/27687/9
Joseph Gmitter [Fri, 16 Jun 2017 15:23:04 +0000 (11:23 -0400)]
LUDOC-367 lnet: Initial MR Documentation

Initial documention for the LNet multi-rail feature added
in LU-7734.

lnetctl commands have been updated in section 9 where
appropriate to reflect MR changes and syntax.

A new section has also been created for current and
future multi-rail specific examples and content.

Signed-off-by: Joseph Gmitter <joseph.gmitter@intel.com>
Change-Id: Ie1d5a174f3fd02e39e011d349828654dfa8d540c
Reviewed-on: https://review.whamcloud.com/27687
Tested-by: Jenkins
Reviewed-by: Sonia Sharma <sonia.sharma@intel.com>
Reviewed-by: Amir Shehata <amir.shehata@intel.com>
6 years agoLUDOC-202 quota: add project quota support 79/26979/9
Wang Shilong [Mon, 8 May 2017 05:46:41 +0000 (13:46 +0800)]
LUDOC-202 quota: add project quota support

LU-4017 implments project quota for Lustre 2.10,
update Lustre manual to reflect changes.

Signed-off-by: Wang Shilong <wshilong@ddn.com>
Change-Id: Ica6f907da2d8c5dbf83a13d77090dd2f525b5e40
Reviewed-on: https://review.whamcloud.com/26979
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Tested-by: Jenkins
Reviewed-by: Fan Yong <fan.yong@intel.com>
6 years agoLUDOC-366 nrs: Add delay policy document 01/27501/6
Chris Horn [Tue, 6 Jun 2017 16:09:21 +0000 (11:09 -0500)]
LUDOC-366 nrs: Add delay policy document

Delay is a new policy for NRS. This patch adds documentation on how
to use it.

Signed-off-by: Chris Horn <hornc@cray.com>
Change-Id: Ibf1d74a9aea0893e07dc4cbe834d54804d214b3c
Reviewed-on: https://review.whamcloud.com/27501
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
6 years agoLUDOC-375 lnet: Add ko2iblnd tuning parameters 74/27474/8
Doug Oucharek [Wed, 7 Jun 2017 00:09:36 +0000 (17:09 -0700)]
LUDOC-375 lnet: Add ko2iblnd tuning parameters

The Jira ticket calls for the new parameter wrq_sge to be
added to the manual.  I'm using this as an opportunity to
add a table with all the ko2iblnd tuning parameters.

Signed-off-by: Doug Oucharek <doug.s.oucharek@intel.com>
Change-Id: Ic01da4ccdfaafb7662dd9dc498560a512957aabc
Reviewed-on: https://review.whamcloud.com/27474
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 years agoLUDOC-326 openib: Remove references to old IB LNDs 78/27378/3
Cory Spitz [Thu, 1 Jun 2017 15:34:34 +0000 (10:34 -0500)]
LUDOC-326 openib: Remove references to old IB LNDs

All of the old IB/IB-like LNDs were removed long ago.  References
to "cib", "openib", "iib", and "vib" should all be removed from
the manual.

Signed-off-by: Cory Spitz <spitzcor@cray.com>
Change-Id: I62ba2d19f4e462355bb91d84037fe801eff8a6c4
Reviewed-on: https://review.whamcloud.com/27378
Tested-by: Jenkins
Reviewed-by: Joseph Gmitter <joseph.gmitter@intel.com>
6 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>
6 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>
6 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>
6 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>
6 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
6 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>