^^^^^^^^^^^^
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.
+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 extremely slow.
* 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)
-need to be installed manually by the user. In an Ubuntu 12.04 LTS system this
-can be archived 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. The first uses official packages whereas
+the second installs snf-image-creator and its dependencies from source. Both
+methods are presented below.
+
+Install snf-image-creator using official packages
+=================================================
+
+This method of installing snf-image-creator has all the advantages of Ubuntu's
+APT installation:
+
+* Automatic resolution of dependencies
+* Simple installation of consequent updates
+
+In order to proceed with the installation, you must first add GRNET's dev repo
+to your sources. You can use the following commands:
+
+.. code-block:: console
+
+ $ cd /etc/apt/sources.list.d
+ $ echo "deb http://apt.dev.grnet.gr precise main" | \
+ sudo tee -a apt.dev.grnet.gr.list
+ $ echo "deb-src http://apt.dev.grnet.gr precise main" | \
+ sudo tee -a apt.dev.grnet.gr.list
+
+You will also need to import the repo's GPG key. You can use the ``curl`` tool
+for this.
+
+.. code-block:: console
+
+ $ sudo apt-get install curl
+
+Use the following command to import the GPG key:
+
+.. code-block:: console
+
+ $ sudo curl https://dev.grnet.gr/files/apt-grnetdev.pub | sudo apt-key add -
+
+You can verify that the repo has been added successfully if snf-image-creator
+exists as a package. First do an update of your sources:
+
+.. code-block:: console
+
+ $ sudo apt-get update
+
+then check if snf-image-creator exists with the following command:
+
+.. code-block:: console
+
+ $ apt-cache showpkg snf-image-creator
+
+If GRNET's dev repo has been added successfully, you can install
+snf-image-creator, along with its dependencies, with the following command:
+
+.. code-block:: console
+
+ $ sudo apt-get install snf-image-creator
+
+The installation might take a while. Please note that at some point during the
+installation you will be prompted to create/update a "supermin appliance". This
+is a setting regarding libguestfs and you can safely choose "Yes".
+
+Install snf-image-creator from source
+=====================================
+
+This method provides you with the cutting edge of snf-image-creator, which
+gives you access to all the latest features. Keep in mind, however,
+that you may experience instability issues.
+
+The first four dependencies (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:
.. code-block:: console
$ apt-get install python-setuptools python-guestfs python-dialog
The rest of the dependencies will be automatically resolved by setuptools.
+Note that at some point during the installation, you will be prompted to
+create/update a "supermin appliance". This is a setting regarding libguestfs
+and you can safely choose "Yes".
+
+In order to download the source files, git needs to be installed. You can do
+so with 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
+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). Installing the Virtual Python Environment builder in Ubuntu can
be accomplished 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
+execute:
+
+.. code-block:: console
+
+ $ python setup.py install
kamaki Installation
-===================
+-------------------
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
-==============================
+------------------------------
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
Running *snf-image-creator* with *--print-sysprep* on a raw file that hosts a
debian system, we get the following output:
+.. _sysprep:
+
.. code-block:: console
$ snf-image-creator --print-sysprep debian_desktop.img
Launching helper VM... done
Inspecting Operating System... found a(n) debian system
Mounting the media read-only... done
-
+
Enabled system preparation operations:
cleanup-cache:
Remove all regular files under /var/cache
-
+
cleanup-log:
Empty all files under /var/log
-
+
cleanup-passwords:
Remove all passwords and lock all user accounts
-
+
cleanup-tmp:
Remove all files under /tmp and /var/tmp
-
+
cleanup-userdata:
Delete sensitive userdata
-
+
fix-acpid:
Replace acpid powerdown action scripts to immediately shutdown the
system without checking if a GUI is running.
-
+
remove-persistent-net-rules:
Remove udev rules that will keep network interface names persistent
after hardware changes and reboots. Those rules will be created again
the next time the image runs.
-
+
remove-swap-entry:
Remove swap entry from /etc/fstab. If swap is the last partition
then the partition will be removed when shrinking is performed. If the
swap partition is not the last partition in the disk or if you are not
going to shrink the image you should probably disable this.
-
+
use-persistent-block-device-names:
Scan fstab & grub configuration files and replace all non-persistent
device references with UUIDs.
-
+
Disabled system preparation operations:
cleanup-mail:
Remove all files under /var/mail and /var/spool/mail
-
+
remove-user-accounts:
Remove all user accounts with id greater than 1000
-
-
+
+
cleaning up...
If we want the image to have all normal user accounts and all mail files
When *snf-mkimage* runs in *wizard* mode, the user is just asked to provide the
following basic information:
- * Name: A short name for image (ex. "Slackware")
+ * Name: A short name for the image (ex. "Slackware")
* Description: An one-line description for the image (ex. "Slackware Linux 14.0 with KDE")
* Account: An *~okeanos* account email
* Token: A token corresponding to the account defined previously
$ wget http://ubuntureleases.tsl.gr/12.04.1/ubuntu-12.04.1-server-amd64.iso
+Verify that it has been downloaded correctly:
+
+.. code-block:: console
+
+ $ echo 'a8c667e871f48f3a662f3fbf1c3ddb17 ubuntu-12.04.1-server-amd64.iso' > check.md5
+ $ md5sum -c check.md5
+
Create a 2G sparce file to host the new system:
.. code-block:: console
.. code-block:: console
$ sudo kvm -boot d -drive file=ubuntu_hd.raw,format=raw,cache=none,if=virtio \
- -cdrom ubuntu-12.04.1-server-amd64.iso
+ -m 1000 -cdrom ubuntu-12.04.1-server-amd64.iso
+
+.. note::
+
+ During the installation, you will be asked about the partition scheme. Since
+ snf-image-creator does not support LVM partitions, you are advised to create
+ regular partitions.
+
+When the installation is complete, you can close the QEMU window. You
+will be able to boot your installed OS and make any changes you want to it
+(e.g. install openssh-server) using the following command::
+
+ $ sudo kvm -m 1000 -drive file=linuxmint.raw,format=raw,cache=none,if=virtio
-After the installation finishes, become root, activate the virtual environment
-you have installed snf-image-creator in, and use *snf-mkimage* to create and
-upload the image:
+After you're done, become root, activate the virtual environment you have
+installed snf-image-creator in, and use *snf-mkimage* to create and upload the
+image:
.. code-block:: console
projects / snf-image-creator / commitdiff
