Revision fa77d79a docs/overview.rst
| b/docs/overview.rst | ||
|---|---|---|
| 1 | 1 |
Overview |
| 2 |
========
|
|
| 2 |
^^^^^^^^
|
|
| 3 | 3 |
|
| 4 | 4 |
snf-image-creator is a simple command-line tools for creating OS images. The |
| 5 | 5 |
original media from which the image is created, can be a block device or a |
| ... | ... | |
| 8 | 8 |
on the snapshot, before the image is created. |
| 9 | 9 |
|
| 10 | 10 |
Snapshotting |
| 11 |
------------
|
|
| 11 |
============
|
|
| 12 | 12 |
|
| 13 | 13 |
snf-image-creator works on snapshots of the original media. Any changes made by |
| 14 | 14 |
the program do not affect the original media. |
| 15 | 15 |
|
| 16 | 16 |
Preparation |
| 17 |
-----------
|
|
| 17 |
===========
|
|
| 18 | 18 |
|
| 19 |
Some of the image preparation tasks that run on each image are OS specific.
|
|
| 20 |
snf-image-creator will use heuristics to detect the OS of the image and
|
|
| 21 |
determine which tasks should run on it. The main purpose of running those tasks
|
|
| 22 |
is to: |
|
| 19 |
Some of the image preparation operations that run on each image are OS
|
|
| 20 |
specific. snf-image-creator will use heuristics to detect the OS of the image
|
|
| 21 |
and determine which operations should run on it. The main purpose of running
|
|
| 22 |
them is to:
|
|
| 23 | 23 |
|
| 24 | 24 |
* Shrink the image |
| 25 | 25 |
* Clear out sensitive user data (passwords, ssh keys, history files, etc.) |
| ... | ... | |
| 27 | 27 |
names, remove persistent net rules, etc.) |
| 28 | 28 |
|
| 29 | 29 |
Creation |
| 30 |
--------
|
|
| 30 |
========
|
|
| 31 | 31 |
|
| 32 | 32 |
The program can either dump the image file locally or directly upload it to |
| 33 | 33 |
pithos and register it with `okeanos <http://www.okeanos.grnet.gr>`_. |
| 34 | 34 |
|
| 35 | 35 |
Image Format |
| 36 |
------------
|
|
| 36 |
============
|
|
| 37 | 37 |
|
| 38 | 38 |
The images the program creates are in diskdump format. This is the recommended |
| 39 | 39 |
format for `snf-image <https://code.grnet.gr/projects/snf-image>`_, the Ganeti |
Also available in: Unified diff