ceph/doc/install/index.rst

   1 .. _install-overview:
   2
   3 ===============
   4 Installing Ceph
   5 ===============
   6
   7 There are several different ways to install Ceph.  Choose the
   8 method that best suits your needs.
   9
  10 Recommended methods
  11 ~~~~~~~~~~~~~~~~~~~
  12
  13 :ref:`Cephadm <cephadm>` installs and manages a Ceph cluster using containers and
  14 systemd, with tight integration with the CLI and dashboard GUI.
  15
  16 * cephadm only supports Octopus and newer releases.
  17 * cephadm is fully integrated with the new orchestration API and
  18   fully supports the new CLI and dashboard features to manage
  19   cluster deployment.
  20 * cephadm requires container support (podman or docker) and
  21   Python 3.
  22
  23 `Rook <https://rook.io/>`_ deploys and manages Ceph clusters running
  24 in Kubernetes, while also enabling management of storage resources and
  25 provisioning via Kubernetes APIs.  We recommend Rook as the way to run Ceph in
  26 Kubernetes or to connect an existing Ceph storage cluster to Kubernetes.
  27
  28 * Rook only supports Nautilus and newer releases of Ceph.
  29 * Rook is the preferred method for running Ceph on Kubernetes, or for
  30   connecting a Kubernetes cluster to an existing (external) Ceph
  31   cluster.
  32 * Rook supports the new orchestrator API. New management features
  33   in the CLI and dashboard are fully supported.
  34
  35 Other methods
  36 ~~~~~~~~~~~~~
  37
  38 `ceph-ansible <https://docs.ceph.com/ceph-ansible/>`_ deploys and manages
  39 Ceph clusters using Ansible.
  40
  41 * ceph-ansible is widely deployed.
  42 * ceph-ansible is not integrated with the new orchestrator APIs,
  43   introduced in Nautlius and Octopus, which means that newer
  44   management features and dashboard integration are not available.
  45
  46
  47 `ceph-deploy <https://docs.ceph.com/projects/ceph-deploy/en/latest/>`_ is a tool for quickly deploying clusters.
  48
  49   .. IMPORTANT::
  50
  51    ceph-deploy is no longer actively maintained. It is not tested on versions of Ceph newer than Nautilus. It does not support RHEL8, CentOS 8, or newer operating systems.
  52
  53 `ceph-salt <https://github.com/ceph/ceph-salt>`_ installs Ceph using Salt and cephadm.
  54
  55 `jaas.ai/ceph-mon <https://jaas.ai/ceph-mon>`_ installs Ceph using Juju.
  56
  57 `github.com/openstack/puppet-ceph <https://github.com/openstack/puppet-ceph>`_  installs Ceph via Puppet.
  58
  59 Ceph can also be :ref:`installed manually <install-manual>`.
  60
  61
  62 .. toctree::
  63    :hidden:
  64
  65    index_manual
  66
  67 Windows
  68 ~~~~~~~
  69
  70 For Windows installations, please consult this document:
  71 `Windows installation guide`_.
  72
  73 .. _Windows installation guide: ./windows-install