This guide describes the standard installation process for kamaki, with the aspiration of covering as much cases as possible. Although kamaki was initially targeted to advanced Linux/Unix-like users, it should be quite straightforward to install and have it up and running in most popular platforms.
+
* Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
* Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
Linux and Unix-like enviroments
-------------------------------
+.. _installing-from-source-ref:
+
Installing from source (git repos.)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Setup a virtual enviroment (optional)
-"""""""""""""""""""""""""""""""""""""
+Requirements
+""""""""""""
+
+Essential:
+
+ * Python 2.6 or better [http://www.python.org]
+ * Python setuptools [http://pypi.python.org/pypi/setuptools]
+
+Optional:
+
+ * VirtualEnv (python-virtualenv) [http://www.virtualenv.org]
+
+1. Setup a virtual enviroment (optional)
+""""""""""""""""""""""""""""""""""""""""
+
+With virtualenv users can setup kamaki and synnefo services in a sandbox environment.
.. code-block:: console
$ virtualenv kamaki-env
-
$ source kamaki-env/bin/activate
-.. hint:: More about virtualenv: `<http://www.virtualenv.org>`_
+A more detailed example of using virtual env can be found at the `snf-image-creator setup guide <http://docs.dev.grnet.gr/snf-image-creator/latest/install.html#python-virtual-environment>`_
-Install snf-common from synnefo project (required since v0.6.1)
-"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+2. Install objpool (was: snf-common)
+""""""""""""""""""""""""""""""""""""""""""
-.. code-block:: console
+.. note:: **versions 0.6.0 - 0.6.1**
- $ git clone http://code.grnet.gr/git/synnefo
+ 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:
- $ cd synnefo/snf-common
+ .. code-block:: console
- $ ./setup build install
+ $ 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 objpool (hence the snf-common dependency is now obsolete). The objpool package is easy to install from source, even on windows platforms:
+.. code-block:: console
+
+ $ git clone http://code.grnet.gr/git/objpool
+ $ cd objpool
+ $ ./setup build install
$ cd -
-Install kamaki
-""""""""""""""
+3. Install kamaki
+"""""""""""""""""
.. code-block:: console
$ git clone http://code.grnet.gr/git/kamaki
-
$ cd kamaki
-
$ ./setup build install
-Install progress and/or ansicolors (optional)
-"""""""""""""""""""""""""""""""""""""""""""""
+4. Install progress and/or ansicolors (optional)
+""""""""""""""""""""""""""""""""""""""""""""""""
+
+progress: command-line progress bars (in some commands)
-|Progress: Allows command-line progress bars in some commands
-|Ansicolors: Colors at kamaki output (can switched on and off in `setup <setup.html>`_)
+ansicolors: color kamaki output (can switched on and off in `setup <setup.html>`_)
.. code-block:: console
$ pip install progress
-
$ pip install ansicolors
Ubuntu and Debian packages
^^^^^^^^^^^^^^^^^^^^^^^^^^
-Mac OS
-------
+The following steps describe a command-line approach, but any graphic package manager can be used instead.
+
+1. Add the following to apt sources list
+""""""""""""""""""""""""""""""""""""""""
+
+* Debian::
+
+ deb http://apt.dev.grnet.gr/ sid main
+
+* Ubuntu::
+
+ deb http://apt.dev.grnet.gr/ precise main
+
+2. Update
+"""""""""
+
+.. code-block:: console
+
+ $ sudo apt-get update
+
+.. note:: Don't forget to get the GPG public key for the GRNET dev team:
+
+ .. code-block:: console
+
+ $ curl https://okeanos.io/files/apt-grnetdev.pub|apt-key add -
+
+ otherwise *apt-get update* will produce GPG warnings.
+
+3. Install kamaki
+"""""""""""""""""
+
+.. note:: **versions 0.6.0 - 0.6.1:**
+
+ The *snf-common* package (available at synnefo apt repository) will be automatically installed as a dependency.
+
+.. note:: **versions 0.6.2 and on:**
+
+ 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.
+
+.. code-block:: console
+
+ $ sudo apt-get install kamaki
+
+4. Install ansicolors and/or progress (Optional)
+""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. code-block:: console
+
+ $ sudo apt-get install python-ansicolors
+ $ sudo apt-get install python-progress
+
+Mac OS X
+--------
+
+Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-source-ref`.
Windows
-------
-Installing from source (git repos.)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Although it is proven not too tricky to install kamaki on Windows console using `git for windows <http://git-scm.com/downloads>`_, Windows environments are not supported at the time being.
projects / kamaki / blobdiff