DPI908/SBR600 Koji Lab
To use and become familiar with the koji tool.
Koji is a client-server system which allows you to queue builds within the Fedora build farm. This permits you to test whether your package builds on multiple different architectures, which is especially useful when you don't otherwise have access to the machines of each architecture. For example, if you are working on a 32-bit PC, you won't be able to directly test builds on a 64-bit PC architecture (x86_64), nor non-PC architectures such as ARM, MIPS, PA-Risc, IA64, S390, Sparc, and PowerPC.
Before starting this lab, you will need:
- Follow the procedure on the UsingKoji page on the Fedora wiki for setup instructions.
Koji is a client-server system. Your computer runs the client software, which will submit the build job to a koji build hub. The build task will go through several states as it is picked up from the koji hub by a builder (a separate server system which retrieves jobs from the koji-hub and builds them) and that build either succeeds or fails.
The main use of the Koji system is to test builds on systems of a different architecture (such as an s390 mainframe) or a different release (such as Fedora 23 when you're running Fedora 22) as well as to prepare the final builds for release.
Queueing the Build Request
To queue the build request on the main koji server, used for primary architecture builds (i386 and x86_64):
- Issue the command:
koji build f18 --scratch yourSRPM
- f18 (called the Target) instructs koji to build the package using the packages available in the Fedora 18 distribution, and prepare it for inclusion in that distribution. Note: for versions of Fedora prior to f16, use dist-fXX where XX is the release.
- The --scratch option causes koji to build the package but not tag it for the target (i.e., not to include it in Fedora). To perform a build that will be passed to Bodhi for distribution, substitute
--scratchand use a git URL for the package (do not do this until you have passed the package review and sponsor procedures!).
- You can either follow the progress of the build by leaving the command running, or you may interrupt the
kojicommand by pressing Ctrl-C once the message "this may be safely interrupted" is printed. Record the taskID printed for future reference.
To queue the build request on the koji server for another architecture, substitute
arch-koji for the
koji command. For example:
arm-koji build f18 --scratch foo*.src.rpm
Use Koji to build a scratch package for each of the following architectures:
- Primary architectures (submit using the "koji" command):
- i386 (32-bit AMD/Intel)
- x86_64 (64-bit AMD/Intel)
- ARM architectures:
- armv5tel (ARM architecture version 5 with "soft fp" ABI)
- armv7hl (ARM architecture verison 7 with "hard fp" ABI)
- s390 mainframe architectures:
- PowerPC architectures:
- ppc (32-bit)
- ppc64 (64-bit)
Viewing the Build Request Status
You can view the status of a task through:
- The original koji command, if you did not interrupt it.
- The command:
koji watch-task taskID
- Using the web interface.
Solving Architecture-Specific Errors Identified with Koji
If your package does not build on a particular architecture using the same spec file contents as on the primary architectures, you can use architecture-specific conditionals to include or exclude parts of the spec file.
To include parts of a specfile only on a particular architecture (ppc in this example):
%ifarch ppc BuildRequires: foo %endif
To exclude parts of a specfile only on a particular architecture:
%ifnarch ppc BuildRequires: bar %endif
You can also use
%else to specify alternation:
%ifarch ppc %configure --baz %else %configure --qux %endif
Excluding an Architecture
If a package will not build on a particular architecture, perhaps because the BuildRequires are not available on that arch, you can specify that the package should be excluded from that arch:
If a package only applies to a certain architecture -- for example, it is CPU-specific microcode -- it can be marked as such:
Note that ExcludeArch is preferred over ExclusiveArch except where the package is definitely architecture-specific.
Create a blog post describing your experience. Include:
- Notes on what you did, and what worked and didn't work.
- How long the overall process took, and the koji build for each architecture (contrast this with the mock and rpmbuild times).
- The results, including a link to your SRPM if it was modified from your previous lab, and interesting snippets from the log files.
- Your reflections on the tools, process, and experience.