]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Minor edits. Still WIP.
authorJohn Wilkins <john.wilkins@dreamhost.com>
Wed, 25 Apr 2012 21:50:15 +0000 (14:50 -0700)
committerTommi Virtanen <tommi.virtanen@dreamhost.com>
Wed, 2 May 2012 19:09:56 +0000 (12:09 -0700)
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
doc/api/index.rst
doc/index.rst
doc/install/build_from_source/build_prerequisites.rst
doc/install/build_from_source/building_ceph.rst
doc/install/build_from_source/cloning_the_ceph_source_code_repository.rst
doc/install/building_ceph_from_source.rst
doc/start/quick_start.rst

index ace387b79840773b17ccdff22bda3fbf7e0cff1e..67d713ae405f229275127facbb1e4f1b53d09676 100644 (file)
@@ -1,6 +1,6 @@
-===================
- API documentation
-===================
+==================
+ API Documentation
+==================
 
 .. toctree::
    :glob:
index 0c3fd50586cb017efd5d4a3536fe0bb9657d3510..2e2e9c19cd73abb5d06d9c1501296981b33e2ee3 100644 (file)
@@ -23,7 +23,6 @@ using NFS or Samba re-exports.
    start/index
    install/index
    create_cluster/index
-   configure/index
    ops/index
    rec/index
    config
index 5d364c9c9bb875d14611b915f8887377166f3cd8..a85d3ed530d646fc6e3ec04262a370779abbaa06 100644 (file)
@@ -31,6 +31,7 @@ depend on the following:
 - ``libexpat1-dev``
 - ``libgtkmm-2.4-dev``
 - ``pkg-config``
+- ``libcurl4-gnutls-dev``
 
 On Ubuntu, execute ``sudo apt-get install`` for each dependency that isn't installed on your host. ::
 
index 81a2039901dacf68d3ede9e299cb84cc68208070..aec425a87d4f977c8cdd67f8a692892e82b9e568 100644 (file)
@@ -17,6 +17,10 @@ You can use ``make -j`` to execute multiple jobs depending upon your system. For
 
        $ make -j4
        
+To install Ceph locally, you may also use:: 
+
+       $ make install
+       
 Building Ceph Documentation
 ===========================
 Ceph utilizes Python’s Sphinx documentation tool. For details on the Sphinx documentation tool, refer to: `Sphinx <http://sphinx.pocoo.org>`_. To build the Ceph documentaiton, navigate to the Ceph repository and execute the build script::
index 8486e2df298702aef9b589e731ed53521fb6bfaf..7666b466834b102cd19384e565c87814a80c609a 100644 (file)
@@ -17,7 +17,7 @@ repository. If you do not have SSH keys for ``github``, execute::
 
        $ ssh-keygen -d
        
-Get the key to add to your ``github`` account::
+Get the key to add to your ``github`` account (the following example assumes you used the default file path)::
 
        $ cat .ssh/id_dsa.pub
        
@@ -43,12 +43,20 @@ Once ``git clone`` executes, you should have a full copy of the Ceph repository.
 
 Clone the Submodules
 --------------------
-Before you can build Ceph, you must get the ``init`` submodule and the ``update`` submodule:: 
+Before you can build Ceph, you must navigate to your new repository and get the ``init`` submodule and the ``update`` submodule:: 
 
+       $ cd ceph       
        $ git submodule init 
        $ git submodule update 
 
 .. tip:: Make sure you maintain the latest copies of these submodules. Running ``git status`` will tell you if the submodules are out of date:: 
 
        $ git status
-       
+
+Choose a Branch
+---------------
+Once you clone the source code and submodules, your Ceph repository will be on the ``master`` branch by default, which is the unstable development branch. You may choose other branches too. 
+
+- ``master``: The unstable development branch.
+- ``stable``: The bugfix branch.
+- ``next``: The release candidate branch.
index 34a3dbae7bb58cadbb6fd9f81c76b2208e061eac..bc3ee10f4bb2e9e66e3060515936f3cb715b553c 100644 (file)
@@ -5,12 +5,12 @@ 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.
 
-1. :doc:`Build Prerequisites <build_from_source/build_prerequisites>`
-2. Get Source Code
-       * :doc:`Downloading a Ceph Release <build_from_source/downloading_a_ceph_release>`
-       * :doc:`Cloning the Ceph Source Code Repository <build_from_source/cloning_the_ceph_source_code_repository>`
-3. :doc:`Building Ceph<build_from_source/building_ceph>`
-4. :doc:`Installing RADOS Processes and Daemons <build_from_source/installing_rados_processes_and_daemons>`
+- :doc:`Build Prerequisites <build_from_source/build_prerequisites>`
+- :doc:`Downloading a Ceph Release <build_from_source/downloading_a_ceph_release>`
+- :doc:`Cloning the Ceph Source Code Repository <build_from_source/cloning_the_ceph_source_code_repository>`
+- :doc:`Building Ceph<build_from_source/building_ceph>`
+- :doc:`Building Ceph Install Packages <build_from_source/build_packages>` 
+
 
 .. toctree::
    :hidden:
@@ -19,4 +19,4 @@ from source, please see the build pre-requisites first. Making sure you have all
    Get a Release <build_from_source/downloading_a_ceph_release>
    Clone the Source <build_from_source/cloning_the_ceph_source_code_repository>
    Build the Source <build_from_source/building_ceph>
-   Installation <build_from_source/installing_rados_processes_and_daemons>
+   Build a Package <build_from_source/build_packages>
\ No newline at end of file
index 78103d90130e0fd388f244cea3497d9eda9f45d2..882c69aa737bec635ce94bc351d17729df955a93 100644 (file)
@@ -2,3 +2,25 @@
 Quick Start
 ===========
 
+Ceph is intended for large-scale deployments, but you may install Ceph on a single host. Quick start is intended for Ubuntu Linux distributions. 
+
+
+Install from a Package
+----------------------
+
+1. Login to your server
+2. Make a directory for ceph packages
+3. 
+
+
+
+
+
+
+Install from Source
+-------------------
+
+
+
+
+