-# $Id$
import random
import base64
import os
import os.path
+import time
from PLC.Faults import *
from PLC.Method import Method
from PLC.Nodes import Node, Nodes
from PLC.Interfaces import Interface, Interfaces
-from PLC.InterfaceSettings import InterfaceSetting, InterfaceSettings
-from PLC.NodeGroups import NodeGroup, NodeGroups
+from PLC.InterfaceTags import InterfaceTag, InterfaceTags
+from PLC.NodeTags import NodeTag, NodeTags
+
+from PLC.Accessors.Accessors_standard import * # import node accessors
# 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
+# reservable nodes being more recent, we do not support the floppy stuff anymore
+allowed_actions = {
+ 'regular' :
+ [ 'node-preview',
+ 'node-floppy',
+ 'node-iso',
+ 'node-usb',
+ 'generic-iso',
+ 'generic-usb',
+ ],
+ 'reservable':
+ [ 'node-preview',
+ 'node-iso',
+ 'node-usb',
+ ],
+ }
# compute a new key
-# xxx used by GetDummyBoxMedium
def compute_key():
# Generate 32 random bytes
bytes = random.sample(xrange(0, 256), 32)
class GetBootMedium(Method):
"""
- This method is a redesign based on former, supposedly dedicated,
+ This method is a redesign based on former, supposedly dedicated,
AdmGenerateNodeConfFile
- As compared with its ancestor, this method provides a much more detailed
+ As compared with its ancestor, this method provides a much more
detailed interface, that allows to
- (*) either just preview the node config file -- in which case
+ (*) either just preview the node config file -- in which case
the node key is NOT recomputed, and NOT provided in the output
- (*) or regenerate the node config file for storage on a floppy
- that is, exactly what the ancestor method used todo,
+ (*) or regenerate the node config file for storage on a floppy
+ that is, exactly what the ancestor method used todo,
including renewing the node's key
(*) or regenerate the config file and bundle it inside an ISO or USB image
- (*) or just provide the generic ISO or USB boot images
+ (*) 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
Apart for the preview mode, this method generates a new node key for the
specified node, effectively invalidating any old boot medium.
+ Note that 'reservable' nodes do not support 'node-floppy',
+ 'generic-iso' nor 'generic-usb'.
In addition, two return mechanisms are supported.
- (*) The default behaviour is that the file's content is returned as a
+ (*) The default behaviour is that the file's content is returned as a
base64-encoded string. This is how the ancestor method used to work.
To use this method, pass an empty string as the file parameter.
- (*) Or, for efficiency -- this makes sense only when the API is used
- by the web pages that run on the same host -- the caller may provide
- a filename, in which case the resulting file is stored in that location instead.
- The filename argument can use the following markers, that are expanded
+ (*) Or, for efficiency -- this makes sense only when the API is used
+ by the web pages that run on the same host -- the caller may provide
+ a filename, in which case the resulting file is stored in that location instead.
+ The filename argument can use the following markers, that are expanded
within the method
- %d : default root dir (some builtin dedicated area under /var/tmp/)
Using this is recommended, and enforced for non-admin users
- - %n : the node's name when this makes sense, or a mktemp-like name when
+ - %n : the node's name when this makes sense, or a mktemp-like name when
generic media is requested
- %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;
+ With the file-based return mechanism, the method returns the full pathname
+ of the result file;
** WARNING **
It is the caller's responsability to remove this file after use.
- Options: an optional array of keywords.
+ Options: an optional array of keywords.
options are not supported for generic images
- Currently supported are
+ Currently supported are
- 'partition' - for USB actions only
- 'cramfs'
- 'serial' or 'serial:<console_spec>'
it is expected to be a colon separated string denoting
tty - baudrate - parity - bits
e.g. ttyS0:115200:n:8
+ - 'variant:<variantname>'
+ passed to build.sh as -V <variant>
+ variants are used to run a different kernel on the bootCD
+ see kvariant.sh for how to create a variant
+ - 'no-hangcheck' - disable hangcheck
+
+ Tags: the following tags are taken into account when attached to the node:
+ 'serial', 'cramfs', 'kvariant', 'kargs', 'no-hangcheck'
Security:
- Non-admins can only generate files for nodes at their sites.
- Non-admins, when they provide a filename, *must* specify it in the %d area
- Housekeeping:
+ Housekeeping:
Whenever needed, the method stores intermediate files in a
private area, typically not located under the web server's
accessible area, and are cleaned up by the 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")
+ # 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@/"
if len(parts) < 2:
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"
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
interfaces = Interfaces(self.api, node['interface_ids'])
for interface in interfaces:
( 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.update_last_download(commit=False)
node.sync()
# Generate node configuration file suitable for BootCD
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()
file += 'DOMAIN_NAME="%s"\n' % domain
# define various interface settings attached to the primary interface
- settings = InterfaceSettings (self.api, {'interface_id':interface['interface_id']})
+ settings = InterfaceTags (self.api, {'interface_id':interface['interface_id']})
categories = set()
for setting in settings:
if setting['category'] is not None:
categories.add(setting['category'])
-
+
for category in categories:
- category_settings = InterfaceSettings(self.api,{'interface_id':interface['interface_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'])
+ file += '%s_%s="%s"\n'%(category.upper(),setting['tagname'].upper(),setting['value'])
for interface in interfaces:
if interface['method'] == 'ipmi':
return file
- # see also InstallBootstrapFS in bootmanager that does similar things
- def get_nodefamily (self, node):
- try:
- (pldistro,arch) = file("/etc/planetlab/nodefamily").read().strip().split("-")
- except:
- (pldistro,arch) = ("planetlab","i386")
-
+ # see also GetNodeFlavour that does similar things
+ def get_nodefamily (self, node, auth):
+ pldistro = self.api.config.PLC_FLAVOUR_NODE_PLDISTRO
+ fcdistro = self.api.config.PLC_FLAVOUR_NODE_FCDISTRO
+ arch = self.api.config.PLC_FLAVOUR_NODE_ARCH
if not node:
- return (pldistro,arch)
-
- known_archs = [ 'i386', 'x86_64' ]
- nodegroupnames = [ ng['groupname'] for ng in NodeGroups (self.api, node['nodegroup_ids'],['groupname'])]
- # (1) if groupname == arch, nodefamily becomes pldistro-groupname
- # (2) else if groupname looks like pldistro-arch, it is taken as a nodefamily
- # (3) otherwise groupname is taken as an extension
- for nodegroupname in nodegroupnames:
- if nodegroupname in known_archs:
- arch = nodegroupname
- else:
- for known_arch in known_archs:
- try:
- (api_pldistro,api_arch)=nodegroupname.split("-")
- # sanity check
- if api_arch != known_arch: raise Exception,"mismatch"
- (pldistro,arch) = (api_pldistro, api_arch)
- break
- except:
- pass
- return (pldistro,arch)
+ return (pldistro,fcdistro,arch)
+
+ node_id=node['node_id']
+
+ # no support for deployment-based BootCD's, use kvariants instead
+ node_pldistro = GetNodePldistro (self.api,self.caller).call(auth, node_id)
+ if node_pldistro: pldistro = node_pldistro
+
+ node_fcdistro = GetNodeFcdistro (self.api,self.caller).call(auth, node_id)
+ if node_fcdistro: fcdistro = node_fcdistro
+
+ node_arch = GetNodeArch (self.api,self.caller).call(auth,node_id)
+ if node_arch: arch = node_arch
+
+ return (pldistro,fcdistro,arch)
def bootcd_version (self):
try:
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:
if self.DEBUG:
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 in [ 'regular', 'reservable' ]:
+
+ 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']
+ if "variant" in build_sh_spec:
+ build_sh_options += " -V %s"%build_sh_spec['variant']
+
+ 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)
+
+ 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 :
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={}
+ # create a dict for build.sh
+ build_sh_spec={'kargs':[]}
+ # use node tags as defaults
+ # check for node tag equivalents
+ tags = NodeTags(self.api,
+ {'node_id': node['node_id'],
+ 'tagname': ['serial', 'cramfs', 'kvariant', 'kargs', 'no-hangcheck']},
+ ['tagname', 'value'])
+ if tags:
+ for tag in tags:
+ if tag['tagname'] == 'serial':
+ build_sh_spec['serial'] = tag['value']
+ if tag['tagname'] == 'cramfs':
+ build_sh_spec['cramfs'] = True
+ if tag['tagname'] == 'kvariant':
+ build_sh_spec['variant'] = tag['value']
+ if tag['tagname'] == 'kargs':
+ build_sh_spec['kargs'] += tag['value'].split()
+ if tag['tagname'] == 'no-hangcheck':
+ build_sh_spec['kargs'].append('hcheck_reboot0')
+ # then options can override tags
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.find("variant:") == 0:
+ build_sh_spec['variant']=option.replace("variant:","")
+ elif option == "no-hangcheck":
+ build_sh_spec['kargs'].append('hcheck_reboot0')
else:
raise PLCInvalidArgument, "unknown option %s"%option
- ### check node if needed
+ # compute nodename according the action
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]
nodename = node['hostname']
-
else:
node = None
# compute a 8 bytes random number
nodename = "".join(map(hexa2,tempbytes))
# get nodefamily
- (pldistro,arch) = self.get_nodefamily(node)
- self.nodefamily="%s-%s"%(pldistro,arch)
+ (pldistro,fcdistro,arch) = self.get_nodefamily(node,auth)
+ self.nodefamily="%s-%s-%s"%(pldistro,fcdistro,arch)
+
# apply on globals
for attr in [ "BOOTCDDIR", "BOOTCDBUILD", "GENERICDIR" ]:
setattr(self,attr,getattr(self,attr).replace("@NODEFAMILY@",self.nodefamily))
-
- ### handle filename
- # 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
+ filename = self.handle_filename(filename, nodename, suffix, arch)
- ### 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 (dirname,0777)
- except:
- raise PLCPermissionDenied, "Could not create dir %s"%dirname
+ # 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:
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
+ # 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':
### check we've got required material
version = self.bootcd_version()
-
+
if not os.path.isfile(self.BOOTCDBUILD):
raise PLCAPIError, "Cannot locate bootcd/build.sh script %s"%self.BOOTCDBUILD
os.chmod(self.WORKDIR,0777)
except:
raise PLCPermissionDenied, "Could not create dir %s"%self.WORKDIR
-
+
try:
# generate floppy config
floppy_text = self.floppy_contents(node,True)
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()
except:
self.cleantrash()
raise
-
+
# we're done here, or we missed something
raise PLCAPIError,'Unhandled action %s'%action
-
git://git.onelab.eu / plcapi.git / blobdiff