cosmetic
[build.git] / README-pldistros.txt
1 We've tried to isolate the distro-dependent configurations from the code
2
3 Most of the .pgks files are optional to define a new distro:
4 missing files are searched in the planetlab distro
5
6 ========== build environment
7 ./build/<pldistro>.mk
8         that defines the contents of the build -- see Makefile
9 ./build/<pldistro>-tags.mk
10         that defines the svn locations of the various modules
11 ./build/<pldistro>-install.mk
12         optional make file to define the install target
13
14 ========== kernel config
15 ./Linux-2.6/configs/kernel-2.6.<n>-<arch>-<pldistro>.config
16         (subject to change location in the future)
17
18 ========== various system images
19 ./build/config.<pldistro>/devel.pkgs
20         set of packages required for building
21 ./build/config.<pldistro>/bootcd.pkgs
22         contents of the bootcd image
23 ./build/config.<pldistro>/nodeimage.pkgs
24         the standard contents of the node software
25         this results in a tarball (tar.bz2) 
26         also used to generate yumgroups.xml on the plc side
27 ./build/config.<pldistro>/nodeimage-*.pkgs
28         each of these files results in an extension tarball
29 ./build/config.<pldistro>/sliceimage.pkgs
30         the contents of the standard vserver reference image
31 ./build/config.<pldistro>/sliceimage-*.pkgs
32         all *.pkgs files here - produce additional vserver images
33 ./build/config.<pldistro>/vtest.pkgs
34         used to create test vservers for myplc-native
35 ./build/config.<pldistro>/yumexclude.pkgs
36         describe the set of node packages that are produced by the myplc build
37         and thus should be excluded from the stock fedora repos
38
39 === extensions
40 as of this writing extensions are managed as follows:
41 - at node installation, the tarball produced from nodeimage.pkgs is
42 downloaded and untared to produce the node root filesystem
43 - then we attempt to install an extension corresponding to each of the
44 extensions that the node has in its 'extensions' tag
45 - the first method is to try and download a tarball named after the
46 extension. such tarballs are produced by the build from a .pkgs file,
47 see above
48 - if that fails, then the extension install is attempted through a
49  yum groupinstall extension<nodegroup>
50