1
0
mirror of https://github.com/ceph/ceph synced 2024-12-27 05:53:20 +00:00
Commit Graph

31 Commits

Author SHA1 Message Date
Ilya Dryomov
9b7364d245 rbd: expose options available to rbd map
Add a -o / --options option, which would allow users to specify
rbd-specific and generic ceph client and osd options available at
mapping time in a comma separated list (similar to mount(8) mount
options).

Exposed options are:

- fsid=%s
- ip=%s
- share
- noshare
- crc
- nocrc
- osdkeepalive=%d
- osd_idle_ttl=%d
- rw
- ro (equivalent to existing --read-only flag)

The rw/ro < 3.7 kernels compatibility kludge added in commit
fb0f198644 is preserved.

Signed-off-by: Ilya Dryomov <ilya.dryomov@inktank.com>
2013-12-27 09:56:24 -08:00
Loic Dachary
8d60cd1ac2 man: Ceph is also an object store
Replace

   Ceph distributed file system

with

   Ceph distributed storage system

to help reduce the idea that Ceph is just a file system.

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-12-10 18:33:05 +01:00
rallred
0de0efa936 RBD Documentation and Example fixes for --image-format
- RBD Documentation, --image-format wrongly specified as --format in examples
 - RBD Documentation, better describe image format, to differentiate from --format

Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2013-11-18 18:12:38 -08:00
Guangliang Zhao
409aba6ff5 rbd.cc: add readonly option for "rbd map"
The device could only be set to rw(default) when mapping
now. This patch only handle the user space, because the
kernel part has been completed.

Signed-off-by: Guangliang Zhao <guangliang@unitedstack.com>
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2013-09-30 20:34:53 -07:00
Josh Durgin
ffc8557acd doc: update rbd man page for new options
--no-progress and --allow-shrink were added recently.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-04-29 15:37:06 -07:00
Sage Weil
325a3372cb rbd: include 'diff' command in man page
Signed-off-by: Sage Weil <sage@inktank.com>
2013-03-31 23:32:41 -07:00
Sage Weil
64a202a7ad rbd: update man page for import-diff and export-diff
Signed-off-by: Sage Weil <sage@inktank.com>
2013-03-31 23:32:41 -07:00
Josh Durgin
8fea6dee76 rbd: add --pretty-format option
This is the same option the rados and radosgw-admin tool use for more
human-readable json/xml.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-16 13:14:49 -08:00
Stratos Psomadakis
84c5d85764 rbd: support plain/json/xml output formatting
This patch renames the --format option to --image-format, for
specifying the RBD image format, and uses --format to specify the
output formatting (to be consistent with the other ceph tools). To
avoid breaking backwards compatibility with existing scripts, rbd will
still accept --format [1|2] for the image format, but will print a
warning message, noting its use is deprecated.

The rbd subcommands that support the new --format option are : ls, info, snap
list, children, showmapped, lock list.

Signed-off-by: Stratos Psomadakis <psomas@grnet.gr>
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-16 13:14:48 -08:00
Dan Mick
b7b724299e rbd: update manpage for import/export
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-12-05 18:17:35 -08:00
Dan Mick
3dffa6dd25 rbd: document defaults for rbd bench-write
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-10-22 13:34:23 -07:00
Sage Weil
86b43179d2 rbd: implement bench-write command
We may want to change the command line args around later to make this
more friendly.

Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-18 16:43:26 -07:00
Sage Weil
ae7271e13f rbd: document stripe unit options on man page
Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-15 15:34:03 -07:00
Dan Mick
61b2e4d6ac rbd: use TextTable to implement ls -l
Signed-off-by: Dan Mick <dan.mick@inktank.com>
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2012-10-04 15:20:29 -07:00
Josh Durgin
eeaa92c471 rbd: add locking commands
The locker (entity_name_t) will be different each time the rbd
command line tool is run, so 'lock remove' is always breaking a lock.

Fixes: 
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-09-07 18:38:27 -07:00
Josh Durgin
649bdc15d3 doc: clarify rbd man page (esp. layering)
* a clone's size can't be overridden
* note which commands require format 2
* clarify details of copy
* add examples for cloning
* add pool to map example for consistency
* fix a couple warnings and re-sync man page with rst

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-08-30 14:34:49 -07:00
Josh Durgin
dcbb87cc0c rbd: add --format option
This chooses whether to use the original (supported by krbd)
or the new (supports layering) format.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-08-30 14:34:49 -07:00
Dan Mick
465fcca1fe rbd: add "children" command, update cli test files
Fixes: 
Signed-off-by: Dan Mick <dan.mick@inktank.com>
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2012-08-29 17:35:27 -07:00
Dan Mick
81694c39d0 Add manpage sections for flatten, snap {un}protect
Signed-off-by: Dan Mick <dan.mick@inktank.com>
Reviewed-by: John Wilkins <john.wilkins@inktank.com>
2012-08-20 18:14:29 -07:00
Sage Weil
b403db197e rbd: update man page to avoid deprecated --secret, --user
Signed-off-by: Sage Weil <sage@inktank.com>
2012-08-17 16:51:16 -07:00
Dan Mick
2a6af20863 rbd: update manpage for clone command
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-07-10 14:00:06 -07:00
Sage Weil
d9e902f9c5 ceph.newdream.net -> ceph.com
wiki url -> docs url
2012-06-16 14:50:29 -07:00
Dan Mick
31fb8f97b6 Put change to rbd manpage in .rst instead, update man/ from output 2012-05-02 11:46:32 -07:00
Florian Haas
a446f32394 doc: fix snapshot creation/deletion syntax in rbd man page (trivial)
Creating a snapshot requires using "rbd snap create",
as opposed to just "rbd create". Also for purposes of
clarification, add note that removing a snapshot similarly
requires "rbd snap rm".

Thanks to Josh Durgin for the explanation on IRC.

Signed-off-by: Florian Haas <florian@hastexo.com>
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2012-02-17 14:27:00 -08:00
Josh Durgin
b6c43d2aff rbd: add a command to delete all snapshots of an image
This makes deleting images with many snapshots easier.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2012-01-05 10:19:17 -08:00
Josh Durgin
480b8260cc rbd: add showmapped to clitests and rst man page
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-11-07 09:27:55 -08:00
Tommi Virtanen
60aea05423 doc: Convert manpages to doc/man/.
Includes various content cleanups: layout of synopsis, layout
of comments in examples, typos.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00
Tommi Virtanen
80f54606b4 doc: Hide TODO note in rbd.8
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00
Tommi Virtanen
3f199beeaf doc: Make rbd.8 "pool-name", like the old man page.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00
Tommi Virtanen
c25b95552b doc: Remove duplicate paragraph from rbd.8
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:39 -07:00
Tommi Virtanen
f1d8964499 First draft of the documentation overhaul.
To build the docs, run ./admin/build-doc. To browse them, either get
them on any static website, or just run ./admin/serve-doc to serve
them quickly off of port 8080.

build-doc sets up a virtualenv to avoid needing Sphinx installed
system-wide. serve-doc needs thttpd installed.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00