source: trunk/debathena/NOTES @ 23050

Revision 23050, 17.2 KB checked in by ghudson, 16 years ago (diff)
Document configuration for making builder able to access by default.
[22689]1This hierarchy contains Debian/Ubuntu-specific materials, also known
2as "Debathena".  The contents are:
4* debathena - Debathena-specific software packages such as PAM and NSS
5  modules.
7* config - Packages for configuring native system software in a manner
8  appropriate for Athena.
10* meta - Packages which contain nothing but dependencies on other
11  packages and serve as an installation convenience.
13* scripts - Build scripts and supporting materials.
15Debathena is a SIPB project, and its infrastructure and procedures
16will need to be adapted for Athena 10.  For the moment this file will
17document the Debathena procedures as they are, not as they will be.
18The current procedures do not even use this svn repository yet.
20Debian software used by Debathena:
22  * schroot - Used to manage build chroot environments for each
23    Debian/Ubuntu version.  We use the lvm-snapshot schroot type,
24    which allows rapid construction of ephemeral copies of template
25    "source" chroots, so that every binary package build is done in a
26    clean environment.
28  * debuild - Used to create Debian source packages from package
29    source directories.
31  * sbuild - Used to build binary packages from source packages inside
32    schroot environments.
34  * equivs - Used to create packages which only contain dependency
35    information.  Somewhat of a dirty hack, since it doesn't keep
36    proper changelogs, but it reduces overhead.
38  * CDBS (Common Debian Build System) - Referenced by debian/rules
39    files in packages.  Contains standard build rules to cut down on
40    per-package boilerplate.
42  * reprepro - Used to upload packages into the apt repositories.
44  * approx - Used to create a local cache of Debian packages on the
45    build server.  This cache is referenced by the build chroots for
46    improved performance.
[22787]48The remainder of this file documents procedures useful to Athena 10
49developers and the release engineer.
[22787]51Developers: Preferences setup
[22787]54You will probably want a $HOME/.devscripts file containing the
[22787]57DEBUILD_DPKG_BUILDPACKAGE_OPTS="-sa -us -uc -i -I.svn"
[22787]59This will save you from having to specify those options every time you
60run debuild.  Athena 10 scripts do not assume the above preferences,
61but the instructions in this file do.  The options mean:
[22787]63  * Look for original source as a tarfile or create one.
64  * Do not sign the source package.
65  * Do not sign the changes file.
66  * Ignore common version control metadata files when creating diffs.
67  * Ignore .svn paths when creating tarballs.
[23046]69You will also want a $HOME/.sbuildrc file containing the following:
71  $nolog = 1;
72  $mailto = 'yourusername';
73  $log_dir = '/tmp/sbuild-logs';
74  $maintainer_name = 'Debian-Athena Project <>';
75  $force_orig_source = 1;
76  $sbuild_mode = "user";
77  1;
[22787]79You should also set the environment variable DEBATHENA_APT to
[22787]82Developers: Preparing a change
[22787]85To prepare a change to a regular package (a source tree containing a
86debian/ subdir), make the edits in a checkout and record a changelog
87entry.  You can either edit debian/changelog using emacs changelog
88mode (C-c C-v to add a new version entry, C-c C-a to add a change
89entry, C-c C-f to finalize the entry) or you can run "dadch".
[22787]91When creating a new version entry, bump the upstream version number
92(to 10.0.0 if it was not already that high) if you are changing the
93main package source.  Otherwise, just bump the Debian version
94component (change 0debathena1 to 0debathena2, for instance).
[22787]96Developers: Building a package for test purposes on one platform
[22787]99After you have prepared a change, you will want to test that it builds
100and perhaps that it works before committing it.  First, if it is an
101Athena source directory using autoconf, run "daconfiscate" to set up
102the autoconf boilerplate which we don't check in.  Second, run
103"daorig" to copy or create an orig tarball in the parent directory if
104necessary.  Third, run "debuild".  The resulting package will be
105placed in the parent directory.
[22787]107In order to test if the package works, you can install it with "dpkg
108-i filename.deb".
[22787]110Developers: Building a package for test purposes on all platforms
[22787]113If the package you are working on interacts with the native OS in ways
114that might vary from platform to platform, you may want to do a test
115build for all platforms.  You will need to do this on or another machine which has been set up with
117build schroots.
119As above, run daconfiscate (if necessary) and then daorig.  Then run
120"debuild -S" to create a source package.  Now cd into the parent
121directory and identify the .dsc file created by debuild -S; it will
122have a name like debathena-just_9.4.0-0debathena2.dsc.  Run "da
123sbuildhack filename.dsc" to perform the package builds.  Each build
124will take place inside an ephemeral chroot based on a snapshot of a
125template for a particular Debian or Ubuntu version.  If a build fails
126and it's not obvious from the build log why, you may need to create
127your own ephemeral chroot session with a command like "schroot -c
128gutsy-amd64-sbuild /bin/sh" and then run debuild from within the
129package sources.
131If the build is successful, it will create a set of packages with
132names like debathena-just_9.4.0-0debathena2~ubuntu6.06_amd64.deb.
134Developers: Building an equivs package
137Most of the packages under debathena/meta are faked up using equivs.
138To build one, just run:
140  equivs-build --full filename.equivs
142These equivs files make reference to ../common, so you must have a
143checkout of debathena/meta/common alongside the particular
144meta-package you are building.
[23018]146Developers: The meaning of metapackages
149If you are adding a new package to the repository, you will probably
150at some point want to add it to one of the metapackages so that it
151doesn't have to be installed by hand.  Here are some descriptions
152which may help identify which metapackage is best:
154* locker: Provides access to Athena locker software--AFS and
155  automounter configuration, locker-related utilities, etc.
157* clients: Provides clients (either locally-written, like athinfo and
158  Discuss, or configurations) for Athena services, as well as
159  Athena-specific utility programs like "jot".  Configurations for
160  graphical client software are generally in the workstation package
161  instead, in order to make this package less intrusive.
163* standard: Implies locker and clients.  Also provides Athena shell
164  customizations and dotfiles.
166* login: Implies standard.  Configurations to merge the MIT user
167  namespace into the local machine namespace for the purpose of user
168  lookups and authentication.
170* workstation: Implies login.  Configurations for the graphical login
171  system and graphical client software intended to provide a standard
172  X login experience using Athena home directories.  Still in
173  development.
175* cluster-software: Provides a set of Debian packages common to
176  cluster machines.  The resulting software set is rather large, and
177  thus may not be desirable to all workstation configurations.  Only
178  stock Debian packages belong in this metapackage; do not add
179  other Debathena packages to it.
181* cluster: Implies workstation and cluster-software.  Also contains
182  configurations for self-maintenance of machines (unattended updates,
183  cleanups between logins, etc.).  Does not exist yet.
185* debian-dev: Intended for developers of the system itself; provides a
186  set of Debian packages used by Debathena for development.
188For the most part a package should be listed in the "Depends:" line of
189a metapackage, but in some cases it is appropriate to hedge by using
190"Recommends:", which will cause aptitude to succeed even if the
191package is unavailable.  For example, a package which doesn't exist in
192all Debian/Ubuntu suites or isn't free can be listed under
193"Recommends:" so that our metapackages still work in all environments.
[22787]195Release engineer: Bootstrapping the project infrastructure
[22764]198  1. Create the package repository (detailed instructions on this
199     pending).  Set the DEBATHENA_APT environment variable to point to
200     the package repository.  Put a copy of the debathena "scripts"
201     subdir in your path.
203  2. Create the build area.
205  3. Build each equivs package under meta/ using "equivs-build --full
206     *.equivs" and upload each with "daequivsupload *.changes".  This
207     has the side-effect of creating the basic structure of the
208     package repository.
210  4. Set up the build server.  The basic structure of the apt
211     repository must work for make-chroot to succeed, so this must
212     happen after step 3.
214  5. For each normal Debian package in dependency order, cd into its
215     directory in the build area and run "da sbuildhack *.dsc" and
[22787]216     "daupload-release *_source.changes".  If the package contains
217     only an "Architecture: all" binary package, pass the -A option to
218     both commands.
220     The all-packages script can generate an approximation of the
221     package list in dependency order, but it doesn't work right yet,
222     and ideally it would be possible to do several builds in parallel
223     using a Makefile like the one in scripts/build-server/build-all.
224     Improvements to this machinery are pending.
[22787]226  6. For each package under third, run "da ./debathenify-PKG source
[23046]227     binary upload".
[22787]229Release engineer: Setting up a build server
[22729]232  1. The build server must be installed with free space in an LVM
[22787]233     volume group.  The build chroots consume 2GB each.  There is a
234     known memory corruption issue with LVM snapshots in the kernel
235     used in Ubuntu Gutsy (which is based on 2.6.22), so use a newer
236     kernel such as the one in Ubuntu Hardy (based on 2.6.24) instead.
[22743]238  2. Install debathena-standard as per the the instructions in
[22743]241  3. apt-key add /afs/
243  4. Install the packages listed in
[22729]244     scripts/build-server/packages (using "aptitude install")
[22743]246  5. Install debathena-login, debathena-ssh-server, and
[22729]247     debathena-build-depends (using "aptitude install").
249     (Depending on how recently debathena-build-depends was rebuilt,
250     additional packages might need to be installed to satisfy the
251     build-depends of newer packages.  This can be taken care of later
252     when an error occurs building a source package.)
[22743]254  6. Edit /etc/security/access.conf and add a first line:
[22729]255     -:ALL EXCEPT root <developer usernames>:ALL
[22788]257  7. Edit /etc/pam.d/schroot, comment out "@include common-session",
[22787]258     and add:
[22787]260       # Basic pam_unix session module in place of common-session.
261       session required
263  8. Edit /etc/group and add the developers to the sbuild group.
265  9. Create /etc/passwd entries for each developer with "hesinfo
[22729]266     username passwd >> /etc/passwd" and then run pwconv.
268     (This is not necessary for the login system on the main root
269     environment, but is for the chroot environments.)
[22787]271  10. Append to /etc/approx/approx.conf the contents of
272       scripts/build-server/approx.conf.tail.
273      Change the last line from to
274       file:///afs/
275      Add "$interval 0" above the repository lines (only necessary if
276       the version of approx as reported by "dpkg -l approx" is less
277       than 3.0)
278      Run: /etc/init.d/approx restart
[22984]280  11. Apply scripts/build-server/mount-defaults.patch.
[22787]282  12. For each supported DIST (see scripts/ run:
[22743]284        VG=/dev/blah scripts/build-server/make-chroot DIST i386
285        VG=/dev/blah scripts/build-server/make-chroot DIST amd64
[22743]287      substituting the name of the volume group for blah.  Omit the
288      amd64 line if DIST is sarge.
[22743]290      Example: VG=/dev/dink scripts/build-server/make-chroot gutsy i386
[23046]292  13. Create a local account for builder with:
294        adduser --uid 1047 --disabled-password builder
296      Make the home directory mode 700.  Install a
297      daemon/ keytab in the home directory as
298      "keytab".  Install a copy of the secret repository-signing key
299      ( in the home directory's keyring with
300      something like:
302        kinit builder
303        gpg --export-secret-keys | \
304          ssh -l builder machinename gpg --import
306      Create a file named .sbuildrc in builder's homedir containing:
308        $nolog = 1;
309        $mailto = '';
310        $log_dir = '/tmp/sbuild-logs';
311        $maintainer_name = 'Debian-Athena Project <>';
312        $force_orig_source = 1;
313        $sbuild_mode = "user";
314        1;
[23050]316      Create a file named .ssh/config in builder's homedir containing:
318        Host
319          User debuildsvn
[23046]321      Add builder to the sbuild group in /etc/group.
323      Copy scripts/build-server/autodebathenify to builder's homedir.
324      Create a file named autodebathenify.config in builder's homedir
325      containing:
328        scripts_dir=/afs/
329        build_dir=/afs/
330        packages="cyrus-sasl2-mit evolution-data-server lprng openafs tcsh"
331        export DEBATHENA_APT=/afs/
333      Copy scripts/build-server/autodebathenify.cron to builder's
334      homedir and install it with "crontab autodebathenify.cron".
[22787]336Release engineer: Removing a build chroot on the build server
[22787]339  1. Run VG=/dev/blah scripts/clean-schroots as root to make sure that
340     the build chroot is not mounted, substituting the name of the
341     volume group for blah.
343  2. Edit /etc/schroot/schroot.conf and delete the section
344     corresponding to the chroot.
346  3. Run lvchange -an blah/chrootname
347     substituting the name of the volume group for blah and the chroot
348     name for chroot.  Example: lvchange -an dink/gutsy-i386-sbuild
[22764]350  4. Run lvremove blah/chrootname
[22985]352Release engineer: Removing a dist from the apt repository
355  1. Inside the apt repository, edit conf/distributions and remove the
356     distribution section.
358  2. Run reprepro -Vb $DEBATHENA_APT --delete clearvanished
[22787]360Release engineer: Setting up a canonical build area
363  1. Create an empty directory and cd into it.  The canonical build
364     area lives in /afs/
[22787]366  2. Run gen-packages to create the table of normal Debian packages.
[22787]368  3. Run dasource to create subdirs and source packages for each
369     normal Debian package.
371  4. Create checkouts of the meta and third directories:
373     svn co svn+ssh://
374     svn co svn+ssh://
376     (A couple of subdirectories of debathena/meta are normal Debian
377     packages, so this will create redundant copies of those.  Ignore
378     them; they won't be used.)
380Release engineer: Adding a new suite
383This process is rarely performed and the infrastructure for it is
384imperfect.  Substitute the name of the new suite for "newdist" in all
385steps below.
[22958]387  1. Make sure the apt repository is up to date with respect to the
388     source tree for the existing dists.
390  2. Add the new dist to scripts/  (It is not
391     necessary to add the new dist to codes at this point, but it must
392     be present in the gettag conditional.)
394  3. Create the new distribution in the apt repository's configuration
[22957]395     file.  Create the skeleton of the dist by installing at least one
396     equivs package from meta/ with "reprepro -Vb $DEBATHENA_APT
397     include newdistname file.changes".
[22958]399  4. On the build server, create a chroot for the new distribution as
[22957]400     documented above.  This may require downloading and installing a
401     more recent version of the debootstrap package from the
402     -backports dist corresponding to the build server's OS.
[22958]404  5. Set the DEBATHENA_BUILD_AREA environment variable to point to the
[22957]405     build area.
[22958]407  6. Fire up screen.
[22958]409  7. mkdir $DEBATHENA_BUILD_AREA/stamps.newdist.
[22958]411  8. cd into a checkout of debathena/scripts/build-server/build-all.
[22958]413  9. Edit Makefile (and check in the edit) so that suite is the new
[22957]414     distribution and psuite is the previously most recent Debian or
415     Ubuntu distribution.
[22958]417  10. Run "make".
[22958]419  11. Run "make -k all STAMPS=$DEBATHENA_BUILD_AREA/stamps.newdist".
420      You can watch the builds happen in the other windows of the
421      screen session.  It's possible to do several builds at once with
422      make -j N.
[22958]424  12. debathenify packages will fail out; they must be built by hand.
[22957]425      When the build fails on one, cd into third/packagename in the
426      build area and run "./debathenify newdist-amd64 -A source binary
427      upload" and "./debathenify newdist-i386 binary upload".  Then
428      touch $DEBATHENA_BUILD_AREA/stamps.newdist/packagename.done" and
429      restart the build.
[22958]431  13. Go into third/openafs in the build area and build AFS modules
[22957]432      for the new suite's kernels.  (Instructions pending.)
Note: See TracBrowser for help on using the repository browser.