trunk/doc/classes_description.txt

Description of the classes              Tue, 10 Jan 2006 18:02:19 +0100
--------------------------

If you want to find all files (except hostnames) that are classes try:
   find /srv/fai/config -type f | egrep '/[[:upper:][:digit:]_]+$'

In cfengine scripts you can find class names using:
   egrep -r '[[:upper:][:digit:]_]+::' /srv/fai/config

Shell scripts are using the commad ifclass. So use:
   egrep -r 'ifclass[[:space:]]+[[:upper:][:digit:]_]+' /srv/fai/config


Class name       used in  Description
----------------------------------------------------
               CHVDPSF A          

DHCPC              PS     do network configuration using dhcp-client

GERMAN             P      packages for the german environment

XFREE              P      packages for xfree server, fonts,...

LILO                S     create lilo.conf, install lilo

GRUB                S     install and configure grub

FAI_BOOTPART        S     add fai boot menu to lilo.conf or grub's menu.lst

LAST                S     remove backup files of cfengine, link /tmp
                          if necessary, add nfs location of debian
                          mirror to fstab 

FAIBASE        C V PS     minimal software list, configure base stuff
                          (TODO: describe in more detail)

FAISERVER      DESFP      setup install server with DHCP, TFTP,
                          partial mirror, call fai-setup during
                          first boot

DEMO               PS     more demo packages, add account demo (pw: fai)

NOMBR               S     install boot loader into root partition (not into MBR)

Explanation of "used in":
-------------------------
C = /fai/class/
V = used for *.var in /fai/class
D = /fai/disk_config/
E = /fai/debconf/
P = /fai/package_config/
S = /fai/scripts/
F = /fai/files/ (used by fcopy)
A = auto class (defined by a script)
H = /fai/hooks

The following classes should always be defined:

LAST, DEFAULT (are defined by default)
BOOT and maybe MBR

Some classes depends on another class. For example, the class NTP is used
in the script NETWORK. So both classes must be defined if the ntp
configuration should be created.
1	Description of the classes Tue, 10 Jan 2006 18:02:19 +0100
2	--------------------------
3
4	If you want to find all files (except hostnames) that are classes try:
5	find /srv/fai/config -type f \| egrep '/[[:upper:][:digit:]_]+$'
6
7	In cfengine scripts you can find class names using:
8	egrep -r '[[:upper:][:digit:]_]+::' /srv/fai/config
9
10	Shell scripts are using the commad ifclass. So use:
11	egrep -r 'ifclass[[:space:]]+[[:upper:][:digit:]_]+' /srv/fai/config
12
13
14	Class name used in Description
15	----------------------------------------------------
16	CHVDPSF A
17
18	DHCPC PS do network configuration using dhcp-client
19
20	GERMAN P packages for the german environment
21
22	XFREE P packages for xfree server, fonts,...
23
24	LILO S create lilo.conf, install lilo
25
26	GRUB S install and configure grub
27
28	FAI_BOOTPART S add fai boot menu to lilo.conf or grub's menu.lst
29
30	LAST S remove backup files of cfengine, link /tmp
31	if necessary, add nfs location of debian
32	mirror to fstab
33
34	FAIBASE C V PS minimal software list, configure base stuff
35	(TODO: describe in more detail)
36
37	FAISERVER DESFP setup install server with DHCP, TFTP,
38	partial mirror, call fai-setup during
39	first boot
40
41	DEMO PS more demo packages, add account demo (pw: fai)
42
43	NOMBR S install boot loader into root partition (not into MBR)
44
45	Explanation of "used in":
46	-------------------------
47	C = /fai/class/
48	V = used for *.var in /fai/class
49	D = /fai/disk_config/
50	E = /fai/debconf/
51	P = /fai/package_config/
52	S = /fai/scripts/
53	F = /fai/files/ (used by fcopy)
54	A = auto class (defined by a script)
55	H = /fai/hooks
56
57	The following classes should always be defined:
58
59	LAST, DEFAULT (are defined by default)
60	BOOT and maybe MBR
61
62	Some classes depends on another class. For example, the class NTP is used
63	in the script NETWORK. So both classes must be defined if the ntp
64	configuration should be created.
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision