]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/install: Rethink doc/install 33613/head
authorSebastian Wagner <sebastian.wagner@suse.com>
Fri, 28 Feb 2020 13:19:40 +0000 (14:19 +0100)
committerSebastian Wagner <sebastian.wagner@suse.com>
Fri, 28 Feb 2020 13:19:40 +0000 (14:19 +0100)
What about having a list of the various installation possibilities?

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
doc/install/index.rst
doc/install/index_manual.rst [new file with mode: 0644]
doc/start/index.rst

index 3f6f5d278fde03c89dbbad9cddf20a8e6b873f87..a4b8a41038512f603c4f8ac5030d7c481b92784f 100644 (file)
@@ -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 <https://docs.ceph.com/ceph-ansible/>`_ 
 
-.. toctree::
-   :maxdepth: 1
+ceph-deploy
+===========
 
-       Get Packages <get-packages>
-       Get Tarballs <get-tarballs>
-       Clone Source <clone-source>
-       Build Ceph <build-ceph>
-       Ceph Mirrors <mirrors>
-       Ceph Containers <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-deploy>
-       Install Ceph Storage Cluster <install-storage-cluster>
-       Install Ceph Object Gateway <install-ceph-gateway>
-       Install Virtualization for Block <install-vm-cloud>
+* :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 <https://github.com/SUSE/DeepSea>`_
 
-.. toctree::
+Juju
+====
 
-       Manual Deployment <manual-deployment>
-       Manual Deployment on FreeBSD <manual-freebsd-deployment>
+Installs Ceph using Juju.
 
-Upgrade Software
-================
+* `jaas.ai/ceph-mon <https://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 <upgrading-ceph>
+Puppet
+======
 
-.. _get packages: ../install/get-packages
+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::
+   :hidden:
+  
+   index_manual
diff --git a/doc/install/index_manual.rst b/doc/install/index_manual.rst
new file mode 100644 (file)
index 0000000..6852073
--- /dev/null
@@ -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
index 2821a0b9012fb32f5dcdedc90fa7ba64aeacd166..40143214dfb082841e28cb0319637d331c18f1e3 100644 (file)
@@ -1,3 +1,5 @@
+.. _ceph-deploy-index:
+
 ============================
  Installation (ceph-deploy)
 ============================