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