From ca34df3815f7945dc2cbf92ac0f739972f24aba3 Mon Sep 17 00:00:00 2001 From: Andreas Dilger Date: Wed, 12 Dec 2018 01:49:00 -0700 Subject: [PATCH] LU-930 doc: man pages for lctl pool_new, pool_add Add man pages for lctl pool_new and lctl pool_add. More pages are needed for other commands, pool_remove, pool_destroy, and pool_list. Test-Parameters: trivial Signed-off-by: Andreas Dilger Change-Id: Ie7cbb80d28610b9f74fe8f58c74c37a72e3ebbe5 Reviewed-on: https://review.whamcloud.com/34524 Reviewed-by: Joseph Gmitter Reviewed-by: Patrick Farrell Tested-by: Jenkins Reviewed-by: Sergey Cheremencev Tested-by: Maloo Reviewed-by: Oleg Drokin --- lustre/doc/lctl-pool_add.8 | 71 ++++++++++++++++++++++++++++++++++++++++++++++ lustre/doc/lctl-pool_new.8 | 48 +++++++++++++++++++++++++++++++ lustre/doc/lfs-df.1 | 2 +- 3 files changed, 120 insertions(+), 1 deletion(-) create mode 100644 lustre/doc/lctl-pool_add.8 create mode 100644 lustre/doc/lctl-pool_new.8 diff --git a/lustre/doc/lctl-pool_add.8 b/lustre/doc/lctl-pool_add.8 new file mode 100644 index 0000000..7c168cf --- /dev/null +++ b/lustre/doc/lctl-pool_add.8 @@ -0,0 +1,71 @@ +.TH LCTL-POOL_ADD 8 2018-10-27 "Lustre" "Lustre Utilities" +.SH NAME +lctl pool_add \- add OSTs to a named pool +.SH SYNOPSIS +.B lctl pool_add \fI.\fR \fI ...\fR +.br +.B lctl pool_add \fI.\fR \fI ...\fR + +.SH DESCRIPTION +Add one or more OSTs to the pool named +.I poolname +in the filesystem named +.IR fsname . +There are several formats that the OSTs can be specified. Simplest is +to just specify a list of +.RI < ost_index > +numbers or OST names. It is also possible to specify an +.RI < ost_range > +expression of the form +.BI [ start - end ] +or +.BI [ start - end / step ] +that adds multiple OSTs with index numbers in the range from +.I start +to +.I end +(inclusive), optionally skipping every +.I step +index values. The +.B lctl pool_add +command must be run on the MGS node and can only be used by the +root user. If the MGS is on a separate node from the MDS, a +Lustre client must be mounted while the +.B lctl +commands are being run. + +The OST pool can be used by +.BR lfs-setstripe (1) +to specify the OSTs on which new files can be created, and +.BR lfs-find (1) +to locate files that were initially created on the specified +.IR poolname . +Note however, that the OSTs that make up a specific pool may change +over time, and it is the +.I poolname +used at creation time that is stored on each file, not necessarily +OSTs that are in the current pool. As well, +.BR lfs-df (1) +can show only the free space or inodes in a named pool. + +.SH EXAMPLES +.TP +.B # lfs pool_new testfs.local +Create a pool named +.B local +in the +.B testfs +filesystem. +.TP +.B # lfs pool_add testfs.local 12 13 14 +Add OSTs numbered 12, 13, and 14 to the +.B testfs.local +pool. + +.SH SEE ALSO +.BR lctl (8), +.BR lctl-pool_new (8), +.BR lfs-df (1), +.BR lfs-find (1), +.BR lfs-setstripe (1), +.BR lustre (7) diff --git a/lustre/doc/lctl-pool_new.8 b/lustre/doc/lctl-pool_new.8 new file mode 100644 index 0000000..97d541e --- /dev/null +++ b/lustre/doc/lctl-pool_new.8 @@ -0,0 +1,48 @@ +.TH LCTL-POOL_NEW 8 2018-10-27 "Lustre" "Lustre Utilities" +.SH NAME +lctl pool_new \- create a new OST pool +.SH SYNOPSIS +.B lctl pool_new \fI.\fR + +.SH DESCRIPTION +Create a list of OSTs with the name +.I poolname +in the filesystem named +.IR fsname . +The +.B lctl pool_new +command must be run on the MGS node and can only be used by the +root user. If the MGS is on a separate node from the MDS, a +Lustre client must be mounted while the +.B lctl +commands are being run. + +This named list of OSTs can be used by +.BR lfs-setstripe (1) +to specify the OSTs on which new files can be created, and +.BR lfs-find (1) +to locate files that were created on the specified pool. As well, +.BR lfs-df (1) +can show only the free space or inodes in a named pool. + +.SH EXAMPLES +.TP +.B # lfs pool_new testfs.local +Create a pool named +.B local +in the +.B testfs +filesystem. +.TP +.B # lfs pool_add testfs.local 12 13 14 +Add OSTs numbered 12, 13, and 14 to the +.B testfs.local +pool. + +.SH SEE ALSO +.BR lctl (8), +.BR lctl-pool_add (8), +.BR lfs-df (1), +.BR lfs-find (1), +.BR lfs-setstripe (1), +.BR lustre (7) diff --git a/lustre/doc/lfs-df.1 b/lustre/doc/lfs-df.1 index 1ca7b73..7c96492 100644 --- a/lustre/doc/lfs-df.1 +++ b/lustre/doc/lfs-df.1 @@ -113,7 +113,7 @@ the client. This avoids blocking the output if a target is offline or unreachable, and only returns the space on OSTs that can currently be accessed. .TP -.BR -p ", " --pool=\fR[\fIfsname\fR.]\fIpool +.BR -p ", " --pool= [ \fIfsname\fR .] \fIpool\fR Limit the usage to report only MDTs and OSTs that are in the specified .IR pool . If multiple filesystems are mounted, list OSTs in -- 1.8.3.1