From 1221ee29b7e06e6ecc532da5a0b62b68a160363a Mon Sep 17 00:00:00 2001 From: Sebastian Wagner Date: Wed, 26 Feb 2020 12:48:37 +0100 Subject: [PATCH] doc/cephadm: Rename section titles and fix introductions Signed-off-by: Sebastian Wagner --- doc/cephadm/administration.rst | 23 ++++------------------- doc/cephadm/index.rst | 13 ++++++++++++- doc/releases/octopus.rst | 2 +- 3 files changed, 17 insertions(+), 21 deletions(-) diff --git a/doc/cephadm/administration.rst b/doc/cephadm/administration.rst index cec8335b270..4e9ed4c174f 100644 --- a/doc/cephadm/administration.rst +++ b/doc/cephadm/administration.rst @@ -1,24 +1,9 @@ -.. _cephadm: +.. _cephadm-administration: -==================== -cephadm orchestrator -==================== +====================== +cephadm Administration +====================== -The cephadm orchestrator is an orchestrator module that does not rely -on a separate system such as Rook or Ansible, but rather manages nodes -in a cluster by establishing an SSH connection and issuing explicit -management commands. - -Orchestrator modules only provide services to other modules, which in turn -provide user interfaces. To try out the cephadm module, you might like -to use the :ref:`Orchestrator CLI ` module. - -Requirements -============ - -- Python 3 -- Podman or Docker -- LVM2 Configuration ============= diff --git a/doc/cephadm/index.rst b/doc/cephadm/index.rst index 068182d9a97..3e962efc4e8 100644 --- a/doc/cephadm/index.rst +++ b/doc/cephadm/index.rst @@ -1,4 +1,4 @@ -.. _bootstrap: +.. _cephadm-bootstrap: ======================== Installation (cephadm) @@ -6,6 +6,11 @@ .. note:: The *cephadm* bootstrap feature is first introduced in Octopus, and is not yet recommended for production deployments. +cephadm is an orchestrator that does not rely +on a separate system such as Rook or Ansible, but rather manages nodes +in a cluster by establishing an SSH connection and issuing explicit +management commands. + A new Ceph cluster is deployed by bootstrapping a cluster on a single node, and then adding additional nodes and daemons via the CLI or GUI dashboard. @@ -21,6 +26,12 @@ should be issued on which systems. of this installation guide means that the associated command can be run on any node. +Requirements +============ + +- Podman or Docker +- LVM2 + .. highlight:: console Get cephadm diff --git a/doc/releases/octopus.rst b/doc/releases/octopus.rst index cfb8a4bea03..d6300a4eb37 100644 --- a/doc/releases/octopus.rst +++ b/doc/releases/octopus.rst @@ -13,7 +13,7 @@ Major Changes from Nautilus * A new deployment tool called **cephadm** has been introduced that integrates Ceph daemon deployment and management via containers into the orchestration layer. For more information see - :ref:`cephadm` and :ref:`bootstrap`. + :ref:`cephadm-bootstrap`. * Health alerts can now be muted, either temporarily or permanently. * A simple 'alerts' capability has been introduced to send email health alerts for clusters deployed without the benefit of an