Skip to content

Commit

Permalink
doc/install: refine index.rst
Browse files Browse the repository at this point in the history
Refine English sentences in doc/install/index.rst. Remove adverbial
phrases of time that refer to Nautilus-era features as "new", since that
was four years ago.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
  • Loading branch information
Zac Dover committed Jan 21, 2023
1 parent 5b06a7d commit e766953
Showing 1 changed file with 23 additions and 20 deletions.
43 changes: 23 additions & 20 deletions doc/install/index.rst
Expand Up @@ -4,34 +4,33 @@
Installing Ceph
===============

There are several different ways to install Ceph. Choose the
method that best suits your needs.
There are multiple ways to install Ceph. Choose the method that best suits
your needs.

Recommended methods
~~~~~~~~~~~~~~~~~~~

:ref:`Cephadm <cephadm_deploying_new_cluster>` installs and manages a Ceph
cluster using containers and systemd, with tight integration with the CLI and
dashboard GUI.

* cephadm only supports Octopus and newer releases.
* 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
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
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 only supports Nautilus and newer releases of Ceph.
* 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 new orchestrator API. New management features
in the CLI and dashboard are fully supported.
* Rook supports the orchestrator API. Management features in the CLI and
dashboard are fully supported.

Other methods
~~~~~~~~~~~~~
Expand All @@ -40,16 +39,20 @@ Other methods
Ceph clusters using Ansible.

* ceph-ansible is widely deployed.
* ceph-ansible is not integrated with the new orchestrator APIs,
introduced in Nautilus and Octopus, which means that newer
management features and dashboard integration are not available.
* 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 for quickly deploying clusters.
`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 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.
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.

Expand All @@ -68,7 +71,7 @@ Ceph can also be :ref:`installed manually <install-manual>`.
Windows
~~~~~~~

For Windows installations, please consult this document:
For Windows installations, consult this document:
`Windows installation guide`_.

.. _Windows installation guide: ./windows-install

0 comments on commit e766953

Please sign in to comment.