ceph/doc/cephadm/index.rst

   1 .. _cephadm:
   2
   3 =======
   4 Cephadm
   5 =======
   6
   7 ``cephadm`` is a utility that is used to manage a Ceph cluster.
   8
   9 Here is a list of some of the things that ``cephadm`` can do:
  10
  11 - ``cephadm`` can add a Ceph container to the cluster.
  12 - ``cephadm`` can remove a Ceph container from the cluster.
  13 - ``cephadm`` can update Ceph containers.
  14
  15 ``cephadm`` does not rely on external configuration tools like Ansible, Rook,
  16 or Salt. However, those external configuration tools can be used to automate
  17 operations not performed by cephadm itself. To learn more about these external
  18 configuration tools, visit their pages:
  19
  20  * https://github.com/ceph/cephadm-ansible
  21  * https://rook.io/docs/rook/v1.10/Getting-Started/intro/
  22  * https://github.com/ceph/ceph-salt
  23
  24 ``cephadm`` manages the full lifecycle of a Ceph cluster. This lifecycle starts
  25 with the bootstrapping process, when ``cephadm`` creates a tiny Ceph cluster on
  26 a single node. This cluster consists of one monitor and one manager.
  27 ``cephadm`` then uses the orchestration interface to expand the cluster, adding
  28 hosts and provisioning Ceph daemons and services. Management of this lifecycle
  29 can be performed either via the Ceph command-line interface (CLI) or via the
  30 dashboard (GUI).
  31
  32 To use ``cephadm`` to get started with Ceph, follow the instructions in
  33 :ref:`cephadm_deploying_new_cluster`.
  34
  35 ``cephadm`` was introduced in Ceph release v15.2.0 (Octopus) and does not
  36 support older versions of Ceph.
  37
  38 .. toctree::
  39     :maxdepth: 2
  40
  41     compatibility
  42     install
  43     adoption
  44     host-management
  45     Service Management <services/index>
  46     upgrade
  47     Cephadm operations <operations>
  48     Client Setup <client-setup>
  49     troubleshooting
  50     Cephadm Feature Planning <../dev/cephadm/index>