Skip to content
Snippets Groups Projects
Commit d9da5c4c authored by Nikos Skalkotos's avatar Nikos Skalkotos
Browse files

Rephrase overview.rst

parent 6d0788a9
No related branches found
No related tags found
No related merge requests found
......@@ -2,10 +2,8 @@ Overview
^^^^^^^^
snf-image-creator is a simple command-line tool for creating OS images. The
original media from which the image is created, can be a block device or a
regular file that represents a hard disk. Given a media file, snf-image-creator
will create a snapshot for it and will run a number of system preparation
operations on the snapshot, before the image is created.
original media, the image is created from, can be a block device or a regular
file that represents a hard disk.
Snapshotting
============
......@@ -13,12 +11,13 @@ Snapshotting
snf-image-creator works on snapshots of the original media. Any changes made by
the program do not affect the original media.
Preparation
===========
Image Preparation
=================
Some of the system preparation operations are OS specific. snf-image-creator
will use heuristics to detect the OS of the media and determine which
operations should perform on it. The main purpose of running them is to:
During the image creation, a number of system preparation operations are
applied on the media snapshot. Some of those are OS specific. snf-image-creator
will use heuristics to detect the OS and determine which operations to apply.
Those operations will:
* Shrink the image
* Clear out sensitive user data (passwords, ssh keys, history files, etc.)
......@@ -28,12 +27,14 @@ operations should perform on it. The main purpose of running them is to:
Creation
========
The program can either dump the image file locally or directly upload it to
pithos and register it with `okeanos <http://www.okeanos.grnet.gr>`_.
The program can either dump the image file locally or use
`./kamaki <https://code.grnet.gr/projects/kamaki>`_ to directly upload and
register it on a `Synnefo <https://code.grnet.gr/projects/synnefo>`_
deployment.
Image Format
============
The images the program creates are in diskdump format. This is the recommended
format for `snf-image <https://code.grnet.gr/projects/snf-image>`_, the Ganeti
OS Definition used by `Synnefo <https://code.grnet.gr/projects/synnefo>`_.
The extracted images are in diskdump format. This is the recommended format for
`snf-image <https://code.grnet.gr/projects/snf-image>`_, the Ganeti OS
Definition used by `Synnefo <https://code.grnet.gr/projects/synnefo>`_.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment