code.grnet.gr Git - kamaki/blob - docs/installation.rst

   1 Installation
   2 ============
   3
   4 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.
   5
   6
   7 * Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
   8
   9 * Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
  10
  11 Linux and Unix-like enviroments
  12 -------------------------------
  13
  14 .. _installing-from-source-ref:
  15
  16 Installing from source (git repos.)
  17 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  18
  19 Requirements
  20 """"""""""""
  21
  22 Essential:
  23
  24  * Python 2.6 or better [http://www.python.org]
  25  * Python setuptools [http://pypi.python.org/pypi/setuptools]
  26
  27 Optional:
  28
  29  * VirtualEnv (python-virtualenv) [http://www.virtualenv.org]
  30
  31 1. Setup a virtual enviroment (optional)
  32 """"""""""""""""""""""""""""""""""""""""
  33
  34 With virtualenv users can setup kamaki and synnefo services in a sandbox environment.
  35
  36 .. code-block:: console
  37
  38     $ virtualenv kamaki-env
  39     $ source kamaki-env/bin/activate
  40
  41 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>`_
  42
  43 2. Install objpool (was: snf-common)
  44 """"""""""""""""""""""""""""""""""""""""""
  45
  46 .. note:: **versions 0.6.0 - 0.6.1**
  47
  48     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:
  49
  50     .. code-block:: console
  51
  52         $ git clone http://code.grnet.gr/git/synnefo
  53         $ cd synnefo/snf-common
  54         $ ./setup build install
  55         $ cd -
  56
  57 **Version 0.6.2 and on:**
  58
  59 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:
  60
  61 .. code-block:: console
  62
  63     $ git clone http://code.grnet.gr/git/objpool
  64     $ cd objpool
  65     $ ./setup build install
  66     $ cd -
  67
  68 3. Install kamaki
  69 """""""""""""""""
  70
  71 .. code-block:: console
  72
  73     $ git clone http://code.grnet.gr/git/kamaki
  74     $ cd kamaki
  75     $ ./setup build install
  76
  77 4. Install progress and/or ansicolors (optional)
  78 """"""""""""""""""""""""""""""""""""""""""""""""
  79
  80 progress: command-line progress bars (in some commands)
  81
  82 ansicolors: color kamaki output (can switched on and off in `setup <setup.html>`_)
  83
  84 .. code-block:: console
  85
  86     $ pip install progress
  87     $ pip install ansicolors
  88
  89 Ubuntu and Debian packages
  90 ^^^^^^^^^^^^^^^^^^^^^^^^^^
  91
  92 The following steps describe a command-line approach, but any graphic package manager can be used instead.
  93
  94 1. Add the following to apt sources list
  95 """"""""""""""""""""""""""""""""""""""""
  96
  97 * Debian::
  98
  99     deb http://apt.dev.grnet.gr/ sid main
 100
 101 * Ubuntu::
 102
 103     deb http://apt.dev.grnet.gr/ precise main
 104
 105 2. Update
 106 """""""""
 107
 108 .. code-block:: console
 109
 110     $ sudo apt-get update
 111
 112 .. note:: Don't forget to get the GPG public key for the GRNET dev team:
 113
 114     .. code-block:: console
 115
 116         $ curl https://okeanos.io/files/apt-grnetdev.pub|apt-key add -
 117
 118     otherwise *apt-get update* will produce GPG warnings.
 119
 120 3. Install kamaki
 121 """""""""""""""""
 122
 123 .. note:: **versions 0.6.0 - 0.6.1:**
 124
 125     The *snf-common* package (available at synnefo apt repository) will be automatically installed as a dependency.
 126
 127 .. note:: **versions 0.6.2 and on:**
 128
 129     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.
 130
 131 .. code-block:: console
 132
 133     $ sudo apt-get install kamaki
 134
 135 4. Install ansicolors and/or progress (Optional)
 136 """"""""""""""""""""""""""""""""""""""""""""""""
 137
 138 .. code-block:: console
 139
 140     $ sudo apt-get install python-ansicolors
 141     $ sudo apt-get install python-progress
 142
 143 Mac OS X
 144 --------
 145
 146 Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-source-ref`.
 147
 148 Windows
 149 -------
 150
 151 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.