2020-02-28 13:19:40 +00:00
.. _install-overview:
2012-11-07 22:09:57 +00:00
2020-02-28 13:19:40 +00:00
===============
Installing Ceph
===============
2012-05-18 20:54:51 +00:00
2020-03-17 13:58:57 +00:00
There are several different ways to install Ceph. Choose the
2020-07-05 08:18:38 +00:00
method that best suits your needs.
2020-02-28 13:19:40 +00:00
2020-03-15 13:45:46 +00:00
Recommended methods
~~~~~~~~~~~~~~~~~~~
2020-03-11 15:28:28 +00:00
2020-03-15 13:45:46 +00:00
:ref: `Cephadm <cephadm>` installs and manages a Ceph cluster using containers and
systemd, with tight integration with the CLI and dashboard GUI.
2020-03-11 15:28:28 +00:00
2020-04-11 12:25:51 +00:00
* cephadm only supports Octopus and newer releases.
2020-03-15 13:45:46 +00:00
* cephadm is fully integrated with the new orchestration API and
fully supports the new CLI and dashboard features to manage
cluster deployment.
* cephadm requires container support (podman or docker) and
Python 3.
2020-03-11 15:28:28 +00:00
2020-03-15 13:45:46 +00:00
`Rook <https://rook.io/> `_ deploys and manages Ceph clusters running
in Kubernetes, while also enabling management of storage resources and
2020-03-17 13:58:57 +00:00
provisioning via Kubernetes APIs. We recommend Rook as the way to run Ceph in
2020-03-15 13:45:46 +00:00
Kubernetes or to connect an existing Ceph storage cluster to Kubernetes.
2020-03-11 15:28:28 +00:00
2020-03-17 13:58:57 +00:00
* Rook only supports Nautilus and newer releases of Ceph.
2020-03-15 13:45:46 +00:00
* Rook is the preferred method for running Ceph on Kubernetes, or for
connecting a Kubernetes cluster to an existing (external) Ceph
cluster.
2020-03-17 13:58:57 +00:00
* Rook supports the new orchestrator API. New management features
2020-03-15 13:45:46 +00:00
in the CLI and dashboard are fully supported.
2020-03-11 15:28:28 +00:00
2020-03-15 13:45:46 +00:00
Other methods
~~~~~~~~~~~~~
2020-03-11 15:28:28 +00:00
2020-03-15 13:45:46 +00:00
`ceph-ansible <https://docs.ceph.com/ceph-ansible/> `_ deploys and manages
Ceph clusters using Ansible.
2020-03-11 15:28:28 +00:00
2020-03-15 13:45:46 +00:00
* ceph-ansible is widely deployed.
* ceph-ansible is not integrated with the new orchestrator APIs,
introduced in Nautlius and Octopus, which means that newer
management features and dashboard integration are not available.
2020-03-11 15:28:28 +00:00
2020-10-06 16:20:58 +00:00
`ceph-deploy <https://docs.ceph.com/projects/ceph-deploy/en/latest/> `_ is a tool for quickly deploying clusters.
2013-10-11 22:08:22 +00:00
2020-03-11 15:28:28 +00:00
.. IMPORTANT ::
2013-10-11 22:08:22 +00:00
2020-03-11 15:28:28 +00:00
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.
2012-11-08 06:42:41 +00:00
2021-02-08 12:35:02 +00:00
`ceph-salt <https://github.com/ceph/ceph-salt> `_ installs Ceph using Salt and cephadm.
2016-02-08 11:11:21 +00:00
2020-03-15 13:45:46 +00:00
`jaas.ai/ceph-mon <https://jaas.ai/ceph-mon> `_ installs Ceph using Juju.
2013-11-21 03:27:20 +00:00
2020-03-15 13:45:46 +00:00
`github.com/openstack/puppet-ceph <https://github.com/openstack/puppet-ceph> `_ installs Ceph via Puppet.
2012-11-08 06:42:41 +00:00
2020-03-15 13:45:46 +00:00
Ceph can also be :ref: `installed manually <install-manual>` .
2012-11-08 06:42:41 +00:00
2020-03-13 14:15:29 +00:00
.. toctree ::
:hidden:
2020-03-15 13:45:46 +00:00
index_manual
2020-02-28 13:19:40 +00:00
2021-03-15 07:38:00 +00:00
Windows
~~~~~~~
2020-02-28 13:19:40 +00:00
2021-03-15 07:38:00 +00:00
For Windows installations, please consult this document:
`Windows installation guide`_ .
2020-02-28 13:19:40 +00:00
2021-03-15 07:38:00 +00:00
.. _Windows installation guide: ./windows-install