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