X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FMethods%2FGetBootMedium.py;h=e2d1ebf147a76ef4cbefd63157fd34f974036d85;hb=a040c4569c5d3aa73aa4166472ef256c8437be46;hp=c8d52a6b31e2addaa22cb2481a9f7fcd88c50671;hpb=ae73709e3da43f26fbfea8d5238e10bb7dcb41ea;p=plcapi.git diff --git a/PLC/Methods/GetBootMedium.py b/PLC/Methods/GetBootMedium.py index c8d52a6..e2d1ebf 100644 --- a/PLC/Methods/GetBootMedium.py +++ b/PLC/Methods/GetBootMedium.py @@ -3,6 +3,7 @@ import random import base64 import os import os.path +import time from PLC.Faults import * from PLC.Method import Method @@ -10,20 +11,26 @@ from PLC.Parameter import Parameter, Mixed from PLC.Auth import Auth from PLC.Nodes import Node, Nodes -from PLC.NodeNetworks import NodeNetwork, NodeNetworks -from PLC.NodeNetworkSettings import NodeNetworkSetting, NodeNetworkSettings +from PLC.Interfaces import Interface, Interfaces +from PLC.InterfaceTags import InterfaceTag, InterfaceTags # could not define this in the class.. -boot_medium_actions = [ 'node-preview', - 'node-floppy', - 'node-iso', - 'node-usb', - 'generic-iso', - 'generic-usb', - ] +# create a dict with the allowed actions for each type of node +allowed_actions = { + 'regular' : [ 'node-preview', + 'node-floppy', + 'node-iso', + 'node-usb', + 'generic-iso', + 'generic-usb', + ], + 'dummynet' : [ 'node-preview', + 'dummynet-iso', + 'dummynet-usb', + ], + } # compute a new key -# xxx used by GetDummyBoxMedium def compute_key(): # Generate 32 random bytes bytes = random.sample(xrange(0, 256), 32) @@ -50,7 +57,10 @@ class GetBootMedium(Method): (*) or just provide the generic ISO or USB boot images in which case of course the node_id_or_hostname parameter is not used - action is expected among the following string constants + action is expected among the following string constants according the + node type value: + + for a 'regular' node: (*) node-preview (*) node-floppy (*) node-iso @@ -58,6 +68,11 @@ class GetBootMedium(Method): (*) generic-iso (*) generic-usb + for a 'dummynet' node: + (*) node-preview + (*) dummynet-iso + (*) dummynet-usb + Apart for the preview mode, this method generates a new node key for the specified node, effectively invalidating any old boot medium. @@ -78,6 +93,8 @@ class GetBootMedium(Method): - %s : a file suffix appropriate in the context (.txt, .iso or the like) - %v : the bootcd version string (e.g. 4.0) - %p : the PLC name + - %f : the nodefamily + - %a : arch With the file-based return mechanism, the method returns the full pathname of the result file; ** WARNING ** @@ -85,10 +102,12 @@ class GetBootMedium(Method): Options: an optional array of keywords. options are not supported for generic images + options are not supported for dummynet boxes Currently supported are - 'partition' - for USB actions only - 'cramfs' - 'serial' or 'serial:' + - 'no-hangcheck' console_spec (or 'default') is passed as-is to bootcd/build.sh it is expected to be a colon separated string denoting tty - baudrate - parity - bits @@ -111,16 +130,17 @@ class GetBootMedium(Method): Auth(), Mixed(Node.fields['node_id'], Node.fields['hostname']), - Parameter (str, "Action mode, expected in " + "|".join(boot_medium_actions)), + Parameter (str, "Action mode, expected value depends of the type of node"), Parameter (str, "Empty string for verbatim result, resulting file full path otherwise"), Parameter ([str], "Options"), ] returns = Parameter(str, "Node boot medium, either inlined, or filename, depending on the filename parameter") - BOOTCDDIR = "/usr/share/bootcd/" - BOOTCDBUILD = "/usr/share/bootcd/build.sh" - GENERICDIR = "/var/www/html/download/" + # define globals for regular nodes, override later for other types + BOOTCDDIR = "/usr/share/bootcd-@NODEFAMILY@/" + BOOTCDBUILD = "/usr/share/bootcd-@NODEFAMILY@/build.sh" + GENERICDIR = "/var/www/html/download-@NODEFAMILY@/" WORKDIR = "/var/tmp/bootmedium" DEBUG = False # uncomment this to preserve temporary area and bootcustom logs @@ -136,9 +156,15 @@ class GetBootMedium(Method): raise PLCInvalidArgument, "Node hostname %s is invalid"%node['hostname'] return parts - # plnode.txt content + # Generate the node (plnode.txt) configuration content. + # + # This function will create the configuration file a node + # composed by: + # - a common part, regardless of the 'node_type' tag + # - XXX a special part, depending on the 'node_type' tag value. def floppy_contents (self, node, renew_key): + # Do basic checks if node['peer_id'] is not None: raise PLCInvalidArgument, "Not a local node" @@ -148,21 +174,21 @@ class GetBootMedium(Method): if node['site_id'] not in self.caller['site_ids']: raise PLCPermissionDenied, "Not allowed to generate a configuration file for %s"%node['hostname'] - # Get node networks for this node + # Get interface for this node primary = None - nodenetworks = NodeNetworks(self.api, node['nodenetwork_ids']) - for nodenetwork in nodenetworks: - if nodenetwork['is_primary']: - primary = nodenetwork + interfaces = Interfaces(self.api, node['interface_ids']) + for interface in interfaces: + if interface['is_primary']: + primary = interface break if primary is None: raise PLCInvalidArgument, "No primary network configured on %s"%node['hostname'] ( host, domain ) = self.split_hostname (node) + # renew the key and save it on the database if renew_key: node['key'] = compute_key() - # Save it node.sync() # Generate node configuration file suitable for BootCD @@ -171,6 +197,8 @@ class GetBootMedium(Method): if renew_key: file += 'NODE_ID="%d"\n' % node['node_id'] file += 'NODE_KEY="%s"\n' % node['key'] + # not used anywhere, just a note for operations people + file += 'KEY_RENEWAL_DATE="%s"\n' % time.strftime('%Y/%m/%d at %H:%M +0000',time.gmtime()) if primary['mac']: file += 'NET_DEVICE="%s"\n' % primary['mac'].lower() @@ -189,8 +217,8 @@ class GetBootMedium(Method): file += 'HOST_NAME="%s"\n' % host file += 'DOMAIN_NAME="%s"\n' % domain - # define various nodenetwork settings attached to the primary nodenetwork - settings = NodeNetworkSettings (self.api, {'nodenetwork_id':nodenetwork['nodenetwork_id']}) + # define various interface settings attached to the primary interface + settings = InterfaceTags (self.api, {'interface_id':interface['interface_id']}) categories = set() for setting in settings: @@ -198,29 +226,48 @@ class GetBootMedium(Method): categories.add(setting['category']) for category in categories: - category_settings = NodeNetworkSettings(self.api,{'nodenetwork_id':nodenetwork['nodenetwork_id'], + category_settings = InterfaceTags(self.api,{'interface_id':interface['interface_id'], 'category':category}) if category_settings: file += '### Category : %s\n'%category for setting in category_settings: file += '%s_%s="%s"\n'%(category.upper(),setting['name'].upper(),setting['value']) - for nodenetwork in nodenetworks: - if nodenetwork['method'] == 'ipmi': - file += 'IPMI_ADDRESS="%s"\n' % nodenetwork['ip'] - if nodenetwork['mac']: - file += 'IPMI_MAC="%s"\n' % nodenetwork['mac'].lower() + for interface in interfaces: + if interface['method'] == 'ipmi': + file += 'IPMI_ADDRESS="%s"\n' % interface['ip'] + if interface['mac']: + file += 'IPMI_MAC="%s"\n' % interface['mac'].lower() break return file + # see also InstallBootstrapFS in bootmanager that does similar things + def get_nodefamily (self, node): + # get defaults from the myplc build + try: + (pldistro,arch) = file("/etc/planetlab/nodefamily").read().strip().split("-") + except: + (pldistro,arch) = ("planetlab","i386") + + # with no valid argument, return system-wide defaults + if not node: + return (pldistro,arch) + + node_id=node['node_id'] + + tag=Nodes(self.api,[node_id],['arch'])[0]['arch'] + if tag: arch=tag + tag=Nodes(self.api,[node_id],['pldistro'])[0]['pldistro'] + if tag: pldistro=tag + + return (pldistro,arch) + def bootcd_version (self): try: - f = open (self.BOOTCDDIR + "/build/version.txt") - version=f.readline().strip() - finally: - f.close() - return version + return file(self.BOOTCDDIR + "/build/version.txt").readline().strip() + except: + raise Exception,"Unknown boot cd version - probably wrong bootcd dir : %s"%self.BOOTCDDIR def cleantrash (self): for file in self.trash: @@ -229,12 +276,98 @@ class GetBootMedium(Method): else: os.unlink(file) + ### handle filename + # build the filename string + # check for permissions and concurrency + # returns the filename + def handle_filename (self, filename, nodename, suffix, arch): + # allow to set filename to None or any other empty value + if not filename: filename='' + filename = filename.replace ("%d",self.WORKDIR) + filename = filename.replace ("%n",nodename) + filename = filename.replace ("%s",suffix) + filename = filename.replace ("%p",self.api.config.PLC_NAME) + # let's be cautious + try: filename = filename.replace ("%f", self.nodefamily) + except: pass + try: filename = filename.replace ("%a", arch) + except: pass + try: filename = filename.replace ("%v",self.bootcd_version()) + except: pass + + ### Check filename location + if filename != '': + if 'admin' not in self.caller['roles']: + if ( filename.index(self.WORKDIR) != 0): + raise PLCInvalidArgument, "File %s not under %s"%(filename,self.WORKDIR) + + ### output should not exist (concurrent runs ..) + if os.path.exists(filename): + raise PLCInvalidArgument, "Resulting file %s already exists"%filename + + ### we can now safely create the file, + ### either we are admin or under a controlled location + filedir=os.path.dirname(filename) + # dirname does not return "." for a local filename like its shell counterpart + if filedir: + if not os.path.exists(filedir): + try: + os.makedirs (filedir,0777) + except: + raise PLCPermissionDenied, "Could not create dir %s"%filedir + + return filename + + # Build the command line to be executed + # according the node type + def build_command(self, node_type, build_sh_spec, node_image, type, floppy_file, log_file): + + command = "" + + # regular node, make build's arguments + # and build the full command line to be called + if node_type == 'regular': + + build_sh_options="" + if "cramfs" in build_sh_spec: + type += "_cramfs" + if "serial" in build_sh_spec: + build_sh_options += " -s %s"%build_sh_spec['serial'] + + for karg in build_sh_spec['kargs']: + build_sh_options += ' -k "%s"'%karg + + log_file="%s.log"%node_image + + command = '%s -f "%s" -o "%s" -t "%s" %s &> %s' % (self.BOOTCDBUILD, + floppy_file, + node_image, + type, + build_sh_options, + log_file) + # dummynet node + elif node_type == 'dummynet': + # the build script expect the following parameters: + # the package base directory + # the working directory + # the full path of the configuration file + # the name of the resulting image file + # the type of the generated image + # the name of the log file + command = "%s -b %s -w %s -f %s -o %s -t %s -l %s" \ + % (self.BOOTCDBUILD, self.BOOTCDDIR, self.WORKDIR, + floppy_file, node_image, type, log_file) + command = "touch %s %s; echo 'dummynet build script not yet supported'" \ + % (log_file, node_image) + + if self.DEBUG: + print "The build command line is %s" % command + + return command + def call(self, auth, node_id_or_hostname, action, filename, options = []): self.trash=[] - ### check action - if action not in boot_medium_actions: - raise PLCInvalidArgument, "Unknown action %s"%action ### compute file suffix and type if action.find("-iso") >= 0 : @@ -247,74 +380,78 @@ class GetBootMedium(Method): suffix=".txt" type = "txt" - # handle / caconicalize options + # check for node existence and get node_type + nodes = Nodes(self.api, [node_id_or_hostname]) + if not nodes: + raise PLCInvalidArgument, "No such node %r"%node_id_or_hostname + node = nodes[0] + + if self.DEBUG: print "%s required on node %s. Node type is: %s" \ + % (action, node['node_id'], node['node_type']) + + # check the required action against the node type + node_type = node['node_type'] + if action not in allowed_actions[node_type]: + raise PLCInvalidArgument, "Action %s not valid for %s nodes, valid actions are %s" \ + % (action, node_type, "|".join(allowed_actions[node_type])) + + # handle / canonicalize options if type == "txt": if options: raise PLCInvalidArgument, "Options are not supported for node configs" else: # create a dict for build.sh - optdict={} + build_sh_spec={'kargs':[]} for option in options: if option == "cramfs": - optdict['cramfs']=True + build_sh_spec['cramfs']=True elif option == 'partition': if type != "usb": raise PLCInvalidArgument, "option 'partition' is for USB images only" else: type="usb_partition" elif option == "serial": - optdict['serial']='default' + build_sh_spec['serial']='default' elif option.find("serial:") == 0: - optdict['serial']=option.replace("serial:","") + build_sh_spec['serial']=option.replace("serial:","") + elif option == "no-hangcheck": + build_sh_spec['kargs'].append('hcheck_reboot0') else: raise PLCInvalidArgument, "unknown option %s"%option - ### compute a 8 bytes random number - tempbytes = random.sample (xrange(0,256), 8); - def hexa2 (c): - return chr((c>>4)+65) + chr ((c&16)+65) - temp = "".join(map(hexa2,tempbytes)) - - ### check node if needed - if action.find("node-") == 0: - nodes = Nodes(self.api, [node_id_or_hostname]) - if not nodes: - raise PLCInvalidArgument, "No such node %r"%node_id_or_hostname - node = nodes[0] + # compute nodename according the action + if action.find("node-") == 0 or action.find("dummynet-") == 0: nodename = node['hostname'] - else: node = None - nodename = temp + # compute a 8 bytes random number + tempbytes = random.sample (xrange(0,256), 8); + def hexa2 (c): return chr((c>>4)+65) + chr ((c&16)+65) + nodename = "".join(map(hexa2,tempbytes)) + + # override some global definition, according node_type + if node_type == 'dummynet': + self.BOOTCDDIR = "/usr/share/dummynet" # the base installation dir + self.BOOTCDBUILD = "/usr/share/dummynet/build.sh" # dummynet build script + self.WORKDIR = "/var/tmp/DummynetBoxMedium" # temporary working dir + + # get nodefamily + (pldistro,arch) = self.get_nodefamily(node) + self.nodefamily="%s-%s"%(pldistro,arch) + + # apply on globals + for attr in [ "BOOTCDDIR", "BOOTCDBUILD", "GENERICDIR" ]: + setattr(self,attr,getattr(self,attr).replace("@NODEFAMILY@",self.nodefamily)) - ### handle filename - filename = filename.replace ("%d",self.WORKDIR) - filename = filename.replace ("%n",nodename) - filename = filename.replace ("%s",suffix) - filename = filename.replace ("%p",self.api.config.PLC_NAME) - # only if filename contains "%v", bootcd is maybe not avail ? - if filename.find("%v") >=0: - filename = filename.replace ("%v",self.bootcd_version()) - - ### Check filename location - if filename != '': - if 'admin' not in self.caller['roles']: - if ( filename.index(self.WORKDIR) != 0): - raise PLCInvalidArgument, "File %s not under %s"%(filename,self.WORKDIR) - - ### output should not exist (concurrent runs ..) - if os.path.exists(filename): - raise PLCInvalidArgument, "Resulting file %s already exists"%filename - - ### we can now safely create the file, - ### either we are admin or under a controlled location - if not os.path.exists(os.path.dirname(filename)): - try: - os.makedirs (os.path.dirname(filename),0777) - except: - raise PLCPermissionDenied, "Could not create dir %s"%os.path.dirname(filename) - + filename = self.handle_filename(filename, nodename, suffix, arch) + # log call + if node: + self.message='GetBootMedium on node %s - action=%s'%(nodename,action) + self.event_objects={'Node': [ node ['node_id'] ]} + else: + self.message='GetBootMedium - generic - action=%s'%action + ### generic media if action == 'generic-iso' or action == 'generic-usb': if options: @@ -327,30 +464,37 @@ class GetBootMedium(Method): generic_path = "%s/%s" % (self.GENERICDIR,generic_name) if filename: - ret=os.system ("cp %s %s"%(generic_path,filename)) + ret=os.system ('cp "%s" "%s"'%(generic_path,filename)) if ret==0: return filename else: - raise PLCPermissionDenied, "Could not copy %s into"%(generic_path,filename) + raise PLCPermissionDenied, "Could not copy %s into %s"%(generic_path,filename) else: ### return the generic medium content as-is, just base64 encoded return base64.b64encode(file(generic_path).read()) - ### config file preview or regenerated - if action == 'node-preview' or action == 'node-floppy': + ### config file preview or regenerated + if action == 'node-preview' or action == 'node-floppy': renew_key = (action == 'node-floppy') floppy = self.floppy_contents (node,renew_key) - if filename: - try: - file(filename,'w').write(floppy) - except: - raise PLCPermissionDenied, "Could not write into %s"%filename - return filename - else: - return floppy + if filename: + try: + file(filename,'w').write(floppy) + except: + raise PLCPermissionDenied, "Could not write into %s"%filename + return filename + else: + return floppy ### we're left with node-iso and node-usb - if action == 'node-iso' or action == 'node-usb': + # the steps involved in the image creation are: + # - create and test the working environment + # - generate the configuration file + # - build and invoke the build command + # - delivery the resulting image file + + if action == 'node-iso' or action == 'node-usb' \ + or action == 'dummynet-iso' or action == 'dummynet-usb': ### check we've got required material version = self.bootcd_version() @@ -379,33 +523,26 @@ class GetBootMedium(Method): self.trash.append(floppy_file) node_image = "%s/%s%s"%(self.WORKDIR,nodename,suffix) - - # make build's arguments - serial_arg="" - if "cramfs" in optdict: type += "_cramfs" - if "serial" in optdict: serial_arg = "-s %s"%optdict['serial'] log_file="%s.log"%node_image - # invoke build.sh - build_command = '%s -f "%s" -o "%s" -t "%s" %s &> %s' % (self.BOOTCDBUILD, - floppy_file, - node_image, - type, - serial_arg, - log_file) - if self.DEBUG: - print 'build command:',build_command - ret=os.system(build_command) + + command = self.build_command(node_type, build_sh_spec, node_image, type, floppy_file, log_file) + + # invoke the image build script + if command != "": + ret=os.system(command) + if ret != 0: - raise PLCAPIError,"bootcd/build.sh failed\n%s\n%s"%( - build_command,file(log_file).read()) + raise PLCAPIError, "%s failed Command line was: %s Error logs: %s" % \ + (self.BOOTCDBUILD, command, file(log_file).read()) self.trash.append(log_file) + if not os.path.isfile (node_image): raise PLCAPIError,"Unexpected location of build.sh output - %s"%node_image # handle result if filename: - ret=os.system("mv %s %s"%(node_image,filename)) + ret=os.system('mv "%s" "%s"'%(node_image,filename)) if ret != 0: self.trash.append(node_image) self.cleantrash()