diff options
author | Prasanna Kumar Kalever <prasanna.kalever@redhat.com> | 2017-02-21 18:25:56 +0530 |
---|---|---|
committer | Prasanna Kumar Kalever <pkalever@redhat.com> | 2017-02-27 04:03:12 -0500 |
commit | 23c424c01bc58c477de513b297cf3b822166a069 (patch) | |
tree | 789a9083c514e100e81aab09609b05016b86c474 | |
parent | 58a376a080c80698a6c243b1dfe948c60ae16ac2 (diff) |
docs: add man page for gluster-block cli
Change-Id: Iff9d693ce4478582ddbbbe487b00d71f456929f8
Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
-rw-r--r-- | Makefile.am | 2 | ||||
-rw-r--r-- | configure.ac | 3 | ||||
-rw-r--r-- | docs/Makefile.am | 7 | ||||
-rw-r--r-- | docs/gluster-block.8 | 124 | ||||
-rw-r--r-- | gluster-block.spec.in | 4 |
5 files changed, 138 insertions, 2 deletions
diff --git a/Makefile.am b/Makefile.am index 90d12ce..ac07516 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ ACLOCAL_AMFLAGS = -I m4 -SUBDIRS = rpc utils cli daemon systemd +SUBDIRS = rpc utils cli daemon systemd docs DISTCLEANFILES = Makefile.in gluster-block.spec autom4te.cache diff --git a/configure.ac b/configure.ac index 231e6a6..dfe6c4a 100644 --- a/configure.ac +++ b/configure.ac @@ -31,7 +31,8 @@ AC_CONFIG_FILES([gluster-block.spec daemon/Makefile utils/Makefile systemd/Makefile - systemd/gluster-blockd.service]) + systemd/gluster-blockd.service + docs/Makefile]) AC_CONFIG_MACRO_DIR([m4]) m4_ifdef([AM_PROG_AR], [AM_PROG_AR]) diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..2430f96 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,7 @@ +EXTRA_DIST = gluster-block.8 + +man8_MANS = gluster-block.8 + +DISTCLEANFILES = Makefile.in + +CLEANFILES = *~ diff --git a/docs/gluster-block.8 b/docs/gluster-block.8 new file mode 100644 index 0000000..f50e95c --- /dev/null +++ b/docs/gluster-block.8 @@ -0,0 +1,124 @@ +.TH gluster-block 8 "command line utility" " 26 Feb 2017" "Red Hat, Inc." +.PP + + +.SH NAME +gluster-block - Gluster Block Storage Console Manager (command line utility) +.PP + + +.SH SYNOPSIS +.B gluster-block +<\fBcreate|list|info|delete\fR> +<\fBvolname\fR[\fB/blockname\fR]> +[\fB<args>\fR] +.PP + + +.SH DESCRIPTION +The Gluster Block Storage Console Manager(\fBgluster-block\fR) is a CLI utility, which aims at making gluster backed block storage creation and maintenance as simple as possible. + +Note that the gluster-blockd daemon is responsible for block management, hence the daemon must be running on all servers. +.PP + + +.SH COMMANDS +.SS +\fBcreate\fR <VOLNAME/NEW-BLOCKNAME> [ha <COUNT>] <HOST1[,HOST2,..]> <BYTES> +create block device. +.TP +[ha <COUNT>] +multipath requirement for high availability (default: 1) +.TP +<HOST1,[HOST2....]> +servers in the pool where targets will be exported. +.TP +<BYTES> +size in KiB|MiB|GiB|TiB|PiB ... +.PP + +.SS +\fBlist\fR <VOLNAME> +list available block devices. +.PP + +.SS +\fBinfo\fR <VOLNAME/BLOCKNAME> +details about block device. +.PP + +.SS +\fBdelete\fR <VOLNAME/BLOCKNAME> +delete block device. +.PP + +.SS +.BR help +show this message and exit. +.PP + +.SS +.BR version +show version info and exit. +.PP + + +.SH EXAMPLES +.nf +To create a block device of size 1GiB +.B # gluster-block create blockVol/sampleBlock ${HOST} 1GiB + +To create a block device of size 1GiB with multi-path(replica) 3 +.B # gluster-block create blockVol/sampleBlock ha 3 ${HOST1},${HOST2},${HOST3} 1GiB + +You can pass more no. of nodes than ha count, this will actually help create in recovering from +failures, incase creation of block fails on any of scheduled(always first in list) ha count nodes. +.B # gluster-block create blockVol/sampleBlock ha 3 ${HOST1},${HOST2},${HOST3},${HOST4},${HOST5} 1GiB + +To list available block devices +.B # gluster-block list blockVol + +To get details of a block device +.B # gluster-block info blockVol/sampleBlock + +To delete a block device +.B # gluster-block delete blockVol/sampleBlock +.fi +.PP + +.SH FILES +/var/log/gluster-block/* +.br +/var/run/gluster-block.socket +.br +/var/run/gluster-block.lock +.PP + + +.SH REPORTING BUGS +Report bugs via gluster-devel <gluster-devel@gluster.org +.br +or <https://github.com/gluster/gluster-block/issues> + + +.SH AUTHOR +Prasanna Kumar Kalever <prasanna.kalever@redhat.com> + +.SH THANKS +Vijay Bellur <vbellur@redhat.com> +.br +Pranith Kumar Karampuri <pkarampu@redhat.com> + + + +.SH SEE ALSO +.nf +\fBtargetcli\fR(8), \fBtcmu-runner\fR(8), \fBglusterfs\fR(8), \fBglusterd\fR(8), \fBgluster\fR(8) +.fi +.PP + + +.SH COPYRIGHT +.nf +Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com> +.PP diff --git a/gluster-block.spec.in b/gluster-block.spec.in index dec3f8d..0be206d 100644 --- a/gluster-block.spec.in +++ b/gluster-block.spec.in @@ -38,11 +38,15 @@ rm -rf ${RPM_BUILD_ROOT} %doc README.md %{_sbindir}/gluster-block %{_sbindir}/gluster-blockd +%{_mandir}/man8/gluster-block*.8* %if ( 0%{?_with_systemd:1} ) %{_unitdir}/gluster-blockd.service %endif %changelog +* Mon Feb 27 2017 Prasanna Kumar Kalever <prasanna.kalever@redhat.com> +- add Man page entry + * Thu Feb 23 2017 Niels de Vos <ndevos@redhat.com> - cleanup and add licenses and README.md to the package |