Commit Graph

240 Commits

Author SHA1 Message Date
Loic Dachary
11fa1dfbcb Merge pull request #3193 from nilamdyuti/wip-doc-ceph-disk
Changes format style in ceph-disk to improve readability as html

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2014-12-19 15:36:39 +01:00
John Wilkins
3b46995c97 Merge pull request #3195 from nilamdyuti/wip-doc-ceph-deploy
doc: Changes format style in ceph-deploy to improve readability as html.

Reviewed-by: John Wilkins <jowilkin@redhat.com>
2014-12-18 15:01:50 -08:00
Nilamdyuti Goswami
8b79617306 doc: Changes format style in ceph to improve readability as html.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 17:11:22 +05:30
Nilamdyuti Goswami
62b3fcdd24 doc: Updates man page for ceph-disk with suggested changes.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 16:48:50 +05:30
Nilamdyuti Goswami
3f6be22f64 doc: Updates man page for ceph-disk.
Changes format style to improve readability as html.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 16:31:35 +05:30
Nilamdyuti Goswami
e638469b58 doc: Updates man page for ceph-deploy.
Changes format style in ceph-deploy to improve readability as html.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 13:51:46 +05:30
John Wilkins
8241f114d1 Merge pull request #3165 from nilamdyuti/wip-doc-ceph
doc: Updates man page for Ceph

Reviewed-by: John Wilkins <jowilkin@redhat.com>
2014-12-16 08:13:53 -08:00
Nilamdyuti Goswami
76da87a64c doc: Adds man page for ceph.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-13 02:24:41 +05:30
Nilamdyuti Goswami
9191005cca doc: Adds man page for ceph-deploy.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-06 00:07:44 +05:30
Loic Dachary
f1296fd87a Merge pull request #3019 from theanalyst/doc/typo/ceph-auth
doc: minor fix in ceph-authtool man page

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2014-11-30 10:23:43 +01:00
Abhishek Lekshmanan
faa4cbbef2 doc: minor fix in ceph-authtool man page
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-11-30 11:20:59 +05:30
Nilamdyuti Goswami
8a48847cd4 doc: Updates the man page for ceph-disk utility with some changes.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-26 22:19:01 +05:30
Nilamdyuti Goswami
242dd1c0bb doc: Removes ceph-deploy usage instances from ceph-disk man page.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-25 21:16:16 +05:30
Nilamdyuti Goswami
7dcc85042b doc: Updates man page for ceph-disk utility.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-25 02:06:39 +05:30
Nilamdyuti Goswami
a450cab2b8 doc: Adds man page for ceph-disk utility.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-24 22:05:11 +05:30
Adam Crume
8d23e8dbdc rbd-replay: Add --dump-perf-counters option
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-09-11 16:48:08 -07:00
Adam Crume
675a6a6704 rbd-replay: Add rbd-replay-many
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-09-11 16:48:03 -07:00
Adam Crume
3911354d61 rbd-replay: Add --anonymize flag to rbd-replay-prep
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-09-11 16:47:56 -07:00
Adam Crume
0cd2651cad rbd-replay: Add man page and package binaries for rbd-replay-prep
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-08-21 10:57:33 -07:00
Adam Crume
e18748ed99 rbd-replay: Add man page, and add binaries to Debian packaging
Signed-off-by: Adam Crume <adamcrume@gmail.com>
2014-08-21 10:57:33 -07:00
Abhishek Lekshmanan
c51182257e doc: update radosgw man page with available opts
Fixes:#8112

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-24 13:21:25 -07:00
Abhishek Lekshmanan
fcbdd2fe9f doc: Fix a typo in the rbd man page
's/specifially/specifically'

Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-09 10:27:41 +05:30
Sage Weil
768d48f6ef Merge pull request #2074 from onlyjob/docs
doc: mention kernel support for rbd format 2

Reviewed-by: Sage Weil <sage@redhat.com>
2014-07-07 09:07:04 -07:00
Dmitry Smirnov
c0806bbdcc doc: mention kernel support for rbd format 2
Signed-off-by: Dmitry Smirnov <onlyjob@member.fsf.org>
2014-07-05 19:27:24 +10:00
Kevin Dalley
ab59a100ad doc: Improve man page for bench
Add information about seq and rand for bench. Also mention
--no-cleanup option.

Signed-off-by: Kevin Dalley <kevin@kelphead.org>
2014-05-29 14:28:47 -07:00
John Spray
45c319efeb doc: Update ceph-mds manpage
Add missing --hot-standby and --journal-check
arguments.

Fixes: #8258
2014-05-20 14:07:51 +01:00
Dmitry Smirnov
f22e2e9a02 spelling corrections 2014-04-17 12:43:30 +10:00
James Ryan Cresawn
c9eaa6510d Changed Availability section of ceph-mds.rst to reference ceph-mds, not ceph-mon.
Signed-off-by: James Ryan Cresawn <jrcresawn@gmail.com>
2014-03-06 22:05:15 -07:00
John Spray
541beb87dc mds: Add encode/decode/dump for use with dencoder
This is for the MDSTable subclasses: AnchorServer,
SnapServer, InoTable.  AnchorServer was partially there
but didn't work in practice dumped objects because of
the version prefix on the object.

This adds a skip argument to ceph-dencoder for getting
past fixed size prefixes.  The encode_server_state method
is also made const to avoid the need for const_casting (and
because it really is const)

Signed-off-by: John Spray <john.spray@inktank.com>
2014-02-20 15:22:29 +00:00
Loic Dachary
efbdd16380 doc: update the crushtool manual page
* add information about CEPH_ARGS
* rework the --build documentation and example
* add an Author section
* replace vi with emacs for no good reason
* cleanup whitespace

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-01-12 18:06:06 +01:00
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
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
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
caleb miles
5ac52de003 crushtool: Miscellaneous cleanup.
Clean up the output messages; add some function documentation and some
unit tests.

Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-31 13:20:30 -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: #2720
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
Travis Rhoden
5c70392720 doc: mkcephfs man page, -c ceph.conf is not optional
[ The following text is in the "ISO-8859-1" character set. ]
    [ Your display is set for the "ANSI_X3.4-1968" character set.  ]
    [ Some characters may be displayed incorrectly. ]

The man page for mkcephfs and the output of mkcephfs --help
do not agree with each other.  the man page says -c ceph.conf
is optional, while mkcephfs --help says it is required.

Through empirical evidence, I believe it is required.  Update
the man page to make it so.

Signed-off-by: Travis Rhoden <trhoden@gmail.com>
2012-08-20 13:26:06 -07:00
Sage Weil
9b1df33abc Merge remote-tracking branch 'gh/master' into wip-auth
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>  (rbd bits)
Reviewed-by: Greg Farnum <greg@inktank.com>
2012-08-17 16:51:46 -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
caleb miles
b15d639264 radosgw-admin.rst: Misc doccumentation update.
Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-09 13:27:28 -07:00
caleb miles
45f7f0602c rgw_admin.cc: Allow removal of a user's buckets during user removal.
Allow the buckets, and any child objects, of a user to be deleted when the
user is deleted through radosgw-admin. In reference to feature request
2499: http://tracker.newdream.net/issues/2499.

Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-09 13:27:21 -07:00
caleb miles
cc8eac2427 rgw_admin.cc: Allow for deletion of objects through radosgw-admin.
Allow objects to be deleted through radosgw-admin with an optional flag
to delete the tail of that object during the processing of the intent log.

Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-09 09:55:27 -07:00
Tommi Virtanen
3671a37e5d doc: Explicitly state mount.ceph two first arguments are fixed.
I've hurt myself too many times with this.

Signed-off-by: Tommi Virtanen <tv@inktank.com>
2012-08-02 16:03:19 -07:00
Tommi Virtanen
17ad4e18d0 doc: mount.ceph is also needed for cephx.
Signed-off-by: Tommi Virtanen <tv@inktank.com>
2012-08-02 16:03:09 -07:00
Dan Mick
83339a0cbb Merge branch 'wip-rbd-clone-dmick' into master
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>
2012-07-10 14:20:18 -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
John Wilkins
82abe00ed1 Merge pull request #15 from fghaas/wip-rgw-doc
radosgw documentation improvements
2012-07-02 08:07:23 -07:00
Florian Haas
e18601348f doc: drop mention of MDS capabilities from radosgw man page
Signed-off-by: Florian Haas <florian@hastexo.com>
2012-07-02 16:54:08 +02:00
Florian Haas
88e31546bb radosgw-admin: improve man page
* remove "OpenStack user" information (deprecated, should no
  longer be used. No reason to keep mentioning it)
* fix description of --uid
* mention subusers
* add key management commands

Signed-off-by: Florian Haas <florian@hastexo.com>
2012-06-26 08:39:22 +02:00
Yehuda Sadeh
58db045a2c docs: clarify example in radosgw-admin
Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-06-21 11:35:13 -07:00
Yehuda Sadeh
62a4ad66d1 docs: update usage logging info
added some text under radosgw, examples under radosgw-admin

Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-06-21 10:47:44 -07:00
Yehuda Sadeh
b84e1ed5f2 doc: document usage log
Modify radosgw, radosgw-admin man page

Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-06-19 15:17:53 -07:00
Sage Weil
d9e902f9c5 ceph.newdream.net -> ceph.com
wiki url -> docs url
2012-06-16 14:50:29 -07:00
Sage Weil
66df6be8bb ceph-authtool: update docs to reflect no more osdcap deny
Signed-off-by: Sage Weil <sage@inktank.com>
2012-06-14 16:36:10 -07:00
Florian Haas
753207c3f2 doc: update examples in radosgw-admin man page
* "user gen" is gone and is now "user create"
* --uid option is mandatory for "user create"

Mailing list thread: http://www.spinics.net/lists/ceph-devel/msg06744.html

Signed-off-by: Florian Haas <florian@hastexo.com>
2012-06-11 23:49:11 +02:00
Josh Durgin
a5026303f4 rados: add commands to interact with object maps
The input values are stored as-is, and any values read are dumped in
hex. Rename listomap to listomapkeys to distinguish from
listomapvalues. Also add it to the man page.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-06-09 17:24:50 -07:00
Sage Weil
55c21de537 Merge branch 'wip-quorum' 2012-05-22 17:13:28 -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
Sage Weil
ece33e5bb5 monmaptool: add --generate, --filter-initial options
Generate a monmap from conf/args, and apply the mon initial hosts to it.

Signed-off-by: Sage Weil <sage@inktank.com>
2012-05-18 16:23:59 -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
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
ab08fb8b32 mkcephfs: note that btrfs (and --mkbtrfs) are optional and experimental
And that --mkbtrfs will be deprecated soon.

Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-04-11 15:53:58 -07:00
Sage Weil
ee39291a4e ceph-authtool: add warning to man page
- data is not encrypted over the wire
- intended for trusted environments

Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-04-11 15:53:55 -07:00
Sage Weil
a6c7f999d0 ceph-dencoder: man page
Signed-off-by: Sage Weil <sage@newdream.net>
2012-02-21 15:44:55 -08:00
Josh Durgin
c1db9009c2 Merge branch 'next' 2012-02-17 14:31:44 -08:00
Josh Durgin
304389ca0e man: move man page fixes to rst
83cf1b62fd and
e5f49104ab updated the nroff output
but not the rst source.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2012-02-17 14:27:06 -08: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
Tommi Virtanen
e32668f8b8 doc: Balance backticks.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-02-14 15:52:55 -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
Sage Weil
2710bd8520 mon: update man page to document --mkfs stuff
Signed-off-by: Sage Weil <sage@newdream.net>
2011-12-19 14:02:10 -08:00
Sage Weil
dc977901c6 osd: --get-journal-fsid
Signed-off-by: Sage Weil <sage@newdream.net>
2011-12-19 08:15:08 -08:00
Josh Durgin
739fd9fee4 man: clarify mount.ceph auth options
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-12-15 14:03:00 -08:00
Josh Durgin
e5a5ae12d7 man: update rule definition for ceph-rbdnamer
This is the rule we install since 891025e539.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-12-15 13:49:10 -08:00
Josh Durgin
4eb836546d authx -> cephx everywhere it's used
The term authx was in the mount.ceph man page, and got accidentally
copied into rbd help.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-12-15 13:43:43 -08:00
Tommi Virtanen
d745ff8d89 doc: "ceph -w" clarification.
Stop saying "watch cluster state" so many times.

Don't say stdout, that's the assumption.

Don't call showing things on terminal "printing".

Don't show -C option here.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-14 11:19:00 -08:00
Sage Weil
8e150fb496 mon: add '--fsid foo' arg for setting generated monmap fsid
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2011-11-12 13:16:30 -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
Sage Weil
9c9560492a mkcephfs: copy ceph.conf to /etc/ceph/ceph.conf (when -a)
You can disable this with --no-copy-conf.

Signed-off-by: Sage Weil <sage@newdream.net>
2011-10-17 10:49:46 -07:00
Sage Weil
6103ee9e88 more radosgw_admin -> radosgw-admin
Signed-off-by: Sage Weil <sage@newdream.net>
2011-10-03 11:25:44 -07:00
Tommi Virtanen
7f301510c2 doc: Fix reStructuredText formatting warnings.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-23 15:55:01 -07:00
Tommi Virtanen
65d2c49943 doc: Leftovers of the c* -> ceph-* rename.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-23 15:55:00 -07:00
Sage Weil
3e9a936062 doc: more c* -> ceph-* renames
Signed-off-by: Sage Weil <sage@newdream.net>
2011-09-22 16:18:37 -07:00
Sage Weil
6f8f140350 c* -> ceph-*
Hopefully I didn't miss too much...

Signed-off-by: Sage Weil <sage@newdream.net>
2011-09-22 15:08:25 -07: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
clever215
23d8a3483a rgw: modify documents and help infos' descriptions to the usage of option date when executing command "log show"
DOCUMENTATION #13235

This modification concerns documents and help infos. To the documents, we delete original incorrect instruction about the usage of the option date which induces user to type the
value of date in the format of "YYYY-MM-DD" when executing "log show" command, and we add the actual usage of "YYYY-MM-DD-hh". To the help infos, we add the NOTE to make user
notice that the usage of option date here is different with default's and of cource we give the right formatting.

Signed-off-by: Kongming Wu <wu.kongming@h3c.com>
2001-05-02 18:09:46 +08:00