From d9da5c4c0338e99ad906a9109dc63057fdf9befc Mon Sep 17 00:00:00 2001 From: Nikos Skalkotos Date: Sun, 30 Dec 2012 16:18:24 +0200 Subject: [PATCH 1/1] Rephrase overview.rst --- docs/overview.rst | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index e375086..14c2180 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -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 `_. +The program can either dump the image file locally or use +`./kamaki `_ to directly upload and +register it on a `Synnefo `_ +deployment. Image Format ============ -The images the program creates are in diskdump format. This is the recommended -format for `snf-image `_, the Ganeti -OS Definition used by `Synnefo `_. +The extracted images are in diskdump format. This is the recommended format for +`snf-image `_, the Ganeti OS +Definition used by `Synnefo `_. -- 1.7.10.4