Whamcloud - gitweb
doc/manual.git
2 months agoLUDOC-393 quota: include lfs project interface 37/44137/5 master
Wang Shilong [Mon, 5 Jul 2021 14:38:59 +0000 (22:38 +0800)]
LUDOC-393 quota: include lfs project interface

lfs-project should be recommended to set/list
project quota since chattr is server side RPMS.

Since 2.14.51, project quota feature is enabled
by default.

Signed-off-by: Wang Shilong <wshilong@ddn.com>
Change-Id: Id3e35776a3f489ec423e7633494fb074c7fc2971
Reviewed-on: https://review.whamcloud.com/44137
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
3 months agoLUDOC-394 manual: remove 'dbdoclet.' from crossrefs 59/43759/3
Andreas Dilger [Fri, 21 May 2021 00:59:47 +0000 (18:59 -0600)]
LUDOC-394 manual: remove 'dbdoclet.' from crossrefs

Remove the "dbdoclet." prefix from manual cross-references.
This is a remnant of auto-generated cross-references when
the manual was originally imported, but is not useful.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Iad17a07542423b9aa99c5d2eb3727b6ef98b14ea
Reviewed-on: https://review.whamcloud.com/43759
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Tested-by: jenkins <devops@whamcloud.com>
3 months agoLUDOC-481 setup: update OSS/MDS RAM requirements 91/41391/3
Andreas Dilger [Tue, 2 Feb 2021 18:36:35 +0000 (11:36 -0700)]
LUDOC-481 setup: update OSS/MDS RAM requirements

Update the MDS and OSS RAM requirements to reflect increased memory
requirements from the base OS for RHEL8, as well as the general
increase in the number of files that are being accessed by clients.

Also, document additional RAM for active-active DNE MDT failover
pairs, which wasn't taken into consideration when first written.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I39545466fbe39eb72a6745294f14f88e023ebbe5
Reviewed-on: https://review.whamcloud.com/41391
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
3 months agoLU-14339 jobid: add %H to complex jobid 57/43757/3
Andreas Dilger [Thu, 20 May 2021 19:20:01 +0000 (13:20 -0600)]
LU-14339 jobid: add %H to complex jobid

The '%H' parameter allows printing the short hostname into the
jobid instead of the fully-qualified hostname.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I1e2735c89192f8bc3d919ae5ebdfb528783ebbe5
Reviewed-on: https://review.whamcloud.com/43757
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Yang Sheng <ys@whamcloud.com>
4 months agoLUDOC-394 manual: Add remaining meaningful ref names 44/43444/2
Arshad Hussain [Wed, 21 Apr 2021 16:40:36 +0000 (22:10 +0530)]
LUDOC-394 manual: Add remaining meaningful ref names

This patch adds meaningful and proper reference name under file
01. ConfigurationFilesModuleParameters.xml
02. LustreTroubleshooting.xml
03. UnderstandingFailover.xml
04. UnderstandingLustreNetworking.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I75206543127ddb0d99f25a6a9ac91f6c420f8615
Reviewed-on: https://review.whamcloud.com/43444
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under SettingUpBonding.xml 43/43443/2
Arshad Hussain [Wed, 21 Apr 2021 15:19:47 +0000 (20:49 +0530)]
LUDOC-394 manual: Add meaningful ref names under SettingUpBonding.xml

This patch adds meaningful and proper reference name under file
SettingUpBonding.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Iffbf75fb37e2758bc6c31dc80e846257bf8b7888
Reviewed-on: https://review.whamcloud.com/43443
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under LNetSelfTest.xml 42/43442/2
Arshad Hussain [Wed, 21 Apr 2021 14:46:15 +0000 (20:16 +0530)]
LUDOC-394 manual: Add meaningful ref names under LNetSelfTest.xml

This patch adds meaningful and proper reference name under file
LNetSelfTest.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I3de2c6ff9c9c0d693497d5ccebd950fd5617e0db
Reviewed-on: https://review.whamcloud.com/43442
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under LustreMonitoring.xml 35/43435/3
Arshad Hussain [Wed, 21 Apr 2021 09:37:29 +0000 (15:07 +0530)]
LUDOC-394 manual: Add meaningful ref names under LustreMonitoring.xml

This patch adds meaningful and proper reference name under file
LustreMonitoring.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Iac0e3a9cece98819ec1587fd32ca32d1a1683f2e
Reviewed-on: https://review.whamcloud.com/43435
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under ManagingFileSystemIO.xml 36/43436/2
Arshad Hussain [Wed, 21 Apr 2021 09:52:56 +0000 (15:22 +0530)]
LUDOC-394 manual: Add meaningful ref names under ManagingFileSystemIO.xml

This patch adds meaningful and proper reference name under file
ManagingFileSystemIO.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I52e47c42613de2e741e731bc05b9acf9500c5411
Reviewed-on: https://review.whamcloud.com/43436
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under UserUtilities.xml 37/43437/2
Arshad Hussain [Wed, 21 Apr 2021 10:07:58 +0000 (15:37 +0530)]
LUDOC-394 manual: Add meaningful ref names under UserUtilities.xml

This patch adds meaningful and proper reference name under file
UserUtilities.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I98223898ac1ca18f73c069c1ae120d6322efcc98
Reviewed-on: https://review.whamcloud.com/43437
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under ConfiguringStorage.xml 34/43434/2
Arshad Hussain [Wed, 21 Apr 2021 08:25:31 +0000 (13:55 +0530)]
LUDOC-394 manual: Add meaningful ref names under ConfiguringStorage.xml

This patch adds meaningful and proper reference name under file
ConfiguringStorage.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I435054a87d86f9411b83b011f662a872467165bb
Reviewed-on: https://review.whamcloud.com/43434
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under SettingLustreProperties.xml 33/43433/2
Arshad Hussain [Wed, 21 Apr 2021 07:47:49 +0000 (13:17 +0530)]
LUDOC-394 manual: Add meaningful ref names under SettingLustreProperties.xml

This patch adds meaningful and proper reference name under file
SettingLustreProperties.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I48d5db1bb39486865e5bf7f887785c662e31ee58
Reviewed-on: https://review.whamcloud.com/43433
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under ManagingLNet.xml 32/43432/2
Arshad Hussain [Wed, 21 Apr 2021 06:59:42 +0000 (12:29 +0530)]
LUDOC-394 manual: Add meaningful ref names under ManagingLNet.xml

This patch adds meaningful and proper reference name under file
ManagingLNet.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Ic55c2fe59c6aa67b0a32f82e37420207439e0d2a
Reviewed-on: https://review.whamcloud.com/43432
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under BenchmarkingTests.xml 38/43438/2
Arshad Hussain [Wed, 21 Apr 2021 11:12:42 +0000 (16:42 +0530)]
LUDOC-394 manual: Add meaningful ref names under BenchmarkingTests.xml

This patch adds meaningful and proper reference name under file
BenchmarkingTests.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I44fda9a62045d2f97c843f245a32ff6df7d21713
Reviewed-on: https://review.whamcloud.com/43438
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under LustreOperations.xml 59/43359/5
Arshad Hussain [Wed, 14 Apr 2021 12:55:06 +0000 (18:25 +0530)]
LUDOC-394 manual: Add meaningful ref names under LustreOperations.xml

This patch adds meaningful and proper reference name under file
LustreOperations.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: If163a343246f8a42eb53d0ec136bc1ca5eacce5a
Reviewed-on: https://review.whamcloud.com/43359
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under SystemConfigurationUtilities.xml 61/43361/3
Arshad Hussain [Wed, 14 Apr 2021 15:11:49 +0000 (20:41 +0530)]
LUDOC-394 manual: Add meaningful ref names under SystemConfigurationUtilities.xml

This patch adds meaningful and proper reference name under file
SystemConfigurationUtilities.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I3120295dea10770780c1b98232f3503100d46bb2
Reviewed-on: https://review.whamcloud.com/43361
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: Andreas Dilger <adilger@whamcloud.com>
4 months agoLUDOC-394 manual: Add meaningful ref names under LustreDebugging.xml 60/43360/3
Arshad Hussain [Wed, 14 Apr 2021 10:03:39 +0000 (15:33 +0530)]
LUDOC-394 manual: Add meaningful ref names under LustreDebugging.xml

This patch adds meaningful and proper reference name under file
LustreDebugging.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Iac26a5dc6fd55656a5dc824029aab7541d9ca9f6
Reviewed-on: https://review.whamcloud.com/43360
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLU-7668 admin: remove OST from config logs 53/41453/5
Andreas Dilger [Tue, 9 Feb 2021 15:55:39 +0000 (08:55 -0700)]
LU-7668 admin: remove OST from config logs

When deactivating an OST permanently, the configuration records can
also be removed from the MGS to avoid the OSC device being configured
on the clients at all using "lctl llog_print" and "lctl llog_cancel".

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I7d76b092b1ae3fc7abc2759651f246a9b03ebbe5
Reviewed-on: https://review.whamcloud.com/41453
Tested-by: jenkins <devops@whamcloud.com>
5 months agoLUDOC-394 manual: Add meaningful ref names under UnderstandingLustre.xml 53/43353/2
Arshad Hussain [Wed, 14 Apr 2021 05:35:52 +0000 (11:05 +0530)]
LUDOC-394 manual: Add meaningful ref names under UnderstandingLustre.xml

This patch adds meaningful and proper reference name under file
UnderstandingLustre.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I0b314bcefeaf4816d78143247f5cdf0e91a97b6b
Reviewed-on: https://review.whamcloud.com/43353
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-394 manual: Add meaningful ref names under ManagingFailover.xml 54/43354/2
Arshad Hussain [Wed, 14 Apr 2021 05:22:05 +0000 (10:52 +0530)]
LUDOC-394 manual: Add meaningful ref names under ManagingFailover.xml

This patch adds meaningful and proper reference name under file
ManagingFailover.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Iaa9324e2b76ab3a4a9dd160a17bcd6113723e7b6
Reviewed-on: https://review.whamcloud.com/43354
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-394 manual: Add meaningful ref names under TroubleShootingRecovery.xml 55/43355/2
Arshad Hussain [Wed, 14 Apr 2021 05:06:42 +0000 (10:36 +0530)]
LUDOC-394 manual: Add meaningful ref names under TroubleShootingRecovery.xml

This patch adds meaningful and proper reference name under file
TroubleShootingRecovery.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I939a50eff6f062cd58a16d66f51339608a194601
Reviewed-on: https://review.whamcloud.com/43355
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-394 manual: Add meaningful ref names under LustreTuning.xml 56/43356/2
Arshad Hussain [Wed, 14 Apr 2021 04:21:32 +0000 (09:51 +0530)]
LUDOC-394 manual: Add meaningful ref names under LustreTuning.xml

This patch adds meaningful and proper reference name under file
LustreTuning.xml.

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Ib0c904174535f3a9488984fc78b520ba5dcec8d9
Reviewed-on: https://review.whamcloud.com/43356
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-394 manual: Add meaningful ref names under InstallingLustre.xml 57/43357/2
Arshad Hussain [Wed, 14 Apr 2021 06:08:55 +0000 (11:38 +0530)]
LUDOC-394 manual: Add meaningful ref names under InstallingLustre.xml

This patch adds meaningful and proper reference name under file
InstallingLustre.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Iba960a961d20a2fecc80e3627d7e1280146a29b7
Reviewed-on: https://review.whamcloud.com/43357
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-394 manual: Add meaningful ref names under UpgradingLustre.xml 58/43358/2
Arshad Hussain [Wed, 14 Apr 2021 06:28:25 +0000 (11:58 +0530)]
LUDOC-394 manual: Add meaningful ref names under UpgradingLustre.xml

This patch adds meaningful and proper reference name under file
UpgradingLustre.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I8fb80355cbdedd94fcd292f642ed4ee4a0a15892
Reviewed-on: https://review.whamcloud.com/43358
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-11 proc: minor clarification of readahead params 82/43282/2
Andreas Dilger [Mon, 12 Apr 2021 20:37:04 +0000 (14:37 -0600)]
LUDOC-11 proc: minor clarification of readahead params

Improve wording for max_read_ahead_mb and max_read_ahead_per_file_mb
to make it clear what each one is applied to.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ic11a220499198c7bf3d1485d9ed62033c6ef0be3
Reviewed-on: https://review.whamcloud.com/43282
Tested-by: jenkins <devops@whamcloud.com>
5 months agoLUDOC-373 manual: Add section on Lustre xattrs 08/42108/4
Arshad Hussain [Fri, 19 Mar 2021 09:27:36 +0000 (14:57 +0530)]
LUDOC-373 manual: Add section on Lustre xattrs

This patch adds a section on lustre attrs

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I29c888390490701b1bafbfc078a2d3ddcf3cb42c
Reviewed-on: https://review.whamcloud.com/42108
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
6 months agoLUDOC-394 manual: Add meaningful ref names under ConfiguringLustre.xml 70/42070/2
Arshad Hussain [Thu, 18 Mar 2021 05:35:38 +0000 (11:05 +0530)]
LUDOC-394 manual: Add meaningful ref names under ConfiguringLustre.xml

Currently, the reference names are auto-generated and obscure
This patch adds meaningful and proper reference name under file
ConfiguringLustre.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Iea3660fe956aa680919751fc646e6925655e1ac5
Reviewed-on: https://review.whamcloud.com/42070
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
6 months agoLUDOC-488 fallocate: Add fallocate tuning information 11/41711/4
Arshad Hussain [Mon, 22 Feb 2021 04:18:40 +0000 (09:48 +0530)]
LUDOC-488 fallocate: Add fallocate tuning information

This patch adds section on how to tune/enable/disable fallocate for
ldiskfs OSTs.

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Ic4c2f8cdff188973cfe1aeb9aac322aa3c3bdb69
Reviewed-on: https://review.whamcloud.com/41711
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
6 months agoLUDOC-322 sec: reinstate Kerberos doc 25/41425/3
Sebastien Buisson [Fri, 5 Feb 2021 13:32:10 +0000 (14:32 +0100)]
LUDOC-322 sec: reinstate Kerberos doc

This patch adds documentation for Kerberos support in Lustre. This is
adapted and updated from the original Lustre user manual.
This doc is added under the Managing Security in a Lustre File System
section.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I430b99d2d11e034347021337b00e063158d7ef4f
Reviewed-on: https://review.whamcloud.com/41425
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
7 months agoLUDOC-458 setup: update ldiskfs MDT inode ratios 92/41392/2
Andreas Dilger [Tue, 2 Feb 2021 18:51:20 +0000 (11:51 -0700)]
LUDOC-458 setup: update ldiskfs MDT inode ratios

Update the documented MDT inode ratios for the current defaults
used by mkfs.lustre for ldiskfs since Lustre 2.10.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Iaf45a1f6d9c4084b6de2f408f7352be34325e017
Reviewed-on: https://review.whamcloud.com/41392
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Cliff White <cwhite@ddn.com>
7 months agoLUDOC-460 quota: statfs functionality for project quota 12/41412/2
Wang Shilong [Thu, 4 Feb 2021 08:33:52 +0000 (16:33 +0800)]
LUDOC-460 quota: statfs functionality for project quota

Document the project quota functionality for "df"
and "lfs df" when being run on a directory with project
quota assigned. This will return the amount of space
available to that project rather the total filesystem
space, if the project quota limit is smaller.

Signed-off-by: Wang Shilong <wshilong@ddn.com>
Change-Id: I33097e508fd9801be63f6aeaa8fa1c6ea586a5ea
Reviewed-on: https://review.whamcloud.com/41412
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
7 months agoLUDOC-419 utils: document 'lfs df' flags 73/41273/2
Andreas Dilger [Wed, 20 Jan 2021 02:18:41 +0000 (19:18 -0700)]
LUDOC-419 utils: document 'lfs df' flags

Document the options and flags for 'lfs df'.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I15f8d018d31005a87eb129b4510d386fd33ebbe5
Reviewed-on: https://review.whamcloud.com/41273
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: johann peyrard <yoyz2k@yahoo.fr>
8 months agoLUDOC-484 misc: add identity_flush documentation 40/41040/2
Andreas Dilger [Fri, 18 Dec 2020 02:13:12 +0000 (19:13 -0700)]
LUDOC-484 misc: add identity_flush documentation

Add a description of the mdt.*.identity_flush parameter.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I92b72e6a06bc0e31c2e27fa05aeec67b9c3ebbe5
Reviewed-on: https://review.whamcloud.com/41040
Tested-by: jenkins <devops@whamcloud.com>
8 months agoLUDOC-462 mdt: doc for directory restripe and auto-split 60/41060/5
Lai Siyao [Fri, 18 Dec 2020 15:03:22 +0000 (23:03 +0800)]
LUDOC-462 mdt: doc for directory restripe and auto-split

Document for directory restripe and auto-split, which is implemented
in LU-11025.

Change-Id: If3b4781cad79eef0678bca98046e15255d150c88
Signed-off-by: Lai Siyao <lai.siyao@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/41060
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
8 months agoLUDOC-11 misc: update URLs from http to https 84/39584/7
Andreas Dilger [Wed, 15 Jul 2020 17:11:45 +0000 (11:11 -0600)]
LUDOC-11 misc: update URLs from http to https

Change URLs in the manual to use https:// from http:// and update
those URLs to new targets where they no longer exist.

Since some of the URL updates are also related to cross-references
to labels within the document, update those labels to have useful
names, rather than the automatically-generated reference names.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Id3f195ceebbe269a10e3218835f855ff1d3ebbe5
Reviewed-on: https://review.whamcloud.com/39584
Reviewed-by: Peter Jones <pjones@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
8 months agoLUDOC-477 sec: fix kernel version for client encryption 46/41046/3
Sebastien Buisson [Fri, 18 Dec 2020 08:16:24 +0000 (09:16 +0100)]
LUDOC-477 sec: fix kernel version for client encryption

For distros explicitly listed in the doc, we use the embedded fscrypt
lib that we have copied and included in the Lustre source tree,
because these distros have not backported fscrypt v2.

Fixes: 1791cdb ("LUDOC-477 sec: doc for client-side encryption")
Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I325438d29b765120aa58187730c33e08f8a8e340
Reviewed-on: https://review.whamcloud.com/41046
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
9 months agoLUDOC-457 proc: add new IO tunable parameters 19/40819/6
Andreas Dilger [Tue, 1 Dec 2020 19:17:29 +0000 (12:17 -0700)]
LUDOC-457 proc: add new IO tunable parameters

Add descriptions for readcache_max_file_size, readcache_max_io_mb,
and writethrough_max_io_mb.  With DoM these parameters are applicable
to both the MDS and OSS, so change the description from "OSS Cache"
to "Server Cache".

Remove use of deprecated "obdfilter.*.*" parameter names.

Explain that some parameters do not apply to osd-zfs.

Wrap modified lines to be within 80 columns.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I09ae0dea50095ad2a3b74f0f0dfe5dfba537fdc3
Reviewed-on: https://review.whamcloud.com/40819
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Olaf Faaland-LLNL <faaland1@llnl.gov>
9 months agoLUDOC-479 lnet: Clarify transmit and routing credits 43/40143/3
Amir Shehata [Mon, 5 Oct 2020 18:31:18 +0000 (11:31 -0700)]
LUDOC-479 lnet: Clarify transmit and routing credits

Updated the explanation of transmit and routing credits to make
them more in line with what is actually implemented in the code.

Change-Id: I912f39167afb4e50271362ed41b7ec6475c96370
Signed-off-by: Amir Shehata <ashehata@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/40143
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
9 months agoLUDOC-477 sec: doc for client-side encryption 02/39602/7
Sebastien Buisson [Fri, 7 Aug 2020 15:48:01 +0000 (17:48 +0200)]
LUDOC-477 sec: doc for client-side encryption

This patch adds documentation for the client-side encryption
feature, as implemented by LU-12275.
This doc is added under the Managing Security in a Lustre File System
section.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I7fac0591faef517f7e74d055d7845a94246b6ffc
Reviewed-on: https://review.whamcloud.com/39602
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
9 months agoLUDOC-467 quota: add ost pool quotas 14/38414/7
Sergey Cheremencev [Wed, 29 Apr 2020 12:32:57 +0000 (15:32 +0300)]
LUDOC-467 quota: add ost pool quotas

Add documentation for ost pool quotas.

Change-Id: I6b2facc8eb4f10b4c3d232d1bad5b369b67f096e
Signed-off-by: Sergey Cheremencev <sergey.cheremencev@hpe.com>
Reviewed-on: https://review.whamcloud.com/38414
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
12 months agoLU-944 misc: update max_cached_mb reference 25/39825/2
Andreas Dilger [Fri, 4 Sep 2020 04:29:15 +0000 (22:29 -0600)]
LU-944 misc: update max_cached_mb reference

Fix a typo max_cache_mb -> max_cached_mb, and update the documented
default value from 3/4 of client RAM to 1/2, which has been the
case since 2.6.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Icfd269e18e52f6df27f681b4dc850d66023ebbe5
Reviewed-on: https://review.whamcloud.com/39825
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Vikentsi Lapa <vlapa@whamcloud.com>
13 months agoLU-8066 misc: replace remaining /proc access with lctl 78/39578/4
Andreas Dilger [Wed, 5 Aug 2020 08:58:46 +0000 (02:58 -0600)]
LU-8066 misc: replace remaining /proc access with lctl

Replace most remaining parameter access references with calls to
"lctl get_param" or "lctl set_param", since these aprameters are
moved as needed to meet upstream kernel requirements.

The last few stragglers are in the output of specific tools that
will need to be fixed before their output will be correct.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I4bbd7bf1bcbe8dadf612daa4917af337d23ebbe5
Reviewed-on: https://review.whamcloud.com/39578
Reviewed-by: Ben Evans <beevans@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
13 months agoLUDOC-11 setup: update limits for new releases 08/39208/4
Andreas Dilger [Sun, 28 Jun 2020 22:25:46 +0000 (16:25 -0600)]
LUDOC-11 setup: update limits for new releases

Update the filesystem limits based on recent changes.
- directory size limits for ldiskfs increase due to large_dir
- maximum OST size limits increase due to recent fixes
- reference ARM for large pages instead of ancient IA64

Add/improve related cross-reference label names, which improves
the visible URL names in the HTML version of the manual.

Signed-off-by: Andreas Dilger <adilger@dilger.ca>
Change-Id: I793b1a8a657bc3470f17c983a98404dcaf3ebbe5
Reviewed-on: https://review.whamcloud.com/39208
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
13 months agoLUDOC-11 misc: remove references for older Lustre 11/39511/9
Andreas Dilger [Thu, 23 Jul 2020 00:28:22 +0000 (18:28 -0600)]
LUDOC-11 misc: remove references for older Lustre

Remove references to Lustre 2.4 and earlier from the manual.
There were even places with referencs to Lustre 1.8 and 2.0.

The text still exists in earlier builds and in Git for reference.
This avoids confusing users with commands that no longer exist,
or highlighting features that are included with all releases.

Add conditions for Lustre 2.15 and 2.16 as they will be used soon.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I0786d88fcc2543f542b7a880bf042928fd3ebbe5
Reviewed-on: https://review.whamcloud.com/39511
Tested-by: jenkins <devops@whamcloud.com>
13 months agoLUDOC-11 misc: fix vim footer formatting 93/39593/2
Andreas Dilger [Thu, 6 Aug 2020 23:24:59 +0000 (17:24 -0600)]
LUDOC-11 misc: fix vim footer formatting

Fix the formatting for the vim expandtab hint to avoid a warning.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ia40dcf7f2fe2034ba5dc5d840ba4c6f1c93ebbe5
Reviewed-on: https://review.whamcloud.com/39593
Tested-by: jenkins <devops@whamcloud.com>
13 months agoLUDOC-11 misc: unify header and add vim footer 82/39582/2
Andreas Dilger [Wed, 15 Jul 2020 17:11:45 +0000 (11:11 -0600)]
LUDOC-11 misc: unify header and add vim footer

Make the header sections consistent and wrapped at 80 columns.
The xmlns URLs cannot be changed to https or the markup breaks.

Add a vim footer to expand tabs into spaces for consistency.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Ib871575ba2ede8e73b35b4683abf35e5db3ebbe5
Reviewed-on: https://review.whamcloud.com/39582
Tested-by: jenkins <devops@whamcloud.com>
13 months agoLUDOC-475 quota: notes about lfs commands 51/39451/3
Vikentsi Lapa [Mon, 20 Jul 2020 12:23:07 +0000 (12:23 +0000)]
LUDOC-475 quota: notes about lfs commands

Update documentation according to changes in LU-1842.
Remove lsf commands quotachown, quotainv.
Update documentation according to changes in LU-5975.
Remove lsf commands quotacheck, quotaon, quotaoff.

Signed-off-by: Vikentsi Lapa <vlapa@whamcloud.com>
Change-Id: If0b823cf436a8154588ff2056a50fbdb247ad977
Reviewed-on: https://review.whamcloud.com/39451
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
16 months agoLUDOC-11 misc: remove pre-2.5 conditional text 64/38364/4
Andreas Dilger [Sat, 25 Apr 2020 08:04:39 +0000 (02:04 -0600)]
LUDOC-11 misc: remove pre-2.5 conditional text

Remove conditional text in the manual for Lustre versions earlier
than 2.5.  It is unlikely that many of the changes in the newer
manual are relevant to such old releases, and they would be better
off using the old manual, if needed.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I82972511a5a53cae0170d37ec422e0ef2fa7dfce
Reviewed-on: https://review.whamcloud.com/38364
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: James Nunez <jnunez@whamcloud.com>
16 months agoLUDOC-469 hsm: correct description of NBR HSM policy 97/38497/2
John L. Hammond [Tue, 5 May 2020 13:56:31 +0000 (08:56 -0500)]
LUDOC-469 hsm: correct description of NBR HSM policy

Correct the description of the Non-Blocking Restore HSM policy.

Signed-off-by: John L. Hammond <jhammond@whamcloud.com>
Change-Id: I0b58bcef3623cf19d067cfb64093176bc40c93ce
Reviewed-on: https://review.whamcloud.com/38497
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Aurelien Degremont <degremoa@amazon.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
18 months agoLU-10391 lnet: document the accept= parameter properly 99/37699/6
Andreas Dilger [Tue, 25 Feb 2020 02:27:08 +0000 (19:27 -0700)]
LU-10391 lnet: document the accept= parameter properly

The lnet "accept=" module parameter was incorrectly documented
as "acceptor" in the manual, even though that has never existed.

Add a subsection for the "accept" parameter, as well as the
"ip2nets" parameter to make the formatting more consistent with
the rest of this section.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I3a8d7d862172a3ced899aafbc0cff38ae73ebbe5
Reviewed-on: https://review.whamcloud.com/37699
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Aurelien Degremont <degremoa@amazon.com>
Reviewed-by: Serguei Smirnov <ssmirnov@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
18 months agoLUDOC-465 misc: fix typo in --mode to be 0666 16/37716/2
Joseph Gmitter [Tue, 25 Feb 2020 13:39:13 +0000 (08:39 -0500)]
LUDOC-465 misc: fix typo in --mode to be 0666

This trivial patch changes a typo for the --mode option
to use 'zero' instead of 'capital-O' in 0666.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I1b9e5ed0b096f57d9713adf0a42405e9e2ea1036
Reviewed-on: https://review.whamcloud.com/37716
Tested-by: jenkins <devops@whamcloud.com>
18 months agoLUDOC-465 foreign: Add foreign LOV/LMV documentation 25/37425/2
Bruno Faccini [Tue, 4 Feb 2020 09:45:04 +0000 (10:45 +0100)]
LUDOC-465 foreign: Add foreign LOV/LMV documentation

Description of and usage information for the foreign
LOV/LMV format that has been introduced by patches
for LU-11376.

Signed-off-by: Bruno Faccini <bruno.faccini@intel.com>
Change-Id: Icf171598c52e49f2b5611c1861498baf8ec50aa6
Reviewed-on: https://review.whamcloud.com/37425
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Wang Shilong <wshilong@ddn.com>
19 months agoLUDOC-11 misc: correct location/setting qos_threshold_rr 95/36695/3
James Nunez [Wed, 6 Nov 2019 22:40:54 +0000 (15:40 -0700)]
LUDOC-11 misc: correct location/setting qos_threshold_rr

The parameter qos_threshold_rr has moved from /sys/fs/.../lov
to lod and, to set this parameter, the command 'lctl set_param'
command should be run on the MDS.  These two things need to be
corrected in the manual.

Change-Id: Ide6d809d2d36e36504d014fb511df82ada80d977
Signed-off-by: James Nunez <jnunez@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/36695
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
20 months agoLUDOC-11 misc: fix typo in lru_size=clear command 53/37153/2
Stephane Thiell [Tue, 7 Jan 2020 18:56:58 +0000 (10:56 -0800)]
LUDOC-11 misc: fix typo in lru_size=clear command

Fix a small typo in the command to flush the xattr cache from the
client by cancelling the MDC locks.

Signed-off-by: Stephane Thiell <sthiell@stanford.edu>
Change-Id: I449a1471414ed3195f6cbb4bd21691a0470eff90
Reviewed-on: https://review.whamcloud.com/37153
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Joseph Gmitter <jgmitter@whamcloud.com>
22 months agoLUDOC-441 lnet: Add Multi-Rail Routing Documentation 73/36573/7 2.13.0
Joseph Gmitter [Fri, 25 Oct 2019 02:33:01 +0000 (22:33 -0400)]
LUDOC-441 lnet: Add Multi-Rail Routing Documentation

This patch adds the feature documentation for the LNet Health
based routing work landed in LU-11297.

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: Id41cf9b16b142a0e6fb797b560a3a553714ff1fd
Reviewed-on: https://review.whamcloud.com/36573
Tested-by: jenkins <devops@whamcloud.com>
22 months agoLUDOC-442 dne: directory creation by space/inode 15/36615/6
Joseph Gmitter [Wed, 30 Oct 2019 14:51:03 +0000 (10:51 -0400)]
LUDOC-442 dne: directory creation by space/inode

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

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

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

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

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

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

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

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

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

Recommend against any cache onboard internal HBA devices.

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

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

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

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

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

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

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

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

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

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

Fix spelling of significant

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

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

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

Add documentation for default quota.

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

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

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

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

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

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

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

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

Fix minor typo in description of e2fsck times.

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

Add overstriping to Lustre manual.

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

Set condition on lfsck_query to be Lustre 2.9

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

Change "completely quite" to quiescent.

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

Fix verb tense.

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

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

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

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

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

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

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

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

Lustre version was not properly set in a few places.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Adds a note to mention nodemaps as an alternative.

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

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

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

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

Clarify the description of DoM usage and limits.

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

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

Improve the description and formatting of lru_size as well.

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

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

Improve content in affected sections of the manual.

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

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

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

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

Clean up the existing parameter sections to be more consistent.

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

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

Create the PFL layout with a more typical configuration.

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

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

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

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

Signed-off-by: Joseph Gmitter <jgmitter@whamcloud.com>
Change-Id: I3fac1dc28e96c34d286f9b14e8cd2b46acb87f53
Reviewed-on: https://review.whamcloud.com/33075
Tested-by: Jenkins
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>