source: ProjectBuilder/devel/pb-modules/lib/ProjectBuilder/VE.pm@ 1966

Last change on this file since 1966 was 1966, checked in by Bruno Cornec, 9 years ago

Add the possibility to use an existing docker image for newve with -i
option
File size: 14.6 KB
Line 
1#!/usr/bin/perl -w
2#
3# Common functions for virtual environment
4#
5# Copyright B. Cornec 2007-2015
6# Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
7# Provided under the GPL v2
8#
9# $Id$
10#
11
12package ProjectBuilder::VE;
13
14use strict;
15use Data::Dumper;
16use Carp 'confess';
17use English;
18use File::Basename;
19use ProjectBuilder::Version;
20use ProjectBuilder::Base;
21use ProjectBuilder::Conf;
22use ProjectBuilder::Distribution;
23
24# Global vars
25# Inherit from the "Exporter" module which handles exporting functions.
26
27use vars qw($VERSION $REVISION @ISA @EXPORT);
28use Exporter;
29
30# Export, by default, all the functions into the namespace of
31# any code which uses this module.
32
33our @ISA = qw(Exporter);
34our @EXPORT = qw(pb_ve_launch pb_ve_snap pb_ve_get_type pb_ve_docker_repo pb_ve_docker_get_image);
35
36($VERSION,$REVISION) = pb_version_init();
37
38=pod
39
40=head1 NAME
41
42ProjectBuilder::VE, part of the project-builder.org - module dealing with Virtual Environment
43
44=head1 DESCRIPTION
45
46This modules provides functions to deal with Virtual Environements (VE), aka chroot/containers.
47
48=head1 SYNOPSIS
49
50 use ProjectBuilder::VE;
51
52 #
53 # Return information on the running distro
54 #
55 my $pbos = pb_ve_launch();
56
57=head1 USAGE
58
59=over 4
60
61=item B<pb_ve_launch>
62
63This function launches a VE, creating it if necessary using multiple external potential tools.
64
65=cut
66
67sub pb_ve_launch {
68
69my $v = shift;
70my $pbforce = shift; # Which step are we in (0: create, 1: setup, 2: build, 3: use)
71my $locsnap = shift;
72my $vetype = shift;
73my $pbimage = shift;
74
75my $dockerregistry = undef;
76my $docrepo = undef; # By default no repository for docker available
77
78pb_log(2,"Entering pb_ve_launch at step $pbforce for type $vetype\n");
79# Get distro context
80my $pbos = pb_distro_get_context($v);
81
82$vetype = pb_ve_get_type($vetype);
83my ($vepath) = pb_conf_get("vepath");
84
85if ($vetype eq "docker") {
86 # Check acces to registry
87 ($dockerregistry) = pb_conf_get("dockerregistry");
88 if ((defined $dockerregistry) && (defined $dockerregistry->{$ENV{'PBPROJ'}})) {
89 pb_ve_docker_registry($dockerregistry->{$ENV{'PBPROJ'}});
90 } else {
91 die "When using docker you need to declare a dockerregistry parameter. Read the man page"
92 }
93}
94
95if (($vetype eq "chroot") || ($vetype eq "schroot") || ($vetype eq "docker")) {
96
97 # We need to avoid umask propagation to the VE
98 umask 0022;
99
100 # We can probably only get those params now we have the distro context
101 my ($rbsb4pi,$rbspi,$vesnap,$oscodename,$osmindep,$verebuild,$rbsmirrorsrv) = pb_conf_get_if("rbsb4pi","rbspi","vesnap","oscodename","osmindep","verebuild","rbsmirrorsrv");
102
103 # Architecture consistency
104 my $arch = pb_get_arch();
105 if ($arch ne $pbos->{'arch'}) {
106 die "Unable to launch a VE of architecture $pbos->{'arch'} on a $arch platform" unless (($pbos->{'arch'} =~ /i?86/o) && ($arch eq "x86_64"));
107 }
108
109 # If we are already root (from pbmkbm e.g.) don't use sudo, just call the command
110 my $sudocmd="";
111 if ($EFFECTIVE_USER_ID != 0) {
112 $sudocmd ="sudo ";
113 foreach my $proxy (qw/http_proxy ftp_proxy/) {
114 if (defined $ENV{$proxy}) {
115 open(CMD,"sudo sh -c 'echo \$$proxy' |") or die "can't run sudo sh?: $!";
116 $_ = <CMD>;
117 chomp();
118 die "sudo not passing through env var $proxy; '$ENV{$proxy}' != '$_'\nAdd line Defaults:`whoami` env_keep += \"$proxy\" to sudoers file?" unless $_ eq $ENV{$proxy};
119 close(CMD);
120 }
121 }
122 }
123
124 # Handle cross arch on Intel based platforms
125 $sudocmd = "setarch i386 $sudocmd" if (($pbos->{'arch'} =~ /i[3456]86/) && ($arch eq 'x86_64'));
126
127 my $root = pb_path_expand($vepath->{$ENV{PBPROJ}});
128
129 if (((((defined $verebuild) && ($verebuild->{$ENV{'PBPROJ'}} =~ /true/i)) || ($pbforce == 0)) && ($vetype ne "docker"))
130 # For docker we may have a reference image that we'll use
131 || (($vetype eq "docker") && ($pbforce == 0) && ((not defined $pbimage) || ($pbimage eq "")))) {
132
133 my ($verpmtype,$vedebtype) = pb_conf_get("verpmtype","vedebtype");
134 my ($rbsopt1) = pb_conf_get_if("rbsopt");
135
136 # We have to rebuild the chroot
137 if ($pbos->{'type'} eq "rpm") {
138
139 # Which tool is used
140 my $verpmstyle = $verpmtype->{$ENV{'PBPROJ'}};
141 die "No verpmtype defined for $ENV{PBPROJ}" unless (defined $verpmstyle);
142
143 # Get potential rbs option
144 my $rbsopt = "";
145 if (defined $rbsopt1) {
146 if (defined $rbsopt1->{$verpmstyle}) {
147 $rbsopt = $rbsopt1->{$verpmstyle};
148 } elsif (defined $rbsopt1->{$ENV{'PBPROJ'}}) {
149 $rbsopt = $rbsopt1->{$ENV{'PBPROJ'}};
150 } else {
151 $rbsopt = "";
152 }
153 }
154
155 my $postinstall = pb_ve_get_postinstall($pbos,$rbspi,$verpmstyle);
156 if ($verpmstyle eq "rinse") {
157 # Need to reshape the mirrors generated with local before-post-install script
158 my $b4post = "--before-post-install ";
159 my $postparam = pb_distro_get_param($pbos,$rbsb4pi);
160 if ($postparam eq "") {
161 $b4post = "";
162 } else {
163 $b4post .= $postparam;
164 }
165
166 # Need to reshape the package list for pb
167 my $addpkgs;
168 $postparam = "";
169 $postparam .= pb_distro_get_param($pbos,$osmindep);
170 if ($postparam eq "") {
171 $addpkgs = "";
172 } else {
173 my $pkgfile = "$ENV{'PBTMP'}/addpkgs.lis";
174 open(PKG,"> $pkgfile") || die "Unable to create $pkgfile";
175 foreach my $p (split(/,/,$postparam)) {
176 print PKG "$p\n";
177 }
178 close(PKG);
179 $addpkgs = "--add-pkg-list $pkgfile";
180 }
181
182 my $rinseverb = "";
183 $rinseverb = "--verbose" if ($pbdebug gt 0);
184 my ($rbsconf) = pb_conf_get("rbsconf");
185
186 my $command = pb_check_req("rinse",0);
187 pb_system("$sudocmd $command --directory \"$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}\" --arch \"$pbos->{'arch'}\" --distribution \"$pbos->{'name'}-$pbos->{'version'}\" --config \"$rbsconf->{$ENV{'PBPROJ'}}\" $b4post $postinstall $rbsopt $addpkgs $rinseverb","Creating the rinse VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})", "verbose");
188 } elsif ($verpmstyle eq "rpmbootstrap") {
189 my $rbsverb = "";
190 foreach my $i (1..$pbdebug) {
191 $rbsverb .= " -v";
192 }
193 my $addpkgs = "";
194 my $postparam = "";
195 $postparam .= pb_distro_get_param($pbos,$osmindep);
196 if ($postparam eq "") {
197 $addpkgs = "";
198 } else {
199 $addpkgs = "-a $postparam";
200 }
201 my $command = pb_check_req("rpmbootstrap",0);
202 pb_system("$sudocmd $command $rbsopt $postinstall $addpkgs $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'} $rbsverb","Creating the rpmbootstrap VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})", "verbose");
203 pb_system("$sudocmd /bin/umount $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/proc","Umounting stale /proc","mayfail") if (-f "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/proc/cpuinfo");
204 } elsif ($verpmstyle eq "mock") {
205 my ($rbsconf) = pb_conf_get("rbsconf");
206 my $command = pb_check_req("mock",0);
207 pb_system("$sudocmd $command --init --resultdir=\"/tmp\" --configdir=\"$rbsconf->{$ENV{'PBPROJ'}}\" -r $v $rbsopt","Creating the mock VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})");
208 # Once setup we need to install some packages, the pb account, ...
209 pb_system("$sudocmd $command --install --configdir=\"$rbsconf->{$ENV{'PBPROJ'}}\" -r $v su","Configuring the mock VE");
210 } else {
211 die "Unknown verpmtype type $verpmstyle. Report to dev team";
212 }
213 } elsif ($pbos->{'type'} eq "deb") {
214 my $vedebstyle = $vedebtype->{$ENV{'PBPROJ'}};
215
216 my $codename = pb_distro_get_param($pbos,$oscodename);
217 my $postparam = "";
218 my $addpkgs;
219 $postparam .= pb_distro_get_param($pbos,$osmindep);
220 if ($postparam eq "") {
221 $addpkgs = "";
222 } else {
223 $addpkgs = "--include $postparam";
224 }
225 my $debmir = "";
226 $debmir .= pb_distro_get_param($pbos,$rbsmirrorsrv);
227
228 # Get potential rbs option
229 my $rbsopt = "";
230 if (defined $rbsopt1) {
231 if (defined $rbsopt1->{$vedebstyle}) {
232 $rbsopt = $rbsopt1->{$vedebstyle};
233 } elsif (defined $rbsopt1->{$ENV{'PBPROJ'}}) {
234 $rbsopt = $rbsopt1->{$ENV{'PBPROJ'}};
235 } else {
236 $rbsopt = "";
237 }
238 }
239
240 # debootstrap works with amd64 not x86_64
241 my $debarch = $pbos->{'arch'};
242 $debarch = "amd64" if ($pbos->{'arch'} eq "x86_64");
243 if ($vedebstyle eq "debootstrap") {
244 my $dbsverb = "";
245 $dbsverb = "--verbose" if ($pbdebug gt 0);
246
247 # Some perl modules are in Universe on Ubuntu
248 $rbsopt .= " --components=main,universe" if ($pbos->{'name'} eq "ubuntu");
249
250 my $cmd1 = pb_check_req("mkdir",0);
251 my $cmd2 = pb_check_req("debootstrap",0);
252 pb_system("$sudocmd $cmd1 -p $root/$pbos->{name}/$pbos->{version}/$pbos->{arch} ; $sudocmd $cmd2 $dbsverb $rbsopt --arch=$debarch $addpkgs $codename \"$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}\" $debmir","Creating the debootstrap VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})", "verbose");
253 # debootstrap doesn't create an /etc/hosts file
254 if (! -f "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/etc/hosts" ) {
255 my $cmd = pb_check_req("cp",0);
256 pb_system("$sudocmd $cmd /etc/hosts $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/etc/hosts");
257 }
258 } else {
259 die "Unknown vedebtype type $vedebstyle. Report to dev team";
260 }
261 } elsif ($pbos->{'type'} eq "ebuild") {
262 die "Please teach the dev team how to build gentoo chroot";
263 } else {
264 die "Unknown distribution type $pbos->{'type'}. Report to dev team";
265 }
266 }
267
268 # Test if an existing snapshot exists and use it if appropriate
269 # And also use it if no local extracted VE is present
270 if ((-f "$root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz") &&
271 (((defined $vesnap->{$v}) && ($vesnap->{$v} =~ /true/i)) ||
272 ((defined $vesnap->{$ENV{'PBPROJ'}}) && ($vesnap->{$ENV{'PBPROJ'}} =~ /true/i))) &&
273 ($locsnap eq 1) &&
274 ($vetype ne "docker") &&
275 (! -d "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}")) {
276 my $cmd1 = pb_check_req("rm",0);
277 my $cmd2 = pb_check_req("mkdir",0);
278 my $cmd3 = pb_check_req("tar",0);
279 pb_system("$sudocmd $cmd1 -rf $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'} ; $sudocmd $cmd2 -p $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'} ; $sudocmd $cmd3 xz -C $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'} -f $root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz","Extracting snapshot of $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz under $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}");
280 }
281
282 if ($vetype ne "docker") {
283 # Fix modes to allow access to the VE for pb user
284 my $command = pb_check_req("chmod",0);
285 pb_system("$sudocmd $command 755 $root/$pbos->{'name'} $root/$pbos->{'name'}/$pbos->{'version'} $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}","Fixing permissions");
286 }
287
288 # If docker, create the image and remove the now temp dir except if we had one already
289 if (($vetype eq "docker") && ($pbforce == 0)) {
290 $docrepo = pb_ve_docker_repo($dockerregistry->{$ENV{'PBPROJ'}});
291 my $cmd1 = pb_check_req("docker",0);
292 # step 0 : nothing at creation -> tag n-v-a (made below)
293
294 if ((not defined $pbimage) || ($pbimage eq "")) {
295 # Snaphot the VE to serve as an input for docker
296 pb_ve_snap($pbos,$root);
297 # Create the docker image from the previous bootstrap
298 # Need sudo to be able to create all files correctly
299 # TODO: check before that the image doesn't already exist in the docker registry
300
301 my $pbimage = "$docrepo:$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}";
302 pb_system("$sudocmd $cmd1 import - $pbimage < $root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz");
303 pb_system("$cmd1 push $pbimage");
304 } else {
305 # If we pass a parameter to -i, this is the name of an existing upstream image for that distro-ver-arch
306 pb_system("$sudocmd $cmd1 tag $pbimage $docrepo:$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}");
307 }
308 }
309
310 # Nothing more to do for VE. No real launch
311} else {
312 die "VE of type $vetype not supported. Report to the dev team";
313}
314}
315
316#
317# Return the postinstall line if needed
318#
319
320sub pb_ve_get_postinstall {
321
322my $pbos = shift;
323my $rbspi = shift;
324my $vestyle = shift;
325my $post = "";
326
327# Do we have a local post-install script
328if ($vestyle eq "rinse") {
329 $post = "--post-install ";
330} elsif ($vestyle eq "rpmbootstrap") {
331 $post = "-s ";
332}
333
334my $postparam = pb_distro_get_param($pbos,$rbspi);
335if ($postparam eq "") {
336 $post = "";
337} else {
338 $post .= $postparam;
339}
340return($post);
341}
342
343# Snapshot the VE
344sub pb_ve_snap {
345
346my $pbos = shift;
347my $root = shift;
348my $tpdir = "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}";
349pb_system("sudo tar cz -C $tpdir -f $root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz .","Creating a snapshot of $tpdir");
350}
351
352# Returns the docker registry to interact with
353sub pb_ve_docker_registry {
354
355my $dockerreg = shift;
356my $wget = pb_check_req("wget",0);
357my ($scheme, $account, $host, $port, $path) = pb_get_uri($dockerreg);
358my $docreg = $scheme."://";
359$docreg .= $account."@" if ((defined $account) && ($account ne ""));
360$docreg .= $host;
361$docreg .= ":$port" if ((defined $port) && ($port ne ""));
362open(FD,"$wget $docreg -q -O -|") || die "Unable to talk to the docker registry $docreg";
363my $found = undef;
364while (<FD>) {
365 $found = 1 if (/docker-registry/);
366}
367close(FD);
368die "No correct docker-registry answering at $docreg. Please check your configuration" if (not defined $found);
369#
370return($docreg);
371}
372
373# Returns the docker repository to interact with
374sub pb_ve_docker_repo {
375
376my $dockerreg = shift;
377my $docrepo = "";
378my ($scheme, $account, $host, $port, $path) = pb_get_uri($dockerreg);
379$docrepo .= $host;
380$docrepo .= ":$port" if ((defined $port) && ($port ne ""));
381$docrepo .= "$path";
382return($docrepo);
383}
384
385sub pb_ve_docker_get_image {
386
387my $pbimage = shift;
388my $found = 0;
389
390die "Unable to handle an undef docker image" if (not defined $pbimage);
391
392# Check that this docker image exists
393my $cmd1 = pb_check_req("docker",0);
394open(CMD, "$cmd1 images |") || die "Unable to get docker image list";
395my ($repo, $tag, $id, $dummy);
396while (<CMD>) {
397 ($repo, $tag, $id, $dummy) = split(/\s+/,$_,4);
398 $found = $id if ("$repo:$tag" eq $pbimage);
399}
400close(CMD);
401return($found);
402}
403
404sub pb_ve_get_type {
405
406my $vetype = shift;
407
408# Get VE context
409if (not defined $vetype) {
410 my ($ptr) = pb_conf_get("vetype");
411 $vetype = $ptr->{$ENV{'PBPROJ'}};
412}
413confess "No vetype defined for $ENV{PBPROJ}" unless (defined $vetype);
414pb_log(1, "Using vetype $vetype for $ENV{PBPROJ}\n");
415return($vetype);
416}
417
418
419=head1 WEB SITES
420
421The main Web site of the project is available at L<http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.
422
423=head1 USER MAILING LIST
424
425None exists for the moment.
426
427=head1 AUTHORS
428
429The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
430
431=head1 COPYRIGHT
432
433Project-Builder.org is distributed under the GPL v2.0 license
434described in the file C<COPYING> included with the distribution.
435
436=cut
437
438
4391;
Note: See TracBrowser for help on using the repository browser.