]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/install: rethink docs install page (similar to PR#33613)
authorZac Dover <zac.dover@gmail.com>
Wed, 11 Mar 2020 15:28:28 +0000 (01:28 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 11 Mar 2020 15:28:28 +0000 (01:28 +1000)
This rearranges the list of installation methods, in accordance with Sage's and Sebastian W's wishes.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/install/index.rst

index a4b8a41038512f603c4f8ac5030d7c481b92784f..298b3b39a75e11d697d3f68e278f2b2c83cccd23 100644 (file)
@@ -4,41 +4,81 @@
 Installing Ceph
 ===============
 
-There are different options to install Ceph. Each solution meet different
-requirements, like ease of maintenance.
+There are various options for installing Ceph. Review the documention for each method before choosing the one that best serves your needs.
 
+We recommend the following installation methods:
+
+   * cephadm
+   * Rook
+
+
+We offer these other methods of installation in addition to the ones we recommend:
+
+   * ceph-ansible
+   * ceph-deploy (no longer actively maintained)
+   * Deepsea (Salt)
+   * Juju
+   * Manual installation (using packages)
+   * Puppet
+
+
+Recommended Methods of Ceph Installation
+========================================
+
+cephadm
+-------
+
+Installs Ceph using containers and systemd.
+
+* :ref:`cephadm-bootstrap`
+
+     * cephadm is supported only on Octopus and newer releases.
+     * cephadm is fully integrated with the new orcehstration API and fully supports the new CLI and dashboard features to manage cluster deployment.
+     * cephadm requires container support (podman or docker) and Python 3.
+
+Rook
+----
+
+Installs Ceph in Kubernetes.
+
+* `rook.io <https://rook.io/>`_ 
+
+   * Rook supports only Nautilus and newer releases of Ceph.
+   * Rook is the preferred deployment method for Ceph with Kubernetes.
+   * Rook fully suports the new orchestrator API. New management features in the CLI and dashboard are fully supported.
+
+Other Methods of Ceph Installation
+==================================
 
 ceph-ansible
-============
+------------
 
 Installs Ceph using Ansible.
 
 * `docs.ceph.com/ceph-ansible <https://docs.ceph.com/ceph-ansible/>`_ 
 
 ceph-deploy
-===========
+-----------
 
 Install ceph using ceph-deploy
 
 * :ref:`ceph-deploy-index`
 
+  .. IMPORTANT::
 
-cephadm
-=======
 
-Installs Ceph using containers and systemd.
+   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.
 
-* :ref:`cephadm-bootstrap`
 
 DeepSea
-=======
+-------
 
 Install Ceph using Salt
 
 * `github.com/SUSE/DeepSea <https://github.com/SUSE/DeepSea>`_
 
 Juju
-====
+----
 
 Installs Ceph using Juju.
 
@@ -46,26 +86,20 @@ Installs Ceph using Juju.
 
 
 Manual
-======
+------
 
 Manually install Ceph using packages.
 
 * :ref:`install-manual`
 
 Puppet
-======
+------
 
 Installs Ceph using Puppet
 
 * `github.com/openstack/puppet-ceph <https://github.com/openstack/puppet-ceph>`_
 
 
-Rook
-====
-
-Installs Ceph in Kubernetes.
-
-* `rook.io <https://rook.io/>`_ 
 
 
 .. toctree::