View source for Funtoo:Metro/Automation

Metro also includes a number of advanced features that can be used to automate builds and set up distributed build servers. These features require you to {{c|emerge sqlalchemy}}, as SQLite is used as a dependency and also {{c|emerge dev-python/lxml}} as this is needed for index file generation.

== Repository Management == <!--T:102-->

<!--T:103-->
Metro includes a script in the {{c|scripts}} directory called {{c|buildrepo}}. Buildrepo serves as the heart of Metro's advanced repository management features.

=== Initial Setup === <!--T:104-->

<!--T:105-->
To use {{c|buildrepo}}, you will first need to create a {{f|.buildbot}} configuration file. Here is the file I use on my AMD Jaguar build server:

<!--T:106-->
{{file|name=/root/.buildbot|lang=python|body=
builds = (
	"funtoo-current",
	"funtoo-current-hardened",
)

<!--T:107-->
arches = (
	"x86-64bit",
	"pure64"
)

<!--T:108-->
subarches = (
	"amd64-jaguar",
	"amd64-jaguar-pure64",
)

<!--T:109-->
def map_build(build, subarch, full, full_date):
	# arguments refer to last build...
	if full == True:
		buildtype =  ( "freshen", )
	else:
		buildtype =  ("full", )
        # return value can be a string like "full+openvz" or a sequence type like [ "freshen", "openvz" ]
	return buildtype
}}

<!--T:110-->
This file is actually a python source file that defines the tuples {{c|builds}}, {{c|arches}} and {{c|subarches}}. These variables tell {{c|buildrepo}} which builds, arches and subarches it should manage. A {{c|map_build()}} function is also defined which {{c|buildbot}} uses to determine what kind of build to perform. The arguments passed to the function are based on the last successful build. The function can read these arguments and return a string to define the type of the next build. In the above example, the {{c|map_build()}} function will cause the next build after a freshen build to be a full build, and the next build after a full build to be a freshen build, so that the build will alternate between full and freshen.

== Automated Builds == <!--T:111-->

<!--T:112-->
Once the {{c|.buildbot}} file has been created, the {{c|buildrepo}} and {{c|buildbot.sh}} tools are ready to use. Here's how they work. These tools are designed to keep your repository ({{c|path/mirror}} in {{f|/root/.metro}} up-to-date by inspecting your repository and looking for stages that are out-of-date. 

<!--T:113-->
To list the next build that will be performed, do this -- this is from my ARM build server:

<!--T:114-->
{{console|body=
# ##i##./buildrepo nextbuild
build=funtoo-current
arch_desc=arm-32bit
subarch=armv7a_hardfp
fulldate=2015-02-08
nextdate=2015-02-20
failcount=0
target=full
extras=''
}}

<!--T:115-->
If no output is displayed, then all your builds are up-to-date.

<!--T:116-->
To actually run the next build, run {{c|buildbot.sh}}:

<!--T:117-->
{{console|body=
# ##i##./buildbot.sh
}}

<!--T:118-->
If you're thinking that {{c|buildbot.sh}} would be a good candidate for a cron job, you've got the right idea!

=== List Builds === <!--T:119-->

<!--T:120-->
To get a quick look at our repository, let's run the {{c|buildrepo fails}} command:

<!--T:121-->
{{console|body=
# ##i##./buildrepo fails
   0   2015-02-18 /home/mirror/funtoo/funtoo-current/x86-64bit/amd64-jaguar
   0   2015-02-18 /home/mirror/funtoo/funtoo-current/pure64/amd64-jaguar-pure64
   0   2015-02-18 /home/mirror/funtoo/funtoo-current-hardened/x86-64bit/amd64-jaguar
   0   2015-02-18 /home/mirror/funtoo/funtoo-current-hardened/pure64/amd64-jaguar-pure64
 }}

<!--T:122-->
On my AMD Jaguar build server, on Feb 20, 2015, this lists all the builds that {{c|buildrepo}} has been configured to manage. The first number on each line is a '''failcount''', which is the number of consecutive times that the build has failed. A zero value indicates that everything's okay. The failcount is an important feature of the advanced repository management features. Here are a number of behaviors that are implemented based on failcount:

<!--T:123-->
* If {{c|buildbot.sh}} tries to build a stage and the build fails, the failcount is incremented.
* If the build succeeds for a particular build, the failcount is reset to zero.
* Builds with the lowest failcount are prioritized by {{c|buildrepo}} to build next, to steer towards builds that are more likely to complete successfully.
* Once the failcount reaches 3 for a particular build, it is removed from the build rotation.

=== Resetting Failcount === <!--T:124-->

<!--T:125-->
If a build has issues, the failcount for a build will reach 3, at which point it will be pulled out of build rotation. To clear failcount, so that these builds are attempted again -- possibly fixed by new updates to the Portage tree -- use {{c|buildrepo zap}}:

<!--T:126-->
{{console|body=
# ##i##/root/metro/scripts/buildrepo zap
Removing /mnt/data/funtoo/funtoo-current/arm-32bit/armv7a_hardfp/.control/.failcount...
Removing /mnt/data/funtoo/funtoo-current/arm-32bit/armv6j_hardfp/.control/.failcount...
Removing /mnt/data/funtoo/funtoo-current/arm-32bit/armv5te/.control/.failcount...
}}

== Repository Maintenance == <!--T:127-->

<!--T:128-->
A couple of repository maintenance tools are provided:

<!--T:129-->
* {{c|buildrepo digestgen}} will generate hash files for the archives in your repository, and clean up stale hashes. 
* {{c|buildrepo index.xml}} will create an index.xml file at the root of your repository, listing all builds available.
* {{c|buildrepo clean}} will output a shell script that will remove old stages. No more than the three most recent stage builds for each build/arch/subarch are kept.

== Distributed Repositories == <!--T:130-->

<!--T:131-->
In many situation, you will have a number of build servers, and each will build a subset of your master repository, and then upload builds to the master repository. This is an area of Metro that is being actively developed. For now, automated upload functionality is not enabled, but is expected to be implemented in the relatively near future. However, it is possible to have your master repository differentiate between subarches that are built locally, and thus should be part of that system's {{c|buildbot}} build rotation, and those that are stored locally and built remotely. These builds should be cleaned when {{c|buildrepo clean}} is run, but should not enter the local build rotation. To set this up, modify {{f|/root/.buildbot}} and use the {{c|subarches}} and {{c|all_subarches}} variables:

<!--T:132-->
{{file|name=/root/.buildbot|desc=Excerpt of .buildbot config for master repository|body=
# subarches we are building locally:

<!--T:133-->
subarches = ( 
        "pentium4",
        "athlon-xp",
        "corei7",
        "corei7-pure64",
        "generic_32", 
        "i686", 
        "amd64-k8",
        "amd64-k8-pure64",
        "core2_64",
        "core2_64-pure64",
        "generic_64",
        "generic_64-pure64",
) 
  
# Things we need to clean, even if we may not be building:
  
all_subarches = subarches + (
        "atom_32",
        "atom_64",
        "atom_64-pure64",
        "amd64-k10",
        "amd64-k10-pure64",
        "amd64-bulldozer",
        "amd64-bulldozer-pure64",
        "amd64-steamroller",
        "amd64-steamroller-pure64",
        "amd64-piledriver",
        "amd64-piledriver-pure64",
        "amd64-jaguar",
        "amd64-jaguar-pure64",
        "intel64-haswell",
        "intel64-haswell-pure64",
        "intel64-ivybridge-pure64",
        "intel64-ivybridge",
        "armv7a_hardfp",
        "armv6j_hardfp",
        "armv5te"
) 
}}
== Using binary cache ==
Metro has built-in feature which allows to use binary packages cache rather then building same list of packages from sources. For example, core packages, such as @system are updated at slower pace and it makes sense to enable binary cache to make stage building blazing fast. However, the real disadvantage with using binary cache could be a core package update that due to internal ABI changes require rebuilding of numerous packages from sources. Good example is {{c|sys-libs/ncurses-5}} to {{c|sys-libs/ncurses-6}} major update. This is the case when you would need to disable binary cache and use regular ebuild installation from sources.  To enable binary cache, in your metro git repository copy, edit the {{c|common.conf}} 
{{file|name=/etc/builds/common.conf|desc=Excerpt of default common.conf|body=
[section metro]

options:
options/stage:
target: gentoo
}}
and set {{c|cache/package}}
{{file|name=/etc/builds/common.conf|desc=Excerpt of common.conf with binary cache enabled|body=
[section metro]

options:
options/stage: cache/package
target: gentoo
}}

During stage build metro will save package cache in {{c|/var/tmp/metro/cache/package-cache}}. With any next builds this binary package  cache will be used.
<!--T:134-->
[[Category:Official Documentation]]
[[Category:Metro]]