source/steps/InstallWriteConfig.py

   1 # Copyright (c) 2003 Intel Corporation
   2 # All rights reserved.
   3
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met:
   7
   8 #     * Redistributions of source code must retain the above copyright
   9 #       notice, this list of conditions and the following disclaimer.
  10
  11 #     * Redistributions in binary form must reproduce the above
  12 #       copyright notice, this list of conditions and the following
  13 #       disclaimer in the documentation and/or other materials provided
  14 #       with the distribution.
  15
  16 #     * Neither the name of the Intel Corporation nor the names of its
  17 #       contributors may be used to endorse or promote products derived
  18 #       from this software without specific prior written permission.
  19
  20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
  24 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25 # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26 # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27 # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28 # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31
  32 # EXPORT LAWS: THIS LICENSE ADDS NO RESTRICTIONS TO THE EXPORT LAWS OF
  33 # YOUR JURISDICTION. It is licensee's responsibility to comply with any
  34 # export regulations applicable in licensee's jurisdiction. Under
  35 # CURRENT (May 2000) U.S. export regulations this software is eligible
  36 # for export from the U.S. and can be downloaded by or otherwise
  37 # exported or reexported worldwide EXCEPT to U.S. embargoed destinations
  38 # which include Cuba, Iraq, Libya, North Korea, Iran, Syria, Sudan,
  39 # Afghanistan and any other country to which the U.S. has embargoed
  40 # goods and services.
  41
  42
  43 import os, string
  44
  45 from Exceptions import *
  46 import utils
  47 from systeminfo import systeminfo
  48 import BootAPI
  49
  50
  51 def Run( vars, log ):
  52
  53     """
  54     Writes out the following configuration files for the node:
  55     /etc/fstab
  56     /etc/hosts
  57     /etc/sysconfig/network-scripts/ifcfg-eth0
  58     /etc/resolv.conf (if applicable)
  59     /etc/sysconfig/network
  60     /etc/modprobe.conf
  61     /etc/ssh/ssh_host_key
  62     /etc/ssh/ssh_host_rsa_key
  63     /etc/ssh/ssh_host_dsa_key
  64
  65     Expect the following variables from the store:
  66     VERSION                 the version of the install
  67     SYSIMG_PATH             the path where the system image will be mounted
  68                             (always starts with TEMP_PATH)
  69     PARTITIONS              dictionary of generic part. types (root/swap)
  70                             and their associated devices.
  71     PLCONF_DIR              The directory to store the configuration file in
  72     NETWORK_SETTINGS  A dictionary of the values from the network
  73                                 configuration file
  74     BOOT_CD_VERSION          A tuple of the current bootcd version
  75
  76     Sets the following variables:
  77     None
  78
  79     """
  80
  81     log.write( "\n\nStep: Install: Writing configuration files.\n" )
  82
  83     # make sure we have the variables we need
  84     try:
  85         VERSION= vars["VERSION"]
  86         if VERSION == "":
  87             raise ValueError, "VERSION"
  88
  89         SYSIMG_PATH= vars["SYSIMG_PATH"]
  90         if SYSIMG_PATH == "":
  91             raise ValueError, "SYSIMG_PATH"
  92
  93         PARTITIONS= vars["PARTITIONS"]
  94         if PARTITIONS == None:
  95             raise ValueError, "PARTITIONS"
  96
  97         PLCONF_DIR= vars["PLCONF_DIR"]
  98         if PLCONF_DIR == "":
  99             raise ValueError, "PLCONF_DIR"
 100
 101         NETWORK_SETTINGS= vars["NETWORK_SETTINGS"]
 102         if NETWORK_SETTINGS == "":
 103             raise ValueError, "NETWORK_SETTINGS"
 104
 105         BOOT_CD_VERSION= vars["BOOT_CD_VERSION"]
 106         if BOOT_CD_VERSION == "":
 107             raise ValueError, "BOOT_CD_VERSION"
 108
 109     except KeyError, var:
 110         raise BootManagerException, "Missing variable in vars: %s\n" % var
 111     except ValueError, var:
 112         raise BootManagerException, "Variable in vars, shouldn't be: %s\n" % var
 113
 114     try:
 115         # we need to keys in PARTITIONS, root and swap, make sure
 116         # they exist
 117         val= PARTITIONS["root"]
 118         val= PARTITIONS["swap"]
 119         val= PARTITIONS["vservers"]
 120         val= PARTITIONS["mapper-root"]
 121         val= PARTITIONS["mapper-swap"]
 122         val= PARTITIONS["mapper-vservers"]
 123     except KeyError, part:
 124         log.write( "Missing partition in PARTITIONS: %s\n" % part )
 125         return 0
 126
 127
 128     log.write( "Setting local time to UTC\n" )
 129     utils.sysexec( "chroot %s ln -sf /usr/share/zoneinfo/UTC /etc/localtime" % \
 130                    SYSIMG_PATH, log )
 131
 132
 133     log.write( "Enabling ntp at boot\n" )
 134     utils.sysexec( "chroot %s chkconfig ntpd on" % SYSIMG_PATH, log )
 135
 136     log.write( "Creating system directory %s\n" % PLCONF_DIR )
 137     if not utils.makedirs( "%s/%s" % (SYSIMG_PATH,PLCONF_DIR) ):
 138         log.write( "Unable to create directory\n" )
 139         return 0
 140
 141
 142     log.write( "Writing network configuration\n" )
 143     write_network_configuration( vars, log )
 144
 145     # write out the modprobe.conf file for the system. make sure
 146     # the order of the ethernet devices are listed in the same order
 147     # as the boot cd loaded the modules. this is found in /tmp/loadedmodules
 148     # ultimately, the order will only match the boot cd order if
 149     # the kernel modules have the same name - which should be true for the later
 150     # version boot cds because they use the same kernel version.
 151     # older boot cds use a 2.4.19 kernel, and its possible some of the network
 152     # module names have changed, in which case the system might not boot
 153     # if the network modules are activated in a different order that the
 154     # boot cd.
 155     log.write( "Writing /etc/modprobe.conf\n" )
 156     write_modprobeconf_file( vars, log )
 157
 158     # dump the modprobe.conf file to the log (not to screen)
 159     log.write( "Contents of new modprobe.conf file:\n" )
 160     modulesconf_file= file("%s/etc/modprobe.conf" % SYSIMG_PATH, "r" )
 161     contents= modulesconf_file.read()
 162     log.write( contents + "\n" )
 163     modulesconf_file.close()
 164     modulesconf_file= None
 165     log.write( "End contents of new modprobe.conf file.\n" )
 166
 167     log.write( "Writing system /etc/fstab\n" )
 168     fstab= file( "%s/etc/fstab" % SYSIMG_PATH, "w" )
 169     fstab.write( "%s           none        swap      sw        0 0\n" % \
 170                  PARTITIONS["mapper-swap"] )
 171     fstab.write( "%s           /           ext3      defaults  0 0\n" % \
 172                  PARTITIONS["mapper-root"] )
 173     fstab.write( "%s           /vservers   ext3      tagxid,defaults  0 0\n" % \
 174                  PARTITIONS["mapper-vservers"] )
 175     fstab.write( "none         /proc       proc      defaults  0 0\n" )
 176     fstab.write( "none         /dev/shm    tmpfs     defaults  0 0\n" )
 177     fstab.write( "none         /dev/pts    devpts    defaults  0 0\n" )
 178     fstab.write( "none         /rcfs       rcfs      defaults  0 0\n" )
 179     fstab.close()
 180
 181
 182     log.write( "Writing system /etc/issue\n" )
 183     issue= file( "%s/etc/issue" % SYSIMG_PATH, "w" )
 184     issue.write( "PlanetLab Node: \\n\n" )
 185     issue.write( "Kernel \\r on an \\m\n" )
 186     issue.write( "http://www.planet-lab.org\n\n" )
 187     issue.close()
 188
 189     log.write( "Setting up authentication (non-ssh)\n" )
 190     utils.sysexec( "chroot %s authconfig --nostart --kickstart --enablemd5 " \
 191                    "--enableshadow" % SYSIMG_PATH, log )
 192     utils.sysexec( "sed -e 's/^root\:\:/root\:*\:/g' " \
 193                    "%s/etc/shadow > %s/etc/shadow.new" % \
 194                    (SYSIMG_PATH,SYSIMG_PATH), log )
 195     utils.sysexec( "chroot %s mv " \
 196                    "/etc/shadow.new /etc/shadow" % SYSIMG_PATH, log )
 197     utils.sysexec( "chroot %s chmod 400 /etc/shadow" % SYSIMG_PATH, log )
 198
 199     # if we are setup with dhcp, copy the current /etc/resolv.conf into
 200     # the system image so we can run programs inside that need network access
 201     method= ""
 202     try:
 203         method= vars['NETWORK_SETTINGS']['method']
 204     except:
 205         pass
 206
 207     if method == "dhcp":
 208         utils.sysexec( "cp /etc/resolv.conf %s/etc/" % SYSIMG_PATH, log )
 209
 210     # the kernel rpm should have already done this, so don't fail the
 211     # install if it fails
 212     log.write( "Mounting /proc in system image\n" )
 213     utils.sysexec_noerr( "mount -t proc proc %s/proc" % SYSIMG_PATH, log )
 214
 215     # mkinitrd references both /etc/modprobe.conf and /etc/fstab
 216     # as well as /proc/lvm/global. The kernel RPM installation
 217     # likely created an improper initrd since these files did not
 218     # yet exist. Re-create the initrd here.
 219     log.write( "Making initrd\n" )
 220
 221     # trick mkinitrd in case the current environment does not have device mapper
 222     fake_root_lvm= 0
 223     if not os.path.exists( "%s/%s" % (SYSIMG_PATH,PARTITIONS["mapper-root"]) ):
 224         fake_root_lvm= 1
 225         utils.makedirs( "%s/dev/mapper" % SYSIMG_PATH )
 226         rootdev= file( "%s/%s" % (SYSIMG_PATH,PARTITIONS["mapper-root"]), "w" )
 227         rootdev.close()
 228
 229     initrd= os.readlink( "%s/boot/initrd-boot" % SYSIMG_PATH )
 230     kernel_version= initrd.replace("initrd-", "").replace(".img", "")
 231     utils.removefile( "%s/boot/%s" % (SYSIMG_PATH, initrd) )
 232     utils.sysexec( "chroot %s mkinitrd /boot/initrd-%s.img %s" % \
 233                    (SYSIMG_PATH, kernel_version, kernel_version), log )
 234
 235     if fake_root_lvm == 1:
 236         utils.removefile( "%s/%s" % (SYSIMG_PATH,PARTITIONS["mapper-root"]) )
 237
 238     log.write( "Writing node install version\n" )
 239     utils.makedirs( "%s/etc/planetlab" % SYSIMG_PATH )
 240     ver= file( "%s/etc/planetlab/install_version" % SYSIMG_PATH, "w" )
 241     ver.write( "%s\n" % VERSION )
 242     ver.close()
 243
 244     log.write( "Creating ssh host keys\n" )
 245     key_gen_prog= "/usr/bin/ssh-keygen"
 246
 247     log.write( "Generating SSH1 RSA host key:\n" )
 248     key_file= "/etc/ssh/ssh_host_key"
 249     utils.sysexec( "chroot %s %s -q -t rsa1 -f %s -C '' -N ''" %
 250                    (SYSIMG_PATH,key_gen_prog,key_file), log )
 251     utils.sysexec( "chmod 600 %s/%s" % (SYSIMG_PATH,key_file), log )
 252     utils.sysexec( "chmod 644 %s/%s.pub" % (SYSIMG_PATH,key_file), log )
 253
 254     log.write( "Generating SSH2 RSA host key:\n" )
 255     key_file= "/etc/ssh/ssh_host_rsa_key"
 256     utils.sysexec( "chroot %s %s -q -t rsa -f %s -C '' -N ''" %
 257                    (SYSIMG_PATH,key_gen_prog,key_file), log )
 258     utils.sysexec( "chmod 600 %s/%s" % (SYSIMG_PATH,key_file), log )
 259     utils.sysexec( "chmod 644 %s/%s.pub" % (SYSIMG_PATH,key_file), log )
 260
 261     log.write( "Generating SSH2 DSA host key:\n" )
 262     key_file= "/etc/ssh/ssh_host_dsa_key"
 263     utils.sysexec( "chroot %s %s -q -t dsa -f %s -C '' -N ''" %
 264                    (SYSIMG_PATH,key_gen_prog,key_file), log )
 265     utils.sysexec( "chmod 600 %s/%s" % (SYSIMG_PATH,key_file), log )
 266     utils.sysexec( "chmod 644 %s/%s.pub" % (SYSIMG_PATH,key_file), log )
 267
 268     return 1
 269
 270
 271
 272 def write_network_configuration( vars, log ):
 273     """
 274     Write out the network configuration for this machine:
 275     /etc/hosts
 276     /etc/sysconfig/network-scripts/ifcfg-eth0
 277     /etc/resolv.conf (if applicable)
 278     /etc/sysconfig/network
 279
 280     It is assumed the caller mounted the root partition and the vserver partition
 281     starting on SYSIMG_PATH - it is not checked here.
 282
 283     The values to be used for the network settings are to be set in vars
 284     in the variable 'NETWORK_SETTINGS', which is a dictionary
 285     with keys:
 286
 287      Key               Used by this function
 288      -----------------------------------------------
 289      node_id
 290      node_key
 291      method            x
 292      ip                x
 293      mac               x (optional)
 294      gateway           x
 295      network           x
 296      broadcast         x
 297      netmask           x
 298      dns1              x
 299      dns2              x (optional)
 300      hostname          x
 301      domainname        x
 302     """
 303
 304     try:
 305         SYSIMG_PATH= vars["SYSIMG_PATH"]
 306         if SYSIMG_PATH == "":
 307             raise ValueError, "SYSIMG_PATH"
 308
 309     except KeyError, var:
 310         raise BootManagerException, "Missing variable in vars: %s\n" % var
 311     except ValueError, var:
 312         raise BootManagerException, "Variable in vars, shouldn't be: %s\n" % var
 313
 314
 315     try:
 316         network_settings= vars['NETWORK_SETTINGS']
 317     except KeyError, e:
 318         raise BootManagerException, "No network settings found in vars."
 319
 320     try:
 321         hostname= network_settings['hostname']
 322         domainname= network_settings['domainname']
 323         method= network_settings['method']
 324         ip= network_settings['ip']
 325         gateway= network_settings['gateway']
 326         network= network_settings['network']
 327         netmask= network_settings['netmask']
 328         dns1= network_settings['dns1']
 329         mac= network_settings['mac']
 330     except KeyError, e:
 331         raise BootManagerException, "Missing value %s in network settings." % str(e)
 332
 333     try:
 334         dns2= ''
 335         dns2= network_settings['dns2']
 336     except KeyError, e:
 337         pass
 338
 339
 340     log.write( "Writing /etc/hosts\n" )
 341     hosts_file= file("%s/etc/hosts" % SYSIMG_PATH, "w" )
 342     hosts_file.write( "127.0.0.1       localhost\n" )
 343     if method == "static":
 344         hosts_file.write( "%s %s.%s\n" % (ip, hostname, domainname) )
 345     hosts_file.close()
 346     hosts_file= None
 347
 348
 349     log.write( "Writing /etc/sysconfig/network-scripts/ifcfg-eth0\n" )
 350     eth0_file= file("%s/etc/sysconfig/network-scripts/ifcfg-eth0" %
 351                     SYSIMG_PATH, "w" )
 352     eth0_file.write( "DEVICE=eth0\n" )
 353     if method == "static":
 354         eth0_file.write( "BOOTPROTO=static\n" )
 355         eth0_file.write( "IPADDR=%s\n" % ip )
 356         eth0_file.write( "NETMASK=%s\n" % netmask )
 357         eth0_file.write( "GATEWAY=%s\n" % gateway )
 358     else:
 359         eth0_file.write( "BOOTPROTO=dhcp\n" )
 360         eth0_file.write( "DHCP_HOSTNAME=%s\n" % hostname )
 361     if mac != "":
 362         eth0_file.write( "HWADDR=%s\n" % mac )
 363     eth0_file.write( "ONBOOT=yes\n" )
 364     eth0_file.write( "USERCTL=no\n" )
 365     eth0_file.close()
 366     eth0_file= None
 367
 368     if method == "static":
 369         log.write( "Writing /etc/resolv.conf\n" )
 370         resolv_file= file("%s/etc/resolv.conf" % SYSIMG_PATH, "w" )
 371         if dns1 != "":
 372             resolv_file.write( "nameserver %s\n" % dns1 )
 373         if dns2 != "":
 374             resolv_file.write( "nameserver %s\n" % dns2 )
 375         resolv_file.write( "search %s\n" % domainname )
 376         resolv_file.close()
 377         resolv_file= None
 378
 379     log.write( "Writing /etc/sysconfig/network\n" )
 380     network_file= file("%s/etc/sysconfig/network" % SYSIMG_PATH, "w" )
 381     network_file.write( "NETWORKING=yes\n" )
 382     network_file.write( "HOSTNAME=%s.%s\n" % (hostname, domainname) )
 383     if method == "static":
 384         network_file.write( "GATEWAY=%s\n" % gateway )
 385     network_file.close()
 386     network_file= None
 387
 388
 389
 390 def write_modprobeconf_file( vars, log, filename = "/etc/modprobe.conf"):
 391     """
 392     write out the system file /etc/modprobe.conf with the current
 393     set of modules.
 394
 395     returns a tuple of the number of network driver lines and storage
 396     driver lines written as (networkcount,storagecount)
 397     """
 398
 399     # make sure we have this class loaded
 400     from systeminfo import systeminfo
 401
 402     try:
 403         SYSIMG_PATH= vars["SYSIMG_PATH"]
 404         if SYSIMG_PATH == "":
 405             raise ValueError, "SYSIMG_PATH"
 406
 407     except KeyError, var:
 408         raise BootManagerException, "Missing variable in vars: %s\n" % var
 409     except ValueError, var:
 410         raise BootManagerException, "Variable in vars, shouldn't be: %s\n" % var
 411
 412
 413     # get the kernel version
 414     initrd= os.readlink( "%s/boot/initrd-boot" % SYSIMG_PATH )
 415     kernel_version= initrd.replace("initrd-", "").replace(".img", "")
 416
 417     sysinfo= systeminfo()
 418     sysmods= sysinfo.get_system_modules(SYSIMG_PATH, kernel_version)
 419     if sysmods is None:
 420         raise BootManagerException, "Unable to get list of system modules."
 421
 422     eth_count= 0
 423     scsi_count= 0
 424
 425     modulesconf_file= file("%s/%s" % (SYSIMG_PATH,filename), "w" )
 426
 427     for type in sysmods:
 428         if type == sysinfo.MODULE_CLASS_SCSI:
 429             for a_mod in sysmods[type]:
 430                 if scsi_count == 0:
 431                     modulesconf_file.write( "alias scsi_hostadapter %s\n" %
 432                                             a_mod )
 433                 else:
 434                     modulesconf_file.write( "alias scsi_hostadapter%d %s\n" %
 435                                             (scsi_count,a_mod) )
 436                 scsi_count= scsi_count + 1
 437
 438         elif type == sysinfo.MODULE_CLASS_NETWORK:
 439             for a_mod in sysmods[type]:
 440                 modulesconf_file.write( "alias eth%d %s\n" %
 441                                         (eth_count,a_mod) )
 442                 eth_count= eth_count + 1
 443
 444     modulesconf_file.close()
 445     modulesconf_file= None
 446
 447     return (eth_count,scsi_count)
 448