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