Commit Graph

212 Commits

Author SHA1 Message Date
Vikhyat Umrao
cd4ac1cae1 rbd: support size suffixes for size-based options
This patch will provide support for size suffixes for
below given options:

--stripe-unit <size in B/K/M>
--io-size <size in B/K/M/G/T>
--io-total <size in B/K/M/G/T>

Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2015-08-06 20:40:51 +05:30
Vikhyat Umrao
85cb86d05f doc: change "--keyfile" description in man page of rbd help
"--keyring" has higher priority than "--keyfile".
"--keyfile" option is overridden by "--keyring"
if latter is also specified.

Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2015-08-03 22:57:04 +05:30
Ilya Dryomov
17a3e4b969 rbd: rename --object-extents option to --whole-object
--object-extents is a bit confusing - extent is generally something of
a varying length and here the meaning is "diff whole objects".  Rename
it to --whole-object (the name of diff_iterate() parameter).

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-27 12:22:04 +03:00
Ilya Dryomov
afbf90d5b5 rbd: du command should take spec as an argument
Change du to take <image-spec> | <snap-spec> as an argument instead of
going through --image option.  The new synopsis is

    (du | disk-usage) [<image-spec> | <snap-spec>]

This is to make it look more like the rest of the commands: the only
other command that takes pool as an argument is ls and it can't really
serve as a prototype for du, because the latter has to work on images
and snapshots as well.

Examples:

    # stats for pool rbd
    $ rbd du
    $ rbd -p rbd du

    # stats for pool foo
    $ rbd -p foo du

    # stats for snapshot mysnap of image baz in pool rbd
    $ rbd du baz@mysnap

    # stats for image bar in pool foo
    $ rbd du foo/bar

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-27 12:22:04 +03:00
Ilya Dryomov
bbc5c71284 rbd: import doesn't require image-spec arg, ditto for export and path
Mark those as such in help and clarify what image-spec defaults to.

Related, all command args in our man page are enclosed into brackets.
I suppose the reason is that they are optional in the sense that you
can have commands like

    $ rbd clone --pool a --image b --snap -c --dest-pool d --dest e

with no args.  Given that we are trying to push people towards

    $ rbd clone a/b@c d/e

undo that so that real optional arguments can be marked optional.
While at it, add synopsis for each command and use backticks for
denoting commands more consistently.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-27 12:22:04 +03:00
Ilya Dryomov
76989cc4ae doc: use spec syntax in rbd docs
Use spec syntax instead of --pool, --image and --snap to hopefully push
people towards the former.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-27 12:22:04 +03:00
Vikhyat Umrao
9909388171 rbd: use image-spec and snap-spec in rbd help
This patch changes image-name instances to image-spec and snap-name
instances to snap-spec to try to clarify usage for some commands and
disambiguate the term {image,snap}-name, which has been used to denote
both simple names and compound names (specs).

<image-spec> is [<pool-name>]/<image-name>
<snap-spec> is [<pool-name>]/<image-name>@<snap-name>

This patch also removes duplicate checks for image-name and snap-name.

Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
[idryomov@gmail.com: some commands take either image-spec or snap-spec,
other fixes, formatting, changelog]
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-27 12:22:04 +03:00
Ilya Dryomov
89c2a0b58a rbd: recognize queue_depth option
.. and also stress the difference between libceph and rbd mapping
options.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-07-06 16:32:15 +03:00
Kefu Chai
ec132a7986 Merge pull request #4166 from sponce/wip-10759
tools: rados cli --striper

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-07-01 23:32:57 +08:00
Kefu Chai
b097e70732 Merge pull request #4840 from tchaikov/wip-11833-crush-dump-tree
mon: add an "osd crush dump tree" command

Reviewed-by: Min Chen <minchen@ubuntukylin.com>
Reviewed-by: Haomai Wang <haomaiwang@gmail.com>
2015-06-24 17:39:49 +08:00
Sebastien Ponce
49ab5bb3c4 rados: Added --striper option to the command line
Fixes: #10759
the new --striper option allows to use the striping API provided by libradosstriper.

Signed-off-by: Sebastien Ponce <sebastien.ponce@cern.ch>
2015-06-23 13:04:21 +02:00
Li Wang
c1bd02c978 Merge pull request #4792 from kylinstorage/wip-writeback-throttling-for-cache-tiering
Wip writeback throttling for cache tiering

This patch is to do write back throttling for cache tiering, which is similar to what the Linux kernel does for  page cache write back.  A paramter 'cache_target_dirty_high_ratio'  (default 0.6) is introduced as the high speed flushing threshold, while leave the 'cache_target_dirty_ratio' (default 0.4) to represent the low speed  threshold. The flush speed is controlled by limiting the parallelism of flushing. The maximum parallelism under low speed is half of the parallelism under high speed. If there is at least one PG such that the dirty ratio beyond the high threshold, full speed mode is entered; If there is no PG such that dirty ratio beyond the low threshold, idle mode is entered; In other cases, slow speed mode is entered.

Signed-off-by: Mingxin Liu <mingxinliu@ubuntukylin.com>
Reviewed-by: Li Wang <liwang@ubuntukylin.com>
Suggested-by: Nick Fisk <nick@fisk.me.uk>
Tested-by: Kefu Chai <kchai@redhat.com>
2015-06-23 15:15:47 +08:00
Loic Dachary
6c93465ec1 Merge pull request #4987 from Aeryax/master
doc: Replaced "disk or drive" by "disk" in ceph-disk.rs

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-06-18 17:10:18 +02:00
Kazhord
3cb8c4e8ef doc: Replaced "disk or drive" by "disk" in ceph-disk.rs
Fixes: #12062
Signed-off-by: Gabriel SENTUCQ <perso@kazhord.fr>
2015-06-18 15:47:26 +02:00
Kévin CARADANT
05c56b7ced doc: ceph-deploy man page: typo #12063
Replace is initial monitor hostname with is the initial monitor hostname
Fixes : #12063
Signed-off-by: CARADANT Kevin <kevin.caradant@gmail.com>
2015-06-17 18:25:08 +02:00
Josh Durgin
6af50f4105 Merge pull request #4948 from vumrao/wip-rbd-11822
[rbd] support G/T units in rbd create/resize

Reviewed-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
Reviewed-by: Sage Weil <sweil@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2015-06-16 23:40:26 -07:00
Vikhyat Umrao
8e56a5b5c4 [rbd] support G/T units in rbd create/resize
Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
2015-06-16 23:27:52 +05:30
Kefu Chai
84e2f8ea99 doc: sync ceph-deploy's man page with the code
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-06-16 22:28:58 +08:00
Kefu Chai
5436c290f3 mon: add an "osd crush tree" command
* to print crush buckets/items in a tree

Fixes: #11833
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-06-14 19:08:32 +08:00
Kefu Chai
f04c8829cf man/create-create-keys: minor fixes
to address the comments on https://github.com/ceph/ceph/pull/4846

Fixes: #10725
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-06-04 11:27:11 +08:00
liumingxin
7aba9476e6 Doc: add write back throttling stuff in document and test scripts
Signed-off-by: Mingxin Liu <mingxinliu@ubuntukylin.com>
Reviewed-by: Li Wang <liwang@ubuntukylin.com>
Suggested-by: Nick Fisk <nick@fisk.me.uk>
2015-06-03 15:57:14 +08:00
Ilya Dryomov
52440c4b97 rbd: document mount_timeout in the man page
With "rbd: timeout watch teardown on unmap with mount_timeout" going
into kernel 4.2, document its effect in the man page.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-05-25 15:41:51 +03:00
Jason Dillaman
7ffafc56b1 rbd: add disk usage tool
The new disk usage tool uses the new fast diff object map feature
(when enabled) to quickly calculate the provisioned vs actual usage
of images and associated snapshots within a pool.

Fixes: #7746
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2015-05-13 10:25:45 -04:00
Loic Dachary
44d6429a5d Merge pull request #4412 from tchaikov/wip-add-man-page
doc: add man page for ceph-create-keys

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-05-12 16:03:07 +02:00
Loic Dachary
0c715f6971 Merge pull request #4532 from dachary/wip-init-system-detection
ceph-detect-init helper and associated tests

Reviewed-by: Ken Dreyer <kdreyer@redhat.com>
Reviewed-by: Sage Weil <sage@redhat.com>
2015-05-07 22:21:26 +02:00
Kefu Chai
410175be89 Merge pull request #3743 from trociny/wip-osd_create
mon: osd create: add optional 'id' parameter

Reviewed-by: Joao Eduardo Luis <joao@suse.de>
2015-05-08 00:13:37 +08:00
Jason Dillaman
b556d3173a librbd: add new deep-flatten RBD feature
Copy-on-read/write will now use an empty snapshot context to
deep-copy the object through all existing snapshots.  With the
deep-flatten feature enabled, the flatten operation will now
disconnect a child image from its parent even if it has existing
snapshots.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2015-05-06 21:51:31 -04:00
Dmitry Yatsushkevich
70585a6f7b rados cli: fix documentation for -b option
Fix focumentation for block size option for rados cli

Signed-off-by: Dmitry Yatsushkevich <dyatsushkevich@mirantis.com>
2015-05-06 10:24:35 -07:00
Loic Dachary
35a16ffc1e ceph-detect-init: integration with automake / make check
* Add the files to the distribution tarbal via EXTRA_DIST
* Build the module via the all-local target
* Add run-tox.sh to the tests run via make check
* Add manual page

Signed-off-by: Loic Dachary <ldachary@redhat.com>
2015-05-06 01:54:36 +02:00
Loic Dachary
8ee5a82832 ceph-disk: implement activate --no-start-daemon
And improve the --mark-init documentation as well.

Signed-off-by: Loic Dachary <ldachary@redhat.com>
2015-05-06 01:54:36 +02:00
Josh Durgin
94a7d11e4a Merge pull request #4186 from ceph/wip-7787
librbd: add fast diff feature

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2015-04-29 16:42:03 -07:00
Kefu Chai
27cee2f1f4 doc: add ceph-create-keys.8
Fixes: #10725
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-22 21:35:01 +08:00
Kefu Chai
a4627aabb7 doc: rework ceph-conf.8
* sync it with the code
* reformat it like a proper man page

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-22 21:30:27 +08:00
Ilya Dryomov
b1d3f918fb rbd: allow unmapping by spec
Make use of krbd_unmap_by_spec() and allow unmapping by <image-name>
(i.e. pool/image@snap spec) with a bunch of careful adjustments to the
fragile command args/options parsing process to make --pool, --image
and --snap options work as expected for rbd unmap <image-name> case.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-04-19 14:45:37 +03:00
Jason Dillaman
11cc7b2715 rbd: add support for new fast diff feature
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2015-04-13 15:24:14 -04:00
Jason Dillaman
eed80f022a rbd: add new --object-extents option to diff / export-diff
The rbd CLI can now use the object map to compute the diffs between
two snapshots.  This option is enabled with the new '--object-extents'
option.

Fixes: #7787
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2015-04-12 21:17:33 -04:00
Mykola Golub
0d1e770391 mon: osd create: add optional 'id' parameter
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-04-12 14:25:45 +03:00
Jason Dillaman
6ce79ab008 rbd: add object map rebuild command
An invalid object map can now be rebuilt via the rbd CLI.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2015-04-10 14:10:05 -04:00
Nilamdyuti Goswami
1cc0181326 doc: Corrects rgw.conf file path for Debian-based and RPM-based distros
in radosgw man page.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-04-08 15:48:39 +05:30
Kefu Chai
251ae614ba doc: ref 9/ceph-mon using relative path
sphinx complains when it failed to find the referenced file using the
absolute path whose root is the $(top_srcdir)/doc/man when rendering
man pages. but it is able to find it when rendering the html, because
build-doc specifies $(top_srcdir)/doc/ as the source directory.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:50 +08:00
Kefu Chai
a0bdf6932b doc: add ":orphan:" field to avoid sphinx warnings
when building man pages from rst files, sphinx complains if any
rst file is not referenced by a doctree.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:50 +08:00
Kefu Chai
0e07ccc197 man: move man/8/*.rst back to doc/man/8
sphinx requires that a document tree to be in a single directory,
and the man pages are references by our document. so a simple solution
would be to put all the rst file under a single directory.

Fixes: #11320
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:49 +08:00
Kefu Chai
301fe6cbf2 doc: generate man pages in man/Makefile
* move rst files from doc/man/8 into man/8
* extract man_pages setting for sphinx from doc/conf.py to man/conf.py
* generate all man pages in `make install`
* add python-sphinx to Build-Depends
* check for sphinx-build in `configure`
* run changed rst files through sphinx-build in `make check`

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-24 12:36:41 +08:00
Loic Dachary
0a3e47d778 Merge pull request #4148 from dobbler123/master
doc: Fixes spelling and grammatical errors

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-03-23 22:30:59 +01:00
Vartika Rai
8471f927c8 doc: Fixes spelling and grammatical errors
Signed-off-by: Vartika Rai <vartikarai17@gmail.com>
2015-03-24 02:11:34 +05:30
Sage Weil
0bee27461d Merge remote-tracking branch 'gh/hammer'
Conflicts:
	src/gmock
2015-03-23 12:45:16 -07:00
Loic Dachary
c5e9a214e4 Merge pull request #3371 from nilamdyuti/wip-doc-ceph-object-gateway
Updates radosgw man page with configuration for mod_proxy_fcgi

Reviewed-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
2015-03-23 18:25:41 +01:00
Nilamdyuti Goswami
e62ff4dbf6 doc: Updates radosgw-admin man page.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-23 16:39:18 +05:30
Nilamdyuti Goswami
e5bc64bfa6 doc: Updates radosgw man page.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-23 16:35:27 +05:30
Nilamdyuti Goswami
7a1984db41 doc: Updates radosgw man page with configuration for mod_proxy_fcgi .
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-23 16:35:27 +05:30