Commit Graph

149 Commits

Author SHA1 Message Date
Loic Dachary
0082d88c7e doc: format man pages with s/2013/2014/
Signed-off-by: Loic Dachary <loic@dachary.org>
2014-01-12 18:06:06 +01:00
Loic Dachary
283793ac44 doc: crushtool man page nroff format
also includes a modification from a prior patch series that was not
formatted to nroff.

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-01-12 18:06:06 +01:00
David Moreau Simard
daefe8159f Be more explicit how to discover available API calls
Signed-off-by: David Moreau Simard <dmsimard@iweb.com>
2014-01-03 13:23:35 -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
420a2f15a5 man: update man/ from doc/man/8
As explained in admin/manpage-howto.txt

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-12-10 18:34:16 +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
Josh Durgin
574cb61efe man: re-generate changed man pages
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-11-18 18:13:40 -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
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
Danny Al-Gaaf
347b5a2078 ceph-authtool.8: add missing commands to man page
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2013-07-28 23:39:09 +02: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
Dan Mick
b5659b5e7f Merge branch 'wip-wsgi' into next
* wip-wsgi:
  ceph-rest-api: separate into module and front-end for WSGI deploy
  ceph-rest-api: make main program be "shell" around WSGI guts

  Reviewed-by: Sage Weil <sage@inktank.com>
2013-07-12 16:38:28 -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
1f8fe709b6 ceph-rest-api: Missing packaging (binary in .spec, manpage in both)
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-07-11 18:25:44 -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
Simon Leinen
da1fb93fab mds: man page: Fixed cut & paste error 2013-07-02 11:03:39 -07:00
Josh Durgin
825a43176b man: update remaining copyright notices
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-04-29 16:01:38 -07:00
Josh Durgin
4abf081495 man: refresh content from rst
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-04-29 16:01:03 -07:00
Greg Farnum
efc4947599 man: make the cephfs man page marginally more truthful
Signed-off-by: Greg Farnum <greg@inktank.com>
2013-02-19 17:48:26 -08:00
Josh Durgin
755b4bb3fe .gitignore: add local ones for ocf and man
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-02-11 09:08:01 -08:00
Gary Lowell
de01bddb3a Makefile: Install new rdb-fuse.8 man page
Signed-off-by: Gary Lowell  <gary.lowell@inktank.com>
2013-01-31 21:04:49 -08:00
Dan Mick
334568e005 rbd-fuse: quick and dirty manpage
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-01-31 19:29:26 -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
d7cdcc0e25 rbd: regenerate man page and cli test
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-16 13:14:49 -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
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
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
50bb65963c man: update ceph-debugpack, ceph man pages
Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-19 10:42:48 -07:00
Sage Weil
c18e17d2fe rbd: update man page build
Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-19 10:41:51 -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
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
Dan Mick
1d231f9364 Refresh manpages from .rst sources
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-09-27 14:33:04 -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
Josh Durgin
f530659786 Merge remote branch 'origin/wip-librbd-locking'
Conflicts:
	qa/workunits/rbd/copy.sh

Reviewed-by: Sage Weil <sage.weil@inktank.com>
2012-09-18 16:06:25 -07:00
Sage Weil
de930440e7 remove obsync
This now lives at http://github.com/ceph/obsync

Signed-off-by: Sage Weil <sage@inktank.com>
2012-09-17 18:23:39 -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: #2556
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
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
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
Tommi Virtanen
7d5fa4e506 man: Remove leftover --bin from ceph-authtool(8).
Regenerate manpage.

See 4832c46eab,
ec732816ef for the actual removal of the
feature.

Signed-off-by: Tommi Virtanen <tv@inktank.com>
2012-05-21 08:56:08 -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
Dan Mick
ee26c5d73a Treat rename across pools as an error
Fixes: #2370
Reviewed-by: Samuel Just <samuel.just@dreamhost.com>
2012-05-01 20:08:00 -07:00
Sage Weil
9cb796a03a obsync: section 8 -> 1
Fixes: #2263
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-04-19 12:47:50 -07:00
Sage Weil
119dd5ae3d mkcephfs: update man page
Signed-off-by: Sage Weil <sage@newdream.net>
2012-04-11 16:00:14 -07:00