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