From e70d170f4f58107a8b65c07217e0f922eabc6ed0 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Thu, 15 Aug 2013 17:05:16 -0400 Subject: [PATCH] update the readme Signed-off-by: Alfredo Deza --- README.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index f55a34f..0841bb6 100644 --- a/README.rst +++ b/README.rst @@ -17,9 +17,55 @@ It does not handle client configuration beyond pushing the Ceph config file and users who want fine-control over security settings, partitions or directory locations should use a tool such as Chef or Puppet. -Setup -===== +Installation +============ +Depending on what type of usage you are going to have with ``ceph-deploy`` you +might want to look into the different ways to install it. For automation, you +might want to ``bootstrap`` directly. Regular users of ``ceph-deploy`` would +probably install from the OS packages or from the Python Package Index. +Python Package Index +-------------------- +If you are familiar with Python install tools (like ``pip`` and +``easy_install``) you can easily install ``ceph-deploy`` like:: + + pip install ceph-deploy + +or:: + + easy_install ceph-deploy + + +It should grab all the dependencies for you and install into the current user's +environment. + +We highly recommend using ``virtualenv`` and installing dependencies in +a contained way. + + +DEB +--- +The DEB repo can be found at http://ceph.com/packages/ceph-extras/debian/ + +But they can also be found for ``ceph`` releases in the ``ceph`` repos like:: + + ceph.com/debian-{release} + ceph.com/debian-testing + +RPM +--- +The RPM repos can be found at http://ceph.com/packages/ceph-extras/rpm/ + +Make sure you add the proper one for your distribution. + +But they can also be found for ``ceph`` releases in the ``ceph`` repos like:: + + ceph.com/rpm-{release} + ceph.com/rpm-testing + + +bootstraping +------------ To get the source tree ready for use, run this once:: ./bootstrap -- 2.47.3