From f53c8206f882ae132885070962ccb67b20b66e09 Mon Sep 17 00:00:00 2001 From: John Wilkins Date: Wed, 25 Apr 2012 14:50:15 -0700 Subject: [PATCH] Minor edits. Still WIP. Signed-off-by: John Wilkins Signed-off-by: Tommi Virtanen --- doc/api/index.rst | 6 ++--- doc/index.rst | 1 - .../build_from_source/build_prerequisites.rst | 1 + .../build_from_source/building_ceph.rst | 4 ++++ ...loning_the_ceph_source_code_repository.rst | 14 +++++++++--- doc/install/building_ceph_from_source.rst | 14 ++++++------ doc/start/quick_start.rst | 22 +++++++++++++++++++ 7 files changed, 48 insertions(+), 14 deletions(-) diff --git a/doc/api/index.rst b/doc/api/index.rst index ace387b798407..67d713ae405f2 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -1,6 +1,6 @@ -=================== - API documentation -=================== +================== + API Documentation +================== .. toctree:: :glob: diff --git a/doc/index.rst b/doc/index.rst index 0c3fd50586cb0..2e2e9c19cd73a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -23,7 +23,6 @@ using NFS or Samba re-exports. start/index install/index create_cluster/index - configure/index ops/index rec/index config diff --git a/doc/install/build_from_source/build_prerequisites.rst b/doc/install/build_from_source/build_prerequisites.rst index 5d364c9c9bb87..a85d3ed530d64 100644 --- a/doc/install/build_from_source/build_prerequisites.rst +++ b/doc/install/build_from_source/build_prerequisites.rst @@ -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. :: diff --git a/doc/install/build_from_source/building_ceph.rst b/doc/install/build_from_source/building_ceph.rst index 81a2039901dac..aec425a87d4f9 100644 --- a/doc/install/build_from_source/building_ceph.rst +++ b/doc/install/build_from_source/building_ceph.rst @@ -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 `_. To build the Ceph documentaiton, navigate to the Ceph repository and execute the build script:: diff --git a/doc/install/build_from_source/cloning_the_ceph_source_code_repository.rst b/doc/install/build_from_source/cloning_the_ceph_source_code_repository.rst index 8486e2df29870..7666b466834b1 100644 --- a/doc/install/build_from_source/cloning_the_ceph_source_code_repository.rst +++ b/doc/install/build_from_source/cloning_the_ceph_source_code_repository.rst @@ -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. diff --git a/doc/install/building_ceph_from_source.rst b/doc/install/building_ceph_from_source.rst index 34a3dbae7bb58..bc3ee10f4bb2e 100644 --- a/doc/install/building_ceph_from_source.rst +++ b/doc/install/building_ceph_from_source.rst @@ -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 ` -2. Get Source Code - * :doc:`Downloading a Ceph Release ` - * :doc:`Cloning the Ceph Source Code Repository ` -3. :doc:`Building Ceph` -4. :doc:`Installing RADOS Processes and Daemons ` +- :doc:`Build Prerequisites ` +- :doc:`Downloading a Ceph Release ` +- :doc:`Cloning the Ceph Source Code Repository ` +- :doc:`Building Ceph` +- :doc:`Building Ceph Install Packages ` + .. toctree:: :hidden: @@ -19,4 +19,4 @@ from source, please see the build pre-requisites first. Making sure you have all Get a Release Clone the Source Build the Source - Installation + Build a Package \ No newline at end of file diff --git a/doc/start/quick_start.rst b/doc/start/quick_start.rst index 78103d90130e0..882c69aa737be 100644 --- a/doc/start/quick_start.rst +++ b/doc/start/quick_start.rst @@ -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 +------------------- + + + + + -- 2.39.5