X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/b50531496d1d44e5562cc164364eb5373f2f9e5e..eb5123b752433283261c4678f520102d1880c414:/docs/install.rst diff --git a/docs/install.rst b/docs/install.rst index e104616..9cf0e6b 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,10 +1,9 @@ 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 will work on processors that do not support virtualization -but it will be extremely slow. +This guide describes how to install snf-image-creator on a Linux system. It is +highly recommended to have virtualization capable hardware. snf-image-creator +will work on processors that do not support virtualization but it will be slow. Dependencies ============ @@ -15,113 +14,165 @@ snf-image-creator depends on the following programs: * Python setuptools [http://pypi.python.org/pypi/setuptools] * Python Dialog [http://pythondialog.sourceforge.net/] * Python bindings for libguestfs [http://libguestfs.org/] - * Kamaki [https://code.grnet.gr/projects/kamaki] + * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile] + * pyparted [https://fedorahosted.org/pyparted/] + * rsync [http://rsync.samba.org/] + * ./kamaki [https://code.grnet.gr/projects/kamaki] * 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, Python-Dialog, and libguestfs) -need to be installed manually by the user. In an Ubuntu 12.04 LTS system this -can be achieved by installing packages provided by the distribution, using the -following command: +The above dependencies are resolved differently, depending on the installation +method you choose. There are two installation methods available: + +#. `Installation using official packages <#install-snf-image-creator-using-official-packages>`_ (currently only for Ubuntu 12.04 LTS and 12.10). + +#. `Installation from source <#install-snf-image-creator-from-source>`_ + +Install snf-image-creator using official packages +================================================= + +For Ubuntu systems, you can use our official packages found in *grnet/synnefo* +Lauchpad PPA. + +Add the synnefo PPA in your system: .. code-block:: console - $ apt-get install python-setuptools python-guestfs python-dialog \ - python-gevent python-dev + $ sudo apt-add-repository ppa:grnet/synnefo + $ sudo apt-get update -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: +If *apt-add-repository* is missing, install *software-properties-common* first: .. code-block:: console - $ apt-get install git + $ sudo apt-get install software-properties-common -Python Virtual Environment -========================== +After the synnefo repository is set up, you should be able to list +snf-image-creator by calling: -Since snf-image-creator and the rest of it's dependencies won't be installed -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 + + $ apt-cache showpkg snf-image-creator + +Install the package by issuing: .. code-block:: console - $ apt-get install python-virtualenv + $ sudo apt-get install snf-image-creator -Now, create a new python virtual environment like this: +If you are using Ubuntu 12.10, also install libguestfs-tools: .. code-block:: console - $ virtualenv --system-site-packages ~/image-creator-env + $ sudo apt-get install libguestfs-tools -and activate it by executing: +.. note:: + If you are asked during the installation to create/update a + "supermin appliance", choose "Yes". + +Install snf-image-creator from source +===================================== + +Manually install the following dependencies: + + * Python 2 [http://www.python.org/] + * Python setuptools [http://pypi.python.org/pypi/setuptools] + * Python Dialog [http://pythondialog.sourceforge.net/] + * Python bindings for libguestfs [http://libguestfs.org/] + * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile] + * pyparted [https://fedorahosted.org/pyparted/] + * rsync [http://rsync.samba.org/] +In Ubuntu you can do this using: + .. code-block:: console - $ source ~/image-creator-env/bin/activate + $ sudo apt-get install python-setuptools python-guestfs python-dialog \ + python-sendfile python-parted rsync -You can later deactivate it using the following command: +If you are using Ubuntu 12.10 you also need to install libguestfs-tools: .. code-block:: console - $ deactivate + $ sudo apt-get install libguestfs-tools + +.. note:: + If you are asked during the installation to create/update a + "supermin appliance", choose "Yes". +Python Virtual Environment +-------------------------- + +Since snf-image-creator and the rest of its dependencies won't be installed +using packages, it's better to work in an isolated python virtual environment +(virtualenv). -snf-common Installation -======================= +Install the Virtual Python Environment builder: +http://pypi.python.org/pypi/virtualenv. -Install snf-common from source, by cloning it's repository: +For Ubuntu use the following command: .. code-block:: console - $ cd ~ - $ git clone https://code.grnet.gr/git/synnefo - $ cd synnefo/snf-common - $ python setup.py build + $ sudo apt-get install python-virtualenv -Then, make sure you are within the activated virtual environment before you +Then create a new python virtual environment: .. code-block:: console - $ python setup.py install - -kamaki Installation -=================== + $ virtualenv --system-site-packages ~/image-creator-env -Install kamaki from source, by cloning it's repository: +and activate it by executing: .. code-block:: console - $ cd ~ - $ git clone https://code.grnet.gr/git/kamaki - $ cd kamaki - $ ./setup.py build + $ source ~/image-creator-env/bin/activate -As above, make sure you are within the activated virtual environment before you -execute: +You may later deactivate it using: .. code-block:: console - $ ./setup.py install + $ deactivate + +kamaki Installation +------------------- + +Refer to `./kamaki documentation `_ +for instructions. You may install kamaki from source inside the virtualenv +you've created above or by using binary packages if they are available for your +distribution. snf-image-creator Installation -============================== +------------------------------ + +Download the latest snf-image-creator source package from +`here `_ and install it +inside the virtualenv using the following commands: -Install snf-image-creator the same way: +.. code-block:: console + + $ tar -xf snf_image_creator-.tar.gz + $ cd snf_image_creator- + $ python ./setup.py install + +Alternatively, you can install the bleeding edge version of the software by +cloning its git repository: .. code-block:: console - $ cd ~ $ git clone https://code.grnet.gr/git/snf-image-creator - $ git checkout stable-0.1 $ cd snf-image-creator - $ ./setup.py build + $ python ./setup.py install -And from within the virtual environment execute: +To do the latter, you'll need to have git (http://git-scm.com/) installed. +For ubuntu this can be done using: .. code-block:: console - $ ./setup.py install + $ sudo apt-get install git + +.. warning:: + Keep in mind that the bleeding edge version may be unstable or even + unusable. +