X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/fa77d79a98c00b71221870f0ed7b6a6ca7b23f41..b50531496d1d44e5562cc164364eb5373f2f9e5e:/docs/install.rst diff --git a/docs/install.rst b/docs/install.rst index 7cb9cb9..e104616 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -3,8 +3,8 @@ Installation This guide describes how to install snf-image-creator on an Ubuntu 12.04 LTS system. It it highly recommended to have virtualization capable hardware. -snf-image-creator can work on processors that do not support virtualization but -it will be extremely slow. +snf-image-creator will work on processors that do not support virtualization +but it will be extremely slow. Dependencies ============ @@ -16,29 +16,36 @@ snf-image-creator depends on the following programs: * Python Dialog [http://pythondialog.sourceforge.net/] * Python bindings for libguestfs [http://libguestfs.org/] * Kamaki [https://code.grnet.gr/projects/kamaki] - * Python Sybprocess Wrapper [http://pypi.python.org/pypi/pbs] + * Python sh (previously pbs) [https://github.com/amoffat/sh] * ANSI colors for Python [http://pypi.python.org/pypi/ansicolors] * progress [http://pypi.python.org/pypi/progress] * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile] -The first four programs (python2, setuptools, libguestfs and Python Dialog) +The first four programs (python2, setuptools, Python-Dialog, and libguestfs) need to be installed manually by the user. In an Ubuntu 12.04 LTS system this -can be archived using packages directly provided by the distribution, using -the following command: +can be achieved by installing packages provided by the distribution, using the +following command: .. code-block:: console - $ apt-get install python-setuptools python-guestfs python-dialog + $ apt-get install python-setuptools python-guestfs python-dialog \ + python-gevent python-dev -The rest of the dependencies will be resolved by setuptools. +The rest of the dependencies will be automatically resolved by setuptools. +Keep in mind though that git needs to be installed to download the source +files. You can use the following command: + +.. code-block:: console + + $ apt-get install git Python Virtual Environment ========================== Since snf-image-creator and the rest of it's dependencies won't be installed -using packages provided by the distribution it's better to work in an isolated -python virtual environment (virtualenv). Installing the Virtual Python -Environment builder in Ubuntu can be accomplished using the following command: +using packages, it's better to work in an isolated python virtual environment +(virtualenv). Installing the Virtual Python Environment builder in Ubuntu can +be accomplished using the following command: .. code-block:: console @@ -63,6 +70,24 @@ You can later deactivate it using the following command: $ deactivate +snf-common Installation +======================= + +Install snf-common from source, by cloning it's repository: + +.. code-block:: console + + $ cd ~ + $ git clone https://code.grnet.gr/git/synnefo + $ cd synnefo/snf-common + $ python setup.py build + +Then, make sure you are within the activated virtual environment before you + +.. code-block:: console + + $ python setup.py install + kamaki Installation =================== @@ -70,16 +95,17 @@ Install kamaki from source, by cloning it's repository: .. code-block:: console + $ cd ~ $ git clone https://code.grnet.gr/git/kamaki $ cd kamaki - $ ./setup build + $ ./setup.py build -Then, make sure you are within the activated virtual environment before you +As above, make sure you are within the activated virtual environment before you execute: .. code-block:: console - $ ./setup install + $ ./setup.py install snf-image-creator Installation ============================== @@ -88,13 +114,14 @@ Install snf-image-creator the same way: .. code-block:: console + $ cd ~ $ git clone https://code.grnet.gr/git/snf-image-creator + $ git checkout stable-0.1 $ cd snf-image-creator - $ ./setup build + $ ./setup.py build And from within the virtual environment execute: .. code-block:: console - $ ./setup install - + $ ./setup.py install