X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/c8025360fc1500322d6e3c6eed06c5752bf2d264..fab154f00c00474d8baf495cf432dc6054f1bc7e:/docs/overview.rst diff --git a/docs/overview.rst b/docs/overview.rst index d823afe..2cd3a19 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,40 +1,40 @@ Overview -======== +^^^^^^^^ -snf-image-creator is a simple command-line tools 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 image preparation task -on the snapshot, before the image is created. +snf-image-creator is a simple command-line tool for creating OS images. The +original media the image is created from, can be a block device, a regular +file that represents a hard disk or the host system itself. Snapshotting ------------- +============ -snf-image-creator works on snapshots of the original media. Any changes made by -the program do not affect the original media. +snf-image-creator works on snapshots. Any changes made by the program do not +affect the original media. -Preparation ------------ +Image Preparation +================= -Some of the image preparation tasks that run on each image are OS specific. -snf-image-creator will use heuristics to detect the OS of the image and -determine which tasks should run on it. The main purpose of running those tasks -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.) - * Prepare the image for being deployed on a virtual environment (change device - names, remove persistent net rules, etc.) + * Prepare the guest OS for being deployed on a virtual environment (change + device names, remove persistent net rules, etc.) 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 as private or public image. 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 `_.