support LBACK_ALLOW network context flag
[build.git] / vbuild-init-vserver.sh
1 #!/bin/bash
2 # -*-shell-*-
3 # $Id$
4
5 #shopt -s huponexit
6
7 COMMAND=$(basename $0)
8 DIRNAME=$(dirname $0)
9
10 # pkgs parsing utilities
11 PATH=$(dirname $0):$PATH export PATH
12 . build.common
13
14 DEFAULT_FCDISTRO=f8
15 DEFAULT_PLDISTRO=planetlab
16 DEFAULT_PERSONALITY=linux32
17 DEFAULT_IFNAME=eth0
18
19 COMMAND_VBUILD="vbuild-init-vserver.sh"
20 COMMAND_MYPLC="vtest-init-vserver.sh"
21
22 function failure () {
23     echo "$COMMAND : Bailing out"
24     exit 1
25 }
26
27 # overwrite vserver's internal yum config from what is in
28 # .distributions/<distrib>/yum/yum.conf and /yum.repos.d 
29
30 function configure_yum_in_vserver () {
31     set -x 
32     set -e 
33     trap failure ERR INT
34
35     vserver=$1; shift
36     fcdistro=$1; shift
37
38     templates=/etc/vservers/.distributions/${fcdistro}
39     if [ -f ${templates}/yum/yum.conf ] ; then
40         echo "Initializing yum.conf in $vserver from ${templates}/yum"
41         sed -e "s!@YUMETCDIR@!/etc!g;
42                 s!@YUMCACHEDIR@!/var/cache/yum!g;
43                 s!@YUMLOGDIR@!/var/log!g;
44                 s!@YUMLOCKDIR@!/var/lock!g;
45                " ${templates}/yum/yum.conf > /vservers/$vserver/etc/yum.conf
46
47         # post process the various @...@ variables from this yum.conf file.
48     else
49         echo "Using $fcdistro default for yum.conf"
50     fi
51
52     if [ -d ${templates}/yum.repos.d ] ; then
53         echo "Initializing yum.repos.d in $vserver from ${templates}/yum.repos.d"
54         rm -rf /vservers/$vserver/etc/yum.repos.d
55         tar -C ${templates} -cf - yum.repos.d | tar -C /vservers/$vserver/etc -xvf -
56     else
57         echo "Cannot initialize yum.repos.d in $vserver"
58     fi
59
60     # for using vtest-init-vserver.sh as a general-purpose vserver creation wrapper
61     # just mention 'none' as the repo url
62     if [ -n "$MYPLC_MODE" -a "$REPO_URL" != "none" ] ; then
63         if [ ! -d /vservers/$vserver/etc/yum.repos.d ] ; then
64             echo "WARNING : cannot create myplc repo"
65         else
66             # exclude kernel from fedora repos 
67             for repo in /vservers/$vserver/etc/yum.repos.d/* ; do
68                 [ -f $repo ] && yumconf_exclude $repo "exclude=$pl_KEXCLUDES" 
69             done
70             # the build repo is not signed at this stage
71             cat > /vservers/$vserver/etc/yum.repos.d/myplc.repo <<EOF
72 [myplc]
73 name= MyPLC
74 baseurl=$REPO_URL
75 enabled=1
76 gpgcheck=0
77 EOF
78         fi
79     fi
80 }    
81
82 # return yum or debootstrap
83 function package_method () {
84     fcdistro=$1; shift
85     case $fcdistro in
86         f[0-9]*|centos[0-9]*) echo yum ;;
87         lenny|etch) echo debootstrap ;;
88         *) echo Unknown distro $fcdistro ;;
89     esac 
90 }
91
92 # return arch from debian distro and personality
93 function canonical_arch () {
94     personality=$1; shift
95     fcdistro=$1; shift
96     case $(package_method $fcdistro) in
97         yum)
98             case $personality in *32) echo i386 ;; *64) echo x86_64 ;; *) echo Unknown-arch-1 ;; esac ;;
99         debootstrap)
100             case $personality in *32) echo i386 ;; *64) echo amd64 ;; *) echo Unknown-arch-2 ;; esac ;;
101         *)
102             echo Unknown-arch-3 ;;
103     esac
104 }
105
106 function setup_vserver () {
107
108     set -x
109     set -e
110     trap failure ERR INT
111
112     vserver=$1; shift
113     fcdistro=$1; shift
114     personality=$1; shift
115
116     if [ -d /vservers/$vserver ] ; then
117         echo "$COMMAND : vserver $vserver seems to exist - bailing out"
118         exit 1
119     fi
120
121     pkg_method=$(package_method $fcdistro)
122     case $pkg_method in
123         yum)
124             build_options="-m yum -- -d $fcdistro" 
125             ;;
126         debootstrap)
127             arch=$(canonical_arch $personality $fcdistro)
128             build_options="-m debootstrap -- -d $fcdistro -- --arch $arch"
129             ;;
130         *)
131             build_options="something wrong" ;;
132     esac
133
134     # create it
135     # try to work around the vserver issue:
136     # vc_ctx_migrate: No such process
137     # rpm-fake.so: failed to initialize communication with resolver
138     for i in $(seq 20) ; do
139         $personality vserver $VERBOSE $vserver build $VSERVER_OPTIONS $build_options && break || true
140         echo "* ${i}-th attempt to 'vserver build' failed - waiting for 3 seconds"
141         sleep 3
142     done
143     # check success
144     [ -d /vservers/$vserver ] 
145
146     if [ ! -z "$personality" ] ; then
147         if [ -f "/etc/vservers/$vserver/personality" ] ; then
148             registered_personality=$(grep $personality /etc/vservers/$vserver/personality | wc -l)
149         else
150             registered_personality=0
151         fi
152         if [ $registered_personality -eq 0 -a "$personality" != "linux64" ] ; then
153             echo $personality >> /etc/vservers/$vserver/personality
154         fi
155     fi
156
157     if [ -n "$VBUILD_MODE" ] ; then 
158         ### capabilities required for a build vserver
159         # set up appropriate vserver capabilities to mount, mknod and IPC_LOCK
160         BCAPFILE=/etc/vservers/$vserver/bcapabilities
161         touch $BCAPFILE
162         cap=$(grep ^CAP_SYS_ADMIN /etc/vservers/$vserver/bcapabilities | wc -l)
163         [ $cap -eq 0 ] && echo 'CAP_SYS_ADMIN' >> /etc/vservers/$vserver/bcapabilities
164         cap=$(grep ^CAP_MKNOD /etc/vservers/$vserver/bcapabilities | wc -l)
165         [ $cap -eq 0 ] && echo 'CAP_MKNOD' >> /etc/vservers/$vserver/bcapabilities
166         cap=$(grep ^CAP_IPC_LOCK /etc/vservers/$vserver/bcapabilities | wc -l)
167         [ $cap -eq 0 ] && echo 'CAP_IPC_LOCK' >> /etc/vservers/$vserver/bcapabilities
168     else
169         ### capabilities required for a myplc vserver
170         # for /etc/plc.d/gpg - need to init /dev/random
171         cap=$(grep ^CAP_MKNOD /etc/vservers/$vserver/bcapabilities | wc -l)
172         [ $cap -eq 0 ] && echo 'CAP_MKNOD' >> /etc/vservers/$vserver/bcapabilities
173         cap=$(grep ^CAP_NET_BIND_SERVICE /etc/vservers/$vserver/bcapabilities | wc -l)
174         [ $cap -eq 0 ] && echo 'CAP_NET_BIND_SERVICE' >> /etc/vservers/$vserver/bcapabilities
175     fi
176
177     # Set persistent for the network context
178     echo persistent,lback_allow > /etc/vservers/$vserver/nflags
179  
180     if [ "$pkg_method" = "yum" ] ; then
181         $personality vyum $vserver -- -y install yum
182         # ditto
183         for i in $(seq 20) ; do
184             $personality vserver $VERBOSE $vserver pkgmgmt internalize && break || true
185             echo "* ${i}-th attempt to 'vserver pkgmgmt internalize' failed - waiting for 3 seconds"
186             sleep 3
187         done
188     fi
189
190     # start the vserver so we can do the following operations
191     # redirect out/err to protect against the vserver's init sequence getting stalled 
192     # mostly used for f10 vservers created remotely through ssh
193     $personality vserver $VERBOSE $vserver start >& /dev/null
194
195     if [ "$pkg_method" == "yum" ] ; then
196         $personality vserver $VERBOSE $vserver exec sh -c "rm -f /var/lib/rpm/__db*"
197
198         # run the host rpmdb_dump and restore with the guest rpmdb_load
199         function translate_rpm_hashes () {
200             set -x
201             set -e
202             local personality="$1"; shift
203             local vserver="$1"; shift
204             # need to have utilities installed
205             type -p file
206             type -p awk
207             type -p cut
208             guest_dir=/var/lib/rpm
209             host_dir=/vservers/$vserver/$guest_dir
210             files=$(cd $host_dir ; file * | grep Hash | cut -d: -f 1)
211             for file in $files; do
212                 (cd $host_dir && mv $file ${file}-foreign)
213                 /usr/lib/rpm/rpmdb_dump $host_dir/${file}-foreign | $personality vserver $VERBOSE $vserver exec /usr/lib/rpm/rpmdb_load $guest_dir/$file
214             done
215             $personality vserver $VERBOSE $vserver exec rpm --rebuilddb
216             return 0
217         }
218
219         # try the simple way, if that fails try to cross fix the rpm hashes
220         $personality vserver $VERBOSE $vserver exec rpm --rebuilddb || translate_rpm_hashes $personality $vserver
221     fi
222
223     # check if the vserver kernel is using VSERVER_DEVICE (vdevmap) support
224     need_vdevmap=$(grep "CONFIG_VSERVER_DEVICE=y" /boot/config-$(uname -r) | wc -l)
225
226     if [ $need_vdevmap -eq 1 ] ; then
227         ctx=$(cat /etc/vservers/$vserver/context)
228         vdevmap --set --xid $ctx --open --create --target /dev/null
229         vdevmap --set --xid $ctx --open --create --target /dev/root
230     fi
231             
232     # minimal config in the vserver for yum to work
233     [ "$pkg_method" = "yum" ] && configure_yum_in_vserver $vserver $fcdistro 
234
235     # set up resolv.conf
236     cp /etc/resolv.conf /vservers/$vserver/etc/resolv.conf
237     # and /etc/hosts for at least localhost
238     [ -f /vservers/$vserver/etc/hosts ] || echo "127.0.0.1 localhost localhost.localdomain" > /vservers/$vserver/etc/hosts
239
240 }
241
242 function devel_or_vtest_tools () {
243
244     set -x 
245     set -e 
246     trap failure ERR INT
247
248     vserver=$1; shift
249     fcdistro=$1; shift
250     pldistro=$1; shift
251     personality=$1; shift
252
253     pkg_method=$(package_method $fcdistro)
254
255     # check for .pkgs file based on pldistro
256     if [ -n "$VBUILD_MODE" ] ; then
257         pkgsname=devel.pkgs
258     else
259         pkgsname=vtest.pkgs
260     fi
261     pkgsfile=$(pl_locateDistroFile $DIRNAME $pldistro $pkgsname)
262
263     ### install individual packages, then groups
264     # get target arch - use uname -i here (we want either x86_64 or i386)
265     vserver_arch=$($personality vserver $vserver exec uname -i)
266     # on debian systems we get arch through the 'arch' command
267     [ "$vserver_arch" = "unknown" ] && vserver_arch=$($personality vserver $vserver exec arch)
268     
269     packages=$(pl_getPackages -a $vserver_arch $fcdistro $pldistro $pkgsfile)
270     groups=$(pl_getGroups -a $vserver_arch $fcdistro $pldistro $pkgsfile)
271
272     [ "$pkg_method" = yum ] && [ -n "$packages" ] && $personality vserver $vserver exec yum -y install $packages
273     [ "$pkg_method" = yum ] && for group_plus in $groups; do
274         group=$(echo $group_plus | sed -e "s,+++, ,g")
275         $personality vserver $vserver exec yum -y groupinstall "$group"
276     done
277
278     [ "$pkg_method" = debootstrap ] && $personality vserver $vserver exec apt-get update
279     [ "$pkg_method" = debootstrap ] && for package in $packages ; do 
280         $personality vserver $vserver exec apt-get install -y $package 
281     done
282     
283     return 0
284 }
285
286 function post_install () {
287     if [ -n "$VBUILD_MODE" ] ; then
288         post_install_vbuild "$@" 
289     else
290         post_install_myplc "$@"
291     fi
292     # setup localtime from the host
293     vserver=$1; shift 
294     cp /etc/localtime /vservers/$vserver/etc/localtime
295 }
296
297 function post_install_vbuild () {
298
299     set -x 
300     set -e 
301     trap failure ERR INT
302
303     vserver=$1; shift
304     personality=$1; shift
305
306 ### From myplc-devel-native.spec
307 # be careful to backslash $ in this, otherwise it's the root context that's going to do the evaluation
308     cat << EOF | $personality vserver $VERBOSE $vserver exec bash -x
309     # set up /dev/loop* in vserver
310     for i in \$(seq 0 255) ; do
311         mknod -m 640 /dev/loop\$i b 7 \$i
312     done
313     
314     # create symlink for /dev/fd
315     [ ! -e "/dev/fd" ] && ln -s /proc/self/fd /dev/fd
316
317     # modify /etc/rpm/macros to not use /sbin/new-kernel-pkg
318     sed -i 's,/sbin/new-kernel-pkg:,,' /etc/rpm/macros
319     if [ -h "/sbin/new-kernel-pkg" ] ; then
320         filename=\$(readlink -f /sbin/new-kernel-pkg)
321         if [ "\$filename" == "/sbin/true" ] ; then
322                 echo "WARNING: /sbin/new-kernel-pkg symlinked to /sbin/true"
323                 echo "\tmost likely /etc/rpm/macros has /sbin/new-kernel-pkg declared in _netsharedpath."
324                 echo "\tPlease remove /sbin/new-kernel-pkg from _netsharedpath and reintall mkinitrd."
325                 exit 1
326         fi
327     fi
328     
329     # customize root's prompt
330     cat << PROFILE > /root/.profile
331 export PS1="[$vserver] \\w # "
332 PROFILE
333
334     uid=2000
335     gid=2000
336     
337     # add a "build" user to the system
338     builduser=\$(grep "^build:" /etc/passwd | wc -l)
339     if [ \$builduser -eq 0 ] ; then
340         groupadd -o -g \$gid build;
341         useradd -o -c 'Automated Build' -u \$uid -g \$gid -n -M -s /bin/bash build;
342     fi
343
344 # Allow build user to build certain RPMs as root
345     if [ -f /etc/sudoers ] ; then
346         buildsudo=\$(grep "^build.*ALL=(ALL).*NOPASSWD:.*ALL"  /etc/sudoers | wc -l)
347         if [ \$buildsudo -eq 0 ] ; then
348             echo "build   ALL=(ALL)       NOPASSWD: ALL" >> /etc/sudoers
349         fi
350         sed -i 's,^Defaults.*requiretty,#Defaults requiretty,' /etc/sudoers
351     fi
352 #
353 EOF
354
355 }
356
357 function post_install_myplc  () {
358     set -x 
359     set -e 
360     trap failure ERR INT
361
362     vserver=$1; shift
363     personality=$1; shift
364
365 # be careful to backslash $ in this, otherwise it's the root context that's going to do the evaluation
366     cat << EOF | $personality vserver $VERBOSE $vserver exec bash -x
367
368     # create /etc/sysconfig/network if missing
369     [ -f /etc/sysconfig/network ] || echo NETWORKING=yes > /etc/sysconfig/network
370
371     # create symlink for /dev/fd
372     [ ! -e "/dev/fd" ] && ln -s /proc/self/fd /dev/fd
373
374     # turn off regular crond, as plc invokes plc_crond
375     chkconfig crond off
376
377     # take care of loginuid in /etc/pam.d 
378     sed -i "s,#*\(.*loginuid.*\),#\1," /etc/pam.d/*
379
380     # customize root's prompt
381     cat << PROFILE > /root/.profile
382 export PS1="[$vserver] \\w # "
383 PROFILE
384
385 EOF
386 }
387
388 # parses ifconfig's output to find out ip address and mask
389 # will then be passed to vserver as e.g. --interface 138.96.250.126/255.255.0.0
390 # default is to use lo, that's enough for local mirrors
391 # use -i eth0 in case your fedora mirror is on a separate box on the network
392 function vserverIfconfig () {
393     ifname=$1; shift
394     local result="" 
395     line=$(ifconfig $ifname 2> /dev/null | grep 'inet addr')
396     if [ -n "$line" ] ; then
397         set $line
398         for word in "$@" ; do
399             addr=$(echo $word | sed -e s,[aA][dD][dD][rR]:,,)
400             mask=$(echo $word | sed -e s,[mM][aA][sS][kK]:,,)
401             if [ "$word" != "$addr" ] ; then
402                 result="${addr}"
403             elif [ "$word" != "$mask" ] ; then
404                 result="${result}/${mask}"
405             fi
406         done
407     fi
408     if [ -z "$result" ] ; then 
409         echo "vserverIfconfig failed to locate $ifname"
410         exit 1
411     else
412         echo $result
413     fi
414 }
415
416 function usage () {
417     set +x 
418     echo "Usage: $COMMAND_VBUILD [options] vserver-name [ -- vserver-options ]"
419     echo "Usage: $COMMAND_MYPLC [options] vserver-name repo-url [ -- vserver-options ]"
420     echo "Requirements: you need to have a vserver-compliant kernel,"
421     echo "   as well as the util-vserver RPM installed"
422     echo "Description:"
423     echo "   This command creates a fresh vserver instance, for building, or running, myplc"
424     echo "Supported options"
425     echo " -f fcdistro - for creating the root filesystem - defaults to $DEFAULT_FCDISTRO"
426     echo " -d pldistro - defaults to $DEFAULT_PLDISTRO"
427     echo " -p personality - defaults to $DEFAULT_PERSONALITY"
428     echo " -i ifname: determines ip and netmask attached to ifname, and passes it to the vserver"
429     echo " -v : verbose - passes -v to calls to vserver"
430     echo "vserver-options"
431     echo "  all args after the optional -- are passed to vserver <name> build <options>"
432     echo "  typical usage is e.g. --interface eth0:200.150.100.10/24"
433     echo "With $COMMAND_MYPLC you can give 'none' as the URL, in which case"
434     echo "   myplc.repo does not get created"
435     exit 1
436 }
437
438 ### parse args and 
439 function main () {
440
441     set -e
442     trap failure ERR INT
443
444     case "$COMMAND" in
445         $COMMAND_VBUILD)
446             VBUILD_MODE=true ;;
447         $COMMAND_MYPLC)
448             MYPLC_MODE=true;;
449         *)
450             usage ;;
451     esac
452
453     VERBOSE=
454     IFNAME=""
455     VSERVER_OPTIONS=""
456     while getopts "f:d:p:i:v" opt ; do
457         case $opt in
458             f) fcdistro=$OPTARG;;
459             d) pldistro=$OPTARG;;
460             p) personality=$OPTARG;;
461             i) IFNAME=$OPTARG;;
462             v) VERBOSE="-v" ;;
463             *) usage ;;
464         esac
465     done
466         
467     shift $(($OPTIND - 1))
468
469     # parse fixed arguments
470     [[ -z "$@" ]] && usage
471     vserver=$1 ; shift
472     if [ -n "$MYPLC_MODE" ] ; then
473         [[ -z "$@" ]] && usage
474         REPO_URL=$1 ; shift
475     fi
476
477     # parse vserver options
478     if [[ -n "$@" ]] ; then
479         if [ "$1" == "--" ] ; then
480             shift
481             VSERVER_OPTIONS="$@"
482         else
483             usage
484         fi
485     fi
486
487     # with new util-vserver, it is mandatory to provide an IP even for building
488     if [ -n "$VBUILD_MODE" ] ; then
489         [ -z "$IFNAME" ] && IFNAME=$DEFAULT_IFNAME
490     fi
491     if [ -n "$IFNAME" ] ; then
492         localip=$(vserverIfconfig $IFNAME)
493         VSERVER_OPTIONS="$VSERVER_OPTIONS --interface $localip"
494     fi
495
496     [ -z "$fcdistro" ] && fcdistro=$DEFAULT_FCDISTRO
497     [ -z "$pldistro" ] && pldistro=$DEFAULT_PLDISTRO
498     [ -z "$personality" ] && personality=$DEFAULT_PERSONALITY
499
500     setup_vserver $vserver $fcdistro $personality 
501     devel_or_vtest_tools $vserver $fcdistro $pldistro $personality
502     post_install $vserver $personality
503
504 }
505
506 main "$@"