-=======================
- Installation (Manual)
-=======================
+.. _install-overview:
+===============
+Installing Ceph
+===============
-Get Software
-============
+There are several different ways to install Ceph. Choose the
+method that best suites your needs.
-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.
+Recommended methods
+~~~~~~~~~~~~~~~~~~~
+:ref:`Cephadm <cephadm>` installs and manages a Ceph cluster using containers and
+systemd, with tight integration with the CLI and dashboard GUI.
-.. toctree::
- :maxdepth: 1
+* cephadm only supports only 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
+ Python 3.
- Get Packages <get-packages>
- Get Tarballs <get-tarballs>
- Clone Source <clone-source>
- Build Ceph <build-ceph>
- Ceph Mirrors <mirrors>
+`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
+Kubernetes or to connect an existing Ceph storage cluster to Kubernetes.
+* Rook only supports 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.
-Install Software
-================
+Other methods
+~~~~~~~~~~~~~
-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.
+`ceph-ansible <https://docs.ceph.com/ceph-ansible/>`_ deploys and manages
+Ceph clusters using Ansible.
-.. toctree::
- :maxdepth: 1
+* ceph-ansible is widely deployed.
+* ceph-ansible is not integrated with the new orchestrator APIs,
+ introduced in Nautlius and Octopus, which means that newer
+ management features and dashboard integration are not available.
- 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:`ceph-deploy <ceph-deploy-index>` is a tool for quickly deploying clusters.
-Deploy a Cluster Manually
-=========================
+ .. IMPORTANT::
-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.
+ 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.
-.. toctree::
+`DeepSea <https://github.com/SUSE/DeepSea>`_ installs Ceph using Salt.
- Manual Deployment <manual-deployment>
- Manual Deployment on FreeBSD <manual-freebsd-deployment>
+`jaas.ai/ceph-mon <https://jaas.ai/ceph-mon>`_ installs Ceph using Juju.
-Upgrade Software
-================
+`github.com/openstack/puppet-ceph <https://github.com/openstack/puppet-ceph>`_ installs Ceph via Puppet.
+
+Ceph can also be :ref:`installed manually <install-manual>`.
-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
+ :hidden:
+
+ index_manual
+ ceph-deploy/index
+
- Upgrading Ceph <upgrading-ceph>
-.. _get packages: ../install/get-packages
projects / ceph.git / blobdiff