Whamcloud - gitweb
doc/manual.git
10 years agoLUDOC-173 trademarks: Completed second pass of Intel trademark compliance review. 24/8124/4 2.5.0
Linda Bebernes [Thu, 31 Oct 2013 19:45:56 +0000 (12:45 -0700)]
LUDOC-173 trademarks:  Completed second pass of Intel trademark compliance review.

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

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

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I8031b9a6c52ac42e1d31d0bb5f8a9624bc96adea
Reviewed-on: http://review.whamcloud.com/8124
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-50 LNET: Added section about LNET Peer Health to Chapter 26 "Lustre Tuning" 27/8127/2
Linda Bebernes [Thu, 31 Oct 2013 21:14:30 +0000 (14:14 -0700)]
LUDOC-50 LNET: Added section about LNET Peer Health to Chapter 26 "Lustre Tuning"

Added section 26.3.7 "LNET Peer Health". Added ID to Section 36.2.2 describing
keepalive information so that I could create a link from LNET peer health
content to that information.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: If1cd51125df8c01424b1a11bbf1aeff5959b1f40
Reviewed-on: http://review.whamcloud.com/8127
Tested-by: Hudson
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-69 failover: Updated failover documentation globally across 6 chapters. 58/8058/7
Linda Bebernes [Thu, 31 Oct 2013 03:04:02 +0000 (20:04 -0700)]
LUDOC-69 failover: Updated failover documentation globally across 6 chapters.

Ch 3 Intro to Failover - edits for clarity, fixed missing figure
Ch 11 Configuring Lustre Failover - major rewrite to update and
clarify content
Ch 13 Lustre Operations - edited failover-related entries for clarity,
updated example from Elan to Ethernet, added cross-ref to Ch 11
Ch 14 Lustre Maintenance  - edited failover-related entries for clarity,
added crossref to Ch 11
Ch 20 MMP - changed chapter name from "Managing Failover" to
"Lustre Failover and Multi-Mount Protection", minor edits, added xref to Ch 11
Ch 36 - updated --servicenode and --failnode descriptons for mkfs.lustre
and tunefs.lustre
Changes to address Intel trademark compliance have also been made in these
chapters.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I6f9b9f0b84d01e4d590c290dbc30738f5a0688cd
Reviewed-on: http://review.whamcloud.com/8058
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-173 trademarks: Completed second pass of Intel trademark compliance review. 05/8105/3
Richard Henwood [Wed, 30 Oct 2013 20:52:26 +0000 (15:52 -0500)]
LUDOC-173 trademarks:  Completed second pass of Intel trademark compliance review.

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

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I1f3ddb7ba4adb731cb3ba8ad9fc8d91d315549a9
Reviewed-on: http://review.whamcloud.com/8105
Tested-by: Hudson
10 years agoLUDOC-121 LNET: Added details about LNET credits tunable 96/7996/4
Richard Henwood [Mon, 28 Oct 2013 18:18:06 +0000 (13:18 -0500)]
LUDOC-121 LNET: Added details about LNET credits tunable

Updated Section 25.3.4 "Network Interface Credits" to describe why
someone might want to adjust the number of credits and added a note
about making the credit tunable consistent across all systems when
o2iblnd driver is used.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I271de47c9c518e5f02284512f0b823403f921685
Reviewed-on: http://review.whamcloud.com/7996
Tested-by: Hudson
10 years agoLUDOC-94 hsm: documentation for HSM feature. 52/7852/10
Richard Henwood [Wed, 2 Oct 2013 19:58:23 +0000 (14:58 -0500)]
LUDOC-94 hsm: documentation for HSM feature.

This change includes the operating instructions for HSM. Available
since lustre software version 2.5.

Fixed bug in style used to generate fo/PDF files.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Idf49b8e16910c09edd8ed962d192b142119ad42e
Reviewed-on: http://review.whamcloud.com/7852
Tested-by: Hudson
Reviewed-by: John L. Hammond <john.hammond@intel.com>
10 years agoLUDOC-114 lnet: LNET/LND credits and flow control 55/7555/5
Linda Bebernes [Mon, 21 Oct 2013 17:08:33 +0000 (10:08 -0700)]
LUDOC-114 lnet: LNET/LND credits and flow control

Summary: Even though the bug is about credits and flow control,
this commit is more about giving a better understanding of
lustre networking and lnet routing. This main topic has also
been touched upon in two files. Big changes to two files and
a small addition to LustreTuning.xml. I have tried to improve
on the  definition of what a lustre network is and how the
phrase-lnet is used differently in different contexts. If time
had permitted, I would have made an illustration for lnet
routing, but I couldn't. It would help to introduce one there
and one in the UnderstandingLustreNetworking.xml file to
illustrate the point that lustre networks are different from
real networks.

Signed-off-by: Avadhani J <avadhanijonnavithula@gmail.com>
Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I7592c5b35f61102050112e1b0e6ac4e042371b2b
Reviewed-on: http://review.whamcloud.com/7555
Tested-by: Hudson
Reviewed-by: Amir Shehata <amir.shehata@intel.com>
10 years agoLUDOC-27 mkfs.lustre: Updated descriptions for filesystem and index options. 47/7947/3
Linda Bebernes [Mon, 14 Oct 2013 21:09:45 +0000 (14:09 -0700)]
LUDOC-27 mkfs.lustre: Updated descriptions for filesystem and index options.

Completed LUDOC-27 "documenting new mkfs.lustre features"
subtask to LUDOC-3) per instructions from Zhiqi. Edited descriptions
for the "filesystem" and "index" options to the mkfs.lustre command
in Section 36.14.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I04e24a3f407e535d740daa1e2963168f9f30dacd
Reviewed-on: http://review.whamcloud.com/7947
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-173 trademarks: Completed first pass of Intel trademark compliance review. 67/8067/3
Linda Bebernes [Thu, 24 Oct 2013 21:04:21 +0000 (14:04 -0700)]
LUDOC-173 trademarks:  Completed first pass of Intel trademark compliance review.

All Intel and third party trademarks now in compliance except Lustre (which
will be addressed in second pass). Occurrences of lustre.org and whamcloud
replaced. Serna statements removed. Spelling of file system corrected where
needed. Misspellings of Lustre fixed.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I020f68b6679ff1ca8db62f06e470642e99cb018c
Reviewed-on: http://review.whamcloud.com/8067
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-50 LNET: Documented small and tiny router buffers in Chapter 25. 97/7997/3
Linda Bebernes [Thu, 17 Oct 2013 21:38:39 +0000 (14:38 -0700)]
LUDOC-50 LNET: Documented small and tiny router buffers in Chapter 25.

Added more details about buffer pools to Section 25.3.5 "Router Buffers".

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I6592771e8a83939e2d4e61228c26de24f7273e39
Reviewed-on: http://review.whamcloud.com/7997
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-57 installation: Added section describing installing Lustre with OFED 05/7805/3
Linda Bebernes [Tue, 1 Oct 2013 23:06:36 +0000 (16:06 -0700)]
LUDOC-57 installation: Added section describing installing Lustre with OFED

Added section to Chapter 29 "Installing from Source, that describes
a procedure for installing Lustre with a third-party network stack
using OFED as an example.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Idd6fce25e7f72e9bf2e6f29b4e7ce51791a5b735
Reviewed-on: http://review.whamcloud.com/7805
Tested-by: Hudson
Reviewed-by: Minh Diep <minh.diep@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-11 xrefs: Added wide striping xrefs to Ch 16, Glossary. 45/7945/8
Linda Bebernes [Mon, 21 Oct 2013 16:55:20 +0000 (09:55 -0700)]
LUDOC-11 xrefs: Added wide striping xrefs to Ch 16, Glossary.

Added links pointing to 18.6 "Lustre Striping Internals" to Chapter 16 "Upgrading
Lustre" and to the _wide striping_ entry in the Glossary. Removed an empty
index entry from Chapter 16.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I898cd6a933b618f8eb4850e6701766f4d1812f1b
Reviewed-on: http://review.whamcloud.com/7945
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-115 monitoring: Added lltop, tacc-stats, and xltop to list of monitoring tools. 44/7944/3
Linda Bebernes [Mon, 14 Oct 2013 18:46:49 +0000 (11:46 -0700)]
LUDOC-115 monitoring: Added lltop, tacc-stats, and xltop to list of monitoring tools.

Added the tools listed above to Chapter 12 "Lustre Monitoring in
Section 12.5 "Other Monitoring Options" with URLs.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ie8e64bd8ce153820f57f61c51961ee2bd8687616
Reviewed-on: http://review.whamcloud.com/7944
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-152 Bug: Added missing links to chapter sections in Chapter 14. 06/7906/3
Linda Bebernes [Wed, 9 Oct 2013 17:48:21 +0000 (10:48 -0700)]
LUDOC-152 Bug: Added missing links to chapter sections in Chapter 14.

Added links to TOC section at head of chapter for Sections 14.8.3 - 14.8.6.
This also fixed missing entries in TOC in PDF version of manual.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ic7e0c1e76ca8500d3b757bedc8bbddc097fa341f
Reviewed-on: http://review.whamcloud.com/7906
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-54 fix: fixed link. 20/7920/3
Richard Henwood [Thu, 10 Oct 2013 20:38:08 +0000 (15:38 -0500)]
LUDOC-54 fix: fixed link.

Now uses the correct xref, rather than link tag. Also added a
conditional for some text I noticed.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I431a3fe2a092a86cd26a8f8cb6f2a678a5149b3a
Reviewed-on: http://review.whamcloud.com/7920
Tested-by: Hudson
10 years agoLUDOC-188 graphic_files: Added two svg graphics to build 05/7905/2
Linda Bebernes [Wed, 9 Oct 2013 17:10:01 +0000 (10:10 -0700)]
LUDOC-188 graphic_files:  Added two svg graphics to build

Two figures were updated in Chapter 1 in an earlier ticket. Only the
.png files for the figures were included in the build at that time.
This commit/push adds the .svg files for the graphics to the build.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ifd42ef43e5b031b55f12c9d23a492f5e061841c0
Reviewed-on: http://review.whamcloud.com/7905
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-68 dirdata: Added documentation for FID, fid-in-dirent, layout EA, linkEA. 44/7844/3
Linda Bebernes [Thu, 3 Oct 2013 16:15:15 +0000 (09:15 -0700)]
LUDOC-68 dirdata:  Added documentation for FID, fid-in-dirent, layout EA, linkEA.

Provided description of features in Chapter 1 "Understanding Lustre" in
"Lustre Storage and I/O" section. Added information about
enabling fid-in-dirent when upgrading from 1.8 to Chapter 16 "Upgrading
Lustre".

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I62ccb4003bdd885c4177becbfad13062c5c27301
Reviewed-on: http://review.whamcloud.com/7844
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-153 Option: Added lazystatsfs option to lfs df documentation. 74/7674/5
Linda Bebernes [Thu, 19 Sep 2013 20:40:21 +0000 (13:40 -0700)]
LUDOC-153 Option: Added lazystatsfs option to lfs df documentation.

Updated Section 32.1.3 to document the lazystatsfs option.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I472777a91b9f7f113157f1f7f2efe59517c64295
Reviewed-on: http://review.whamcloud.com/7674
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-185 failover: Replaced links to lustre.org articles with links to tool webpages. 04/7704/3
Linda Bebernes [Thu, 19 Sep 2013 18:43:08 +0000 (11:43 -0700)]
LUDOC-185 failover: Replaced links to lustre.org articles with links to tool webpages.

Replaced lustre.org links with links to Red Hat Cluster Tool and Pacemaker webpages.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I744d0d4d370c5274b53529ae5f95d49c444de7c1
Reviewed-on: http://review.whamcloud.com/7704
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-11 bugfix: Changed block to bulk, other misc. formatting changes. 19/7819/2
Linda Bebernes [Tue, 1 Oct 2013 19:34:02 +0000 (12:34 -0700)]
LUDOC-11 bugfix:  Changed block to bulk, other misc. formatting changes.

In section 24.6.1 "Using stats_collect", changed "block" to "bulk" for
BRW definition.  Also, added some "literal" formats.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ib01dbcfc0f3a5616a7923075a9b48688b7bb88d4
Reviewed-on: http://review.whamcloud.com/7819
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-157 lnet: Add priority parameter to routes for LNet 28/7428/6
Linda Bebernes [Thu, 19 Sep 2013 18:58:29 +0000 (11:58 -0700)]
LUDOC-157 lnet: Add priority parameter to routes for LNet

Change LU-2934 added a new LNet route parameter called priority.
This change is to document the route priority parameter in the manual.

Signed-off-by: Doug Oucharek <doug.s.oucharek@intel.com>
Change-Id: I4cff3a9caf5ce3d1ef6285f4663f8cb31dba9cfd
Reviewed-on: http://review.whamcloud.com/7428
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Hudson
10 years agoLUDOC-10 newcontent: Added MGT space requirements to Chapter 5 01/7701/3
Linda Bebernes [Wed, 18 Sep 2013 20:24:47 +0000 (13:24 -0700)]
LUDOC-10 newcontent: Added MGT space requirements to Chapter 5

Added information describing space requirements for MGT including
co-located MGT.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I380d5aeb13d1c26864b59c3b8cf7aed05d89ee06
Reviewed-on: http://review.whamcloud.com/7701
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-98 mgs: Document new lctl replace_nids feature 59/7459/5
Artem Blagodarenko [Tue, 27 Aug 2013 13:53:57 +0000 (17:53 +0400)]
LUDOC-98 mgs: Document new lctl replace_nids feature

This is to track documentation for the "lctl replace_nids"
feature in LU-1430.

Xyratex-bug-id: MRP-397
Signed-off-by: Artem Blagodarenko <artem_blagodarenko@xyratex.com>
Change-Id: I3f5de27b51fd2cdb467f6ca5c0c308bd8c72f5b9
Reviewed-on: http://review.whamcloud.com/7459
Tested-by: Hudson
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-169 large_xattr: Added index entries and notes to enhance large_xattr documenta... 31/7731/2
Linda Bebernes [Mon, 23 Sep 2013 18:09:32 +0000 (11:09 -0700)]
LUDOC-169 large_xattr: Added index entries and notes to enhance large_xattr documentation.

Added index entries to Section 5.3.3 "Setting up Lustre File System" and
Section 16.2 "Upgrading Lustre" to make information about large_attr option
to tune2fs and mkfs.lustre easier to find.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Id6794ecb97d8368f04b32d7d20c4ce4817380316
Reviewed-on: http://review.whamcloud.com/7731
Tested-by: Hudson
Reviewed-by: Jian Yu <jian.yu@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-160 lustreproc: Added note, reordered content in Monitoring section for clarity. 63/7763/2
Linda Bebernes [Wed, 25 Sep 2013 19:46:17 +0000 (12:46 -0700)]
LUDOC-160 lustreproc: Added note, reordered content in Monitoring section for clarity.

Brett Lee has confirmed the content issues in this ticket were addressed in
LUDOC-168 (LustreProc rework). Changes made now include adding a note to clarify
how extents_stats and offsets_stats are enabled and minor rearrangements
to text for clarity.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I451cad9dfe67d504d6c90faf992595e0f199e043
Reviewed-on: http://review.whamcloud.com/7763
Tested-by: Hudson
Reviewed-by: Brett Lee <brett.lee@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-148 LustreProc: Documented buddy group cache content. 28/7728/3
Linda Bebernes [Mon, 23 Sep 2013 16:38:09 +0000 (09:38 -0700)]
LUDOC-148 LustreProc: Documented buddy group cache content.

Added information about buddy group cache to Section 31.2 (mballoc).

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I19ce6b58d4b0f4516856564e395c0ef8b5fabe70
Reviewed-on: http://review.whamcloud.com/7728
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Hudson
10 years agoLUDOC-167 formatting: Replaced {mdtname} with form used in rest of manual. 05/7705/2
Linda Bebernes [Thu, 19 Sep 2013 18:58:29 +0000 (11:58 -0700)]
LUDOC-167 formatting: Replaced {mdtname} with form used in rest of manual.

Replaced {mdtname} with ${FSNAME}-MDT{xxxx} for consistency with the rest of the manual.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I470318217387b615ab05ff8064ac9dd7c048bfe9
Reviewed-on: http://review.whamcloud.com/7705
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-54 option: Documented lfs_migrate -c <stripe_count> option. 87/7687/3
Linda Bebernes [Wed, 18 Sep 2013 16:54:25 +0000 (09:54 -0700)]
LUDOC-54 option: Documented lfs_migrate -c <stripe_count> option.

Updated lfs_migrate options in Section 32.2. Enhanced note in
Chapter 16 "Upgrading" about disabling wide striping on an MDS
to be downgraded.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I1c945ad775d89eadb508951ab6ff3d071788229e
Reviewed-on: http://review.whamcloud.com/7687
Tested-by: Hudson
Reviewed-by: Jian Yu <jian.yu@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-11 proc: correct some errors in Chapter 31.9 28/7628/4
Emoly Liu [Wed, 18 Sep 2013 08:57:10 +0000 (16:57 +0800)]
LUDOC-11 proc: correct some errors in Chapter 31.9

This patch includes the following changes:
1) correct some proc parameter name erros
2) correct "lctl conf_param" description and add
   "lctl set_param -P" usage.

Signed-off-by: Emoly Liu <emoly.liu@intel.com>
Change-Id: I9e972558c389fa537b8d3cd59f6b9fc873fbcd91
Reviewed-on: http://review.whamcloud.com/7628
Tested-by: Hudson
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-184 misc: change URLs to *.hpdd.intel.com 77/7677/2
Andreas Dilger [Mon, 16 Sep 2013 23:32:20 +0000 (17:32 -0600)]
LUDOC-184 misc: change URLs to *.hpdd.intel.com

Update the URLs in the manual to use *.hpdd.intel.com instead of
the older *.whamcloud.com addresses.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I262abeee78bfd09f2c5f81b3dfe46859c0a4db4b
Reviewed-on: http://review.whamcloud.com/7677
Tested-by: Hudson
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-130 fix: improvements for accuracy. 11/7511/5
Richard Henwood [Thu, 29 Aug 2013 23:23:07 +0000 (18:23 -0500)]
LUDOC-130 fix: improvements for accuracy.

This patch updates LUDOC-130 work to enhance accuracy.
The improvments implemented in the patch were provided against a
recently landed patch http://review.whamcloud.com/#/c/6608/

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I1fc7c5b1a71fe293b5308b1ba61c4e5151494222
Reviewed-on: http://review.whamcloud.com/7511
Tested-by: Hudson
10 years agoLUDOC-73 bugfix: Removed text describing obsolete lfs df -i behavior 87/7587/2
Linda Bebernes [Mon, 9 Sep 2013 17:48:19 +0000 (10:48 -0700)]
LUDOC-73 bugfix: Removed text describing obsolete lfs df -i behavior

Deleted outdated text from Section 18.5.1. Checking File System Free Space

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I0f7036f0313f8c468abacd2eba9efc24a04f3f45
Reviewed-on: http://review.whamcloud.com/7587
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-65 bugfix: Added workaround needed for setting quotas. 40/7540/5
Linda Bebernes [Mon, 9 Sep 2013 18:41:14 +0000 (11:41 -0700)]
LUDOC-65 bugfix: Added workaround needed for setting quotas.

Also, split section 25.1 into two subsections, one addressing the 2.4+ solution
and one addressing pre-2.4 releases (including workaround). Added l24 condition
to 2.4 section.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I01fd4ab846fb788cbeb10d6f34a360c0769e184e
Reviewed-on: http://review.whamcloud.com/7540
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-64 bugfix: Changed path2fid to fid2path 65/7465/4
Linda Bebernes [Mon, 9 Sep 2013 20:52:00 +0000 (13:52 -0700)]
LUDOC-64 bugfix: Changed path2fid to fid2path

In Section 13.14, corrected Step 2 describing how to look up FID on MDS.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I3aefa3426e87759994424aec13b4cd5fed08aac8
Reviewed-on: http://review.whamcloud.com/7465
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Hudson
10 years agoLUDOC-61 bugfix: Added note to lfs setstripe about inactive OSTs. 71/7471/3
Linda Bebernes [Wed, 28 Aug 2013 19:15:20 +0000 (12:15 -0700)]
LUDOC-61 bugfix: Added note to lfs setstripe about inactive OSTs.

Added a note describing what happens if lfs setstripe specifies
a start OST that is inactive or degraded.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I068f0636acdadd22a6984d33f2c61c8b5d418473
Reviewed-on: http://review.whamcloud.com/7471
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-166 mgs: Document new "lctl set_param -P" option 58/7458/4
Artem Blagodarenko [Tue, 27 Aug 2013 09:57:17 +0000 (13:57 +0400)]
LUDOC-166 mgs: Document new "lctl set_param -P" option

The new "lctl set_param -P" syntax for setting permanent
configuration parameters in LU-3155 needs to be added to
the Lustre manual.

Xyratex-bug-id: MRP-272
Signed-off-by: Artem Blagodarenko <artem_blagodarenko@xyratex.com>
Change-Id: I44d89d1219ed865d87368ef958a9f5aa207db49e
Reviewed-on: http://review.whamcloud.com/7458
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-130 install-progrIF: Updated install procedures. Also LUDOC-116,158. 08/6608/7
Linda Bebernes [Thu, 29 Aug 2013 02:01:08 +0000 (19:01 -0700)]
LUDOC-130 install-progrIF: Updated install procedures. Also LUDOC-116,158.

Updates to Chapter 8 (Installing from RPMs), new content
in Chapter 29 (Installing from source), updates to Chapter 33
(Programming Interfaces), new content in Chapter 16 (Upgrading).
All of these chapters are interconnected by cross-references to
target text that required editing.  Since Ch 33 was being edited,
it was updated with changes unrelated to installation as well.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I4e2f696d043979cb4a490bd3af376bf894e784b1
Reviewed-on: http://review.whamcloud.com/6608
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-45 bugfixes: Changed iokit script names from *_survey to *-survey 74/7474/2
Linda Bebernes [Tue, 27 Aug 2013 22:02:15 +0000 (15:02 -0700)]
LUDOC-45 bugfixes: Changed iokit script names from *_survey to *-survey

Fixed iokit script names in Ch 10, Ch 24, and Ch 36.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I41e77b06c18c8a141121b92e93f31214d85b1127
Reviewed-on: http://review.whamcloud.com/7474
Tested-by: Hudson
Reviewed-by: Minh Diep <minh.diep@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-177 bug: manual now builds again. 55/7455/2
Richard Henwood [Mon, 26 Aug 2013 19:59:50 +0000 (14:59 -0500)]
LUDOC-177 bug: manual now builds again.

A recent commit broke the manual. A bug in the custom
transforms means you can't apply a 'condition' to an orderedlist.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Id4d18510e6304b410fafc953c6c9d1fe2a0134b2
Reviewed-on: http://review.whamcloud.com/7455
Tested-by: Hudson
10 years agoLUDOC-168 proc: Reworked Ch 31: LustreProc 62/7362/5
Linda Bebernes [Fri, 16 Aug 2013 17:10:13 +0000 (10:10 -0700)]
LUDOC-168 proc: Reworked Ch 31: LustreProc

Reorganized and updated Chapter 31.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ifebf0a24aaafc5b6a0b603f2062edf06c08ed19e
Reviewed-on: http://review.whamcloud.com/7362
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-102 format-options: Fixed inode ratio description. Also addressed LUDOC-49. 47/6847/3
Linda Bebernes [Wed, 17 Jul 2013 21:05:53 +0000 (14:05 -0700)]
LUDOC-102 format-options: Fixed inode ratio description. Also addressed LUDOC-49.

Updated section 5.3 content about setting file system formatting options.
Removed obsolete note. Changed chapter title.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ib4368708c23d50c750c208a81d32294425a3fb2f
Reviewed-on: http://review.whamcloud.com/6847
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Keith Mannthey <keith.mannthey@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-159 extents-glossary: Glossary updated. Extents definition added. 90/6990/3
Linda Bebernes [Tue, 23 Jul 2013 16:05:58 +0000 (09:05 -0700)]
LUDOC-159 extents-glossary: Glossary updated. Extents definition added.

Glossary entries have been updated and edited and trademark compliance completed.
A definition for extents has been added.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I298a9a08dc7dc7a5d30532c26e456ea458b167a4
Reviewed-on: http://review.whamcloud.com/6990
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
10 years agoLUDOC-154 striping: Updated Ch 18. Also fixes LUDOC-132. 42/7042/4
Linda Bebernes [Mon, 5 Aug 2013 20:16:08 +0000 (13:16 -0700)]
LUDOC-154 striping: Updated Ch 18. Also fixes LUDOC-132.

Updated Ch 18: Managing File Striping and Free Space.
Added wide striping content. Corrected content in
Ch 31: LustreProc.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I9978788c7970e6c231148c63eddc0a8bd08b3317
Reviewed-on: http://review.whamcloud.com/7042
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Hudson
10 years agoLUDOC-144 LustreProc: Also LUDOC-143. Bug fixes and formatting. 41/6941/2
Linda Bebernes [Thu, 11 Jul 2013 17:35:48 +0000 (10:35 -0700)]
LUDOC-144 LustreProc:  Also LUDOC-143. Bug fixes and formatting.

Updated content, corrected errors, fixed mis-aligned tables.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I258df4809026ac6e53b95205eb8a1da869d6af58
Reviewed-on: http://review.whamcloud.com/6941
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-119 build: chunked html output directory. 43/6943/2
Richard Henwood [Thu, 11 Jul 2013 19:33:54 +0000 (14:33 -0500)]
LUDOC-119 build: chunked html output directory.

The chunked-html output goes into a suitabably named
directory.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I1e7c431c22c27cd24ef0d992adaa215e3724301d
Reviewed-on: http://review.whamcloud.com/6943
Tested-by: Hudson
Reviewed-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
10 years agoLUDOC-119: Segment HTML version of Lustre manual 34/5834/2
Przemyslaw Dubaniewicz [Mon, 25 Mar 2013 15:17:44 +0000 (16:17 +0100)]
LUDOC-119: Segment HTML version of Lustre manual

Change of the Lustre documentation Makefile.
The new created rule "chunked-html" allows
to divide the manual into sections. Output files
are created under the directory ./{$TGT_BASE}.

Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Change-Id: I195ac7cdb52591b262934dcba7bb8602ec41adc9
Reviewed-on: http://review.whamcloud.com/5834
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-147 lnet: Describe routes config in Manual 38/6538/8
Amir Shehata [Mon, 3 Jun 2013 22:59:04 +0000 (15:59 -0700)]
LUDOC-147 lnet: Describe routes config in Manual

Describe how to dynamically configure LNET routes using the two new
scripts which were added: luster_routes_config and
lustre_routes_conversion.
Sections 15.5 was added in the Lustre Manual.

LU-2950 tracks the change which landed to provide the
above functionality.

Signed-off-by: Amir Shehata <amir.shehata@intel.com>
Change-Id: I3974286bce9d726abd12a5deb568740bca4544aa
Reviewed-on: http://review.whamcloud.com/6538
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>
10 years agoLUDOC-12 intro: add Windows and Mac OS X 33/6133/4
Andreas Dilger [Tue, 23 Apr 2013 18:35:09 +0000 (12:35 -0600)]
LUDOC-12 intro: add Windows and Mac OS X

Allow searching for Windows and MacOS in the manual, so that users can
at least get a starting point.  Support for multiple OSs needs its own
section.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Change-Id: I1a7c26ec25e06f88e7c52f19a4df889152f2d1cd
Reviewed-on: http://review.whamcloud.com/6133
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-146 benchmark: water-down obdfilter-survey warning. 16/6416/10
Richard Henwood [Wed, 22 May 2013 14:08:01 +0000 (09:08 -0500)]
LUDOC-146 benchmark: water-down obdfilter-survey warning.

The obdfilter-survey uses a different object sequence (2) compared to
normal filesystem objects (currently always 0), so the two do not
collide.

The manual now indicates that obdfilter-survey may not destroy
production data. A brief description of the object sequence difference
between obdfilter_survey and normal objects is included.

The task to provide evidence to reduce the vagueness of this warning
is LU-3444.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Iac5fd3d9a89906dd04290ab62b2cff43ece29e53
Reviewed-on: http://review.whamcloud.com/6416
Tested-by: Hudson
10 years agoLUDOC-19 bug: Updated Reporting Lustre Bug section
Linda Bebernes [Mon, 10 Jun 2013 18:14:53 +0000 (11:14 -0700)]
LUDOC-19 bug: Updated Reporting Lustre Bug section

Updated procedure with new content and several links.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I2aed9e4cbbcd6e7a26f1c516c6f40ae538035e6d
Reviewed-on: http://review.whamcloud.com/6545
Tested-by: Hudson
Reviewed-by: James Nunez <james.a.nunez@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-74 bug: Fixed dd option.
Linda Bebernes [Thu, 6 Jun 2013 21:08:17 +0000 (14:08 -0700)]
LUDOC-74 bug: Fixed dd option.

Added conv=notrunc

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I0b3a802b41e16dbca167b1e4b5584c333f40d7e5
Reviewed-on: http://review.whamcloud.com/6581
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-151 quota: wrong least inode qunit
Niu Yawei [Mon, 27 May 2013 05:54:33 +0000 (01:54 -0400)]
LUDOC-151 quota: wrong least inode qunit

The least inode qunit is 1024 but not 1000.

Signed-off-by: Niu Yawei <yawei.niu@intel.com>
Change-Id: Ia54a82c9c0143468a350567af3ccaf0b6a7395a5
Reviewed-on: http://review.whamcloud.com/6455
Tested-by: Hudson
Reviewed-by: Johann Lombardi <johann.lombardi@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-109: Added scheduler default and recommendations. 2.4.0
Linda Bebernes [Wed, 29 May 2013 16:28:26 +0000 (09:28 -0700)]
LUDOC-109: Added scheduler default and recommendations.

Added note about scheduler default (deadline)
and recommendations (deadline, noop).

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I8cd1e3d9e547b28ccf87274b3d1737762c8fc21f
Reviewed-on: http://review.whamcloud.com/6486
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-140 Add contents info to pdf edition
Przemyslaw Dubaniewicz [Wed, 10 Apr 2013 10:29:38 +0000 (12:29 +0200)]
LUDOC-140 Add contents info to pdf edition

Enable a "fop1.extensions" in order to show
bookmarks in a pdf version of the manual.

Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Change-Id: I07a55d227ebf169587ef6671eddb633b1cbdb1f4
Reviewed-on: http://review.whamcloud.com/6008
Tested-by: Hudson
Reviewed-by: Nathaniel Clark <nathaniel.l.clark@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
10 years agoLUDOC-118 trademarks: trademark policy must be applied.
Richard Henwood [Thu, 9 May 2013 18:27:25 +0000 (13:27 -0500)]
LUDOC-118 trademarks: trademark policy must be applied.

A trademark compliance review was completed on the opening content and
Section 1: Lustre Intro and a few additional minor edits were made.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Iaedab4e3d1b4f53e2d0d6c35171c4b270d37b909
Reviewed-on: http://review.whamcloud.com/6303
Tested-by: Hudson
10 years agoLUDOC-117 cleanup: minor changes to wording and markup.
Richard Henwood [Tue, 30 Apr 2013 22:27:26 +0000 (17:27 -0500)]
LUDOC-117 cleanup: minor changes to wording and markup.

Minor changes to add clarify.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Ic5c8c6cf23d9779c0d1ad7a5cb702a179f9dca0b
Reviewed-on: http://review.whamcloud.com/6218
Tested-by: Hudson
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>
10 years agoLUDOC-79 ptlrpc: Add NRS documentation
Nikitas Angelinas [Wed, 27 Mar 2013 01:05:22 +0000 (01:05 +0000)]
LUDOC-79 ptlrpc: Add NRS documentation

This patch adds a description of NRS changes added to Lustre from
LU-398, including policies and their tunables.

Signed-off-by: Nikitas Angelinas <nikitas_angelinas@xyratex.com>
Change-Id: I87de8c3d63d84a23215a5375384462a3429bcbab
Oracle-bug-id: b=13634
Xyratex-bug-id: MRP-73
Reviewed-on: http://review.whamcloud.com/5848
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-80: 4MB RPC Doc Changes
Sergii Glushchenko [Thu, 28 Mar 2013 15:34:07 +0000 (17:34 +0200)]
LUDOC-80: 4MB RPC Doc Changes

Reflect changes introduced in LU-1431 in the Lustre manual:
maximum value of max_pages_per_rpc is now 1024.

Change-Id: I0a2e5c6c94f99f5380200cfc1e856f4f2e3d2585
Signed-off-by: Sergii Glushchenko <sergii_glushchenko@xyratex.com>
Xyratex-bug-id: MRP-319
Reviewed-on: http://review.whamcloud.com/5534
Tested-by: Hudson
Reviewed-by: Oleg Drokin <oleg.drokin@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
10 years agoLUDOC-117 cleanup: minor changes to wording and cleanup.
Richard Henwood [Tue, 8 Jan 2013 23:07:30 +0000 (17:07 -0600)]
LUDOC-117 cleanup: minor changes to wording and cleanup.

Minor wording changes to add clarity.

Reviewed position of replaceable markup tags.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: If0be703ac384d468cd56262fa3dd789209d009be
Reviewed-on: http://review.whamcloud.com/4974
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
10 years agoLUDOC-28 llapi: clean up sample code
Richard Henwood [Wed, 28 Nov 2012 11:32:45 +0000 (11:32 +0000)]
LUDOC-28 llapi: clean up sample code

Clean up the examples for using the lustreapi interfaces.

This code is updated following fixes for the client API which
are tracked against LU-1606.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I87f8f5a5d7f7f4792e088b45863b6656391525e9
Reviewed-on: http://review.whamcloud.com/1879
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
11 years agoLUDOC-11 cleanup: cleanups of examples and text
Andreas Dilger [Wed, 17 Aug 2011 21:33:05 +0000 (15:33 -0600)]
LUDOC-11 cleanup: cleanups of examples and text

Clean up some examples seen in the manual while working on LUDOC-14.

When the --index parameter is passed to mkfs.lustre, it will already
assign an OST or MDT index, so OSTffff will not be in the output.

Clean up the example for multiple NIDs to remove the use of the old
elan network type.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Ibe1068d66627e72a88c2584f413d2c40df99cab0
Reviewed-on: http://review.whamcloud.com/2181
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
11 years agoLUDOC-11: Removed Serna note.
Linda Bebernes [Mon, 22 Apr 2013 20:20:54 +0000 (13:20 -0700)]
LUDOC-11: Removed Serna note.

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: I2f66d7239769822dec401ecc518bf03631867825
Reviewed-on: http://review.whamcloud.com/6118
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-11 typos: Correct assorted minor errors
James Nunez [Mon, 8 Apr 2013 21:25:35 +0000 (15:25 -0600)]
LUDOC-11 typos: Correct assorted minor errors

Correct the following errors:
Section 8.1.1.2 Changed "utilities are must be" to "utilities must be"
Section 9.1 Changed text formatting of "networks" to match "ip2nets"
Section 9.1 Changed text formatting of "routes" to match "networks"
and "ip2nets" in the same section
Section 10.1 Changed "and MGS" to "an MGS"
Section 10.1 Changed "simplify the translating" to "simplify
translating"
Section 26.1.2 Extended text formatting to the end of the line
"Lustre logs are dumped to /proc/sys/lnet/debug_path"
Section 30.6 Changed "will still be notified reconnect" to "will
still be notified to reconnect"
Section 30.6 Changed "the last the non-IR client" to "the last non-IR
client"

Signed-off-by: James Nunez <james.a.nunez@intel.com>
Change-Id: I0148156245452e231a15fa1f863830b6df30e8bc
Reviewed-on: http://review.whamcloud.com/5976
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-126 startup: component start-up order.
Richard Henwood [Fri, 8 Mar 2013 01:27:50 +0000 (19:27 -0600)]
LUDOC-126 startup: component start-up order.

Component startup order is now correct.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I3b9f24323c539d042858e98a1566ce1fadee0748
Reviewed-on: http://review.whamcloud.com/5645
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Linda Bebernes <linda.bebernes@intel.com>
Reviewed-by: Cory Spitz <spitzcor@cray.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-85 enhance: new LFSCK options are now documented.
Richard Henwood [Thu, 21 Mar 2013 16:10:36 +0000 (11:10 -0500)]
LUDOC-85 enhance: new LFSCK options are now documented.

LFSCK has added significant functionality in the recent release. The
manual now makes a clear distinction which version of lustre supports
the various lfsck options.

LFSCK namespace is now included and documented.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Iff0ff5b696b8a55fefedfcfe78031e28c2a93749
Reviewed-on: http://review.whamcloud.com/5801
Tested-by: Hudson
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
11 years agoLUDOC-11 typos: minor cleanup of text.
Przemyslaw Dubaniewicz [Wed, 27 Mar 2013 12:18:14 +0000 (13:18 +0100)]
LUDOC-11 typos: minor cleanup of text.

Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Change-Id: I6047faadbead0e81c7c0dd94ec3ef2cd94e109ca
Reviewed-on: http://review.whamcloud.com/5853
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-104 style: added style elements for 2.1, 2.2 and 2.5
Richard Henwood [Fri, 22 Mar 2013 20:21:37 +0000 (15:21 -0500)]
LUDOC-104 style: added style elements for 2.1, 2.2 and 2.5

Style rules now support condition='{l21|l22|l23|l24|l25}'.
Code refactored for simplicity.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I2ef60e50f390b566a2193a0114bfbac3aee54979
Reviewed-on: http://review.whamcloud.com/5753
Tested-by: Hudson
11 years agoLUDOC-129: Corrected dircount language
Linda Bebernes [Wed, 20 Mar 2013 16:43:05 +0000 (09:43 -0700)]
LUDOC-129:  Corrected dircount language

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
Change-Id: Ifea277ebb4199db5abde7b37d4638d1e8c38604e
Reviewed-on: http://review.whamcloud.com/5788
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-70: Small editing changes
Linda Bebernes [Wed, 20 Mar 2013 16:31:47 +0000 (09:31 -0700)]
LUDOC-70: Small editing changes

Signed-off-by: Linda Bebernes <linda.bebernes@intel.com>
11 years agoLUDOC-128 build: commit hooks
Richard Henwood [Fri, 8 Mar 2013 01:47:28 +0000 (19:47 -0600)]
LUDOC-128 build: commit hooks

Commit hooks help commit messages conform to best practice. These
hooks are copied from the Lustre code commit hooks. Modified to make
them specific to the Manual.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I407644562011fe66ace0e34667f67f04b9d58070
Reviewed-on: http://review.whamcloud.com/5646
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
11 years agoLUDOC-34 remove modules with 'lustre_rmmod'
Przemyslaw Dubaniewicz [Mon, 11 Mar 2013 11:14:21 +0000 (12:14 +0100)]
LUDOC-34 remove modules with 'lustre_rmmod'

Use "lustre_rmmod" instead of
"lctl modules | awk '{print $2}' | xargs rmmod" to remove modules.
(Corrected tip in section 15.2.2)

Change-Id: I833f83a85e87d00427ed41180e0db6fa51074d2d
Signed-off-by: Przemyslaw Dubaniewicz <przemyslaw@dubaniewicz.com>
Reviewed-on: http://review.whamcloud.com/5668
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
11 years agoLUDOC-125 lnet: Add Remote Network Hash Table Size Parameter
Doug Oucharek [Fri, 22 Feb 2013 08:22:37 +0000 (00:22 -0800)]
LUDOC-125 lnet: Add Remote Network Hash Table Size Parameter

Change LU-2466 added a new module parameter: rnet_htable_size
to let the user optimize the size of the LNet remote networks
hash table.

This change is to document rnet_htable_size in the manual.

Signed-off-by: Doug Oucharek <doug.s.oucharek@intel.com>
Change-Id: I4e95acb752c6c1accf13307990210120cbb78c4c
Reviewed-on: http://review.whamcloud.com/5510
Tested-by: Hudson
Reviewed-by: Cliff White <cliff.white@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-123: provide instruction on listing debug masks.
Richard Henwood [Mon, 11 Feb 2013 19:55:41 +0000 (13:55 -0600)]
LUDOC-123: provide instruction on listing debug masks.

Clarifies instructions for the subsystem_mask parameter of lctl debug.
Provides examples.

Change-Id: I51e2104469721d15a29dda1dbaf3caeebe65b252
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Signed-off-by: Cliff White <cliff.white@intel.com>
Reviewed-on: http://review.whamcloud.com/5320
Tested-by: Hudson
Reviewed-by: John Hammond <johnlockwoodhammond@gmail.com>
11 years agoLUDOC-111 recovery: Add a section on "suppress_pings"
Li Wei [Tue, 5 Mar 2013 07:20:35 +0000 (15:20 +0800)]
LUDOC-111 recovery: Add a section on "suppress_pings"

This patch adds a section on the new ptlrpc kernel module parameter
"suppress_pings".

Signed-off-by: Li Wei <wei.g.li@intel.com>
Change-Id: I93a63df4fa0cd15b2901161201a578236baa2d01
Reviewed-on: http://review.whamcloud.com/5588
Tested-by: Hudson
Reviewed-by: Emoly Liu <emoly.liu@intel.com>
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
11 years agoLUDOC-91: Add wireshark to debugging tools
Nathaniel Clark [Mon, 28 Jan 2013 21:28:24 +0000 (16:28 -0500)]
LUDOC-91: Add wireshark to debugging tools

Add section on wireshark and pointing to wireshark plugins in contrib.

Change-Id: Id7bcbcb1ac7803c1893a75d08a62edc6f45e548b
Signed-off-by: Nathaniel Clark <nathaniel.l.clark@intel.com>
Reviewed-on: http://review.whamcloud.com/5197
Tested-by: Hudson
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-104: Design elements to highlight lustre specific features.
Richard Henwood [Wed, 26 Dec 2012 21:01:43 +0000 (15:01 -0600)]
LUDOC-104: Design elements to highlight lustre specific features.

The Docbook 5 standard allows for a condition attribute to all
elements. By setting this condition with the value of l23 or l24
passages of the manual that are specific to version of Lustre
can be marked up.

This change adds an annotation against elements that have the
condition attribute set. Graphics are rendered in-line at the
relevant point in the text and against the relevant entries in
the table of contents.

'condition' annotations to two existing lustre specific sections
of the to demonstrate this new design feature.

The document design elements are displayed similarly across epub, html,
xhtml and pdf renderings of the manual.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Idd2cb762e219204bfc63c9ed81ccedd49b2c43ac
Reviewed-on: http://review.whamcloud.com/4611
Tested-by: Hudson
11 years agoLUDOC-11 typo: minor cleanup of virtual block device section.
Richard Henwood [Tue, 29 Jan 2013 22:33:47 +0000 (16:33 -0600)]
LUDOC-11 typo: minor cleanup of virtual block device section.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Ib29454dd0d4105f35ee0d049cf5f66fdc77fb196
Reviewed-on: http://review.whamcloud.com/5201
Tested-by: Hudson
11 years agoLUDOC-117 style: use <replaceable> in example text
Andreas Dilger [Sat, 12 Jan 2013 01:40:27 +0000 (18:40 -0700)]
LUDOC-117 style: use <replaceable> in example text

Use the <replaceable> tag and {} instead of <emphasis> and
<> for user-supplied text.  The XML markup is intended to
be semantic, so <replaceable> is more correct to use.

The use of <> makes the XML ugly, since it needs to be
written as &gt;&lt; in the .xml files.

Some incorrect usages of <emphasis> were corrected.

Signed-off-by: Andreas Dilger <andreas.dilger@intel.com>
Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I8edb59a100e20573e06f11ce10fe1642d45fbd4f
Reviewed-on: http://review.whamcloud.com/5006
Tested-by: Hudson
11 years agoLUDOC-71: clean-up of OST removal text.
Richard Henwood [Wed, 14 Nov 2012 22:09:34 +0000 (16:09 -0600)]
LUDOC-71: clean-up of OST removal text.

There is no-longer duplicate text in the introduction to
removing OSTs.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: Icfce0c0bdefded1202af7c2fa0ce8831e0c824d5
Reviewed-on: http://review.whamcloud.com/4585
Tested-by: Hudson
11 years agoLUDOC-108 dne: Manual includes DNE usage instructions.
Richard Henwood [Fri, 7 Dec 2012 21:54:21 +0000 (15:54 -0600)]
LUDOC-108 dne: Manual includes DNE usage instructions.

The manual now includes instructions to:
- add a MDT.
- remove a MDT.
- upgrade to multiple MDT configurations.
- designing active-active MDS configurations.
- warns against having chained remote directories.
- added administrative documentation for lfs.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I9b4fb35d7932b9e90561e03b0b72271b9c2728cf
Reviewed-on: http://review.whamcloud.com/4773
Tested-by: Hudson
11 years agoLUDOC-11: Correct assorted minor errors
James Nunez [Wed, 2 Jan 2013 14:55:22 +0000 (07:55 -0700)]
LUDOC-11: Correct assorted minor errors

Corrected three minor errors:
Section 1.2.3 removed "something" before the link to the LNET section.

Section 9.1 removed duplicate text "Setting the LNET Module ip2nets Parameter"

Section 23.1 added closing parenthesis

Signed-off-by: James Nunez <james.a.nunez@intel.com>
Change-Id: If1bac00b0245e82d21290f86ce9890a167478ada
Reviewed-on: http://review.whamcloud.com/4941
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-89 quota: updates for new quota implementation
Johann Lombardi [Fri, 16 Nov 2012 14:19:07 +0000 (15:19 +0100)]
LUDOC-89 quota: updates for new quota implementation

2.4 comes with many quota changes which require updates to the
lustre documentation.

Signed-off-by: Johann Lombardi <johann.lombardi@intel.com>
Change-Id: If465eb2b92d955a29799d041662b770e84891d39
Reviewed-on: http://review.whamcloud.com/4600
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-100 monitoring: jobstats manual
Niu Yawei [Fri, 9 Nov 2012 09:10:26 +0000 (04:10 -0500)]
LUDOC-100 monitoring: jobstats manual

Update manual for jobstats.

Signed-off-by: Niu Yawei <niu@whamcloud.com>
Change-Id: Icfd85f788c1657b0601d06f2890db03068ea5c06
Reviewed-on: http://review.whamcloud.com/4500
Tested-by: Hudson
Reviewed-by: Andreas Dilger <andreas.dilger@intel.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-95: fix server kernel RPM entry.
Richard Henwood [Wed, 14 Nov 2012 21:57:10 +0000 (15:57 -0600)]
LUDOC-95: fix server kernel RPM entry.

Table 8.1 in Section 8.1.1 in the Lustre manual contains
outdated references to the Lustre patched kernel RPM
kernel-ib-<ver>. This has been removed.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I9a4c9024faa34e6fa26e8aee16d2518682172d8a
Reviewed-on: http://review.whamcloud.com/4584
Tested-by: Hudson
Reviewed-by: Brian J. Murrell <brian.murrell@intel.com>
11 years agoLUDOC-99 quota: clarified quota behavior.
Richard Henwood [Thu, 8 Nov 2012 00:29:06 +0000 (18:29 -0600)]
LUDOC-99 quota: clarified quota behavior.

Documentation has been corrected to remove erroneous
wording that implied a quota could be applied to a directory.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I46161dcff8e57b5c224270c85d99311d9882725c
Reviewed-on: http://review.whamcloud.com/4492
Tested-by: Hudson
Reviewed-by: Bob Glossman <bob.glossman@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
11 years agoLUDOC-103 version: mds-survey is now marked as 2.2 and beyond.
Richard Henwood [Wed, 14 Nov 2012 02:51:02 +0000 (20:51 -0600)]
LUDOC-103 version: mds-survey is now marked as 2.2 and beyond.

mds-survey is only available in version of Lustre version 2.2. The
Manual now includes text to this effect.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Change-Id: I43349f5994d7ff0f55db7cf58b3fd3b316f200fc
Reviewed-on: http://review.whamcloud.com/4527
Tested-by: Hudson
Reviewed-by: wangdi <di.wang@intel.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
11 years agoLUDOC-66 lfsck: improve online LFSCK documentation
Andreas Dilger [Wed, 17 Oct 2012 21:22:02 +0000 (15:22 -0600)]
LUDOC-66 lfsck: improve online LFSCK documentation

Improve the description of the online LFSCK feature, providing a
high-level overview of the feature of what the LFSCK feature is,
and improving the readability of the text.

Also update the Backup/Restore section to replace bugzilla reference
with Jira bug reference.  Also mention that the OST device label needs
to be reset for 2.4 and later filesystems.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Iadbdec4f17ca7bc1ad49065756088e4d05ddcab0
Reviewed-on: http://review.whamcloud.com/4506
Tested-by: Hudson
Reviewed-by: Fan Yong <yong.fan@whamcloud.com>
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-76 license: change Whamcloud to Intel
Andreas Dilger [Fri, 9 Nov 2012 20:20:48 +0000 (13:20 -0700)]
LUDOC-76 license: change Whamcloud to Intel

Change references in the manual from Whamcloud over to Intel in
both the license cover page as well as within the manual.

Update URLs for package downloads to reference the release download
title page instead of the top-level wiki page.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I8d0926881a140e3e76202dc442037366046b6469
Reviewed-on: http://review.whamcloud.com/4497
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
11 years agoLUDOC-97 tuning: SMP node affinity parameters are now documented. 2.3.0
Richard Henwood [Tue, 30 Oct 2012 19:58:08 +0000 (14:58 -0500)]
LUDOC-97 tuning: SMP node affinity parameters are now documented.

SMP Node Affinity arrived with Lustre 2.3 (LU-56). The default
values SMP machines are judged to be suitable for most workloads.
If and administrator does want to tinker, this change records
the available parameters.

Entries added to the glossary for NUMA and Node Affinity.

Signed-off-by: Richard Henwood <richard.henwood@intel.com>
Signed-off-by: Liang Zhen <liang.zhen@intel.com>
Change-Id: Ib5dd25431046d2842cbde77f0b6fede47a790da7
Reviewed-on: http://review.whamcloud.com/4413
Tested-by: Hudson
Reviewed-by: Doug Oucharek <doug.s.oucharek@intel.com>
Reviewed-by: Liang Zhen <liang@whamcloud.com>
Reviewed-by: Cliff White <cliff.white@intel.com>
11 years agoLUDOC-11 fix assorted minor errors
Ned Bass [Fri, 7 Sep 2012 20:09:16 +0000 (13:09 -0700)]
LUDOC-11 fix assorted minor errors

A number of grammatical, spelling, and formatting errors were found by
running the html manual through aspell -H.

Signed-off-by: Ned Bass <bass6@llnl.gov>
Change-Id: Ie4f3cfba62cfb452c1bddb21a3137142dada9d47
Reviewed-on: http://review.whamcloud.com/3908
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
11 years agoLUDOC-75 lnet: Add lst utility environment variable LST_FEATURES
Doug Oucharek [Thu, 6 Sep 2012 20:54:31 +0000 (13:54 -0700)]
LUDOC-75 lnet: Add lst utility environment variable LST_FEATURES

Change LU-521 added a new environment variable LST_FEATURES.
This change is to document LST_FEATURES in the manul.

Signed-off-by: Doug Oucharek <doug.s.oucharek@intel.com>
Change-Id: I8760bb902b45d82203645f26c0d1df3e17b8891b
Reviewed-on: http://review.whamcloud.com/3893
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
Reviewed-by: Liang Zhen <liang@whamcloud.com>
Reviewed-by: Cliff White <cliffw@whamcloud.com>
11 years agoLUDOC-11 debug: fix wrong libcfs debug header path
Ned Bass [Wed, 5 Sep 2012 22:34:34 +0000 (15:34 -0700)]
LUDOC-11 debug: fix wrong libcfs debug header path

An incorrect path was given to the header file listing debug
subsystems and message types.

Signed-off-by: Ned Bass <bass6@llnl.gov>
Change-Id: Ib272ed9630f23f99d5f66760804bc3627d58f5dc
Reviewed-on: http://review.whamcloud.com/3882
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
Tested-by: Richard Henwood <Richard.Henwood@intel.com>
11 years agoLUDOC-66 lfsck: User interface documentation.
Richard Henwood [Tue, 10 Jul 2012 13:57:49 +0000 (08:57 -0500)]
LUDOC-66 lfsck: User interface documentation.

lfsck with OI Scrub is new in Lustre 2.3. The user interface is documented by
this change.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I5a74e3ed143ed1c067e41731edf666e900a3b485
Reviewed-on: http://review.whamcloud.com/3368
Tested-by: Hudson
Reviewed-by: Fan Yong <yong.fan@whamcloud.com>
Reviewed-by: Cliff White <cliffw@whamcloud.com>
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
11 years agoLUDOC-62 admin: better OST/MDT migrate description
Andreas Dilger [Thu, 30 Aug 2012 07:38:17 +0000 (01:38 -0600)]
LUDOC-62 admin: better OST/MDT migrate description

Instead of restating the backup/restore steps for OST/MDT migration,
reference the existing file/device backup/restore process.  Clean up
the formatting of backup/restore examples a bit.

Update the OST object-to-MDS file mapping process to reference new
MDT FIDs and fid2path, in preference to the old 1.8 debugfs method.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ida33c2f055cf9f66fa1ec7463e1ca36875aecab0
Reviewed-on: http://review.whamcloud.com/3827
Tested-by: Hudson
Reviewed-by: Richard Henwood <Richard.Henwood@intel.com>
Reviewed-by: Cliff White <cliffw@whamcloud.com>
11 years agoMerge "LUDOC-62 backup: file-level MDT backup now supported."
Richard Henwood [Mon, 30 Jul 2012 18:47:50 +0000 (14:47 -0400)]
Merge "LUDOC-62 backup: file-level MDT backup now supported."

11 years agoLUDOC-58: Clarify multiple file system issues. 30/2630/8
Richard Henwood [Fri, 27 Jul 2012 21:48:39 +0000 (16:48 -0500)]
LUDOC-58: Clarify multiple file system issues.

Manual is updated to emphasise Lustre is designed to only have one MGS. If
there are multiple MGSs then best practice suggests fsname must be unique.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I82af8e6004fe1d7f70f4a8c93d60103271fcd298

11 years agoLUDOC-62 backup: file-level MDT backup now supported. 65/3265/2
Richard Henwood [Tue, 3 Jul 2012 16:38:59 +0000 (11:38 -0500)]
LUDOC-62 backup: file-level MDT backup now supported.

Because LU-957 will land for 2.3 the Manual now describes file level
back for both an MDT and an OST.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
Change-Id: I8f797f8566453f99b2fe67f26e780db07a9eb3e0

11 years agoMerge "LUDOC-49: MDT sizing hint for stripes."
Richard Henwood [Tue, 29 May 2012 18:01:01 +0000 (14:01 -0400)]
Merge "LUDOC-49: MDT sizing hint for stripes."

11 years agoLUDOC-11: tidied up minor word ordering errors. 31/2631/1
Richard Henwood [Wed, 2 May 2012 16:42:31 +0000 (11:42 -0500)]
LUDOC-11: tidied up minor word ordering errors.

Signed-off-by: Richard Henwood <rhenwood@whamcloud.com>
11 years agoLUDOC-24 Glossary: Fix a typo 12/2612/2 2.2.0
Cliff White [Sun, 29 Apr 2012 17:20:13 +0000 (10:20 -0700)]
LUDOC-24 Glossary: Fix a typo

Change-Id: I1349f0a79729efcdb94d25a1da0977450250915a
Signed-off-by: Cliff White <cliffw@whamcloud.com>