The content of this section is considered
DEPRECATED and OBSOLETE
It is preserved for historical or documenting reasons.
Pilgrim is a disk-image compiler. This means that it converts collections of packages (RPMs) and hacks into clean-installable disk images for the XO. It is typically run on a dedicated Linux server or virtual machine like xs-dev.laptop.org or pilgrim.laptop.org. 2010 OLPC builds use the OS Builder utility instead.
Output from the Build System
The build system produces things:
- An RPM repository, currently located under the repository root
- The output of the build system is currently located under the streams root at http://pilgrim.laptop.org/~pilgrim/olpc/streams/ for update.1, and somewhere else (maybe http://xs-dev.laptop.org/~cscott/olpc/streams/ for joyride.
For an image called
<imagename>, the files you will find inside are...
- fs.zip - signatures file
- fs.zip.md5 - the md5 checksum of fs.zip
- <imagename>.crc - the crc of the image
- <imagename>.crc.md5 - the md5 checksum of the crc of the image
- <imagename>.img - the image file itself
- <imagename>.img.md5 - the md5 checksum of the image file
If the image contains Activities and other customizations on top of a build, you will also find the following files. Note that this is rare and typically only done once a year for images shipped on G1G1 XOs.
- <imagename>.zip - the customization key included in the image.
- <imagename>.zip.md5 - the md5 checksum of the customization key included in the image.
The build system we want to have consists of the following components:
| F7 yum |--------+
| repos | |
/--------\ +--------+ +----------+ +---------+ /------\
| upstream | | distro | | pkg build| |compose | | stable |
| src |-->| SCM |-->| system |-->| tools |-->| rainbow|
| repos | | (CVS) | | (Koji) | |(joyride)| | xtest |
\--------/ +--------+ +----------+ +---------+ \------/
^ ^ ^
/--------\ | | |
|patches |-----+ | + - - - - - - - + |
\--------/ | | dropbox | |
+----->| system |----+
/--------\ | | (public_rpms) |
| olpc | | + - - - - - - - +
| sources |-------+
| (GIT) |
|-----------| |----------------------------| |-----------------------|
sources package maintenance package composition
CVS,GIT Koji, Mock, rpmbuild mash, pilgrim, ChangeLogs
The one we actually have is fairly similar but the package-construction step is done partially in Koji and partially by individual package maintainers using tools like Mock and rpmbuild.
Pilgrim is composed of two large and two small scripts and many configuration files.
pilgrim # user-interface
pilgrim-autobuild # implementation
build-one # build the current branch
make-repos # touch up yum repositories
The most important branch is "autobuild". This is where changes deemed suitable for all build branches should be merged. See Pilgrim Commit Policy.
The other branches - joyride, meshtest, xtest, and rainbow store branch-specific data like which yum repositories to compose into the image, which packages to pull, which activities to include, and so on.
These data are mostly recorded in
streams.d/olpc-branch.conf # a few important config variables
streams.d/olpc-development-yum-install.conf # yum repositories to compose, package exclusions
streams.d/olpc-development.stream # lists of packages and activities to install
- How do you enumerate the available branches? I.e. if you don't want to rely on the documentation being kept up to date...
- Where can one find the streams.d directory?
This tutorial explains how you can build a completely customized OS image which can be used with:
The following procedure has been tested on a Fedora 8 x86_64, but should work just fine on Fedora 7 and on i386.
Any Linux distribution capable of running yum should be able to run Pilgrim, maybe with minor adjustments.
The intended audience of this document is an OS developer with some experience in rebuilding RPMs and managing yum repositories.
Before installing pilgrim, you need to install mtd-utils.
sudo yum install mtd-utils
git clone git://dev.laptop.org/users/cscott/pilgrim
sudo make install
Note: this will litter your system with pilgrim files, but you can clean it up later with make uninstall.
Prepare your custom repositories
Build your custom RPMs and place them in a directory accessible via http.
It is recommended, but not necessary, to adopt the standard Fedora layout:
i386/os/ - i386 and noarch packages
i386/debug/ - debuginfo packages
source/ - src rpms
Create or update the RPM metadata information for your repositories:
Adding your yum repositories
Edit streams.d/olpc-development-yum-install.conf and append your yum repository
(you only need the one containing the binary RPMs here). Mine looks like this:
name=OLPC bernie - i386
Note that I've explicitly specified i386 because the $basearch variable would expand to x86_64 on my host.
If you provide the full set of OS packages in your repository, then you should remove the default repositories altogether.
Adding repositories for the target
Edit streams.d/olpc-development.stream, and find the line saying
"Writing out configuration for OLPC yum repo". The repositories listed here
will appear in /etc/yum.repos.d on the target and are only used when
the image is booted on the target.
Add your yum repositories below the official ones.
This is what I do for xtest:
# keep this in sync with same repo defined in olpc-development-yum-install.conf
cat <<EOF > $INSTALL_ROOT/etc/yum.repos.d/olpc-development.repo
cat <<EOF > $INSTALL_ROOT/etc/yum.repos.d/olpc-bernie.repo
name=OLPC bernie - \$basearch
name=OLPC bernie - \$basearch - Debug
name=OLPC bernie - Source
Adding and removing packages
The list of packages that will be installed is in streams.d/olpc-development.stream.
If your spec files are correct, you will only need to list the leaf packages here and yum will pull in all their dependencies automatically.
Read README.olpc in the root directory of Pilgrim for further information.
The short story is:
./pilgrim-autobuild --config-dir . --stream olpc-development --dest-dir .
If you're only interest in the jffs2 image, do:
./pilgrim-autobuild --config-dir . --stream olpc-development --dest-dir . --variant devel_jffs2
To install OS images see Clean-install procedure