From: Owen Synge <osynge@suse.com>
Date: Fri, 20 May 2016 11:34:16 +0000 (+0200)
Subject: [fix-remove-ceph-create-keys-dep_cp] docs.source.index: Update basic install
X-Git-Tag: v1.5.34~5^2~4
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=6d7d323521a07c34a70d8ad7b311b556cf91b26f;p=ceph-deploy.git

[fix-remove-ceph-create-keys-dep_cp] docs.source.index: Update basic install

Updated the basic install instructions.

(1) Added a creating a new configuration section.
(2) Added reference to the 'new' subcommand
(3) Added reference to the 'mon' subcommand
(4) Improved Gather keys
(5) Added reference to the 'gatherkeys' subcommand
(6) Moved Admin hosts section as now it is more important.
(7) Added reference to the 'admin' subcommand

The gatherkeys subcommand does not depend upon ceph-create-keys so does not
have to have the side effect of making mons admin nodes. To get this in I
must add documentation to ceph-deploy.

Signed-off-by: Owen Synge <osynge@suse.com>
---

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 30f8e20..c97ddd8 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -175,6 +175,19 @@ hosts, for example::
     https_proxy=http://host:port
 
 
+Creating a new configuration
+============================
+
+To create a new configuration file and secret key, decide what hosts
+will run ``ceph-mon``, and run::
+
+  ceph-deploy new MON [MON..]
+
+For detailed information on new instructions refer to the :ref:`new`
+section.
+
+For detailed information on ``new`` subcommand refer to the
+:ref:`mon` section.
 
 Deploying monitors
 ==================
@@ -187,10 +200,13 @@ Without explicit hosts listed, hosts in ``mon_initial_members`` in the
 config file are deployed. That is, the hosts you passed to
 ``ceph-deploy new`` are the default value here.
 
+For detailed information on ``mon`` subcommand refer to the
+:ref:`mon` section.
+
 Gather keys
 ===========
 
-To gather authenticate keys (for administering the cluster and
+To gather authentication keys (for administering the cluster and
 bootstrapping new nodes) to the local directory, run::
 
   ceph-deploy gatherkeys HOST [HOST...]
@@ -199,6 +215,23 @@ where ``HOST`` is one of the monitor hosts.
 
 Once these keys are in the local directory, you can provision new OSDs etc.
 
+For detailed information on ``gatherkeys`` subcommand refer to the
+:ref:`gatherkeys` section.
+
+Admin hosts
+===========
+
+To prepare a host with a ``ceph.conf`` and ``ceph.client.admin.keyring``
+keyring so that it can administer the cluster, run::
+
+  ceph-deploy admin HOST [HOST ...]
+
+Older versions of ceph-deploy automatically added the admin keyring to
+all mon nodes making them admin nodes. For detailed information on the
+admin command refer to the :ref:`admin` section.
+
+For detailed information on ``admin`` subcommand refer to the
+:ref:`admin` section.
 
 Deploying OSDs
 ==============
@@ -222,15 +255,6 @@ OSD, you can also do::
 
 This is useful when you are managing the mounting of volumes yourself.
 
-
-Admin hosts
-===========
-
-To prepare a host with a ``ceph.conf`` and ``ceph.client.admin.keyring``
-keyring so that it can administer the cluster, run::
-
-  ceph-deploy admin HOST [HOST ...]
-
 Forget keys
 ===========