Statistics
| Branch: | Tag: | Revision:

root / docs / overview.rst @ c71f38be

History | View | Annotate | Download (1.4 kB)

1 7b006adb Nikos Skalkotos
Overview
2 fa77d79a Nikos Skalkotos
^^^^^^^^
3 7b006adb Nikos Skalkotos
4 b28209d9 Alex Pyrgiotis
snf-image-creator is a simple command-line tool for creating OS images. The
5 8c7d7b90 Nikos Skalkotos
original media the image is created from, can be a block device, a regular
6 8c7d7b90 Nikos Skalkotos
file that represents a hard disk or the host system itself.
7 7b006adb Nikos Skalkotos
8 7b006adb Nikos Skalkotos
Snapshotting
9 fa77d79a Nikos Skalkotos
============
10 7b006adb Nikos Skalkotos
11 afdddc8d Nikos Skalkotos
snf-image-creator works on snapshots. Any changes made by the program do not
12 afdddc8d Nikos Skalkotos
affect the original media.
13 7b006adb Nikos Skalkotos
14 d9da5c4c Nikos Skalkotos
Image Preparation
15 d9da5c4c Nikos Skalkotos
=================
16 7b006adb Nikos Skalkotos
17 d9da5c4c Nikos Skalkotos
During the image creation, a number of system preparation operations are
18 d9da5c4c Nikos Skalkotos
applied on the media snapshot. Some of those are OS specific. snf-image-creator
19 d9da5c4c Nikos Skalkotos
will use heuristics to detect the OS and determine which operations to apply.
20 d9da5c4c Nikos Skalkotos
Those operations will:
21 7b006adb Nikos Skalkotos
22 7b006adb Nikos Skalkotos
 * Shrink the image
23 c8025360 Nikos Skalkotos
 * Clear out sensitive user data (passwords, ssh keys, history files, etc.)
24 3f4e2409 Nikos Skalkotos
 * Prepare the guest OS for being deployed on a virtual environment (change
25 3f4e2409 Nikos Skalkotos
   device names, remove persistent net rules, etc.)
26 7b006adb Nikos Skalkotos
27 7b006adb Nikos Skalkotos
Creation
28 fa77d79a Nikos Skalkotos
========
29 7b006adb Nikos Skalkotos
30 d9da5c4c Nikos Skalkotos
The program can either dump the image file locally or use
31 d9da5c4c Nikos Skalkotos
`./kamaki <https://code.grnet.gr/projects/kamaki>`_ to directly upload and
32 d9da5c4c Nikos Skalkotos
register it on a `Synnefo <https://code.grnet.gr/projects/synnefo>`_
33 ccb6b943 Nikos Skalkotos
deployment as private or public image.
34 7b006adb Nikos Skalkotos
35 7b006adb Nikos Skalkotos
Image Format
36 fa77d79a Nikos Skalkotos
============
37 7b006adb Nikos Skalkotos
38 d7a0de81 Nikos Skalkotos
The extracted images are in diskdump format, which is a raw dump of a disk
39 d7a0de81 Nikos Skalkotos
device (or file). This is the recommended format for
40 d9da5c4c Nikos Skalkotos
`snf-image <https://code.grnet.gr/projects/snf-image>`_, the Ganeti OS
41 d9da5c4c Nikos Skalkotos
Definition used by `Synnefo <https://code.grnet.gr/projects/synnefo>`_.