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
  40     $ source kamaki-env/bin/activate
  41
  42 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>`_
  43
  44 2. Install snf-common
  45 """""""""""""""""""""
  46
  47 Package snf-common is part of the synnefo project and is a kamaki dependency since version 0.6.0.
  48
  49 .. code-block:: console
  50
  51     $ git clone http://code.grnet.gr/git/synnefo
  52
  53     $ cd synnefo/snf-common
  54
  55     $ ./setup build install
  56
  57     $ cd -
  58
  59 3. Install kamaki
  60 """""""""""""""""
  61
  62 .. code-block:: console
  63
  64     $ git clone http://code.grnet.gr/git/kamaki
  65
  66     $ cd kamaki
  67
  68     $ ./setup build install
  69
  70 4. Install progress and/or ansicolors (optional)
  71 """"""""""""""""""""""""""""""""""""""""""""""""
  72
  73 progress: command-line progress bars (in some commands)
  74
  75 ansicolors: color kamaki output (can switched on and off in `setup <setup.html>`_)
  76
  77 .. code-block:: console
  78
  79     $ pip install progress
  80
  81     $ pip install ansicolors
  82
  83 Ubuntu and Debian packages
  84 ^^^^^^^^^^^^^^^^^^^^^^^^^^
  85
  86 The following steps describe a command-line approach, but any graphic package manager can be used instead.
  87
  88 1. Add the following to apt sources list
  89 """"""""""""""""""""""""""""""""""""""""
  90
  91 * Debian::
  92
  93     deb http://apt.dev.grnet.gr/ sid main
  94
  95 * Ubuntu::
  96
  97     deb http://apt.dev.grnet.gr/ precise main
  98
  99 2. Update
 100 """""""""
 101
 102 .. code-block:: console
 103
 104     $ sudo apt-get update
 105
 106 .. note:: Safely ignore a signature verification error like the following, if it emerges:
 107
 108     .. warning:: GPG error: http://apt.dev.grnet.gr precise/sid InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY XXXXXXXX
 109
 110 3. Install kamaki
 111 """""""""""""""""
 112
 113 Since version 0.6.0, the package snf-common (available at synnefo apt repository) will be automatically installed as a dependency.
 114
 115 .. code-block:: console
 116
 117     $ sudo apt-get install kamaki
 118
 119 4. Install ansicolors and/or progress (Optional)
 120 """"""""""""""""""""""""""""""""""""""""""""""""
 121
 122 .. code-block:: console
 123
 124     $ sudo apt-get install python-ansicolors
 125
 126     $ sudo apt-get install python-progress
 127
 128 Mac OS X
 129 --------
 130
 131 Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-source-ref`.
 132
 133 Windows
 134 -------
 135
 136 It has proven possible (and not too tricky) to install kamaki on Windows console using some auxiliary applications, but Windows users are not the target audience for the time being.