Skip to content

Commit

Permalink
doc: add ceph-create-keys.8
Browse files Browse the repository at this point in the history
Fixes: ceph#10725
Signed-off-by: Kefu Chai <[email protected]>
  • Loading branch information
tchaikov committed Apr 22, 2015
1 parent a4627aa commit 27cee2f
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 0 deletions.
1 change: 1 addition & 0 deletions ceph.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -637,6 +637,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
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,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
Original file line number Diff line number Diff line change
@@ -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 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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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

0 comments on commit 27cee2f

Please sign in to comment.