Skip to content

Commit

Permalink
add inst files documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jreidinger committed Nov 1, 2013
1 parent 55d9fbf commit 02ab045
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 120 deletions.
2 changes: 1 addition & 1 deletion doc/Makefile.am
@@ -1,4 +1,4 @@
SUBDIRS = autodocs proposal inst_images
SUBDIRS = autodocs proposal

doc_DATA = *.html

Expand Down
73 changes: 73 additions & 0 deletions doc/inst-images.md
@@ -0,0 +1,73 @@
Installation Images
===================

Installation images are used to speed installation up. Each separate
image contains a compact part of a filesystem. Several images can be
combined together to finally create several different complete systems -
the only unique image for each such system is a separate image
containing RPM (plus other metadata) database for a particular system.

Example of images on media:

Available Images:
* Base_System
* Xorg
* Additional_Tools
* Metadata_image_*, one for each imageset

Example of imagesets (combinations of images):

Base System:
+ Base_System
+ Metadata_image_1 (Base_System.meta)

Advanced System:
+ Base_System
+ Xorg
+ Metadata_image_2 (Base_System.meta + Xorg.meta)

Superadvanced System
+ Base_System
+ Xorg
+ Additional_Tools
+ Metadata_image_3 (Base_System.meta + Xorg.meta + Additional_Tools.meta)

Supported Types of Images
-------------------------

- *\*.lzma* (((files)tar)lzma) - TAR\* archive additionally compressed
with LZMA

- *\*.xz* - (((files)tar)lzma) - TAR\* archive additionally compressed
with newer LZMA

- *\*.tar.bzip2, \*.tar.gz* (((files)tar)bzip2/gzip) - TAR\*/Bzip2;
resp. TAR\*/Gzip archive

\* Each TAR archive is created with: *--numeric-owner --checkpoint=400
--record-size=10240*

Imagesets Description
---------------------

If we want to use installation images, we have to describe them first.
See the [example of file](inst_images/images.xml.example) stored on the first
installation media:

This XML file describes sets of images from which an installation
chooses the best-matching one according to \<patterns\>...\</patterns\>
item defined in each *imageset*.

Images Details
--------------

Each imageset contains one or more images. To provide a useful feedback
when deploying the images, they have to be described in
*/images/details-$ARCH.xml*, respectively in file
*/images/details.xml* stored on the first installation media:

*$ARCH* is one of: *i386*, *sparc*, *mips*, *ppc*, *alpha*, *s390*,
*ia64*, and *x86\_64*.

Mandatary items for each *image* (file name) are *file* and *size* (in
bytes).
28 changes: 0 additions & 28 deletions doc/inst_images/Makefile.am

This file was deleted.

91 changes: 0 additions & 91 deletions doc/inst_images/inst_images.xml

This file was deleted.

0 comments on commit 02ab045

Please sign in to comment.