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

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>

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

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>

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

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>

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

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>

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

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>

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>

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>

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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

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>

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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

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>

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>

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>

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>

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>

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>

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

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>

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>

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>

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>

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>

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>

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

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

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

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>

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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

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>

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

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>

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>

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

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>

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>

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>

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

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

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

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

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

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

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

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>