« Previous - Version 35/133 (diff) - Next » - Current version
Nikos Skalkotos, 11/24/2011 03:49 pm


snf-image

snf-image logo (400x100px)

Introduction - Features

snf-image is a Ganeti OS Provider, primarily used by Synnefo.

It is rewritten from scratch and allows Ganeti to launch instances from predefined or untrusted custom Images. The whole process of deploying an Image onto the block device, as provided by Ganeti, is done in complete isolation from the physical host, enhancing robustness and security.

There are also additional hooks that can be enabled at image deployment. They allow for:

  • changing the password of root or arbitrary users
  • injecting files at arbitrary locations inside the filesystem, e.g., SSH keys
  • setting a custom hostname
  • re-creating SSH host keys to ensure the image uses unique keys

snf-image has been used successfully to deploy many major Linux distributions (Debian, Ubuntu/Kubuntu, CentOS, Fedora), as well as Windows 2008 R2.

The snf-image Ganeti OS Provider is released under GNU Generic Public Lisence version 2.

Ganeti OS Interface

snf-image requires ganeti-os-interface v20 to operate.
It introduces the following OS parameters:

  • img_id (required): the unique id of the image as known by the storage backend
  • img_format (required): the image format (extdump and ntfsdump [dd] currently supported)
  • img_passwd (required): the passwd to be injected inside the image
  • img_properties (optional): additional image properties used to customize the image (details)
  • img_personality (optional): files to be injected into the image filesystem. It is a JSON-encoded list of files to be injected: every file is defined by its path and base64-encoded data. This format follows the notation proposed by the OpenStack Compute API v1.1. [more... ] for defining server personalities.

Architecture

snf-image is split in two components: A part running on the Ganeti host, with full root privilege (snf-image-host), and a part running inside an unprivileged, helper VM (snf-image-helper).

snf-image-host

This part implements the Ganeti OS interface. It extracts the Image onto the Ganeti-provided block device, using streaming block I/O (dd with oflag=direct), then passes control to snf-image-helper running inside a helper VM. The helper VM is created using KVM, runs as an unprivileged user, nobody by default.

There is no restriction on the distribution running inside the helper VM, as long as it executes the snf-image-helper component automatically upon bootup. The snf-image-update-helper script is provided with snf-image-host to automate the creation of a helper VM image based on Debian Stable, using debootstrap.

The snf-image-helper component is spawned inside a specific hardware environment:

  • The VM features a virtual floppy, containing an ext2 filesystem with all parameters needed for image customization.
  • The hard disk of the VM being deployed is accessible as the first virtio hard disk.
  • All kernel/console output is redirected to the first virtual serial console, and eventually finds its way into the OS provider log files that Ganeti maintains.
  • The helper VM is expected to output "SUCCESS" to its second serial port if image customization was successful inside the VM.
    In any other case, execution of the helper VM or snf-image-helper has failed.
  • The helper VM is expected to shutdown automatically once it is done. Its execution is time-limited; if it has not terminated after a number of seconds, configurable via /etc/default/snf-image, it is sent a SIGTERM and/or a SIGKILL.

KVM is currently a dependency for snf-image, meaning it is needed to spawn the helper VM. There is no restriction on the hypervisor used for the actual Ganeti instances. This is not a strict requirement; KVM could be replaced by qemu, doing full CPU virtualization without any kernel support for spawning the helper VM.

snf-image-helper

This part runs inside the helper VM and undertakes customization of the VM being deployed using a number of hooks, or tasks.
The tasks run in an environment, specified by rules found in a virtual floppy, placed there by the snf-image-host component.
snf-image-helper uses runparts to run tasks found under /usr/lib/snf-image-helper/tasks by default.

The architecture is presented below:

Graphical Representation

snf-image architecture

Download

Download the latest debian packages (v0.2):

Previous versions and source tarballs can be found here:
https://code.grnet.gr/projects/snf-image/files

Sample images for testing snf-image will be made available soon.

Installation

Before installing snf-image be sure to have a working Ganeti installation in your cluster. The installation process should take place in all ganeti nodes. Here we will describe the installation in a single node. The process is identical for all nodes and should be repeated manually or automatically, e.g., with puppet.

  1. Download the snf-image-host debian package as described in the download section.
  2. Install the snf-image-host debian package:
     # dpkg -i snf-image-host_version.deb
    
  3. If the dependencies are not met, install all the dependencies using apt-get install
  4. Download the snf-image-helper debian package as described in the download section and store it in a handy location.
  5. Do NOT install the snf-image-helper debian package in the Ganeti node (the deb file should be present in all nodes, but NOT installed in any node).
  6. Configure the package, as described in the next section, before you can start using the new OS Provider.

Configuration

Once you have installed snf-image-host in the Ganeti node and also snf-image-helper is present, proceed with the following configuration:

  1. Edit /etc/default/snf-image and set the IMAGE_DIR variable to point at the location where you have stored all your disk image files (by default /var/lib/snf-image). All disk image files must have the following name format: img_id-x86_64.img_format
    This means that if you have an image with img_id = debian_base_0.5-2 and img_format = extdump
    then it's filename should be debian_base_0.5-2-x86_64.extdump
  2. Edit /etc/default/snf-image and set the HELPER_DIR variable to a directory in which all snf-helper related stuff are going to be stored (the directory should be able to store at least 700MB of data)
  3. Move the snf-image-helper debian package inside this directory and edit the HELPER_PKG variable in /etc/default/snf-image accordingly:
     $ mv /path/to/handy/location/snf-image-helper_version.deb $HELPER_DIR/
    
  4. Run snf-image-update-helper (installed as part of the snf-image-host package), which will take care of the creation of a Debian stable-based helper VM image and the installation of $HELPER_PKG in it:
     $ /usr/bin/snf-image-update-helper
    
  5. You are now ready to use the new snf-image OS Provider

Sample usage

Use a command like the following to add your first Ganeti instance using snf-image. The command assumes there
is an image named 'debian_base-6.0-5-x86_64.extdump' under IMAGE_DIR:

gnt-instance add -o snf-image+default --os-parameters img_passwd=SamplePassw0rd,img_format=extdump,img_id=debian_base-6.0-5 -t plain --disk=0:size=10G --no-name-check --no-ip-check --no-nics test1

Developers

If you are a developer or want to use the latest source code you can
download the latest development version; use git to clone the snf-image repository:

 $ git clone https://code.grnet.gr/git/snf-image

The master branch contains the latest development version
The debian branch contains the master plus the debian packaging directories.

For more information on how to configure, install or package from source, see the Developer's page.
For more information on the image format used in snf-image, see Image Format.

Community & Support

Your help is very important. Any contributions and bug reports will be highly appreciated. You can contact the team at:

snf-image_arch.png - snf-image architecture (55.1 kB) Constantinos Venetsanopoulos, 10/10/2011 07:33 pm

snf-image-logo.png - snf-image logo (400x100px) (9.3 kB) Constantinos Venetsanopoulos, 10/11/2011 02:24 pm