Merge branch 'feature-store' into develop

[kamaki] / docs / installation.rst

diff --git a/docs/installation.rst b/docs/installation.rst
index bd00411..87e777c 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -11,60 +11,62 @@ This guide describes the standard installation process for kamaki, with the aspi
 Linux and Unix-like enviroments
 -------------------------------
 
 Linux and Unix-like enviroments
 -------------------------------
 

-Ubuntu and Debian packages
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Debian:
+^^^^^^^

 
 The following steps describe a command-line approach, but any graphic package manager can be used instead.
 
 
 The following steps describe a command-line approach, but any graphic package manager can be used instead.
 

-Add the following to apt sources list
-"""""""""""""""""""""""""""""""""""""
+* As root, append the following to */etc/apt/sources.list* ::

 
 

-As root, append one of the following to */etc/apt/sources.list*:
+    deb http://apt.dev.grnet.gr/ squeeze main
+    deb http://apt2.dev.grnet.gr stable/

 
 

+* Make sure the GPG public key for the GRNET dev team is added:

 
 

-* Debian Stable (kamaki 0.6.2)::
+    .. code-block:: console

 
 

-    deb http://apt.dev.grnet.gr/ squeeze main
-    deb http://apt2.dev.grnet.gr stable/
+        $ sudo curl https://dev.grnet.gr/files/apt-grnetdev.pub|apt-key add -

 
 

-* Ubuntu (kamaki 0.6.2)::
+    otherwise *apt-get update* will produce GPG warnings.

 
 

-    deb http://apt.dev.grnet.gr/ precise main
+* Update the Debian sources:

 
 

+    .. code-block:: console

 
 

-Update
-""""""
+        $ sudo apt-get update

 
 

-.. note:: make sure the GPG public key for the GRNET dev team is added:
+* Install kamaki:

 
     .. code-block:: console
 
 
     .. code-block:: console
 

-        $ curl https://dev.grnet.gr/files/apt-grnetdev.pub|apt-key add -
+        $ sudo apt-get install kamaki

 
 

-    otherwise *apt-get update* will produce GPG warnings.
+Ubuntu
+^^^^^^

 
 

-.. code-block:: console
+The following steps describe a command-line approach, but any graphic package manager can be used instead.

 
 

-    $ sudo apt-get update
+* Let ppa take care of the repository configuration:

 
 

+    .. code-block:: console

 
 

-Install kamaki
-""""""""""""""
+        $ sudo apt-get install python-software-properties
+        $ sudo add-apt-repository ppa:grnet/synnefo

 
 

-.. note:: **versions 0.6.0 - 0.6.1 only:**
+* Update the Debian sources:

 
 

-    The *snf-common* package (available at synnefo apt repository) will be automatically installed as a dependency.
+    .. code-block:: console

 
 

-.. note:: **versions 0.6.2 and on:**
+        $ sudo apt-get update

 
 

-    Since version 0.6.2, *objpool* replaces *snf-common*. The objpool package is also available at synnefo repository and is automatically installed as a dependency. The *snf-common* dependency is removed.
+* Install kamaki:

 
 

-.. code-block:: console
+    .. code-block:: console

 
 

-    $ sudo apt-get install kamaki
+        $ sudo apt-get install kamaki

 
 

-Install ansicolors and/or progress (Optional)
-"""""""""""""""""""""""""""""""""""""""""""""
+Install ansicolors and/or progress (Optional but recommended)
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

 
 .. code-block:: console
 
 
 .. code-block:: console
 

@@ -103,19 +105,6 @@ A more detailed example of using virtual env can be found at the `snf-image-crea
 Install objpool (was: snf-common)
 """""""""""""""""""""""""""""""""
 
 Install objpool (was: snf-common)
 """""""""""""""""""""""""""""""""
 

-.. note:: **versions 0.6.0 - 0.6.1 only**
-
-    Package snf-common is part of the synnefo project and used to be a kamaki dependency in versions from 0.6.0 to 0.6.1 to provide a connection pooling mechanism. Users who still run 0.6.0 or 0.6.1 may need to manually install the snf-common package:
-
-    .. code-block:: console
-
-        $ git clone http://code.grnet.gr/git/synnefo
-        $ cd synnefo/snf-common
-        $ ./setup build install
-        $ cd -
-
-**Version 0.6.2 and on:**
-

 Since 0.6.2, kamaki is based on python-objpool. The objpool package is easy to install from source (even on windows platforms):
 
 .. code-block:: console
 Since 0.6.2, kamaki is based on python-objpool. The objpool package is easy to install from source (even on windows platforms):
 
 .. code-block:: console

@@ -128,7 +117,7 @@ Since 0.6.2, kamaki is based on python-objpool. The objpool package is easy to i
 Install kamaki
 """"""""""""""
 
 Install kamaki
 """"""""""""""
 

-Kamaki can be downloaded from `here <https://code.grnet.gr/projects/kamaki/files>`_, where users can pick the version they prefer and unzip it locally:
+Kamaki can be downloaded from `this location <https://code.grnet.gr/projects/kamaki/files>`_, where users can pick the version they prefer and unzip it locally:

 
 .. code-block:: console
 
 
 .. code-block:: console
 

@@ -143,6 +132,7 @@ or it can be downloaded directly from the git repository:
 and then installed by the setup script:
 
 .. code-block:: console
 and then installed by the setup script:
 
 .. code-block:: console

+

     $ cd kamaki
     $ ./setup build install
 
     $ cd kamaki
     $ ./setup build install