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

doc: missing man pages for ceph-create-keys, ceph-disk-* #4846

Merged
2 commits merged into from Jun 15, 2015
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
1 change: 1 addition & 0 deletions ceph.spec.in
Expand Up @@ -610,6 +610,7 @@ fi
%config(noreplace) %{_sysconfdir}/logrotate.d/ceph
%{_mandir}/man8/ceph-deploy.8*
%{_mandir}/man8/ceph-disk.8*
%{_mandir}/man8/ceph-create-keys.8*
%{_mandir}/man8/ceph-mon.8*
%{_mandir}/man8/ceph-mds.8*
%{_mandir}/man8/ceph-osd.8*
Expand Down
1 change: 1 addition & 0 deletions debian/ceph.install
Expand Up @@ -23,6 +23,7 @@ usr/libexec/ceph/ceph-osd-prestart.sh
usr/share/doc/ceph/sample.ceph.conf
usr/share/doc/ceph/sample.fetch_config
usr/share/man/man8/ceph-clsinfo.8
usr/share/man/man8/ceph-create-keys.8
usr/share/man/man8/ceph-debugpack.8
usr/share/man/man8/ceph-deploy.8
usr/share/man/man8/ceph-disk.8
Expand Down
63 changes: 63 additions & 0 deletions doc/man/8/ceph-create-keys.rst
@@ -0,0 +1,63 @@
:orphan:

===============================================
ceph-create-keys -- ceph keyring generate tool
===============================================

.. program:: ceph-create-keys

Synopsis
========

| **ceph-create-keys** [-h] [-v] [--cluster *name*] --id *id*


Description
===========

:program:`ceph-create-keys` is a utility to generate bootstrap keyrings using
the given monitor when it is ready.

It creates following auth entities (or users)

``client.admin``

and its key for your client host.

``client.bootstrap-{osd, rgw, mds}``

and their keys for bootstrapping corresponding services

To list all users in the cluster::

ceph auth list


Options
=======

.. option:: --cluster

name of the cluster (default 'ceph').

.. option:: -i, --id

id of a ceph-mon that is coming up. **ceph-create-keys** will wait until it joins quorum.

.. option:: -v, --verbose

be more verbose.


Availability
============

**ceph-create-keys** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer
to the Ceph documentation at http://ceph.com/docs for more
information.


See also
========

:doc:`ceph <ceph>`\(8)
1 change: 1 addition & 0 deletions man/CMakeLists.txt
Expand Up @@ -11,6 +11,7 @@ install(FILES
ceph-run.8
ceph.8
mount.ceph.8
ceph-create-keys.8
radosgw.8
radosgw-admin.8
ceph-authtool.8
Expand Down
1 change: 1 addition & 0 deletions man/Makefile-server.am
Expand Up @@ -3,6 +3,7 @@ dist_man_MANS += \
crushtool.8 \
ceph-run.8 \
mount.ceph.8 \
ceph-create-keys.8 \
ceph-rest-api.8 \
ceph-debugpack.8

Expand Down
97 changes: 97 additions & 0 deletions man/ceph-create-keys.8
@@ -0,0 +1,97 @@
.\" Man page generated from reStructuredText.
.
.TH "CEPH-CREATE-KEYS" "8" "June 02, 2015" "dev" "Ceph"
.SH NAME
ceph-create-keys \- ceph keyring generate tool
.
.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
.fi
.sp
.SH DESCRIPTION
.sp
\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)
.sp
\fBclient.admin\fP
.INDENT 0.0
.INDENT 3.5
and its key for your client host.
.UNINDENT
.UNINDENT
.sp
\fBclient.bootstrap\-{osd, rgw, mds}\fP
.INDENT 0.0
.INDENT 3.5
and their keys for bootstrapping corresponding services
.UNINDENT
.UNINDENT
.sp
To list all users in cluster:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ceph auth list
.ft P
.fi
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-cluster
name of the cluster (default \(aqceph\(aq).
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-id
id of a ceph\-mon that is coming up. \fBceph\-create\-keys\fP will wait until it joins quorum.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
be more verbose.
.UNINDENT
.SH AVAILABILITY
.sp
\fBceph\-create\-keys\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
\fBceph\fP(8)
.SH COPYRIGHT
2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
.\" Generated by docutils manpage writer.
.