doc/install: Rethink doc/install

What about having a list of the various installation possibilities?

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
This commit is contained in:
Sebastian Wagner 2020-02-28 14:19:40 +01:00
parent c62f43e81d
commit ba5cefa5fb
3 changed files with 143 additions and 65 deletions

View File

@ -1,72 +1,74 @@
=======================
Installation (Manual)
=======================
.. _install-overview:
===============
Installing Ceph
===============
There are different options to install Ceph. Each solution meet different
requirements, like ease of maintenance.
Get Software
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 <https://docs.ceph.com/ceph-ansible/>`_
ceph-deploy
===========
Install ceph using ceph-deploy
* :ref:`ceph-deploy-index`
cephadm
=======
Installs Ceph using containers and systemd.
* :ref:`cephadm-bootstrap`
DeepSea
=======
Install Ceph using Salt
* `github.com/SUSE/DeepSea <https://github.com/SUSE/DeepSea>`_
Juju
====
Installs Ceph using Juju.
* `jaas.ai/ceph-mon <https://jaas.ai/ceph-mon>`_
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::
:maxdepth: 1
Get Packages <get-packages>
Get Tarballs <get-tarballs>
Clone Source <clone-source>
Build Ceph <build-ceph>
Ceph Mirrors <mirrors>
Ceph Containers <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-deploy>
Install Ceph Storage Cluster <install-storage-cluster>
Install Ceph Object Gateway <install-ceph-gateway>
Install Virtualization for Block <install-vm-cloud>
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>
Manual Deployment on FreeBSD <manual-freebsd-deployment>
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 <upgrading-ceph>
.. _get packages: ../install/get-packages
:hidden:
index_manual

View File

@ -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-packages>
Get Tarballs <get-tarballs>
Clone Source <clone-source>
Build Ceph <build-ceph>
Ceph Mirrors <mirrors>
Ceph Containers <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-deploy>
Install Ceph Storage Cluster <install-storage-cluster>
Install Ceph Object Gateway <install-ceph-gateway>
Install Virtualization for Block <install-vm-cloud>
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>
Manual Deployment on FreeBSD <manual-freebsd-deployment>
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 <upgrading-ceph>
.. _get packages: ../install/get-packages

View File

@ -1,3 +1,5 @@
.. _ceph-deploy-index:
============================
Installation (ceph-deploy)
============================