From ba5cefa5fb2ae61525243643cbd429d966fa255e Mon Sep 17 00:00:00 2001 From: Sebastian Wagner Date: Fri, 28 Feb 2020 14:19:40 +0100 Subject: [PATCH] doc/install: Rethink doc/install What about having a list of the various installation possibilities? Signed-off-by: Sebastian Wagner --- doc/install/index.rst | 102 ++++++++++++++++++----------------- doc/install/index_manual.rst | 74 +++++++++++++++++++++++++ doc/start/index.rst | 2 + 3 files changed, 128 insertions(+), 50 deletions(-) create mode 100644 doc/install/index_manual.rst diff --git a/doc/install/index.rst b/doc/install/index.rst index 3f6f5d278fde0..a4b8a41038512 100644 --- a/doc/install/index.rst +++ b/doc/install/index.rst @@ -1,72 +1,74 @@ -======================= - Installation (Manual) -======================= +.. _install-overview: +=============== +Installing Ceph +=============== -Get Software +There are different options to install Ceph. Each solution meet different +requirements, like ease of maintenance. + + +ceph-ansible ============ -There are several methods for getting Ceph software. The easiest and most common -method is to `get packages`_ by adding repositories for use with package -management tools such as the Advanced Package Tool (APT) or Yellowdog Updater, -Modified (YUM). You may also retrieve pre-compiled packages from the Ceph -repository. Finally, you can retrieve tarballs or clone the Ceph source code -repository and build Ceph yourself. +Installs Ceph using Ansible. +* `docs.ceph.com/ceph-ansible `_ -.. toctree:: - :maxdepth: 1 +ceph-deploy +=========== - Get Packages - Get Tarballs - Clone Source - Build Ceph - Ceph Mirrors - Ceph Containers +Install ceph using ceph-deploy +* :ref:`ceph-deploy-index` -Install Software -================ -Once you have the Ceph software (or added repositories), installing the software -is easy. To install packages on each :term:`Ceph Node` in your cluster. You may -use ``ceph-deploy`` to install Ceph for your storage cluster, or use package -management tools. You should install Yum Priorities for RHEL/CentOS and other -distributions that use Yum if you intend to install the Ceph Object Gateway or -QEMU. +cephadm +======= -.. toctree:: - :maxdepth: 1 +Installs Ceph using containers and systemd. - Install ceph-deploy - Install Ceph Storage Cluster - Install Ceph Object Gateway - Install Virtualization for Block +* :ref:`cephadm-bootstrap` +DeepSea +======= -Deploy a Cluster Manually -========================= +Install Ceph using Salt -Once you have Ceph installed on your nodes, you can deploy a cluster manually. -The manual procedure is primarily for exemplary purposes for those developing -deployment scripts with Chef, Juju, Puppet, etc. +* `github.com/SUSE/DeepSea `_ -.. toctree:: +Juju +==== - Manual Deployment - Manual Deployment on FreeBSD +Installs Ceph using Juju. -Upgrade Software -================ +* `jaas.ai/ceph-mon `_ -As new versions of Ceph become available, you may upgrade your cluster to take -advantage of new functionality. Read the upgrade documentation before you -upgrade your cluster. Sometimes upgrading Ceph requires you to follow an upgrade -sequence. -.. toctree:: - :maxdepth: 2 +Manual +====== + +Manually install Ceph using packages. + +* :ref:`install-manual` - Upgrading Ceph +Puppet +====== -.. _get packages: ../install/get-packages +Installs Ceph using Puppet + +* `github.com/openstack/puppet-ceph `_ + + +Rook +==== + +Installs Ceph in Kubernetes. + +* `rook.io `_ + + +.. toctree:: + :hidden: + + index_manual diff --git a/doc/install/index_manual.rst b/doc/install/index_manual.rst new file mode 100644 index 0000000000000..68520735ac670 --- /dev/null +++ b/doc/install/index_manual.rst @@ -0,0 +1,74 @@ +.. _install-manual: + +======================= + Installation (Manual) +======================= + + +Get Software +============ + +There are several methods for getting Ceph software. The easiest and most common +method is to `get packages`_ by adding repositories for use with package +management tools such as the Advanced Package Tool (APT) or Yellowdog Updater, +Modified (YUM). You may also retrieve pre-compiled packages from the Ceph +repository. Finally, you can retrieve tarballs or clone the Ceph source code +repository and build Ceph yourself. + + +.. toctree:: + :maxdepth: 1 + + Get Packages + Get Tarballs + Clone Source + Build Ceph + Ceph Mirrors + Ceph Containers + + +Install Software +================ + +Once you have the Ceph software (or added repositories), installing the software +is easy. To install packages on each :term:`Ceph Node` in your cluster. You may +use ``ceph-deploy`` to install Ceph for your storage cluster, or use package +management tools. You should install Yum Priorities for RHEL/CentOS and other +distributions that use Yum if you intend to install the Ceph Object Gateway or +QEMU. + +.. toctree:: + :maxdepth: 1 + + Install ceph-deploy + Install Ceph Storage Cluster + Install Ceph Object Gateway + Install Virtualization for Block + + +Deploy a Cluster Manually +========================= + +Once you have Ceph installed on your nodes, you can deploy a cluster manually. +The manual procedure is primarily for exemplary purposes for those developing +deployment scripts with Chef, Juju, Puppet, etc. + +.. toctree:: + + Manual Deployment + Manual Deployment on FreeBSD + +Upgrade Software +================ + +As new versions of Ceph become available, you may upgrade your cluster to take +advantage of new functionality. Read the upgrade documentation before you +upgrade your cluster. Sometimes upgrading Ceph requires you to follow an upgrade +sequence. + +.. toctree:: + :maxdepth: 2 + + Upgrading Ceph + +.. _get packages: ../install/get-packages diff --git a/doc/start/index.rst b/doc/start/index.rst index 2821a0b9012fb..40143214dfb08 100644 --- a/doc/start/index.rst +++ b/doc/start/index.rst @@ -1,3 +1,5 @@ +.. _ceph-deploy-index: + ============================ Installation (ceph-deploy) ============================ -- 2.39.5