Commit Graph

332 Commits

Author SHA1 Message Date
Sage Weil
1e7dc441ff Merge branch 'wip-doc-rebase-2' 2012-05-03 12:16:55 -07:00
John Wilkins
d49c3d29a7 Removed "Ceph Development Status" per Bryan
Modified title syntax per Tommi
Modified paragraph width to 80-chars per Dan
Moved "Build from Source" out of Install
Renamed create_cluster to config-cluster
Added config-ref with configuration reference tables
Added a toc ref for man/1/obsync per Dan
Removed redundant sections from Ops
Deleted "Why use Ceph" and "Introduction to Storage Clusters"



Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
2012-05-02 20:31:35 -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