X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=ceph%2Fdoc%2Fcephadm%2Findex.rst;h=bfa3a4bb23b6306f8e478c8dcb50fa0ebcb26d23;hb=39ae355f72b1d71f2212a99f2bd9f6c1e0d35528;hp=d57fe288a01d6a8be810b926bca600f4a168b010;hpb=e04241aa9b639588fa6c864845287d2824cb6b55;p=ceph.git diff --git a/ceph/doc/cephadm/index.rst b/ceph/doc/cephadm/index.rst index d57fe288a..bfa3a4bb2 100644 --- a/ceph/doc/cephadm/index.rst +++ b/ceph/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 pages: + + * https://github.com/ceph/cephadm-ansible + * https://rook.io/docs/rook/v1.10/Getting-Started/intro/ + * https://github.com/ceph/ceph-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 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`` to 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