Whamcloud - gitweb
doc/manual.git
7 weeks agoLUDOC-394 manual: Remove extra 'held' word 70/54170/2 master
Arshad Hussain [Mon, 19 Feb 2024 07:51:05 +0000 (13:21 +0530)]
LUDOC-394 manual: Remove extra 'held' word

This patch removes extra 'held' word from
Section 'I' under glossary.xml

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Icd9b631b54f83a5416d8724584381a57677a9859
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/54170
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 months agoLU-16228 utils: update jobstats section 48/53948/2
Andreas Dilger [Wed, 7 Feb 2024 01:17:41 +0000 (18:17 -0700)]
LU-16228 utils: update jobstats section

Describe the "jobid_name=session" option more completely.

Add a description of the "lljobstats" utility.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I2bb678f8caa015cf773ccbf020fa0d1a593553c9
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/53948
Tested-by: jenkins <devops@whamcloud.com>
2 months agoLUDOC-524 SEL: added spill counter info 16/53816/3
Rajeev Mishra [Wed, 24 Jan 2024 21:55:59 +0000 (21:55 +0000)]
LUDOC-524 SEL: added spill counter info

This change was made as part of LU-15011
spill hit counter was added as part of
this change

Signed-off-by: Rajeev Mishra <rajeevm@hpe.com>
Change-Id: Ia102f9143be17484cd374b17eed2728510a14162
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/53816
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
3 months agoLU-17428 doc: remove default value for lru_age_max 84/53684/2
Andreas Dilger [Tue, 16 Jan 2024 09:36:19 +0000 (02:36 -0700)]
LU-17428 doc: remove default value for lru_age_max

The actual value of lru_max_age doesn't need to be documented in
the manual, since it is different in various Lustre versions.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I910c2da31c3baaa1017a52869046faf9693ebbe5
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/53684
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Aurelien Degremont <adegremont@nvidia.com>
4 months agoLUDOC-521 pcc: fix mistake in example 80/53180/3
Lei Feng [Mon, 20 Nov 2023 00:52:47 +0000 (08:52 +0800)]
LUDOC-521 pcc: fix mistake in example

The value of uid in pcc param should be embranced in {}.

Signed-off-by: Lei Feng <flei@whamcloud.com>
Change-Id: Ie7fbf69790490681569e55461d9d38b026158ce9
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/53180
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-11 misc: remove old tools from manual 68/53168/4
Andreas Dilger [Fri, 17 Nov 2023 07:57:10 +0000 (00:57 -0700)]
LUDOC-11 misc: remove old tools from manual

Remove old tools from the manual.

Remove extents_stats and stats_track_* parameters since they are
already described in the "Monitoring Client Activity" section.

Some formatting cleanup of nearby sections.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I608c645694ad1c85ed2f0c8d2835856807d0be3c
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/53168
Tested-by: jenkins <devops@whamcloud.com>
5 months agoLUDOC-11 glossary: update glossary definitions 66/53166/2
Andreas Dilger [Fri, 17 Nov 2023 07:29:20 +0000 (00:29 -0700)]
LUDOC-11 glossary: update glossary definitions

Update several definitions to better reflect current usage, and remove
some obsolete terms that are no longer used in the manual.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I27a6d1950f7f963a37b1151513c4a5713409d355
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/53166
Tested-by: jenkins <devops@whamcloud.com>
5 months agoLUDOC-11 utils: remove obsolete utilities 65/53165/2
Andreas Dilger [Fri, 17 Nov 2023 06:31:35 +0000 (23:31 -0700)]
LUDOC-11 utils: remove obsolete utilities

Remove the descriptions of obsolete userspace utilities:
- e2scan removed in 2011 when LFSCK was written?
- ll_recover_lost_found_objs removed in Lustre 2.8
- plot_llstat removed some time ago, not sure when

Fix a typo in the lshowmount section name.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: If029e949b9ea46ca30752dc7b59f76378b3ebbe5
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/53165
Tested-by: jenkins <devops@whamcloud.com>
5 months agoLU-15246 params: document per-device timeouts 45/52945/2
Andreas Dilger [Thu, 2 Nov 2023 02:53:02 +0000 (20:53 -0600)]
LU-15246 params: document per-device timeouts

Add a mention of per-device at_min, at_max, at_history,
and ldlm_enqueue_min.

Some reformatting of the timeout-related text to wrap at 80 cols.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I42557e708950d729a55e0ed17d424965c6dbc357
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/52945
Tested-by: jenkins <devops@whamcloud.com>
5 months agoLUDOC-516 sec: doc update for 'readonly_mount' nm property 62/51862/2
Sebastien Buisson [Thu, 3 Aug 2023 09:22:23 +0000 (11:22 +0200)]
LUDOC-516 sec: doc update for 'readonly_mount' nm property

This patch updates the "Managing the Properties" section of the Lustre
Operations Manual to introduce the 'readonly_mount' nodemap property
as implemented by LU-15451.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I8d9760e87c3b63306c0ccc753daf3c038e2c90ff
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/51862
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLUDOC-515 sec: doc update for 'rbac' nodemap property 38/51838/3
Sebastien Buisson [Tue, 1 Aug 2023 13:02:34 +0000 (15:02 +0200)]
LUDOC-515 sec: doc update for 'rbac' nodemap property

This patch updates the "Managing the Properties" section of the Lustre
Operations Manual to introduce the 'rbac' nodemap property as
implemented by LU-16524.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I27beea5b36748e13b11ca3872b77af650ce3704a
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/51838
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
5 months agoLU-7004 utils: prefer 'set_param -P' over 'conf_param' 53/52553/3
Andreas Dilger [Fri, 29 Sep 2023 00:42:10 +0000 (18:42 -0600)]
LU-7004 utils: prefer 'set_param -P' over 'conf_param'

Replace examples using "lctl conf_param" with "lctl set_param -P"
since this has been available since Lustre 2.5 and is the easier
interface to use.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I9d534355d476a27d1bfba388a8269d3f4b3ebbe5
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/52553
Tested-by: jenkins <devops@whamcloud.com>
6 months agoLUDOC-511 pool: reserved poolname "inherit" and "ignore" 12/52712/3
Etienne AUJAMES [Mon, 16 Oct 2023 15:08:40 +0000 (17:08 +0200)]
LUDOC-511 pool: reserved poolname "inherit" and "ignore"

Add documentation for the special/reserved poolname "inherit" and
"ignore".

These reserved names were added by the patch:
https://review.whamcloud.com/46955 ("LU-15707 lod: force creation of a
component without a pool")

Change-Id: I411a810ed79c9d647d7d9a5e59066d33abb9ee21
Signed-off-by: Etienne AUJAMES <eaujames@ddn.com>
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/52712
Tested-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
6 months agoLUDOC-11 dne: fix examples for default dir layout 52/52552/2
Andreas Dilger [Fri, 29 Sep 2023 00:25:30 +0000 (18:25 -0600)]
LUDOC-11 dne: fix examples for default dir layout

Improve wording around default directory layouts, and discourage the
use of default striped directories.

Fix the examples given for enabling default directory layouts
during upgrade to actually include the "-D" option.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I13dee2b7fc4d80db4ac9e33a193cc3a4773ebbe5
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/52552
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Lai Siyao <lai.siyao@whamcloud.com>
7 months agoLUDOC-518 quota: change conf_param to set_param 76/52276/3
Andreas Dilger [Tue, 5 Sep 2023 16:05:13 +0000 (10:05 -0600)]
LUDOC-518 quota: change conf_param to set_param

Updatee quota enabling commands to use "lctl set_param -P" since
conf_param is deprecated for a while already.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I5ed236dc073492b18ba3dda461050468c29f7626
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/52276
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Sergey Cheremencev <scherementsev@ddn.com>
8 months agoQualify use of _netdev, recommend x-systemd.requires 48/50048/2
Laura Hild [Fri, 17 Feb 2023 16:32:33 +0000 (11:32 -0500)]
Qualify use of _netdev, recommend x-systemd.requires

Signed-off-by: Laura Hild <lsh@jlab.org>
Change-Id: I2d6aa0a1669d0095c7860904dc60508a606c9afa
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/50048
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
8 months agoLUDOC-499 LNet health: fix bad formula 18/45618/3
Cyril Bordage [Thu, 18 Nov 2021 23:33:41 +0000 (00:33 +0100)]
LUDOC-499 LNet health: fix bad formula

The formula for lnet_lnd_timeout is wrong. It should be
lnet_lnd_timeout = (lnet_transaction_timeout-1) / (retry_count+1)
Also, some default values were fixed.

Change-Id: I742a8a56ab0e49e68668db5d13170415a2306e4a
Signed-off-by: Cyril Bordage <cbordage@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/45618
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
8 months agoLUDOC-494 lnet: clarify use of route hopcount 16/44916/6
Serguei Smirnov [Tue, 14 Sep 2021 19:23:35 +0000 (12:23 -0700)]
LUDOC-494 lnet: clarify use of route hopcount

Clarify that the default route hop setting is "undefined" (-1).
The default hopcount is interpreted as 1 when comparing routes
as part of the route selection procedure when sending.
The default hop setting may be used to create single-hop and
multi-hop routes.

Provide example to illustrate the case when hopcount should be set:
If avoid_asym_router_failure feature is enabled and single-hop
router NIs on the remote network fail to come up, using the default
hopcount will cause the route to be misinterpreted as multi-hop
and the router will still be selected for sending.

To avoid this case, set hop=1 if avoid_asym_router_failure
is enabled.

Signed-off-by: Serguei Smirnov <ssmirnov@whamcloud.com>
Change-Id: Ic0b97000b22389bb6950ad48070dd7d7682f9c56
Signed-off-by: Gian-Carlo DeFazio <defazio1@llnl.gov>
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/44916
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Olaf Faaland <faaland1@llnl.gov>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
8 months agoLUDOC-512 manual: add append_pool and append_stripe_count 25/49725/10
Cory Spitz [Fri, 20 Jan 2023 20:58:17 +0000 (14:58 -0600)]
LUDOC-512 manual: add append_pool and append_stripe_count

append_pool and append_stripe_count are recommend for O_APPEND

Signed-off-by: Cory Spitz <cory.spitz@hpe.com>
Change-Id: I132d0dc0438d33ecee3f80dd49b9b3e7a9e6a54e
Signed-off-by: Cory Spitz <cory.spitz@hpe.com>
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/49725
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Petros Koutoupis <petros.koutoupis@hpe.com>
Reviewed-by: Jian Yu <yujian@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
9 months agoLUDOC-514: add --acls and -P for MDT backup/restore 99/51599/3
Stephane Thiell [Thu, 6 Jul 2023 22:55:05 +0000 (15:55 -0700)]
LUDOC-514: add --acls and -P for MDT backup/restore

Tar will only restore the following xattr if --acls is provided:
system.posix_acl_access
system.posix_acl_default

Update the documentation to mention --acls for MDT backup/restore.

Lastly, using -P / --absolute-names speeds up tremendously the
extraction for trusted archive with hardlinks (like MDT backup
archives).

Signed-off-by: Stephane Thiell <sthiell@stanford.edu>
Change-Id: I9db6729c029580edaf77129fc752befb6f0dc9fb
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/51599
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
13 months agoLUDOC-513 zfs: Add example under ZFS snapshot config 77/50077/2
Arshad Hussain [Tue, 21 Feb 2023 12:12:29 +0000 (07:12 -0500)]
LUDOC-513 zfs: Add example under ZFS snapshot config

Add another example and explaination under
ZFS snapshot config section.

Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: I49dfd7f29a530127393ea965bebd3b0faf93b452
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/50077
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
17 months agoLUDOC-11 misc: minor corrections 53/49053/3
Felix Pusch [Sat, 29 Oct 2022 14:10:48 +0000 (16:10 +0200)]
LUDOC-11 misc: minor corrections

Signed-off-by: Felix Pusch <felix.pusch@studium.uni-hamburg.de>
Change-Id: I7782bc926d3c66f9246100754ac35bef73f90fad
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/49053
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
17 months agoLUDOC-505 sec: nodemap must be used for root squash 31/49031/2
Sebastien Buisson [Thu, 3 Nov 2022 16:18:05 +0000 (17:18 +0100)]
LUDOC-505 sec: nodemap must be used for root squash

Nodemap is the preferred way to implement root squash, so it should be
documented to use it instead of the legacy root squash mechanism.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: Ie453d843eced825b0e381f6a02cb2676bc8da3a1
Reviewed-on: https://review.whamcloud.com/c/doc/manual/+/49031
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
20 months agoLU-7668 misc: add support for versions 2.17/2.18 37/48237/2
Andreas Dilger [Wed, 17 Aug 2022 00:29:21 +0000 (18:29 -0600)]
LU-7668 misc: add support for versions 2.17/2.18

Add support to the manual for Lustre 2.17 and 2.18 to eventually
be used by "<para condition=l2H>" and "<para condition=l2I>" for
features eventually added in that version.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I9db9794c922d085dbce92d4d97871c6dff3e4a2a
Reviewed-on: https://review.whamcloud.com/48237
Tested-by: jenkins <devops@whamcloud.com>
20 months agoLU-7668 admin: reference the del_ost command 54/41454/8
Andreas Dilger [Tue, 9 Feb 2021 16:04:45 +0000 (09:04 -0700)]
LU-7668 admin: reference the del_ost command

Reference the new "lctl del_ost" command to remove the OST config
records from the config llogs on the MGS.

Signed-off-by: Andreas Dilger <adilger@dilger.ca>
Change-Id: Ic6281b92c22f7a4537b7e802ebadf9a2303ebbe5
Reviewed-on: https://review.whamcloud.com/41454
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
21 months agoLUDOC-11 security: remove client 'acl' mount option 67/47767/2
Andreas Dilger [Fri, 24 Jun 2022 16:38:06 +0000 (10:38 -0600)]
LUDOC-11 security: remove client 'acl' mount option

The 'acl' mount option on the client has been deprecated since
Lustre 1.8, and unsupported since Lustre 2.8.  It should no longer
be mentioned in the manual.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Iceb02088931ed291695c2eac824c673f79647e70
Reviewed-on: https://review.whamcloud.com/47767
Tested-by: jenkins <devops@whamcloud.com>
22 months agoLUDOC-11 misc: update limits to recent values 76/47676/2
Andreas Dilger [Fri, 17 Jun 2022 22:48:39 +0000 (16:48 -0600)]
LUDOC-11 misc: update limits to recent values

Frontier has 700PB storage, sites with 25B files, 40 MDTs.

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: If916bfae51a8ac1c8224435d2cc2e44049a3c3f0
Reviewed-on: https://review.whamcloud.com/47676
Tested-by: jenkins <devops@whamcloud.com>
22 months agoLUDOC-507 sec: clarify doc for enable_filename_encryption 21/47521/4
Sebastien Buisson [Fri, 3 Jun 2022 10:05:49 +0000 (12:05 +0200)]
LUDOC-507 sec: clarify doc for enable_filename_encryption

Clarify that enable_filename_encryption tuning parameter is only
available when Lustre client is built against embedded llcrypt.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I9100a512e774b2560f01e40fde75d434b1ecf646
Reviewed-on: https://review.whamcloud.com/47521
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
22 months agoLUDOC-506 sec: doc update for enable_filename_encryption 56/47356/3
Sebastien Buisson [Mon, 16 May 2022 12:38:44 +0000 (14:38 +0200)]
LUDOC-506 sec: doc update for enable_filename_encryption

This patch updates the "Encrypting files and directories" section of
the Lustre Operations Manual to introduce enable_filename_encryption
parameter as implemented by LU-15858.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: Ie77a9a2bcb83467c0e1d71f73bbf2ea38a2a80f7
Reviewed-on: https://review.whamcloud.com/47356
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 years agoLUDOC-500 quota: fix the default quota usage 06/46606/2
Andreas Dilger [Thu, 24 Feb 2022 22:28:43 +0000 (15:28 -0700)]
LUDOC-500 quota: fix the default quota usage

The "-d" short option for "--default" was deprecated in LU-15218
in favor of "-D".  This better matches "lfs setdirstripe -d" and
eventually opens up the use of "-d" for "--delete" in the future.

Document "--default" in the manual since this works with both old
and new Lustre releases.

Fixes: 3bf774f3d9a7 ("LUDOC-500 quota: fix the default quota usage")
Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I7a47ad7dd1df4788335d46e98282ed1f9e101f76
Reviewed-on: https://review.whamcloud.com/46606
Tested-by: jenkins <devops@whamcloud.com>
2 years agoLUDOC-504 nodemap: servers must be in a trusted+admin group 01/46801/3
Sebastien Buisson [Fri, 11 Mar 2022 16:16:53 +0000 (17:16 +0100)]
LUDOC-504 nodemap: servers must be in a trusted+admin group

Make it clear that Lustre requires a "TrustedSystems" nodemap covering
all servers, with both admin and trusted properties set.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I364557a5dc35abe597ae53658f1839c900863fbf
Reviewed-on: https://review.whamcloud.com/46801
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 years agoLUDOC-493 sec: update nodemap section for projid 24/44124/3
Sebastien Buisson [Thu, 1 Jul 2021 09:09:22 +0000 (11:09 +0200)]
LUDOC-493 sec: update nodemap section for projid

This patch adds documentation for the projid mapping feature,
as implemented by LU-14797.
This doc is added under the Mapping UIDs and GIDs with Nodemap
section.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: Ice2709847a07cd3ce02703317f6cc5ecd9a4bed3
Reviewed-on: https://review.whamcloud.com/44124
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 years agoLUDOC-500 quota: fix the default quota usage 96/45996/2
Hongchao Zhang [Fri, 7 Jan 2022 09:22:12 +0000 (17:22 +0800)]
LUDOC-500 quota: fix the default quota usage

Setting quota limits as "0" is to remove quota limits, option "-d"
should be used to set the quota ID to use default quota.

Change-Id: I39f3933ee8658f6f7a4b1d754e09dc22a5d2addb
Signed-off-by: Hongchao Zhang <hongchao@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/45996
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 years agoLUDOC-501 manual: add max_stripecount and max_mdt_stripecount 48/46548/9
Lei Feng [Fri, 18 Feb 2022 08:11:15 +0000 (16:11 +0800)]
LUDOC-501 manual: add max_stripecount and max_mdt_stripecount

Add the description of max_stripecount and max_mdt_stripecount.
Add the description of max-inherit and its default values.

Change-Id: I8a00f66eaa755eeeb270547f2d5da610aecd8590
Signed-off-by: Lei Feng <flei@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/46548
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
2 years agoLUDOC-495 dne: add filesystem-wide default directory striping 14/44714/3
Lai Siyao [Thu, 5 Aug 2021 08:36:16 +0000 (04:36 -0400)]
LUDOC-495 dne: add filesystem-wide default directory striping

Add description of filesystem-wide default directory striping.

Signed-off-by: Lai Siyao <lai.siyao@whamcloud.com>
Change-Id: Ib8d01d09e76896121bc2bca220b94889706a04a8
Reviewed-on: https://review.whamcloud.com/44714
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 years agoLUDOC-502 sec: doc update for filename encryption 94/46394/5
Sebastien Buisson [Mon, 31 Jan 2022 17:03:37 +0000 (18:03 +0100)]
LUDOC-502 sec: doc update for filename encryption

This patch updates the "Encrypting files and directories" section of
the Lustre Operations Manual to reflect filename encryption support
as implemented by LU-13717.

Signed-off-by: Sebastien Buisson <sbuisson@ddn.com>
Change-Id: I59cae29db3dfff6552d46c752870ade76c06d89f
Reviewed-on: https://review.whamcloud.com/46394
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 years agoLUDOC-496 nrs: Format of TBF rule name field is not defined 44/45144/3
Etienne AUJAMES [Thu, 7 Oct 2021 08:12:55 +0000 (10:12 +0200)]
LUDOC-496 nrs: Format of TBF rule name field is not defined

Lustre manual should define the format (alphanumeric + '_') and length
(15 characters) of a TBF rule name field.

This is important because there is buffer overflow for the TBF rule name
(LU-15059): the length is not checked by ptlrpc.

Change-Id: I29efb7e5891c0fba308b683bf92b26e4fefa7695
Signed-off-by: Etienne AUJAMES <eaujames@ddn.com>
Reviewed-on: https://review.whamcloud.com/45144
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
2 years agoLUDOC-393 quota: include lfs project interface 37/44137/5
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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
2 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
3 years 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>
4 years 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>
4 years 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>
4 years 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>
4 years 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>
4 years 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>
4 years 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>
4 years agoLUDOC-442 dne: directory creation by space/inode 15/36615/6
Joseph Gmitter [Wed, 30 Oct 2019 14:51:03 +0000 (10:51 -0400)]
LUDOC-442 dne: directory creation by space/inode

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

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

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

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

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

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

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

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

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

Recommend against any cache onboard internal HBA devices.

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

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

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

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

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

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

Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: Id14f19a9d31643d44038446b93edd944db6ca2fc
Reviewed-on: https://review.whamcloud.com/35996
Tested-by: jenkins <devops@whamcloud.com>