doc/cephadm: update install.rst

This commit addresses https://github.com/ceph/ceph/pull/43250,
which has remained unmerged for thirteen months. The issues
raised in that PR are addressed here.

This commit contributes to the simplification of the procedure
that explains how to install cephadm. More remains to be done
on this page, but the old PR had to be dealt with first.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit c8f01d3a32b889a0f3b68f619bfed36f6579c28b)

diff --git a/doc/cephadm/index.rst b/doc/cephadm/index.rst
index d57fe288a01d6a8be810b926bca600f4a168b010..43e4b3b9d2ee3c676509536d393d9a83102d31e5 100644 (file)
--- a/doc/cephadm/index.rst
+++ b/doc/cephadm/index.rst
@@ -4,21 +4,36 @@
 Cephadm
 =======
 
-``cephadm`` deploys and manages a Ceph cluster. It does this by connecting the
-manager daemon to hosts via SSH. The manager daemon is able to add, remove, and
-update Ceph containers. ``cephadm`` does not rely on external configuration
-tools such as Ansible, Rook, and Salt.
-
-``cephadm`` manages the full lifecycle of a Ceph cluster. This lifecycle
-starts with the bootstrapping process, when ``cephadm`` creates a tiny
-Ceph cluster on a single node. This cluster consists of one monitor and
-one manager. ``cephadm`` then uses the orchestration interface ("day 2"
-commands) to expand the cluster, adding all hosts and provisioning all
-Ceph daemons and services. Management of this lifecycle can be performed
-either via the Ceph command-line interface (CLI) or via the dashboard (GUI).
-
-``cephadm`` is new in Ceph release v15.2.0 (Octopus) and does not support older
-versions of Ceph.
+``cephadm`` is a utility that is used to manage a Ceph cluster. 
+
+Here is a list of some of the things that ``cephadm`` can do:
+
+- ``cephadm`` can add a Ceph container to the cluster.
+- ``cephadm`` can remove a Ceph container from the cluster.
+- ``cephadm`` can update Ceph containers.
+
+``cephadm`` does not rely on external configuration tools like Ansible, Rook,
+or Salt. However, those external configuration tools can be used to automate
+operations not performed by cephadm itself. To learn more about these external
+configuration tools, visit their GitHub pages:
+
+ * https://github.com/ceph/cephadm-ansible
+ * https://github.com/ceph/ceph-salt
+ * https://rook.io/
+
+``cephadm`` manages the full lifecycle of a Ceph cluster. This lifecycle starts
+with the bootstrapping process, when ``cephadm`` creates a tiny Ceph cluster on
+a single node. This cluster consists of one monitor and one manager.
+``cephadm`` then uses the orchestration interface to expand the cluster, adding
+hosts and provisioning Ceph daemons and services. Management of this lifecycle
+can be performed either via the Ceph command-line interface (CLI) or via the
+dashboard (GUI).
+
+To use ``cephadm`` get started with Ceph, follow the instructions in
+:ref:`cephadm_deploying_new_cluster`.
+
+``cephadm`` was introduced in Ceph release v15.2.0 (Octopus) and does not
+support older versions of Ceph.
 
 .. toctree::
     :maxdepth: 2

diff --git a/doc/cephadm/install.rst b/doc/cephadm/install.rst
index 845297fa20c1aba0e62dec9a178394c0958f4a5b..d2096a187ca72a4797abf1fbb2b1a7dbac662084 100644 (file)
--- a/doc/cephadm/install.rst
+++ b/doc/cephadm/install.rst
@@ -1,3 +1,5 @@
+.. _cephadm_deploying_new_cluster:
+
 ============================
 Deploying a new Ceph cluster
 ============================
@@ -8,7 +10,6 @@ then deploying the needed services.
 
 .. highlight:: console
 
-
 .. _cephadm-host-requirements:
 
 Requirements
@@ -35,17 +36,12 @@ Ceph.
 Install cephadm
 ===============
 
-The ``cephadm`` command can 
-
-#. bootstrap a new cluster
-#. launch a containerized shell with a working Ceph CLI
-#. aid in debugging containerized Ceph daemons
-
 There are two ways to install ``cephadm``:
 
 #. a :ref:`curl-based installation<cephadm_install_curl>` method
 #. :ref:`distribution-specific installation methods<cephadm_install_distros>`
 
+
 .. _cephadm_install_curl:
 
 curl-based installation