diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /doc/install/index.rst | |
parent | Initial commit. (diff) | |
download | ceph-upstream/18.2.2.tar.xz ceph-upstream/18.2.2.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/install/index.rst')
-rw-r--r-- | doc/install/index.rst | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/install/index.rst b/doc/install/index.rst new file mode 100644 index 000000000..58ef92a27 --- /dev/null +++ b/doc/install/index.rst @@ -0,0 +1,76 @@ +.. _install-overview: + +=============== +Installing Ceph +=============== + +There are multiple ways to install Ceph. + +Recommended methods +~~~~~~~~~~~~~~~~~~~ + +:ref:`Cephadm <cephadm_deploying_new_cluster>` installs and manages a Ceph +cluster that uses containers and systemd and is tightly integrated with the CLI +and dashboard GUI. + +* cephadm supports only Octopus and newer releases. +* cephadm is fully integrated with the orchestration API and fully supports the + CLI and dashboard features that are used to manage cluster deployment. +* cephadm requires container support (in the form of Podman or Docker) and + Python 3. + +`Rook <https://rook.io/>`_ deploys and manages Ceph clusters running +in Kubernetes, while also enabling management of storage resources and +provisioning via Kubernetes APIs. We recommend Rook as the way to run Ceph in +Kubernetes or to connect an existing Ceph storage cluster to Kubernetes. + +* Rook supports only Nautilus and newer releases of Ceph. +* Rook is the preferred method for running Ceph on Kubernetes, or for + connecting a Kubernetes cluster to an existing (external) Ceph + cluster. +* Rook supports the orchestrator API. Management features in the CLI and + dashboard are fully supported. + +Other methods +~~~~~~~~~~~~~ + +`ceph-ansible <https://docs.ceph.com/ceph-ansible/>`_ deploys and manages +Ceph clusters using Ansible. + +* ceph-ansible is widely deployed. +* ceph-ansible is not integrated with the orchestrator APIs that were + introduced in Nautilus and Octopus, which means that the management features + and dashboard integration introduced in Nautilus and Octopus are not + available in Ceph clusters deployed by means of ceph-ansible. + + +`ceph-deploy <https://docs.ceph.com/projects/ceph-deploy/en/latest/>`_ is a +tool that can be used to quickly deploy clusters. It is deprecated. + + .. IMPORTANT:: + + ceph-deploy is not actively maintained. It is not tested on versions of Ceph + newer than Nautilus. It does not support RHEL8, CentOS 8, or newer operating + systems. + +`ceph-salt <https://github.com/ceph/ceph-salt>`_ installs Ceph using Salt and cephadm. + +`jaas.ai/ceph-mon <https://jaas.ai/ceph-mon>`_ installs Ceph using Juju. + +`github.com/openstack/puppet-ceph <https://github.com/openstack/puppet-ceph>`_ installs Ceph via Puppet. + +Ceph can also be :ref:`installed manually <install-manual>`. + + +.. toctree:: + :hidden: + + index_manual + +Windows +~~~~~~~ + +For Windows installations, consult this document: +`Windows installation guide`_. + +.. _Windows installation guide: ./windows-install |