Difference between pages "Metro" and "Repository Configuration"

(Difference between pages)
 
(Migrating existing configurations)
 
Line 1: Line 1:
{{#layout:doc}}{{#widget:AddThis}}[[Metro]] is the build system for Funtoo Linux and [[Gentoo Linux]] stages. It automates the bootstrapping process.
+
{{Warning|This article is a work-in-progress referring to a future Portage version. It does not apply to the current Funtoo Portage version. Please do not update your configuration yet.}}
  
This tutorial will take you through installing, setting up and running [[Metro]].
+
Starting with Portage-2.3.8, a switch to a new repository configuration framework is complete and users may want to update their configuration files. This document aims to describe the goals for the new framework and how to use it.
  
These other Metro documents are also available:
+
== Multiple repository layout ==
 +
One of the most important changes is the switch from the old ''overlay'' layout to a new cleaner ''repository'' system. The new layout is more flexible and more predictable. For example, repositories can now use resources (eclasses, for example) provided by other repositories.
  
{{#ask: [[Category:Metro]]
+
The old layout was based on the concept of one ''main tree'' and optionally a number of overlays. The main tree provided base system ebuilds, eclasses, profiles, while overlays mostly were able to provide their own ebuilds. The ebuild provided by overlays overrode the ebuilds in main tree to the extend of making it impossible to install the main tree version. Overlays could also provide eclasses for their own ebuilds and package.* entries that applied to all overlays and to the main tree. The Package Manager is responsible for updating the main tree, while overlays are managed externally.
|format=ul
+
}}
+
  
= Preface =
+
The new layout is based on the concept of one or more configurable repositories. Each repository can either be stand-alone or depend upon other repositories. The distribution provides a repository called ''funtoo'' (a drop-in replacement for Gentoo's ''gentoo'' repository). Users can install more repositories at they will, the repositories providing their own ebuilds, eclasses and profiles as necessary and/or using them from other repositories. Users can explicitly choose the repository they want to install packages from. The Package Manager can update all repositories.
  
== How Metro Works ==  
+
== Portage configuration ==
 +
=== New repository layout ===
 +
The repository configuration should be stored in <code>/etc/portage/repos.conf</code>. It can be either a single file or a directory containing one or more ''.conf'' files.
  
Metro is the Funtoo Linux automated build system, and is used to build Funtoo Linux stage tarballs.
+
The default configuration is installed as <code>/usr/share/portage/config/repos.conf</code>. This file is internal configuration file installed with portage ebuild and should '''not''' be modified. Instead, the configuration in <code>/etc/portage/repos.conf</code> can override the defaults specified there.
  
[[Metro]] cannot create a stage tarball out of thin air. To build a new stage tarball, [[Metro]] must use an existing, older stage tarball called a "seed" stage. This seed stage typically is used as the ''build environment'' for creating the stage we want.
+
The configuration uses format similar to Windows .ini files. Each section heading (repository name in square brackets) signifies a single repository, followed by one or more key-value option pairs. For example, the following file copies default configuration for Funtoo repository:
  
[[Metro]] can use two kinds of seed stages. Traditionally, [[Metro]] has used a stage3 as a seed stage. This stage3 is then used to build a new stage1, which in turn is used to build a new stage2, and then a new stage3. This is generally the most reliable way to build [[Gentoo Linux]] or Funtoo Linux, so it's the recommended approach.
+
{{file|name=/etc/portage/repos.conf/funtoo.conf|desc=Example configuration override for Funtoo repository to move it to non-standard location|body=
{{fancyimportant|'''After switching metro builds to Funtoo profile, Gentoo stages are no longer provided'''!}}
+
[funtoo]
 
+
# moved to non-standard location!
== Seeds and Build Isolation ==
+
location = /var/db/repos/funtoo
 
+
sync-type = git
Another important concept to mention here is something called ''build isolation''. Because [[Metro]] creates an isolated build environment, and the build environment is explicitly defined using existing, tangible entities -- a seed stage and a portage snapshot -- you will get consistent, repeatable results. In other words, the same seed stage, portage snapshot and build instructions will generate an essentially identical result, even if you perform the build a month later on someone else's workstation.
+
sync-uri = git://github.com/funtoo/ports-2015.git
 
+
auto-sync = yes
== Local Build ==
+
 
+
Say you wanted to build a new <tt>pentium4</tt> stage3 tarball. The recommended method of doing this would be to grab an existing <tt>pentium4</tt> stage3 tarball to use as your seed stage. [[Metro]] will be told to use this existing <tt>pentium4</tt> stage3 to build a new stage1 for the same <tt>pentium4</tt>. For this process, the generic <tt>pentium4</tt> stage3 would provide the ''build environment'' for creating our new stage1. Then, the new stage1 would serve as the build environment for creating the new <tt>pentium4</tt> stage2. And the new <tt>pentium4</tt> stage2 would serve as the build environment for creating the new <tt>pentium4</tt> stage3.
+
 
+
In the [[Metro]] terminology this is called a '''local build''', which means a stage3 of a given architecture is used to seed a brand new build of the same architecture. Incidentally this will be the first exercise we are going to perform in this tutorial.
+
 
+
A week later, you may want to build a brand new <tt>pentium4</tt> stage3 tarball. Rather than starting from the original <tt>pentium4</tt> stage3 again, you'd probably configure [[Metro]] to use the most-recently-built <tt>pentium4</tt> stage3 as the seed. [[Metro]] has built-in functionality to make this easy, allowing it to easily find and track the most recent stage3 seed available.
+
 
+
== Remote Build ==
+
 
+
[[Metro]] can also perform '''remote build''', where a stage3 of a different, but binary compatible, architecture is used as a seed to build a different architecture stage3. Consequentiality the second exercise we are going to perform in this tutorial will be to build a <tt>core2 32bit</tt> stage3 tarball from the <tt>pentium4</tt> stage3 tarball we have just built.
+
 
+
TODO: add caveats about what archs can be seeded and what can be not (maybe a table?)
+
 
+
== Tailored Build ==
+
 
+
Last, it's also worthy noting that both in <tt>local</tt> and <tt>remote builds</tt>, [[Metro]] can be configured to add and/or remove individual packages to the final tarball.
+
Let's say you can't live without <tt>app-misc/screen</tt>, at the end of this tutorial, we will show how to have your tailored stage3 to include it.
+
 
+
== Installing Metro ==
+
 
+
'''The recommended and supported method''' is to use the Git repository of [[Metro]]. 
+
 
+
Ensure that {{Package|dev-vcs/git}} and {{Package|dev-python/boto}} (optional; required for EC2 support) are installed on your system:
+
 
+
<console>
+
# ##i##emerge dev-vcs/git
+
# ##i##emerge dev-python/boto
+
</console>
+
 
+
Next, clone the master git repository as follows:
+
 
+
<console>
+
# ##i##cd /root
+
# ##i##git clone git://github.com/funtoo/metro.git
+
# ##i##cp /root/metro/metro.conf ~/.metro
+
</console>
+
 
+
You will now have a directory called <tt>/root/metro</tt> that contains all the [[Metro]] source code.
+
 
+
Metro is now installed. It's time to customize it for your local system.
+
 
+
= Configuring Metro =
+
 
+
{{Note|Metro is not currently able to build Gentoo stages. See {{Bug|FL-901}}.}}
+
 
+
[[User:Drobbins|Daniel Robbins]] maintains [[Metro]], so it comes pre-configured to successfully build [[Funtoo Linux]] releases. Before reading further, you might want to customize some basic settings like the number of concurrent jobs to fit your hardware's capabilities or the directory to use for produced stage archives. This is accomplished by editing <tt>~/.metro</tt> which is the [[Metro]]'s master configuration file.
+
 
+
Please note that <code>path/install</code> must point to where metro was installed. Point <code>path/distfiles</code> to where your distfiles reside. Also set <code>path/mirror/owner</code> and <code>path/mirror/group</code> to the owner and group of all the files that will be written to the build repository directory, which by default (as per the configuration file) is at <code>/home/mirror/funtoo</code>. The cache directory normally resides inside the temp directory -- this can be modified as desired. The cache directory can end up holding many cached .tbz2 packages, and eat up a lot of storage. You may want to place the temp directory on faster storage, for faster compile times, and place the cache directory on slower, but more plentiful storage.
+
 
+
{{file|name=.metro|desc=Metro configuration|body=
+
# Main metro configuration file - these settings need to be tailored to your install:
+
 
+
[section path]
+
install: /root/metro
+
tmp: /var/tmp/metro
+
cache: $[path/tmp]/cache
+
distfiles: /var/src/distfiles
+
work: $[path/tmp]/work/$[target/build]/$[target/name]
+
 
+
[section path/mirror]
+
 
+
: /home/mirror/funtoo
+
owner: root
+
group: repomgr
+
dirmode: 775
+
 
+
[section portage]
+
 
+
MAKEOPTS: auto  
+
 
+
[section emerge]
+
 
+
options: --jobs=4 --load-average=4 --keep-going=n
+
 
+
# This line should not be modified:
+
[collect $[path/install]/etc/master.conf]
+
 
}}
 
}}
  
== Arch and Subarch ==
+
The most useful repository configuration options are listed below:
 +
;location: ''Obligatory.'' Specifies the directory where repository is/will be stored. If Portage knows how to sync the repository and the location does not exist, it will be created on next ''emerge --sync''. Otherwise, the directory must exist.
 +
;priority: Specifies the priority used for ordering ebuilds from different repositories. If two repositories provide an ebuild with matching versions, the repository with higher priority will be used.
 +
;auto-sync: Specifies whether ''emerge --sync'' should update the repository. Defaults to ''yes'' if ''sync-type'' is specified, ''no'' otherwise.
 +
;sync-depth: Specifies ''--depth'' for git clone. Used only on initial sync. Defaults to 1. Can be set to 0 to force full clone (not pass ''--depth'' at all).
 +
;sync-type: Specifies syncing/update method. Can be one of: ''cvs'', ''git'', ''rsync'', ''svn''.
 +
;sync-umask: Specifies the umask used when updating/syncing the repository.
 +
;sync-uri: Specifies remote URI from which the repository will be cloned/synced. Can use any syntax valid for a particular syncing method.
 +
;sync-user: Specifies the user[:group] used to update/sync the repository. If ''FEATURES=usersync'' is used, defaults to the credentials of directory owner.
  
In the following example we are creating a pentium4 stage 3 compiled for x86-32bit binary compatibility. Pentium4 is a subarch of the x86-32bit architecture. Once you have metro installed you may find a full list of each subarch in your <tt>/root/metro/subarch</tt> directory each subarch will have the file extension .spec
+
Additionally a <code>[DEFAULT]</code> section may be specified. Options in this section are used as defaults for all repositories.
Example:
+
<console>
+
###i## ls /root/metro/subarch
+
# ls subarch/
+
amd64-bulldozer-pure64.spec  armv7a.spec          core-avx-i.spec        i686.spec        pentium.spec
+
amd64-bulldozer.spec        armv7a_hardfp.spec  core2_32.spec          k6-2.spec        pentium2.spec
+
amd64-k10-pure64.spec        athlon-4.spec        core2_64-pure64.spec    k6-3.spec        pentium3.spec
+
amd64-k10.spec              athlon-mp.spec      core2_64.spec          k6.spec          pentium4.spec
+
amd64-k8+sse3.spec          athlon-tbird.spec    corei7-pure64.spec      native_32.spec    pentiumpro.spec
+
amd64-k8+sse3_32.spec        athlon-xp.spec      corei7.spec            native_64.spec    prescott.spec
+
amd64-k8-pure64.spec        athlon.spec          generic_32.spec        niagara.spec      ultrasparc.spec
+
amd64-k8.spec                atom_32.spec        generic_64-pure64.spec  niagara2.spec    ultrasparc3.spec
+
amd64-k8_32.spec            atom_64-pure64.spec  generic_64.spec        nocona.spec      xen-pentium4+sse3.spec
+
armv5te.spec                atom_64.spec        generic_sparcv9.spec    opteron_64.spec  xen-pentium4+sse3_64.spec
+
armv6j.spec                  btver1.spec          geode.spec              pentium-m.spec
+
armv6j_hardfp.spec          btver1_64.spec      i486.spec              pentium-mmx.spec
+
</console>
+
  
= First stages build (local build) =
+
=== Migrating existing configurations ===
 
+
The new configuration format provides replacement for existing configuration done through <code>/etc/portage/make.conf</code> and environment variables. While the variables are still supported for backwards compatibility, users are recommended to move to the new configuration scheme. Funtoo portage ebuild is planned to make the migration unattended (repos.conf installed automatically to ease the config steps) with the following file:
To get this all started, we need to bootstrap the process by downloading an initial seed stage3 to use for building and place it in its proper location in <tt>/home/mirror/funtoo</tt>, so that [[Metro]] can find it. We will also need to create some special &quot;control&quot; files in <tt>/home/mirror/funtoo</tt>, which will allow [[Metro]] to understand how it is supposed to proceed.
+
 
+
{{file|name=/etc/portage/repos.conf/funtoo.conf|body=
== Step 1: Set up pentium4 repository (local build) ==
+
[funtoo]
 
+
location = /usr/portage
Assuming we're following the basic steps outlined in the previous section, and building an unstable funtoo (<tt>funtoo-current</tt>) build for the <tt>pentium4</tt>, using a generic <tt>pentium4</tt> stage3 as a seed stage, then here the first set of steps we'd perform:
+
sync-type = git
 
+
sync-uri = git://github.com/funtoo/ports-2015.git
<console>
+
auto-sync = yes
# ##i##install -d /home/mirror/funtoo/funtoo-current/x86-32bit/pentium4
+
# ##i##install -d /home/mirror/funtoo/funtoo-current/snapshots
+
# ##i##cd /home/metro/mirror/funtoo/funtoo-current/x86-32bit/pentium4
+
# ##i##install -d 2011-12-13
+
# ##i##cd 2011-12-13
+
# ##i##wget -c http://ftp.osuosl.org/pub/funtoo/funtoo-current/x86-32bit/pentium4/2011-12-13/stage3-pentium4-funtoo-current-2011-12-13.tar.xz
+
# ##i##cd ..
+
# ##i##install -d .control/version
+
# ##i##echo "2011-12-13" > .control/version/stage3
+
# ##i##install -d .control/strategy
+
# ##i##echo local >  .control/strategy/build
+
# ##i##echo stage3 > .control/strategy/seed
+
</console>
+
 
+
OK, let's review the steps above. First, we create the directory <tt>/home/mirror/funtoo/funtoo-current/x86-32bit/pentium4</tt>, which is where Metro will expect to find unstable <tt>funtoo-current</tt> pentium4 builds -- it is configured to look here by default. Then we create a specially-named directory to house our seed x86 stage3. Again, by default, Metro expects the directory to be named this way. We enter this directory, and download our seed x86 stage3 from funtoo.org. Note that the <tt>2010-12-24</tt> version stamp matches. Make sure that your directory name matches the stage3 name too. Everything has been set up to match Metro's default filesystem layout.
+
 
+
Next, we go back to the <tt>/home/mirror/metro/funtoo-current/x86-32bit/pentium4</tt> directory, and inside it, we create a <tt>.control</tt> directory. This directory and its subdirectories contain special files that Metro references to determine certain aspects of its behavior. The <tt>.control/version/stage3</tt> file is used by Metro to track the most recently-built stage3 for this particular build and subarch. Metro will automatically update this file with a new version stamp after it successfully builds a new stage3. But because Metro didn't actually ''build'' this stage3, we need to set up the <tt>.control/version/stage3</tt> file manually. This will allow Metro to find our downloaded stage3 when we set up our pentium4 build to use it as a seed. Also note that Metro will create a similar <tt>.control/version/stage1</tt> file after it successfully builds an pentium4 funtoo-current stage1.
+
 
+
We also set up <tt>.control/strategy/build</tt> and <tt>.control/strategy/seed</tt> files with values of <tt>local</tt> and <tt>stage3</tt> respectively. These files define the building strategy Metro will use when we build pentium4 funtoo-current stages. With a build strategy of <tt>local</tt>, Metro will source its seed stage from funtoo-current pentium4, the current directory. And with a seed strategy of <tt>stage3</tt>, Metro will use a stage3 as a seed, and use this seed to build a new stage1, stage2 and stage3.
+
 
+
== Step 2: Building the pentium4 stages ==
+
 
+
Incidentally, if all you wanted to do at this point was to build a new pentium4 funtoo-current stage1/2/3 (plus openvz and vserver templates). You would begin the process by typing:
+
 
+
<console>
+
# ##i##cd /root/metro
+
# ##i##scripts/ezbuild.sh funtoo-current pentium4
+
</console>
+
 
+
If you have a slow machine, it could take several hours to be completed because several "heavy" components like gcc or glibc have to be recompiled in each stage. Once a stage has been successfully completed, it is placed in the <tt>"${METRO_MIRROR}/funtoo-current/x32-bit/pentium4/YYYY-MM-DD"</tt> subdirectory, where <tt>YYYY-MM-DD</tt> is today's date at the time the <tt>ezbuild.sh</tt> script was started or the date you put on the ezscript.sh command line.
+
 
+
= Building for another binary compatible architecture (remote build) =
+
 
+
As written above, [[Metro]] is able to perform '''remote build''' building different architecture stage3 from a binary compatible seeding stage3 (e.g. using a pentium4 stage3 to seed a <tt>Intel Core2 32bits</tt> stage3).
+
 
+
In the Metro terminology this is called a '''remote build''' (a stage 3 of a different, but binary compatible, architecture is used as a seed).  
+
What's not compatible? You can't use a <tt>Sparc</tt> architecture to generate an <tt>x86</tt> or <tt>ARM</tt> based stage and vice-versa. If you use a 32bit stage then you don't want to seed a 64bit build from it. Be sure that you are using a stage from the same architecture that you are trying to seed. Check [http://ftp.osuosl.org/pub/funtoo/funtoo-current/ Funtoo-current FTP Mirror] for a stage that is from the same Architecture that you will be building. 
+
 
+
{{Note|Often, one build (ie. funtoo-current) can be used as a seed for another build such as funtoo-stable. However, hardened builds require hardened stages as seeds in order for the build to complete successfully.}}
+
 
+
== Step 1: Set up Core_2 32bit repository ==
+
 
+
In this example, we're going to use this pentium4 funtoo-current stage3 to seed a new Core_2 32bit funtoo-current build. To get that done, we need to set up the pentium4 build directory as follows:
+
 
+
<console>
+
# ##i## cd /home/mirror/funtoo/funtoo-current/x86-32bit
+
# ##i##install -d core2_32
+
# ##i##cd core2_32
+
# ##i##install -d .control/strategy
+
# ##i##echo remote > .control/strategy/build
+
# ##i##echo stage3 > .control/strategy/seed
+
# ##i##install -d .control/remote
+
# ##i##echo funtoo-current > .control/remote/build
+
# ##i##echo x86-32bit > .control/remote/arch_desc
+
# ##i##echo pentium4 > .control/remote/subarch
+
</console>
+
 
+
The steps we follow are similar to those we performed for a ''local build'' to set up our pentium4 directory for local build. However, note the differences. We didn't download a stage, because we are going to use the pentium4 stage to build a new Core_2 32bit stage. We also didn't create the <tt>.control/version/stage{1,3}</tt> files because Metro will create them for us after it successfully builds a new stage1 and stage3. We are still using a <tt>stage3</tt> seed strategy, but we've set the build strategy to <tt>remote</tt>, which means that we're going to use a seed stage that's not from this particular subdirectory. Where are we going to get it from? The <tt>.control/remote</tt> directory contains this information, and lets Metro know that it should look for its seed stage3 in the <tt>/home/mirror/funtoo/funtoo-current/x86-32bit/pentium4</tt> directory. Which one will it grab? You guessed it -- the most recently built ''stage3'' (since our seed strategy was set to <tt>stage3</tt>) that has the version stamp of <tt>2010-12-24</tt>, as recorded in <tt>/home/mirror/funtoo-current/x86-32bit/pentium4/.control/version/stage</tt>. Now you can see how all those control files come together to direct Metro to do the right thing.
+
 
+
{{Note|<code>arch_desc</code> should be set to one of: <code>x86-32bit</code>, <code>x86-64bit</code> or <code>pure64</code> for PC-compatible systems. You must use a 32-bit build as a seed for other 32-bit builds, and a 64-bit build as a seed for other 64-bit builds.}}
+
 
+
== Step 2: Building the Core_2 32bit stages ==
+
 
+
Now, you could start building your new Core_2 32bit stage1/2/3 (plus openvz and vserver templates) by typing the following:
+
 
+
<console>
+
# ##i##/root/metro/scripts/ezbuild.sh funtoo-current core2_32
+
</console>
+
 
+
In that case, the produced stages are placed in the <tt>/home/mirror/funtoo/funtoo-current/x32-bit/core2_32/YYYY-MM-DD</tt> subdirectory.
+
 
+
== Step 3: The Next Build ==
+
 
+
At this point, you now have a new Core_2 32bit stage3, built using a "remote" pentium4 stage3. Once the first remote build completes successfully, metro will automatically change <code>.control/strategy/build</code> to be <code>local</code> instead of <code>remote</code>, so it will use the most recently-built Core_2 32bit stage3 as a seed for any new Core_2 32bit builds from now on.
+
 
+
= Build your own tailored stage3 =
+
 
+
Metro can be easily configured for building custom stage3 by including additional packages. Edit the following configuration file <tt>/root/metro/etc/builds/funtoo-current/build.conf</tt>:
+
{{file|name=funtoo-current/build.conf|body=
+
[collect ../../fslayouts/funtoo/layout.conf]
+
 
+
[section release]
+
 
+
author: Daniel Robbins <drobbins@funtoo.org>
+
 
+
[section target]
+
 
+
compression: xz
+
 
+
[section portage]
+
 
+
FEATURES:
+
SYNC: $[snapshot/source/remote]
+
USE:
+
 
+
[section profile]
+
 
+
format: new
+
path: gentoo:funtoo/1.0/linux-gnu
+
arch: $[:path]/arch/$[target/arch_desc]
+
build: $[:path]/build/current
+
flavor: $[:path]/flavor/core
+
mix-ins:
+
 
+
[section version]
+
 
+
python: 2.7
+
 
+
[section emerge]
+
 
+
 
+
[section snapshot]
+
 
+
type: live
+
compression: xz
+
 
+
[section snapshot/source]
+
 
+
type: git
+
branch: funtoo.org
+
# branch to have checked out for tarball:
+
branch/tar: origin/master
+
name: ports-2012
+
remote: git://github.com/funtoo/ports-2012.git
+
options: pull
+
 
+
[section metro]
+
 
+
options:
+
options/stage: cache/package
+
target: gentoo
+
 
+
[section baselayout]
+
 
+
services: sshd
+
 
+
[section multi]
+
 
+
snapshot: snapshot
+
 
+
[section files]
+
 
+
motd/trailer: [
+
 
+
>>> Send suggestions, improvements, bug reports relating to...
+
 
+
>>> This release:                  $[release/author]
+
>>> Funtoo Linux (general):        Funtoo Linux (http://www.funtoo.org)
+
>>> Gentoo Linux (general):        Gentoo Linux (http://www.gentoo.org)
+
]
+
 
+
[collect ../../multi-targets/$[multi/mode:zap]]
+
 
}}
 
}}
 +
The following replacements are provided for existing variables:
 +
;PORTDIR: Used to specify main tree location. Replaced by ''location'' key in the section corresponding to the default repository (<code>[funtoo]</code> by default).
 +
;PORTDIR_OVERLAY: Used to specify locations of overlays. Each of the paths needs to be replaced with a separate repository section, with the path placed in ''location'' key. Additionally, ''priority'' may be used to force specific ordering of ebuild overrides.
 +
;SYNC: Used to specify URI for syncing the main repository, also implied a protocol for doing that. Replaced by the ''sync-uri'' and ''sync-type'' keys in the default repository section.
 +
;SYNC_UMASK: Used to specify umask for syncing repositories. Replaced by ''sync-umask'' key in repository configuration. Can be specified in <code>[DEFAULT]</code> section to apply to all repositories.
 +
;SYNC_USER: Used to specify user credentials for syncing repositories. Replaced by ''sync-user'' key in repository configuration. Can be specified in <code>[DEFAULT]</code> section to apply to all repositories.
  
= Building Gentoo stages =
+
{{file|name=/etc/portage/make.conf|desc=Example old make.conf file|body=
 +
# user changed PORTDIR location
 +
PORTDIR="/var/db/repos/funtoo"
 +
PORTDIR_OVERLAY="/var/db/repos/foo /var/db/repos/bar"
  
Currently, Gentoo stages cannot be built in Metro. We have an open bug for this -- it is simply due to the fact that we focus on ensuring Funtoo Linux builds and building Gentoo is a lower priority. Historical note: Funtoo Linux originally started as a fork of Gentoo Linux so that metro could reliably build Gentoo stages.
+
SYNC="git://github.com/funtoo/ports-2015.git"
 
+
SYNC_USER="oleg"
= Advanced Features =
+
SYNC_UMASK="022"
 
+
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.
+
 
+
== Repository Management ==
+
 
+
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 ===
+
 
+
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:
+
 
+
{{file|name=/root/.buildbot|lang=python|body=
+
builds = (
+
"funtoo-current",
+
"funtoo-current-hardened",
+
"funtoo-stable",
+
)
+
 
+
arches = (
+
"x86-64bit",
+
"pure64"
+
)
+
 
+
subarches = (
+
"amd64-jaguar",
+
"amd64-jaguar-pure64",
+
)
+
 
+
def map_build(build, subarch, full, full_date):
+
# arguments refer to last build...
+
if full == True:
+
buildtype =  ( "freshen", )
+
else:
+
buildtype =  ("full", )
+
return buildtype
+
 
}}
 
}}
  
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.
+
{{file|name=/etc/portage/repos.conf|desc=Replacement repos.conf file|body=
 +
[DEFAULT]
 +
sync-user = oleg
 +
sync-umask = 022
  
=== Automated Builds ===
+
[funtoo]
 +
location = /var/db/repos/funtoo
 +
sync-type = git
 +
sync-uri = git://github.com/funtoo/ports-2015.git
  
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.
+
[foo]
 +
location = /var/db/repos/foo
 +
priority = 1
  
To list the next build that will be performed, do this -- this is from my ARM build server:
+
[bar]
 
+
location = /var/db/repos/bar
{{console|body=
+
priority = 2
# ##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=''
+
 
}}
 
}}
  
If no output is displayed, then all your builds are up-to-date.
+
The <code>repos.conf</code> configuration can be further extended with ''sync-type'' and ''sync-uri'' for overlays to get ''emerge --sync'' updating them automatically.
  
To actually run the next build, run {{c|buildbot.sh}}:
+
let's see a real example of tree and overlays added.
 +
{{file|name=/etc/portage/repos.conf|desc=Replacement repos.conf file|body=
  
{{console|body=
+
[gentoo]
# ##i##./buildbot.sh
+
location = /usr/portage
 +
sync-type = git
 +
sync-uri = git://github.com/funtoo/ports-2012.git
 +
 +
[funtoo-overlay]
 +
location = /root/git/funtoo-overlay
 +
 +
[funtoo-gnome]
 +
location = /root/git/funtoo-gnome-overlay
 
}}
 
}}
 
+
funtoo-overlay and funtoo-gnome-overlay are an overlays added on top of regular portage tree.
If you're thinking that {{c|buildbot.sh}} would be a good candidate for a cron job, you've got the right idea!
+
[[Category:Portage]]
 
+
==== List Builds ====
+
 
+
To get a quick look at our repository, let's run the {{c|buildrepo fails}} command:
+
 
+
{{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
+
  0  2015-02-18 /home/mirror/funtoo/funtoo-stable/x86-64bit/amd64-jaguar
+
  0  2015-02-18 /home/mirror/funtoo/funtoo-stable/pure64/amd64-jaguar-pure64
+
}}
+
 
+
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:
+
 
+
* 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 {{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 ====
+
 
+
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}}:
+
 
+
{{console|body=
+
# /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 ====
+
 
+
A couple of repository maintenance tools are provided:
+
 
+
* {{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 ===
+
 
+
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:
+
 
+
{{file|name=/root/.metro|desc=Excerpt of .metro config for master repository|body=
+
# subarches we are building locally:
+
 
+
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"
+
)
+
}}
+
 
+
[[Category:HOWTO]]
+
[[Category:Metro]]
+
__TOC__
+

Latest revision as of 05:39, February 21, 2015

Warning

This article is a work-in-progress referring to a future Portage version. It does not apply to the current Funtoo Portage version. Please do not update your configuration yet.

Starting with Portage-2.3.8, a switch to a new repository configuration framework is complete and users may want to update their configuration files. This document aims to describe the goals for the new framework and how to use it.

Multiple repository layout

One of the most important changes is the switch from the old overlay layout to a new cleaner repository system. The new layout is more flexible and more predictable. For example, repositories can now use resources (eclasses, for example) provided by other repositories.

The old layout was based on the concept of one main tree and optionally a number of overlays. The main tree provided base system ebuilds, eclasses, profiles, while overlays mostly were able to provide their own ebuilds. The ebuild provided by overlays overrode the ebuilds in main tree to the extend of making it impossible to install the main tree version. Overlays could also provide eclasses for their own ebuilds and package.* entries that applied to all overlays and to the main tree. The Package Manager is responsible for updating the main tree, while overlays are managed externally.

The new layout is based on the concept of one or more configurable repositories. Each repository can either be stand-alone or depend upon other repositories. The distribution provides a repository called funtoo (a drop-in replacement for Gentoo's gentoo repository). Users can install more repositories at they will, the repositories providing their own ebuilds, eclasses and profiles as necessary and/or using them from other repositories. Users can explicitly choose the repository they want to install packages from. The Package Manager can update all repositories.

Portage configuration

New repository layout

The repository configuration should be stored in /etc/portage/repos.conf. It can be either a single file or a directory containing one or more .conf files.

The default configuration is installed as /usr/share/portage/config/repos.conf. This file is internal configuration file installed with portage ebuild and should not be modified. Instead, the configuration in /etc/portage/repos.conf can override the defaults specified there.

The configuration uses format similar to Windows .ini files. Each section heading (repository name in square brackets) signifies a single repository, followed by one or more key-value option pairs. For example, the following file copies default configuration for Funtoo repository:

/etc/portage/repos.conf/funtoo.conf - Example configuration override for Funtoo repository to move it to non-standard location
[funtoo]
# moved to non-standard location!
location = /var/db/repos/funtoo
sync-type = git
sync-uri = git://github.com/funtoo/ports-2015.git
auto-sync = yes

The most useful repository configuration options are listed below:

location
Obligatory. Specifies the directory where repository is/will be stored. If Portage knows how to sync the repository and the location does not exist, it will be created on next emerge --sync. Otherwise, the directory must exist.
priority
Specifies the priority used for ordering ebuilds from different repositories. If two repositories provide an ebuild with matching versions, the repository with higher priority will be used.
auto-sync
Specifies whether emerge --sync should update the repository. Defaults to yes if sync-type is specified, no otherwise.
sync-depth
Specifies --depth for git clone. Used only on initial sync. Defaults to 1. Can be set to 0 to force full clone (not pass --depth at all).
sync-type
Specifies syncing/update method. Can be one of: cvs, git, rsync, svn.
sync-umask
Specifies the umask used when updating/syncing the repository.
sync-uri
Specifies remote URI from which the repository will be cloned/synced. Can use any syntax valid for a particular syncing method.
sync-user
Specifies the user[:group] used to update/sync the repository. If FEATURES=usersync is used, defaults to the credentials of directory owner.

Additionally a [DEFAULT] section may be specified. Options in this section are used as defaults for all repositories.

Migrating existing configurations

The new configuration format provides replacement for existing configuration done through /etc/portage/make.conf and environment variables. While the variables are still supported for backwards compatibility, users are recommended to move to the new configuration scheme. Funtoo portage ebuild is planned to make the migration unattended (repos.conf installed automatically to ease the config steps) with the following file:

/etc/portage/repos.conf/funtoo.conf
[funtoo]
location = /usr/portage
sync-type = git
sync-uri = git://github.com/funtoo/ports-2015.git
auto-sync = yes

The following replacements are provided for existing variables:

PORTDIR
Used to specify main tree location. Replaced by location key in the section corresponding to the default repository ([funtoo] by default).
PORTDIR_OVERLAY
Used to specify locations of overlays. Each of the paths needs to be replaced with a separate repository section, with the path placed in location key. Additionally, priority may be used to force specific ordering of ebuild overrides.
SYNC
Used to specify URI for syncing the main repository, also implied a protocol for doing that. Replaced by the sync-uri and sync-type keys in the default repository section.
SYNC_UMASK
Used to specify umask for syncing repositories. Replaced by sync-umask key in repository configuration. Can be specified in [DEFAULT] section to apply to all repositories.
SYNC_USER
Used to specify user credentials for syncing repositories. Replaced by sync-user key in repository configuration. Can be specified in [DEFAULT] section to apply to all repositories.
/etc/portage/make.conf - Example old make.conf file
# user changed PORTDIR location
PORTDIR="/var/db/repos/funtoo"
PORTDIR_OVERLAY="/var/db/repos/foo /var/db/repos/bar"

SYNC="git://github.com/funtoo/ports-2015.git"
SYNC_USER="oleg"
SYNC_UMASK="022"
/etc/portage/repos.conf - Replacement repos.conf file
[DEFAULT]
sync-user = oleg
sync-umask = 022

[funtoo]
location = /var/db/repos/funtoo
sync-type = git
sync-uri = git://github.com/funtoo/ports-2015.git

[foo]
location = /var/db/repos/foo
priority = 1

[bar]
location = /var/db/repos/bar
priority = 2

The repos.conf configuration can be further extended with sync-type and sync-uri for overlays to get emerge --sync updating them automatically.

let's see a real example of tree and overlays added.

/etc/portage/repos.conf - Replacement repos.conf file
[gentoo]
location = /usr/portage
sync-type = git
sync-uri = git://github.com/funtoo/ports-2012.git
 
[funtoo-overlay]
location = /root/git/funtoo-overlay
 
[funtoo-gnome]
location = /root/git/funtoo-gnome-overlay

funtoo-overlay and funtoo-gnome-overlay are an overlays added on top of regular portage tree.