3 # ------------------------------------------------------------------------
4 # THIS file used to be named alpina.py, from the node installer. Since then
5 # the installer has been expanded to include all the functions of the boot
6 # manager as well, hence the new name for this file.
7 # ------------------------------------------------------------------------
9 # Copyright (c) 2003 Intel Corporation
10 # All rights reserved.
12 # Redistribution and use in source and binary forms, with or without
13 # modification, are permitted provided that the following conditions are
16 # * Redistributions of source code must retain the above copyright
17 # notice, this list of conditions and the following disclaimer.
19 # * Redistributions in binary form must reproduce the above
20 # copyright notice, this list of conditions and the following
21 # disclaimer in the documentation and/or other materials provided
22 # with the distribution.
24 # * Neither the name of the Intel Corporation nor the names of its
25 # contributors may be used to endorse or promote products derived
26 # from this software without specific prior written permission.
28 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
32 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
33 # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
34 # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
35 # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
36 # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
37 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
38 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 # EXPORT LAWS: THIS LICENSE ADDS NO RESTRICTIONS TO THE EXPORT LAWS OF
41 # YOUR JURISDICTION. It is licensee's responsibility to comply with any
42 # export regulations applicable in licensee's jurisdiction. Under
43 # CURRENT (May 2000) U.S. export regulations this software is eligible
44 # for export from the U.S. and can be downloaded by or otherwise
45 # exported or reexported worldwide EXCEPT to U.S. embargoed destinations
46 # which include Cuba, Iraq, Libya, North Korea, Iran, Syria, Sudan,
47 # Afghanistan and any other country to which the U.S. has embargoed
52 import sys, os, traceback
53 from time import gmtime, strftime
54 from gzip import GzipFile
57 from Exceptions import *
58 import notify_messages
62 # all output is written to this file
63 LOG_FILE= "/tmp/bm.log"
67 # the new contents of PATH when the boot manager is running
68 BIN_PATH= ('/usr/local/bin',
74 '/usr/local/planetlab/bin')
80 def __init__( self, OutputFilePath= None ):
82 self.UPLOAD_LOG_URL= None
86 self.OutputFilePath= OutputFilePath
87 self.OutputFile= GzipFile( OutputFilePath, "w", 9 )
89 print( "Unable to open output file for log, continuing" )
93 def LogEntry( self, str, inc_newline= 1, display_screen= 1 ):
95 self.OutputFile.write( str )
97 sys.stdout.write( str )
101 sys.stdout.write( "\n" )
103 self.OutputFile.write( "\n" )
106 self.OutputFile.flush()
109 def write( self, str ):
111 make log behave like a writable file object (for traceback
114 self.LogEntry( str, 0, 1 )
117 def SetUploadServer( self, server ):
119 set the url we should use to upload the logs to
121 self.UPLOAD_LOG_URL = "http://%s/alpina-logs/upload.php" % server
126 upload the contents of the log to the server
129 if self.OutputFile is not None and self.UPLOAD_LOG_URL is not None:
130 self.LogEntry( "Uploading logs to %s" % self.UPLOAD_LOG_URL )
132 self.OutputFile.close()
133 self.OutputFile= None
135 curl_cmd= "%s -s --connect-timeout 60 --max-time 600 " \
136 "--form log=@%s %s" % \
137 (CURL_PATH, self.OutputFilePath, self.UPLOAD_LOG_URL)
138 os.system( curl_cmd )
147 # file containing initial variables/constants
148 VARS_FILE = "configuration"
151 def __init__(self, log):
152 # this contains a set of information used and updated
156 # the main logging point
159 # set to 1 if we can run after initialization
162 if not self.ReadBMConf():
163 self.LOG.LogEntry( "Unable to read configuration vars." )
166 # find out which directory we are running it, and set a variable
167 # for that. future steps may need to get files out of the bootmanager
169 current_dir= os.getcwd()
170 self.VARS['BM_SOURCE_DIR']= current_dir
172 # not sure what the current PATH is set to, replace it with what
173 # we know will work with all the boot cds
174 os.environ['PATH']= string.join(BIN_PATH,":")
181 def ReadBMConf(self):
183 read in and store all variables in VARS_FILE into
186 each line is in the format name=val (any whitespace around
187 the = is removed. everything after the = to the end of
188 the line is the value
191 vars_file= file(self.VARS_FILE,'r')
192 for line in vars_file:
193 # if its a comment or a whitespace line, ignore
194 if line[:1] == "#" or string.strip(line) == "":
197 parts= string.split(line,"=")
199 self.LOG.LogEntry( "Invalid line in vars file: %s" % line )
202 name= string.strip(parts[0])
203 value= string.strip(parts[1])
205 self.VARS[name]= value
212 core boot manager logic.
214 the way errors are handled is as such: if any particular step
215 cannot continue or unexpectibly fails, an exception is thrown.
216 in this case, the boot manager cannot continue running.
218 these step functions can also return a 0/1 depending on whether
219 or not it succeeded. In the case of steps like ConfirmInstallWithUser,
220 a 0 is returned and no exception is thrown if the user chose not
221 to confirm the install. The same goes with the CheckHardwareRequirements.
222 If requriements not met, but tests were succesfull, return 0.
224 for steps that run within the installer, they are expected to either
225 complete succesfully and return 1, or throw an execption.
227 For exact return values and expected operations, see the comments
228 at the top of each of the invididual step functions.
232 InitializeBootManager.Run( self.VARS, self.LOG )
233 ReadNodeConfiguration.Run( self.VARS, self.LOG )
234 AuthenticateWithPLC.Run( self.VARS, self.LOG )
235 GetAndUpdateNodeDetails.Run( self.VARS, self.LOG )
237 if self.VARS['BOOT_STATE'] == 'new' or \
238 self.VARS['BOOT_STATE'] == 'inst':
239 if not ConfirmInstallWithUser.Run( self.VARS, self.LOG ):
242 self.VARS['BOOT_STATE']= 'rins'
243 UpdateBootStateWithPLC.Run( self.VARS, self.LOG )
245 if not CheckHardwareRequirements.Run( self.VARS, self.LOG ):
246 self.VARS['BOOT_STATE']= 'dbg'
247 UpdateBootStateWithPLC.Run( self.VARS, self.LOG )
248 raise BootManagerException, "Hardware requirements not met."
252 if ValidateNodeInstall.Run( self.VARS, self.LOG ):
253 SendHardwareConfigToPLC.Run( self.VARS, self.LOG )
254 ChainBootNode.Run( self.VARS, self.LOG )
256 self.VARS['BOOT_STATE']= 'dbg'
257 self.VARS['STATE_CHANGE_NOTIFY']= 1
258 self.VARS['STATE_CHANGE_NOTIFY_MESSAGE']= \
259 notify_messages.MSG_NODE_NOT_INSTALLED
260 UpdateBootStateWithPLC.Run( self.VARS, self.LOG )
263 elif self.VARS['BOOT_STATE'] == 'rins':
264 if not CheckHardwareRequirements.Run( self.VARS, self.LOG ):
265 self.VARS['BOOT_STATE']= 'dbg'
266 UpdateBootStateWithPLC.Run( self.VARS, self.LOG )
267 raise BootManagerException, "Hardware requirements not met."
271 if ValidateNodeInstall.Run( self.VARS, self.LOG ):
272 SendHardwareConfigToPLC.Run( self.VARS, self.LOG )
273 ChainBootNode.Run( self.VARS, self.LOG )
275 self.VARS['BOOT_STATE']= 'dbg'
276 self.VARS['STATE_CHANGE_NOTIFY']= 1
277 self.VARS['STATE_CHANGE_NOTIFY_MESSAGE']= \
278 notify_messages.MSG_NODE_NOT_INSTALLED
279 UpdateBootStateWithPLC.Run( self.VARS, self.LOG )
281 elif self.VARS['BOOT_STATE'] == 'boot':
282 if ValidateNodeInstall.Run( self.VARS, self.LOG ):
283 UpdateNodeConfiguration.Run( self.VARS, self.LOG )
284 CheckForNewDisks.Run( self.VARS, self.LOG )
285 SendHardwareConfigToPLC.Run( self.VARS, self.LOG )
286 ChainBootNode.Run( self.VARS, self.LOG )
288 self.VARS['BOOT_STATE']= 'dbg'
289 self.VARS['STATE_CHANGE_NOTIFY']= 1
290 self.VARS['STATE_CHANGE_NOTIFY_MESSAGE']= \
291 notify_messages.MSG_NODE_NOT_INSTALLED
292 UpdateBootStateWithPLC.Run( self.VARS, self.LOG )
294 elif self.VARS['BOOT_STATE'] == 'dbg':
295 StartDebug.Run( self.VARS, self.LOG )
298 self.LOG.write( "\n\nKeyError while running: %s\n" % str(e) )
299 except BootManagerException, e:
300 self.LOG.write( "\n\nException while running: %s\n" % str(e) )
306 def RunInstaller(self):
308 since the installer can be invoked at more than one place
309 in the boot manager logic, seperate the steps necessary
313 InstallInit.Run( self.VARS, self.LOG )
314 InstallPartitionDisks.Run( self.VARS, self.LOG )
315 InstallBootstrapRPM.Run( self.VARS, self.LOG )
316 InstallWriteConfig.Run( self.VARS, self.LOG )
317 InstallBuildVServer.Run( self.VARS, self.LOG )
318 InstallNodeInit.Run( self.VARS, self.LOG )
319 InstallUninitHardware.Run( self.VARS, self.LOG )
321 self.VARS['BOOT_STATE']= 'boot'
322 self.VARS['STATE_CHANGE_NOTIFY']= 1
323 self.VARS['STATE_CHANGE_NOTIFY_MESSAGE']= \
324 notify_messages.MSG_INSTALL_FINISHED
325 UpdateBootStateWithPLC.Run( self.VARS, self.LOG )
327 SendHardwareConfigToPLC.Run( self.VARS, self.LOG )
331 if __name__ == "__main__":
333 # set to 0 if no error occurred
336 # all output goes through this class so we can save it and post
337 # the data back to PlanetLab central
340 LOG.LogEntry( "BootManager started at: %s" % \
341 strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime()) )
346 LOG.LogEntry( "Unable to initialize BootManager." )
348 LOG.LogEntry( "Running version %s of BootManager." %
352 LOG.LogEntry( "\nDone!" );
354 LOG.LogEntry( "\nError occurred!" );
357 traceback.print_exc(file=LOG.OutputFile)
358 traceback.print_exc()
360 LOG.LogEntry( "BootManager finished at: %s" % \
361 strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime()) )