NodeUpdate.py

   1 #!/usr/bin/python2
   2
   3 import sys, os
   4 from random import Random
   5 import string
   6 from types import StringTypes
   7
   8 from time import strftime
   9 TIMEFORMAT="%Y-%m-%d %H:%M:%S"
  10
  11 NODEUPDATE_PID_FILE= "/var/run/NodeUpdate.pid"
  12
  13 # variables for cron file creation
  14 TARGET_SCRIPT = '(echo && date && echo && /usr/bin/NodeUpdate.py start) >>/var/log/NodeUpdate.log 2>&1'
  15 TARGET_DESC = 'Update node RPMs periodically'
  16 TARGET_USER = 'root'
  17 TARGET_SHELL = '/bin/bash'
  18 CRON_FILE = '/etc/cron.d/NodeUpdate.cron'
  19
  20 YUM_PATH = "/usr/bin/yum"
  21
  22 RPM_PATH = "/bin/rpm"
  23
  24 RPM_GPG_PATH = "/etc/pki/rpm-gpg"
  25
  26 # location of file containing http/https proxy info, if needed
  27 PROXY_FILE = '/etc/planetlab/http_proxy'
  28
  29 # this is the flag that indicates an update needs to restart
  30 # the system to take effect. it is created by the rpm that requested
  31 # the reboot
  32 REBOOT_FLAG = '/etc/planetlab/update-reboot'
  33
  34 # location of directory containing boot server ssl certs
  35 SSL_CERT_DIR='/mnt/cdrom/bootme/cacert/'
  36
  37 # file containing the list of extensions this node has, each
  38 # correspond to a package group in yum repository.
  39 # this is expected to be updated from the 'extensions tag'
  40 # through the 'extensions.php' nodeconfig script
  41 EXTENSIONS_FILE='/etc/planetlab/extensions'
  42
  43 # file containing a list of rpms that we should attempt to delete
  44 # before updating everything else. This list is not removed with
  45 # 'yum remove', because that could accidently remove dependency rpms
  46 # that were not intended to be deleted.
  47 DELETE_RPM_LIST_FILE= '/etc/planetlab/delete-rpm-list'
  48
  49 # ok, so the logic should be simple, just yum update the world
  50 # however there are many cases in the real life where this
  51 # just does not work, because of a glitch somewhere
  52 # so, we force the update of crucial pkgs independently, as
  53 # the whole group is sometimes too much to swallow
  54 # this one is builtin
  55 CRUCIAL_PACKAGES_BUILTIN=[ 'NodeUpdate' , 'nodemanager' ]
  56 # and operations can also try to push a list through a conf_file
  57 # should use the second one for consistency, try the first one as well for legacy
  58 CRUCIAL_PACKAGES_OPTIONAL_PATH1='/etc/planetlab/NodeUpdate.packages'
  59 CRUCIAL_PACKAGES_OPTIONAL_PATH2='/etc/planetlab/crucial-rpm-list'
  60
  61
  62 # print out a message only if we are displaying output
  63 def Message(message):
  64     if displayOutput:
  65         if isinstance(message,StringTypes) and len(message) >=2 and message[0]=="\n":
  66             print "\n",
  67             message=message[1:]
  68         print strftime(TIMEFORMAT),
  69         print message
  70
  71 # always print errors
  72 def Error(Str):
  73     print strftime(TIMEFORMAT),
  74     print Str
  75
  76
  77 # create an entry in /etc/cron.d so we run periodically.
  78 # we will be run once a day at a 0-59 minute random offset
  79 # into a 0-23 random hour
  80 def UpdateCronFile():
  81     try:
  82
  83         randomMinute= Random().randrange( 0, 59, 1 );
  84         randomHour= Random().randrange( 0, 11, 1 );
  85
  86         f = open( CRON_FILE, 'w' );
  87         f.write( "# %s\n" % (TARGET_DESC) );
  88         ### xxx is root aliased to the support mailing list ?
  89         f.write( "MAILTO=%s\n" % (TARGET_USER) );
  90         f.write( "SHELL=%s\n" % (TARGET_SHELL) );
  91         f.write( "%s %s,%s * * * %s %s\n\n" %
  92                  (randomMinute, randomHour, randomHour + 12, TARGET_USER, TARGET_SCRIPT) );
  93         f.close()
  94
  95         print( "Created new cron.d entry." )
  96     except:
  97         print( "Unable to create cron.d entry." )
  98
  99
 100 # simply remove the cron file we created
 101 def RemoveCronFile():
 102     try:
 103         os.unlink( CRON_FILE )
 104         print( "Deleted cron.d entry." )
 105     except:
 106         print( "Unable to delete cron.d entry." )
 107
 108
 109
 110 class NodeUpdate:
 111
 112     def __init__( self, doReboot ):
 113         if self.CheckProxy():
 114             os.environ['http_proxy']= self.HTTP_PROXY
 115             os.environ['HTTP_PROXY']= self.HTTP_PROXY
 116
 117         self.doReboot= doReboot
 118
 119
 120
 121     def CheckProxy( self ):
 122         Message( "Checking existence of proxy config file..." )
 123
 124         if os.access(PROXY_FILE, os.R_OK) and os.path.isfile(PROXY_FILE):
 125             self.HTTP_PROXY= string.strip(file(PROXY_FILE,'r').readline())
 126             Message( "Using proxy %s." % self.HTTP_PROXY )
 127             return 1
 128         else:
 129             Message( "Not using any proxy." )
 130             return 0
 131
 132
 133     def InstallKeys( self ):
 134         Message( "\nRemoving any existing GPG signing keys from the RPM database" )
 135         os.system( "%s --allmatches -e gpg-pubkey" % RPM_PATH )
 136
 137         Message( "\nInstalling all GPG signing keys in %s" % RPM_GPG_PATH )
 138         os.system( "%s --import %s/*" % (RPM_PATH, RPM_GPG_PATH) )
 139
 140
 141     def ClearRebootFlag( self ):
 142         os.system( "/bin/rm -rf %s" % REBOOT_FLAG )
 143
 144
 145     def CheckForUpdates( self ):
 146
 147         Message( "\nRemoving any existing reboot flags" )
 148         self.ClearRebootFlag()
 149
 150         if self.doReboot == 0:
 151             Message( "\nIgnoring any reboot flags set by RPMs" );
 152
 153         Message( "\nChecking if yum supports SSL certificate checks" )
 154         if os.system( "%s --help | grep -q sslcertdir" % YUM_PATH ) == 0:
 155             Message( "It does, using --sslcertdir option" )
 156             sslcertdir = "--sslcertdir=" + SSL_CERT_DIR
 157         else:
 158             Message( "Unsupported, not using --sslcertdir option" )
 159             sslcertdir = ""
 160
 161         yum_options=""
 162         Message( "\nChecking if yum supports --verbose" )
 163         if os.system( "%s --help | grep -q verbose" % YUM_PATH ) == 0:
 164             Message( "It does, using --verbose option" )
 165             yum_options += " --verbose"
 166         else:
 167             Message( "Unsupported, not using --verbose option" )
 168
 169         # a configurable list of packages to try and update independently
 170         # cautious..
 171         try:
 172             crucial_packages = []
 173             for package in CRUCIAL_PACKAGES_BUILTIN: crucial_packages.append(package)
 174             try: crucial_packages += file(CRUCIAL_PACKAGES_OPTIONAL_PATH1).read().split()
 175             except: pass
 176             try: crucial_packages += file(CRUCIAL_PACKAGES_OPTIONAL_PATH2).read().split()
 177             except: pass
 178             for package in crucial_packages:
 179                 # if package is not yet installed, like e.g. slice images,
 180                 # need to yum install, not yum update
 181                 if os.system("rpm -q %s > /dev/null"%package)==0:
 182                     Message( "\nUpdating crucial package %s" % package)
 183                     os.system( "%s %s -y update %s" %(YUM_PATH, yum_options, package))
 184                 else:
 185                     Message( "\Installing crucial package %s" % package)
 186                     os.system( "%s %s -y install %s" %(YUM_PATH, yum_options, package))
 187         except:
 188             pass
 189
 190         Message( "\nUpdating PlanetLab group" )
 191         os.system( "%s %s %s -y groupinstall \"PlanetLab\"" %
 192                    (YUM_PATH, yum_options, sslcertdir) )
 193
 194         Message( "\nUpdating rest of system" )
 195         os.system( "%s %s %s -y update" % (YUM_PATH, yum_options, sslcertdir) )
 196
 197         Message( "\nChecking for extra groups (extensions) to update" )
 198         if os.access(EXTENSIONS_FILE, os.R_OK) and \
 199            os.path.isfile(EXTENSIONS_FILE):
 200             extensions_contents= file(EXTENSIONS_FILE).read()
 201             extensions_contents= string.strip(extensions_contents)
 202             if extensions_contents == "":
 203                 Message( "No extra groups found in file." )
 204             else:
 205                 extensions_contents.strip()
 206                 for extension in extensions_contents.split():
 207                     group = "extension%s" % extension
 208                     Message( "\nUpdating %s group" % group )
 209                     os.system( "%s %s %s -y groupinstall \"%s\"" %
 210                                (YUM_PATH, yum_options, sslcertdir, group) )
 211         else:
 212             Message( "No extensions file found" )
 213
 214         if os.access(REBOOT_FLAG, os.R_OK) and os.path.isfile(REBOOT_FLAG) and self.doReboot:
 215             Message( "\nAt least one update requested the system be rebooted" )
 216             self.ClearRebootFlag()
 217             os.system( "/sbin/shutdown -r now" )
 218
 219     def RebuildRPMdb( self ):
 220         Message( "\nRebuilding RPM Database." )
 221         try: os.system( "rm /var/lib/rpm/__db.*" )
 222         except Exception, err: print "RebuildRPMdb: %s" % err
 223         try: os.system( "%s --rebuilddb" % RPM_PATH )
 224         except Exception, err: print "RebuildRPMdb: %s" % err
 225
 226     def YumCleanAll ( self ):
 227         Message ("\nCleaning all yum cache (yum clean all)")
 228         try:
 229             os.system( "yum clean all")
 230         except:
 231             pass
 232
 233     def RemoveRPMS( self ):
 234
 235         Message( "\nLooking for RPMs to be deleted." )
 236         if os.access(DELETE_RPM_LIST_FILE, os.R_OK) and \
 237            os.path.isfile(DELETE_RPM_LIST_FILE):
 238             rpm_list_contents= file(DELETE_RPM_LIST_FILE).read().strip()
 239
 240             if rpm_list_contents == "":
 241                 Message( "No RPMs listed in file to delete." )
 242                 return
 243
 244             rpm_list= string.split(rpm_list_contents)
 245
 246             Message( "Deleting RPMs from %s: %s" %(DELETE_RPM_LIST_FILE," ".join(rpm_list)))
 247
 248             # invoke them separately as otherwise one faulty (e.g. already uninstalled)
 249             # would prevent the other ones from uninstalling
 250             for rpm in rpm_list:
 251                 # is it installed
 252                 is_installed = os.system ("%s -q %s"%(RPM_PATH,rpm))==0
 253                 if not is_installed:
 254                     Message ("Ignoring rpm %s marked to delete, already uninstalled"%rpm)
 255                     continue
 256                 uninstalled = os.system( "%s -ev %s" % (RPM_PATH, rpm) )==0
 257                 if uninstalled:
 258                     Message ("Successfully removed RPM %s"%rpm)
 259                     continue
 260                 else:
 261                     Error( "Unable to delete RPM %s, continuing. rc=%d" % (rpm,uninstalled))
 262
 263         else:
 264             Message( "No RPMs list file found." )
 265
 266
 267
 268 if __name__ == "__main__":
 269
 270     # if we are invoked with 'start', display the output.
 271     # this is useful for running something silently
 272     # under cron and as a service (at startup),
 273     # so the cron only outputs errors and doesn't
 274     # generate mail when it works correctly
 275
 276     displayOutput= 0
 277
 278     # if we hit an rpm that requests a reboot, do it if this is
 279     # set to 1. can be turned off by adding noreboot to command line
 280     # option
 281
 282     doReboot= 1
 283
 284     if "start" in sys.argv or "display" in sys.argv:
 285         displayOutput= 1
 286         Message ("\nTurning on messages")
 287
 288     if "noreboot" in sys.argv:
 289         doReboot= 0
 290
 291     if "updatecron" in sys.argv:
 292         # simply update the /etc/cron.d file for us, and exit
 293         UpdateCronFile()
 294         sys.exit(0)
 295
 296     if "removecron" in sys.argv:
 297         RemoveCronFile()
 298         sys.exit(0)
 299
 300
 301     # see if we are already running by checking the existance
 302     # of a PID file, and if it exists, attempting a test kill
 303     # to see if the process really does exist. If both of these
 304     # tests pass, exit.
 305
 306     if os.access(NODEUPDATE_PID_FILE, os.R_OK):
 307         pid= string.strip(file(NODEUPDATE_PID_FILE).readline())
 308         if pid <> "":
 309             if os.system("/bin/kill -0 %s > /dev/null 2>&1" % pid) == 0:
 310                 Message( "It appears we are already running, exiting." )
 311                 sys.exit(1)
 312
 313     # write out our process id
 314     pidfile= file( NODEUPDATE_PID_FILE, 'w' )
 315     pidfile.write( "%d\n" % os.getpid() )
 316     pidfile.close()
 317
 318
 319     nodeupdate= NodeUpdate(doReboot)
 320     if not nodeupdate:
 321         Error( "Unable to initialize." )
 322     else:
 323         nodeupdate.RebuildRPMdb()
 324         nodeupdate.RemoveRPMS()
 325         nodeupdate.InstallKeys()
 326         nodeupdate.YumCleanAll()
 327         nodeupdate.CheckForUpdates()
 328         Message( "\nUpdate complete." )
 329
 330     # remove the PID file
 331     os.unlink( NODEUPDATE_PID_FILE )
 332