The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.
Metro
{{#layout:doc}}Metro é o build system para os stages Funtoo Linux e Gentoo Linux. Ele automatiza o processo de bootstrap.
Esse tutorial te guiará através da instalação, configuração e execução do Metro.
Esses outros documentos do Metro também estão disponíveis:
{{#ask: |format=ul }}
Preface
Como o Metro Funciona
Metro é um sistema de construção automática do Funtoo, e é utilizado para construir os tarballs do Linux stage tarballs.
Metro Não pode gerar um stage tarball vazio. Para gerar um novo stage tarball, o Metro precisa utilizar um stage tarball antigo existente chamado de um "seed" stage. Esse seed stage tipicamente é utilizando como o ambiente build para a criação do stage que queremos.
O Metro pode utilizar dois tipos de seed stages. Tradicionalmente, o Metro tem utilizando um stage3 como um seed stage. Esse stage3 é então utilizado para construir um novo stage1, que por sua vez é utilizado para construir um novo stage2, e depois um novo stage3. Esse é geralmente o mais confiável meio de construir Gentoo Linux ou Funtoo Linux, assim ele é a aproximação recomendada.
Depois de carregar o metro builds no Funtoo profile, Gentoo stages não são mais fornecidos!
Seeds e Build Isolation
um outro conceito importante a mencionar aqui é algo chamado de build isolation. Porque o Metro gera um ambiente build isolado, e o ambiente build é explicitamente definido utilizando entidades tangíveis existentes -- um seed stage e um portage snapshot -- você obterá resultados repetíveis, consistentes. Em outras palavras, A mesma seed stage, portage snapshot e instruções de build gerarão um resultado essencialmente idêntico, mesmo se você desempenhar o build um mês depois na workstation de outra pessoa.
Build Local
Digamos que você quisesse construir um novo stage3 tarball pentium4. O método recomendado de se fazer isso seria agarrar um stage3 tarball pentium4 existente para utilizar como seu seed stage. Será dito ao Metro que utilizr esse stage3 pentium4 existente para construir um novo stage1 para o mesmo pentium4. Para esse processo, o stage3 pentium4 genérico forneceria o build environment para a criação de nosso novo stage1. Depois, o novo stage1 serviria como o build environment para a criação de novo stage2 pentium4. E o novo stage2 pentium4 serviria como build environment para a criação do novo stage3 pentium4.
Na terminologia Metro isso é chamado de um local build, que significa que um stage3 de uma dada arquitetura é utilizada para semear (seed) um build novinho da mesma arquitetura. Incidentalmente esse será o primeiro exercício que vamos realizar nesse tutorial.
Uma semana depois, você pode querer construir um stage34 tarball pentium4 novo. Ao invés de iniciar a partir do stage3 pentium4 original novamente, provavelmente você configuraria o Metro para utilizar o stage3 pentium4 mais recentemente construído como a seed. Metro possui funcionalidade built-in para tornar isso fácil, permitindo facilmente encontrar e rastrear a stage3 seed mais recente disponível.
Build Remoto
Metro pode também desempenhar remote build, onde um stage3 de uma arquitetura diferente, mas binariamente compatível, é utilizada como uma seed para construir um stage3 de arquitetura diferente. Consequentemente o segundo exercício que vamos realizar nesse tutorial será construir um stage3 tarball core2 32bit a partir do stage3 tarball do pentium4 que acabamos de construir.
TODO: adicione ressalvas a respeito de qual archs podem ser semeadas e qual não pode (talvez uma tabela?)
Build Adaptado
Por ultimo, de nada também vale a pena que ambos local e remote builds, Metro pode ser configurado para adicionar e/ou remover pacotes individuais ao tarball final. Vamos dizer que você não possa viver sem app-misc/screen, no final desse tutorial, nós mostraremos como ter seu stage3 adaptado para incluí-lo.
Instalando o Metro
O método recomendado e que possui suporte é utilizar o Git repository do Metro.
Certifique-se de que o dev-vcs/git e o No results (opcional; necessário para suporte EC2) estejam instalados no seu sistema:
root # emerge dev-vcs/git root # emerge dev-python/boto
Depois, clone o master git repository como a seguir:
root # cd /root root # git clone git://github.com/funtoo/metro.git root # cp /root/metro/metro.conf ~/.metro
Você agora terá um diretório chamado /root/metro que contem todo o código fonte do Metro.
O Metro está agora instalado. É hora de personalizá-lo para seu sistema local.
Configurando o Metro
Metro não é atualmente capaz de construir Gentoo stages. Veja FL-901.
Daniel Robbins mantem Metro, então ele vem pre-configurado para com sucesso construir releases (lançamentos) do Funtoo Linux. Antes de ler mais adiantes, você pode querer personalizar algumas configurações básicas como o número de serviços atuais para encaixar suas compatibilidades de hardware ou o diretório se utilizar para produzir arquivos stage. Isso This is realizado ao editar ~/.metro que é o o arquivo de configuração mestre do Metro.
Note que path/install deve apontar para aonde o metro foi instalado. Aponte path/distfiles para aonde seus distfiles residem. Também defina path/mirror/owner e path/mirror/group ao proprietário e grupo de todos os arquivos que serão escritos ao diretório do repositório build, que por padrão (como pelo arquivo de configuração) está em /home/mirror/funtoo. O diretório cache normalmente reside dentro do diretório temp -- Isso pode ser modificado como desejado. O diretório cache pode acabar mantendo muitos pacotes .tbz2 em cache, e consumir um monte do storage. Você pode querer alocar o diretório temp em mais rápidos, para obter tempos de compilação mais rápido, e alocar o diretório cache en storage mais lento, porém mais abundante.
.metro - Metro configuration# 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 e Subarch
No exemplo a seguir, estamos gerando um stage3 pentium4 compilado para compatibilidade binária x86-32bit. Pentium4 é uma subarch da arquitetura x86-32bit. Uma vez que você tenha metro instalado você pode encontrar uma lista completa de cada subarch em seu diretório /root/metro/subarch; cada subarch terá a extensão de arquivo .spec Example:
root # ls /root/metro/subarch root # 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
Primeiras contruções de stages (local build)
Para começar tudo isso, precisamos inicializar o processo ao baixar uma semente stage3 inicial para utilizar para a construção e alocá-la em seu local apropriado em /home/mirror/funtoo, então assim Metro pode encontrá-la. Também precisaremos criar alguns "controles" especiais; arquivos em /home/mirror/funtoo, que permitirão ao Metro entender como ele deve se proceder.
Primeiro Passo: Definir repositório pentium4 (build local)
Assumindo que estamos segundo os passos básicos esboçados na seção anterior, e construindo um funtoo instável (funtoo-current) construído para o pentium4, utilizando um stage3 pentium4 genérico como uma semente stage, então aqui o primeiro conjunto de passos que desempenharemos:
root # install -d /home/mirror/funtoo/funtoo-current/x86-32bit/pentium4 root # install -d /home/mirror/funtoo/funtoo-current/snapshots root # cd /home/metro/mirror/funtoo/funtoo-current/x86-32bit/pentium4 root # install -d 2011-12-13 root # cd 2011-12-13 root # 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 root # cd .. root # install -d .control/version root # echo "2011-12-13" > .control/version/stage3 root # install -d .control/strategy root # echo local > .control/strategy/build root # echo stage3 > .control/strategy/seed
OK, vamos rever os passos acima. Primeiro, criamos o diretório /home/mirror/funtoo/funtoo-current/x86-32bit/pentium4, ao qual é aonde Metro esperará encontrar builds pentium4 instáveis funtoo-current -- ele é configurado para procurar aqui por padrão. depois criamos um diretório especialmente nomeado para abrigar nossa semente x86 stage3. De novo, por padrão, Metro espera que o diretório seja nomeado desse jeito. Entramos nesse diretório, e baixamos nossa semente x86 stage3 a partir do funtoo.org. Note que o selo da versão 2010-12-24 corresponde. Certifique-se de que o nome do seu diretório corresponde com o nome do stage3 também. Tudo tem sido configurado para corresponder com o layout de sistema de arquivo padrão do Metro.
Depois, voltamos ao dirtório/home/mirror/metro/funtoo-current/x86-32bit/pentium4, e dentro dele, geramos um diretório .control. Esse diretório e seus subdiretórios contem arquivos especiais que o Metro refere para determinar certo aspectos de seu comportamento. O arquivo .control/version/stage3 é utilizado pelo Metro para rastrear o stage3 construído mais recentemente para essa build e subarch particular. Metro automaticamente atualizará esse arquivo com um novo selo de versão depois que ele constrói com sucesso um novo stage3. Mas por rasão que Metro não construiu na verdade esse stage3, precisamos definir o arquivo .control/version/stage3 manualmente. Isso permite ao Metro encontrar nosso stage3 baixado quando definimos nosso build pentium4 build a se utilizar como uma seed. Note também que o Metro gerará um arquivo .control/version/stage1 similar depois que ele construir com sucesso um stage1 funtoo-current para pentium4.
Definimos também os arquivos .control/strategy/build e .control/strategy/seed com valores de local e stage3 respectivamente. Esses arquivos definem a estratégia de construção que Metro utilizará quando nós construirmos stages funtoo-current para pentium4. Com uma estratégia de construção de local, Metro gerará raíz de sia seed stage a partir do funtoo-current pentium4, o diretório atual. E com uma estratégia de seed de stage3, Metro utilizará um stage3 como uma seed, e utilizará essa seed para construir um novo stage1, stage2 e stage3.
Segundo Passo: Construindo os stages para pentium4
Incidentalmente, se tudo o que você queria fazer nesse ponto era construir um novo stage1/2/3 do funtoo-current para pentium4 (mais o openvz e vserver templates). Você começaria o processo ao digitar:
root # cd /root/metro root # scripts/ezbuild.sh funtoo-current pentium4
Se tiver uma máquina lenta, isso poderia levar várias horas para ser completada por que vários componentes "pesados" como gcc ou glibc tem que ser compilados em cada stage. Uma vêz que um stage tem sido completado com sucesso, ele é alocado no subdiretório "${METRO_MIRROR}/funtoo-current/x32-bit/pentium4/YYYY-MM-DD", onde YYYY-MM-DD é a data de hoje no horário que o script ezbuild.sh foi iniciado ou a data que você inseriu na linha de comando ezscript.sh.
Construir para outra arquitetura compatível binária (remote build)
Como escrito acima, Metro é capaz de desenvolver remote build construindo stage3 para arquitetura disferente a partir de uma seeding stage3 binária compatível (ex. utilizando um stage3 para pentium4 para semear um stage3 para Intel Core2 32bits).
Na terminologia Metro Isso é chamado de uma remote build (um stage 3 de uma arquitetura diferente, mas binariamente compatível, é utilizada como uma semente). Qual não é compatível? Você não pode utilizar uma arquitetura Sparc para gerar um stage baseado em x86 ou ARM e vice-versa. Se você utilizar um stage para 32bit então você não quer semear uma build 64bit a partir dessa. Certifique-se de que você está utilizando um stage a partir da mesma arquitetura que você está tentando semear. Verifique Funtoo-current FTP Mirror para um stage que é da mesma Arquitetura que você estará construindo.
Com frequência, uma build (ex. funtoo-current) pode ser utilizada como uma seed (semente) para outra build como funtoo-stable. No entanto, hardened builds requerem hardened stages como seeds a fim de que a build finalize com sucesso.
Primeiro Passo: Definir o repositório Core_2 32bit
Nesse exemplo, vamos utilizar esse stage3 funtoo-current para pentium4 para semear um novo stage3 funtoo-current build para Core_2 32bit. Para conseguir fazer isso, precisamos definir o diretório pentium4 build como a seguir:
root # cd /home/mirror/funtoo/funtoo-current/x86-32bit root # install -d core2_32 root # cd core2_32 root # install -d .control/strategy root # echo remote > .control/strategy/build root # echo stage3 > .control/strategy/seed root # install -d .control/remote root # echo funtoo-current > .control/remote/build root # echo x86-32bit > .control/remote/arch_desc root # echo pentium4 > .control/remote/subarch
Os passos que seguimos são similares aqueles que realizamos para um local build para definir nosso diretório pentium4 directory para 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 .control/version/stage{1,3} files because Metro will create them for us after it successfully builds a new stage1 and stage3. We are still using a stage3 seed strategy, but we've set the build strategy to remote, 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 .control/remote directory contains this information, and lets Metro know that it should look for its seed stage3 in the /home/mirror/funtoo/funtoo-current/x86-32bit/pentium4 directory. Which one will it grab? You guessed it -- the most recently built stage3 (since our seed strategy was set to stage3) that has the version stamp of 2010-12-24, as recorded in /home/mirror/funtoo-current/x86-32bit/pentium4/.control/version/stage. Now you can see how all those control files come together to direct Metro to do the right thing.
arch_desc should be set to one of: x86-32bit, x86-64bit or pure64 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:
root # /root/metro/scripts/ezbuild.sh funtoo-current core2_32
In that case, the produced stages are placed in the /home/mirror/funtoo/funtoo-current/x32-bit/core2_32/YYYY-MM-DD 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 .control/strategy/build to be local instead of remote, 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 /root/metro/etc/builds/funtoo-current/build.conf:
funtoo-current/build.conf [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]]
Building Gentoo stages
Metro can also build Gentoo stages. After switching to Funtoo profile, see http://www.funtoo.org/Funtoo_Profiles metro require additional steps for this. 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. http://www.funtoo.org/Funtoo_Profiles
Advanced Features
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 emerge sqlalchemy, as SQLite is used as a dependency.
Repository Management
Metro includes a script in the scripts directory called buildrepo. Buildrepo serves as the heart of Metro's advanced repository management features.
Initial Setup
To use buildrepo, you will first need to create a .buildbot configuration file. Here is the file I use on my AMD Jaguar build server:
/root/.buildbot (python source code) 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 builds, arches and subarches. These variables tell buildrepo which builds, arches and subarches it should manage. A map_build() function is also defined which 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 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
Once the .buildbot file has been created, the buildrepo and buildbot.sh tools are ready to use. Here's how they work. These tools are designed to keep your repository (path/mirror in /root/.metro up-to-date by inspecting your repository and looking for stages that are out-of-date.
To list the next build that will be performed, do this -- this is from my ARM build server:
root # ./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.
To actually run the next build, run buildbot.sh:
root # ./buildbot.sh
If you're thinking that buildbot.sh would be a good candidate for a cron job, you've got the right idea!
List Builds
To get a quick look at our repository, let's run the buildrepo fails command:
root # ./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 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
buildbot.shtries 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 Template: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 buildrepo zap:
root # /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:
buildrepo digestgenwill generate hash files for the archives in your repository, and clean up stale hashes.buildrepo index.xmlwill create an index.xml file at the root of your repository, listing all builds available.buildrepo cleanwill 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 buildbot build rotation, and those that are stored locally and built remotely. These builds should be cleaned when buildrepo clean is run, but should not enter the local build rotation. To set this up, modify /root/.buildbot and use the subarches and all_subarches variables:
/root/.metro - Excerpt of .metro config for master repository# 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"
)