doc: add ceph-create-keys.8

Fixes: #10725
Signed-off-by: Kefu Chai <kchai@redhat.com>
(cherry picked from commit 27cee2f1f46a9f47cda9dfeb56ff1259e982960c)

Conflicts:
    doc/man/8/ceph-create-keys.rst
    Includes fixes from https://github.com/ceph/ceph/pull/4855

diff --git a/ceph.spec.in b/ceph.spec.in
index f3cfaf003f214004a912ce5e1713fff20e6c0976..3c4f20c576c98725ef13655e0bdcbcfafb54269d 100644 (file)
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -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*

diff --git a/debian/ceph.install b/debian/ceph.install
index 42dd3c26c245d7b4a0a9a189e634866292d289e1..6a405214ee8f4a6781443a96df02030372e24166 100644 (file)
--- a/debian/ceph.install
+++ b/debian/ceph.install
@@ -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

diff --git a/doc/man/8/ceph-create-keys.rst b/doc/man/8/ceph-create-keys.rst
new file mode 100644 (file)
index 0000000..8d1dc91
--- /dev/null
+++ b/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)

diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt
index f7896d6c7164927640bd5df63949db88d0bdc432..ea0ef47609c94936b4913f4524146f13ad4badb9 100644 (file)
--- a/man/CMakeLists.txt
+++ b/man/CMakeLists.txt
@@ -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

diff --git a/man/Makefile-server.am b/man/Makefile-server.am
index 794275b543172fb9240215ee8c9f56a38237d128..a780ebe1e378cda924d8ccfd88053964df2ecfa0 100644 (file)
--- a/man/Makefile-server.am
+++ b/man/Makefile-server.am
@@ -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