From: John Wilkins Date: Thu, 8 Nov 2012 06:42:41 +0000 (-0800) Subject: doc: Rewrote index for install section per new IA. X-Git-Tag: v0.55~154 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=937345219dc37f02d3f89cbe0c0ea785063e48af;p=ceph.git doc: Rewrote index for install section per new IA. Signed-off-by: John Wilkins --- diff --git a/doc/install/index.rst b/doc/install/index.rst index eba6d1567a15b..9c17f9849b182 100644 --- a/doc/install/index.rst +++ b/doc/install/index.rst @@ -2,25 +2,70 @@ Installation ============== -Storage clusters are the foundation of the Ceph system. Ceph storage hosts -provide object storage. Clients access the Ceph storage cluster directly from -an application (using ``librados``), over an object storage protocol such as -Amazon S3 or OpenStack Swift (using ``radosgw``), or with a block device -(using ``rbd``). To begin using Ceph, you must first set up a storage cluster. +The Ceph Object Store is the foundation of all Ceph clusters, and it consists +primarily of two types of daemons: Object Storage Daemons (OSDs) and monitors. +The Ceph Object Store is based upon the concept of +:abbr:`RADOS (Reliable Autonomic Distributed Object Store)`, which eliminates +single points of failure and delivers infinite scalability. For details on +the architecture of Ceph and RADOS, refer to `Ceph Architecture`_. All Ceph +deployments have OSDs and monitors, so you should prepare your Ceph cluster +by focusing first on the object storage cluster. -You may deploy Ceph with our ``mkcephfs`` bootstrap utility for development -and test environments. For production environments, we recommend deploying -Ceph with the Chef cloud management tool. +.. raw:: html -If your deployment uses OpenStack, you will also need to install OpenStack. - -The following sections provide guidance for installing components used with -Ceph: +

Recommendations

+ +To begin using Ceph in production, you should review our hardware +recommendations and operating system recommendations. Many of the +frequently-asked questions in our mailing list involve hardware-related +questions and how to install Ceph on various distributions. .. toctree:: Hardware Recommendations OS Recommendations + +.. raw:: html + +

Installation

+ +If you are deploying a Ceph cluster (that is, not developing Ceph), +install Ceph using our stable release packages. For testing, you +may install development release and testing packages. If you intend +to deploy Ceph using OpsCode Chef, review the instructions for +Chef below. + +.. tip:: If you are using Dell Crowbar, or Ceph-Deploy you do not + need to install OpsCode Chef. + +.. toctree:: + Installing Debian/Ubuntu Packages Installing RPM Packages - Installing Chef + Installing OpsCode Chef + +.. raw:: html + +

Building Ceph from Source

+ +You can build Ceph from source by downloading a release or cloning the ``ceph`` +repository at github. If you intend to build Ceph from source, please see the +build pre-requisites first. Making sure you have all the pre-requisites +will save you time. + +.. toctree:: + + Prerequisites + Get a Tarball + Set Up Git + Clone the Source + Build the Source + Build a Package + Contributing Code + + +.. raw:: html + +
+ +.. _Ceph Architecture: ../architecture/