projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 9f95a23c | 1 | .. _install-overview: |
| 7c673cae | 2 | |
| 9f95a23c TL |
3 | =============== |
| 4 | Installing Ceph | |
| 5 | =============== | |
| 7c673cae | 6 | |
| 9f95a23c | 7 | There are several different ways to install Ceph. Choose the |
| f67539c2 | 8 | method that best suits your needs. |
| 7c673cae | 9 | |
| 9f95a23c TL |
10 | Recommended methods |
| 11 | ~~~~~~~~~~~~~~~~~~~ | |
| 7c673cae | 12 | |
| 9f95a23c TL |
13 | :ref:`Cephadm <cephadm>` installs and manages a Ceph cluster using containers and |
| 14 | systemd, with tight integration with the CLI and dashboard GUI. | |
| 7c673cae | 15 | |
| 1911f103 | 16 | * cephadm only supports Octopus and newer releases. |
| 9f95a23c TL |
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. | |
| 7c673cae | 22 | |
| 9f95a23c TL |
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. | |
| 7c673cae | 27 | |
| 9f95a23c TL |
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. | |
| 7c673cae | 34 | |
| 9f95a23c TL |
35 | Other methods |
| 36 | ~~~~~~~~~~~~~ | |
| 7c673cae | 37 | |
| 9f95a23c TL |
38 | `ceph-ansible <https://docs.ceph.com/ceph-ansible/>`_ deploys and manages |
| 39 | Ceph clusters using Ansible. | |
| 7c673cae | 40 | |
| 9f95a23c TL |
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. | |
| 7c673cae | 45 | |
| 7c673cae | 46 | |
| f67539c2 | 47 | `ceph-deploy <https://docs.ceph.com/projects/ceph-deploy/en/latest/>`_ is a tool for quickly deploying clusters. |
| 7c673cae | 48 | |
| 9f95a23c | 49 | .. IMPORTANT:: |
| 7c673cae | 50 | |
| 9f95a23c | 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. |
| 7c673cae | 52 | |
| 20effc67 | 53 | `ceph-salt <https://github.com/ceph/ceph-salt>`_ installs Ceph using Salt and cephadm. |
| 7c673cae | 54 | |
| 9f95a23c | 55 | `jaas.ai/ceph-mon <https://jaas.ai/ceph-mon>`_ installs Ceph using Juju. |
| 7c673cae | 56 | |
| 9f95a23c TL |
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>`. | |
| 7c673cae | 60 | |
| 7c673cae FG |
61 | |
| 62 | .. toctree:: | |
| 9f95a23c TL |
63 | :hidden: |
| 64 | ||
| 65 | index_manual | |
| 9f95a23c | 66 | |
| f67539c2 TL |
67 | Windows |
| 68 | ~~~~~~~ | |
| 7c673cae | 69 | |
| f67539c2 TL |
70 | For Windows installations, please consult this document: |
| 71 | `Windows installation guide`_. | |
| 7c673cae | 72 | |
| f67539c2 | 73 | .. _Windows installation guide: ./windows-install |