Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hammer: doc: regenerate man pages, add orphans commands to radosgw-admin(8) #7524

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 18 additions & 0 deletions doc/man/8/radosgw-admin.rst
Expand Up @@ -83,6 +83,12 @@ Commands
:command:`usage trim`
Trim usage information (with optional user and date range)

:command:`orphans find`
Init and run search for leaked rados objects

:command:`orphans finish`
Clean up search for leaked rados objects


Options
=======
Expand Down Expand Up @@ -150,6 +156,18 @@ Options
Defer removal of object tail


Orphans Search Options
======================

.. option:: --pool

Data pool to scan for leaked rados objects

.. option:: --num-shards

Number of shards to use for keeping the temporary scan info


Examples
========

Expand Down
4 changes: 2 additions & 2 deletions man/ceph-authtool.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-AUTHTOOL" "8" "November 30, 2014" "dev" "Ceph"
.TH "CEPH-AUTHTOOL" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-authtool \- ceph keyring manipulation tool
.
Expand Down Expand Up @@ -287,7 +287,7 @@ mount \-t ceph serverhost:/ mountpoint \-o name=foo,secret=\(gaceph\-authtool \-
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-authtool\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please
\fBceph\-authtool\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-clsinfo.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-CLSINFO" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-CLSINFO" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-clsinfo \- show class object information
.
Expand Down Expand Up @@ -84,7 +84,7 @@ Shows the class architecture
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-clsinfo\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please
\fBceph\-clsinfo\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-conf.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-CONF" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-CONF" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-conf \- ceph conf file tool
.
Expand Down Expand Up @@ -147,7 +147,7 @@ ceph\-conf \-c foo.conf \-L
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-conf\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer
\fBceph\-conf\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer
to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
Expand Down
33 changes: 30 additions & 3 deletions man/ceph-create-keys.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-CREATE-KEYS" "8" "June 02, 2015" "dev" "Ceph"
.TH "CEPH-CREATE-KEYS" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-create-keys \- ceph keyring generate tool
.
Expand Down Expand Up @@ -30,6 +30,33 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBceph\-create\-keys\fP [\-h] [\-v] [\-\-cluster \fIname\fP] \-\-id \fIid\fP
Expand All @@ -40,7 +67,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBceph\-create\-keys\fP is a utility to generate bootstrap keyrings using
the given monitor when it is ready.
.sp
it creates following auth entities (or users)
It creates following auth entities (or users)
.sp
\fBclient.admin\fP
.INDENT 0.0
Expand All @@ -56,7 +83,7 @@ and their keys for bootstrapping corresponding services
.UNINDENT
.UNINDENT
.sp
To list all users in cluster:
To list all users in the cluster:
.INDENT 0.0
.INDENT 3.5
.sp
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-debugpack.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-DEBUGPACK" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-DEBUGPACK" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-debugpack \- ceph debug packer utility
.
Expand Down Expand Up @@ -82,7 +82,7 @@ startup.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-debugpack\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please
\fBceph\-debugpack\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
Expand Down
32 changes: 29 additions & 3 deletions man/ceph-dencoder.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-DENCODER" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-DENCODER" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-dencoder \- ceph encoder/decoder utility
.
Expand Down Expand Up @@ -100,6 +100,12 @@ Select the given type for future \fBencode\fP or \fBdecode\fP operations.
.UNINDENT
.INDENT 0.0
.TP
.B skip <bytes>
Seek <bytes> into the imported file before reading data structure, use
this with objects that have a preamble/header before the object of interest.
.UNINDENT
.INDENT 0.0
.TP
.B decode
Decode the contents of the in\-memory buffer into an instance of the
previously selected type. If there is an error, report it.
Expand Down Expand Up @@ -143,7 +149,7 @@ versions of the software (for those types that support it).
.UNINDENT
.SH EXAMPLE
.sp
Say you want to examine an attribute on an object stored by \fBceph\-osd\fP\&. You can do:
Say you want to examine an attribute on an object stored by \fBceph\-osd\fP\&. You can do this:
.INDENT 0.0
.INDENT 3.5
.sp
Expand Down Expand Up @@ -179,9 +185,29 @@ $ ceph\-dencoder type object_info_t import /tmp/a decode dump_json
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively, perhaps you wish to dump an internal CephFS metadata object, you might
do that like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ rados \-p metadata get mds_snaptable mds_snaptable.bin
$ ceph\-dencoder type SnapServer skip 8 import mds_snaptable.bin decode dump_json
{ "snapserver": { "last_snap": 1,
"pending_noop": [],
"snaps": [],
"need_to_purge": {},
"pending_create": [],
"pending_destroy": []}}
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-dencoder\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please
\fBceph\-dencoder\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-deploy.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-DEPLOY" "8" "December 20, 2014" "dev" "Ceph"
.TH "CEPH-DEPLOY" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-deploy \- Ceph deployment tool
.
Expand Down Expand Up @@ -827,7 +827,7 @@ The domain for the Calamari master server.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-deploy\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
\fBceph\-deploy\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the documentation at \fI\%http://ceph.com/ceph-deploy/docs\fP for more information.
.SH SEE ALSO
.sp
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-disk.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-DISK" "8" "December 18, 2014" "dev" "Ceph"
.TH "CEPH-DISK" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-disk \- Ceph disk preparation and activation utility for OSD
.
Expand Down Expand Up @@ -388,7 +388,7 @@ Provide init system to manage the OSD directory.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-disk\fP is a part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
\fBceph\-disk\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-fuse.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-FUSE" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-FUSE" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-fuse \- FUSE-based client for ceph
.
Expand Down Expand Up @@ -108,7 +108,7 @@ Use root_directory as the mounted root, rather than the full Ceph tree.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-fuse\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
\fBceph\-fuse\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
Expand Down
14 changes: 12 additions & 2 deletions man/ceph-mds.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-MDS" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-MDS" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-mds \- ceph metadata server daemon
.
Expand Down Expand Up @@ -106,9 +106,19 @@ startup.
Connect to specified monitor (instead of looking through
\fBceph.conf\fP).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-journal\-check <rank>
Attempt to replay the journal for MDS <rank>, then exit.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hot\-standby <rank>
Start as a hot standby for MDS <rank>.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-mon\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at
\fBceph\-mds\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to the Ceph documentation at
\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-mon.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-MON" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-MON" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-mon \- ceph monitor daemon
.
Expand Down Expand Up @@ -123,7 +123,7 @@ Specify a keyring for use with \fB\-\-mkfs\fP\&.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-mon\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer
\fBceph\-mon\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer
to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-osd.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-OSD" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-OSD" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-osd \- ceph object storage daemon
.
Expand Down Expand Up @@ -155,7 +155,7 @@ Connect to specified monitor (instead of looking through
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-osd\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
\fBceph\-osd\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-post-file.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-POST-FILE" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-POST-FILE" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-post-file \- post files for ceph developers
.
Expand Down Expand Up @@ -118,7 +118,7 @@ ceph\-post\-file \-d \(aqmon data directories\(aq /var/log/ceph/mon/*
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-post\-file\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
\fBceph\-post\-file\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-rbdnamer.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-RBDNAMER" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-RBDNAMER" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-rbdnamer \- udev helper to name RBD devices
.
Expand Down Expand Up @@ -79,7 +79,7 @@ KERNEL=="rbd[0\-9]*", PROGRAM="/usr/bin/ceph\-rbdnamer %n", SYMLINK+="rbd/%c{1}/
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-rbdnamer\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please
\fBceph\-rbdnamer\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please
refer to the Ceph documentation at \fI\%http://ceph.com/docs\fP for more
information.
.SH SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions man/ceph-rest-api.8
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-REST-API" "8" "January 12, 2014" "dev" "Ceph"
.TH "CEPH-REST-API" "8" "February 04, 2016" "dev" "Ceph"
.SH NAME
ceph-rest-api \- ceph RESTlike administration server
.
Expand Down Expand Up @@ -197,7 +197,7 @@ exception to be raised; see your WSGI server documentation for how to
see those messages in case of problem.
.SH AVAILABILITY
.sp
\fBceph\-rest\-api\fP is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at
\fBceph\-rest\-api\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to the Ceph documentation at
\fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
Expand Down