Commit Graph

109 Commits

Author SHA1 Message Date
David Moreau Simard 42e98aca62 Be more explicit how to discover available API calls
I believe it cannot hurt to be slightly more explicit about how
to retrieve API calls and provide examples.

Signed-off-by: David Moreau Simard <dmsimard@iweb.com>
2013-12-31 16:48:55 -05:00
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
Loic Dachary 472f495e40 crush: document the --test mode of operations
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-12-09 21:10:23 +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
Adam Twardowski 5d2cf46c1d Update ceph-authtool.rst
Fix typo
2013-10-18 13:14:25 -04: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
John Wilkins 874186bacc doc: Updated the usage scenario and made a few syntax edits.
fixes: #6308

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-16 18:38:55 -07:00
John Wilkins 4c5b3c7bee doc: Syntax fix to suppress gitbuilder errors.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:30:19 -07:00
John Wilkins 8bf858f2f2 doc: Removed mkcephfs reference.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:29:56 -07:00
John Wilkins ac609a4fe2 doc: Syntax fixes to remove gitbuilder errors.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:22:08 -07:00
John Wilkins deb43d9463 doc: Fixed typo.
fixes: #5968

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-08-21 10:56:23 -07:00
Sage Weil d08e05e463 ceph-post-file: single command to upload a file to cephdrop
Use sftp to upload to a directory that only this user and ceph devs can
access.

Distribute an ssh key to connect to the account.  This will let us revoke
the key in the future if we feel the need.  Also distribute a known_hosts
file so that users have some confidence that they are connecting to the
real ceph drop account and not some third party.

Signed-off-by: Sage Weil <sage@inktank.com>
Reviewed-by: Dan Mick <dan.mick@inktank.com>
2013-08-16 17:59:11 -07:00
Sage Weil ee18322e5b Merge remote-tracking branch 'gh/next' 2013-07-28 16:17:55 -07:00
Dan Mick 8af47755af ceph-rest-api: clean up options/environment
ceph-rest-api:
* create app from wrapper by calling generate_app()
* pass args to generate_app() (early parsed in wrapper)
* parse -i/--id here as well
* set addr:port on returned app object
* handle only EnvironmentError exceptions; let others spew traceback
* turn off debug when running singlethreaded server

ceph_rest_api.py:
* put glob.* on app.ceph_* instead; pass around app in init code
* drop conf parsing (let librados do its job)

Documentation updated to match.

Signed-off-by: Dan Mick <dan.mick@inktank.com>
Reviewed-by: Sage Weil <sage@inktank.com>
2013-07-26 21:38:12 -07:00
Sage Weil 4bf4d92a8b doc: radosgw needs 'mon = allow rw' to create its own pools
Fixes: #5674
Signed-off-by: Sage Weil <sage@inktank.com>
Reviewed-by: Yehuda Sadeh <yehuda@inktank.com>
2013-07-19 10:04:40 -07:00
Dan Mick cc10988850 ceph-rest-api: separate into module and front-end for WSGI deploy
To deploy ceph-rest-api within a WSGI server (apache/mod_wsgi,
nginx/uwsgi, etc.), there needs to be an importable (.py) module
that performs all init/config when imported.  ceph-rest-api was
close, but it needs to be named properly, and there's no argument
passing, so it needs to get args from a fixed file or the env.

Separate most of ceph-rest-api into pybind/ceph_rest_api.py, and make
its arguments come from the environment, and init errors be
ImportError exceptions.  Recase ceph-rest-api as a thin layer that
does the usual setup and arg parsing, and then sets args into the
environment and imports ceph_rest_api.py, catching exceptions and
reporting errors.  This allows standalone execution as usual.
ceph-rest-api grabs a few module globals (addr/port and the flask.app)
to use after it imports.

Accept cluster name, and do the ceph.conf search using cluster name
in the appropriate places in the searched-for files.

Also ceph_rest_api.py gets a little cleanup (fewer global variables,
cleaner conf file search algorithm, better error reporting on conf
load)

Also: doc updates, packaging updates to include ceph_rest_api.py

Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-07-12 16:37:32 -07:00
Dan Mick e4d063b082 ceph-rest-api manpage
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-07-10 20:58:51 -07:00
Sage Weil c693ba5732 rados: add whole-object 'clonedata' command
Clone the data stream from one object to another.

Signed-off-by: Sage Weil <sage@inktank.com>
2013-05-06 16:45:12 -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
John Wilkins ba13173b7f doc: Deleted old index. Generates warnings otherwise.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-26 14:07:55 -07:00
John Wilkins 3dd9574bbf doc: Usage requires --num_osds.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-22 21:03:15 -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
Greg Farnum 3692ccd696 doc: make the cephfs man page marginally more truthful
Put it in the right place this time.

Signed-off-by: Greg Farnum <greg@inktank.com>
2013-02-19 18:00:44 -08:00
Dan Mick 91f8c3c859 rbd-fuse: quick and dirty manpage
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-01-31 18:44:16 -08:00
Josh Durgin 97b789247a doc: update ceph man page link
It's not the wiki anymore, and the man page needed to be regenerated.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-28 16:52:48 -08:00
Josh Durgin 91a0bc891a ceph, rados: update pool delete docs and usage
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-28 16:52:33 -08: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
Gary Lowell 5dd6b19918 Merge branch 'next' 2012-12-31 21:31:17 -08:00
Josh Durgin 8bbb4a364d doc: fix rbd permissions for unprotect
Unprotect examines all pools, so use blanket x before 0.54. After
that, use class-read restricted by object_prefix to rbd_children.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-12-30 00:06:11 -08:00
Sage Weil f5403f9493 doc/man/8/mkcephfs: update --mkfs a bit
Document that 'devs' and 'osd mkfs type' must be defined.

Signed-off-by: Sage Weil <sage@inktank.com>
2012-12-26 09:42:13 -08:00
Dan Mick 3e98d1af4d Merge branch 'testing' into next 2012-12-05 18:18:41 -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
John Wilkins f2c7a60c90 doc: Fixed many hyperlinks, a few typos, and some minor clarifications.
fixes: #3564

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-03 12:22:37 -08:00
Danny Al-Gaaf df550c9cce make mkcephfs and init-ceph osd filesystem handling more flexible
Remove btrfs specific keys and replace them by more generic
keys to be able to replace btrfs with e.g. xfs or ext4 easily.

Add new key to define the osd fs type: 'osd mkfs type', which can
get defined in the [osd] section for all OSDs.

Replaced config keys:
- 'btrfs devs' -> 'devs'
- 'btrfs path' -> 'fs path'
- 'btrfs options' -> 'osd mount options $fstype'

New config key:
- 'osd mkfs options $fstype': file system specific options for mkfs
- 'osd mkfs type': to define the filesystem for mkfs and also mount

Replaced in mkcephfs: --mkbtrfs with --mkfs

Replaced in init-ceph:
- --btrfs with --fsmount
- --nobtrfs with --nofsmount
- --btrfsumount with --fsumount

NOTE: old options from mkcephfs and init-ceph will still work, but
      get may removed in the future from the scripts.

Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2012-11-23 19:14:52 -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 e5e076dfa1 Merge branch 'wip-rbd-stripe' (early part)
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2012-10-18 16:42:15 -07:00
Dan Mick 96e365be85 radosgw-admin manpage: Fix broken quotes
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-10-15 18:18:49 -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
Sage Weil f268d4ef60 ceph-debugpack: updates
- avoid copying data around; tar things directly into the tgz
- 'ceph report' instead of all the little bits
- unrotated logs only
- ensure target doesn't already exist

Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-09 14:13:57 -07:00
Josh Durgin c8721b956c Merge branch 'wip-osd-caps'
Conflicts:
	src/osd/OSDCap.cc
	src/test/osd/osdcap.cc

Reviewed-by: Sage Weil <sage.weil@inktank.com>
2012-10-05 16:21:12 -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 9362f726aa doc: add rbd example to ceph-authtool man page
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-10-02 15:43:38 -07:00
Josh Durgin 7ea8f16e22 doc: update ceph-authtool man page for new osd caps
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-10-02 15:43:37 -07:00
Sage Weil 5a0461af57 ceph tool: update url in man page
Signed-off-by: Sage Weil <sage@inktank.com>
2012-09-28 17:38:02 -07:00
Sage Weil 1d552a4ba0 rados: fix man page
Default bench IO size if 4MB.

Fixes: 3230
Signed-off-by: Sage Weil <sage@inktank.com>
2012-09-27 14:10:51 -07:00
Josh Durgin 8c3bfaa30a doc: update ceph-authtool man page
* document osd capabilities
* fix librados user example
* fix example with outdated syntax (pool= and uid= are not supported)
* ignore auid, object prefix, and class restrictions for now since
  they aren't usable yet
* fix header for keyring file section

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-09-26 17:41:03 -07:00