X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/f154a7a37a0dfb0192fa29a9c906c455a2a9f66b..bdefe5dd311f72b591a4dcf50e01715930d2f00d:/lib/backend.py diff --git a/lib/backend.py b/lib/backend.py index 3aac250..367e89c 100644 --- a/lib/backend.py +++ b/lib/backend.py @@ -23,9 +23,17 @@ @var _ALLOWED_UPLOAD_FILES: denotes which files are accepted in the L{UploadFile} function +@var _ALLOWED_CLEAN_DIRS: denotes which directories are accepted + in the L{_CleanDirectory} function """ +# pylint: disable-msg=E1103 + +# E1103: %s %r has no %r member (but some types could not be +# inferred), because the _TryOSFromDisk returns either (True, os_obj) +# or (False, "string") which confuses pylint + import os import os.path @@ -34,7 +42,6 @@ import time import stat import errno import re -import subprocess import random import logging import tempfile @@ -52,6 +59,11 @@ from ganeti import ssconf _BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id" +_ALLOWED_CLEAN_DIRS = frozenset([ + constants.DATA_DIR, + constants.JOB_QUEUE_ARCHIVE_DIR, + constants.QUEUE_DIR, + ]) class RPCFail(Exception): @@ -138,6 +150,10 @@ def _CleanDirectory(path, exclude=None): to the empty list """ + if path not in _ALLOWED_CLEAN_DIRS: + _Fail("Path passed to _CleanDirectory not in allowed clean targets: '%s'", + path) + if not os.path.isdir(path): return if exclude is None: @@ -147,7 +163,7 @@ def _CleanDirectory(path, exclude=None): exclude = [os.path.normpath(i) for i in exclude] for rel_name in utils.ListVisibleFiles(path): - full_name = os.path.normpath(os.path.join(path, rel_name)) + full_name = utils.PathJoin(path, rel_name) if full_name in exclude: continue if os.path.isfile(full_name) and not os.path.islink(full_name): @@ -349,7 +365,10 @@ def AddNode(dsa, dsapub, rsa, rsapub, sshkey, sshpub): utils.AddAuthorizedKey(auth_keys, sshpub) - utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"]) + result = utils.RunCmd([constants.DAEMON_UTIL, "reload-ssh-keys"]) + if result.failed: + _Fail("Unable to reload SSH keys (command %r, exit code %s, output %r)", + result.cmd, result.exit_code, result.output) def LeaveCluster(modify_ssh_setup): @@ -383,7 +402,7 @@ def LeaveCluster(modify_ssh_setup): utils.RemoveFile(constants.HMAC_CLUSTER_KEY) utils.RemoveFile(constants.RAPI_CERT_FILE) utils.RemoveFile(constants.SSL_CERT_FILE) - except: + except: # pylint: disable-msg=W0702 logging.exception("Error while removing cluster secrets") result = utils.RunCmd([constants.DAEMON_UTIL, "stop", constants.CONFD]) @@ -542,6 +561,10 @@ def VerifyNode(what, cluster_name): tmpr.append("The procfs filesystem doesn't seem to be mounted" " under /proc, missing required directory /proc/sys and" " the file /proc/sysrq-trigger") + + if constants.NV_TIME in what: + result[constants.NV_TIME] = utils.SplitTime(time.time()) + return result @@ -657,7 +680,7 @@ def BridgesExist(bridges_list): missing.append(bridge) if missing: - _Fail("Missing bridges %s", ", ".join(missing)) + _Fail("Missing bridges %s", utils.CommaJoin(missing)) def GetInstanceList(hypervisor_list): @@ -776,24 +799,43 @@ def GetAllInstancesInfo(hypervisor_list): return output -def InstanceOsAdd(instance, reinstall): +def _InstanceLogName(kind, os_name, instance): + """Compute the OS log filename for a given instance and operation. + + The instance name and os name are passed in as strings since not all + operations have these as part of an instance object. + + @type kind: string + @param kind: the operation type (e.g. add, import, etc.) + @type os_name: string + @param os_name: the os name + @type instance: string + @param instance: the name of the instance being imported/added/etc. + + """ + base = "%s-%s-%s-%d.log" % (kind, os_name, instance, int(time.time())) + return utils.PathJoin(constants.LOG_OS_DIR, base) + + +def InstanceOsAdd(instance, reinstall, debug): """Add an OS to an instance. @type instance: L{objects.Instance} @param instance: Instance whose OS is to be installed @type reinstall: boolean @param reinstall: whether this is an instance reinstall + @type debug: integer + @param debug: debug level, passed to the OS scripts @rtype: None """ inst_os = OSFromDisk(instance.os) - create_env = OSEnvironment(instance, inst_os) + create_env = OSEnvironment(instance, inst_os, debug) if reinstall: create_env['INSTANCE_REINSTALL'] = "1" - logfile = "%s/add-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os, - instance.name, int(time.time())) + logfile = _InstanceLogName("add", instance.os, instance.name) result = utils.RunCmd([inst_os.create_script], env=create_env, cwd=inst_os.path, output=logfile,) @@ -807,25 +849,26 @@ def InstanceOsAdd(instance, reinstall): " log file:\n%s", result.fail_reason, "\n".join(lines), log=False) -def RunRenameInstance(instance, old_name): +def RunRenameInstance(instance, old_name, debug): """Run the OS rename script for an instance. @type instance: L{objects.Instance} @param instance: Instance whose OS is to be installed @type old_name: string @param old_name: previous instance name + @type debug: integer + @param debug: debug level, passed to the OS scripts @rtype: boolean @return: the success of the operation """ inst_os = OSFromDisk(instance.os) - rename_env = OSEnvironment(instance, inst_os) + rename_env = OSEnvironment(instance, inst_os, debug) rename_env['OLD_INSTANCE_NAME'] = old_name - logfile = "%s/rename-%s-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os, - old_name, - instance.name, int(time.time())) + logfile = _InstanceLogName("rename", instance.os, + "%s-%s" % (old_name, instance.name)) result = utils.RunCmd([inst_os.rename_script], env=rename_env, cwd=inst_os.path, output=logfile) @@ -871,7 +914,7 @@ def _GetVGInfo(vg_name): "vg_free": int(round(float(valarr[1]), 0)), "pv_count": int(valarr[2]), } - except ValueError, err: + except (TypeError, ValueError), err: logging.exception("Fail to parse vgs output: %s", err) else: logging.error("vgs output has the wrong number of fields (expected" @@ -880,8 +923,8 @@ def _GetVGInfo(vg_name): def _GetBlockDevSymlinkPath(instance_name, idx): - return os.path.join(constants.DISK_LINKS_DIR, - "%s:%d" % (instance_name, idx)) + return utils.PathJoin(constants.DISK_LINKS_DIR, + "%s:%d" % (instance_name, idx)) def _SymlinkBlockDev(instance_name, device_path, idx): @@ -1182,6 +1225,8 @@ def BlockdevCreate(disk, size, owner, on_primary, info): it's not required to return anything. """ + # TODO: remove the obsolete 'size' argument + # pylint: disable-msg=W0613 clist = [] if disk.children: for child in disk.children: @@ -1193,6 +1238,7 @@ def BlockdevCreate(disk, size, owner, on_primary, info): # we need the children open in case the device itself has to # be assembled try: + # pylint: disable-msg=E1103 crdev.Open() except errors.BlockDeviceError, err: _Fail("Can't make child '%s' read-write: %s", child, err) @@ -1327,6 +1373,7 @@ def BlockdevAssemble(disk, owner, as_primary): try: result = _RecursiveAssembleBD(disk, owner, as_primary) if isinstance(result, bdev.BlockDev): + # pylint: disable-msg=E1103 result = result.dev_path except errors.BlockDeviceError, err: _Fail("Error while assembling disk: %s", err, exc=True) @@ -1414,6 +1461,8 @@ def BlockdevRemovechildren(parent_cdev, new_cdevs): else: devs.append(bd.dev_path) else: + if not utils.IsNormAbsPath(rpath): + _Fail("Strange path returned from StaticDevPath: '%s'", rpath) devs.append(rpath) parent_bdev.RemoveChildren(devs) @@ -1501,7 +1550,7 @@ def BlockdevGetsize(disks): for cf in disks: try: rbd = _RecursiveFindBD(cf) - except errors.BlockDeviceError, err: + except errors.BlockDeviceError: result.append(None) continue if rbd is None: @@ -1622,22 +1671,20 @@ def _ErrnoOrStr(err): return detail -def _OSOndiskAPIVersion(name, os_dir): +def _OSOndiskAPIVersion(os_dir): """Compute and return the API version of a given OS. - This function will try to read the API version of the OS given by - the 'name' parameter and residing in the 'os_dir' directory. + This function will try to read the API version of the OS residing in + the 'os_dir' directory. - @type name: str - @param name: the OS name we should look for @type os_dir: str - @param os_dir: the directory inwhich we should look for the OS + @param os_dir: the directory in which we should look for the OS @rtype: tuple @return: tuple (status, data) with status denoting the validity and data holding either the vaid versions or an error message """ - api_file = os.path.sep.join([os_dir, constants.OS_API_FILE]) + api_file = utils.PathJoin(os_dir, constants.OS_API_FILE) try: st = os.stat(api_file) @@ -1693,7 +1740,7 @@ def DiagnoseOS(top_dirs=None): logging.exception("Can't list the OS directory %s: %s", dir_name, err) break for name in f_names: - os_path = os.path.sep.join([dir_name, name]) + os_path = utils.PathJoin(dir_name, name) status, os_inst = _TryOSFromDisk(name, base_dir=dir_name) if status: diagnose = "" @@ -1722,12 +1769,13 @@ def _TryOSFromDisk(name, base_dir=None): """ if base_dir is None: os_dir = utils.FindFile(name, constants.OS_SEARCH_PATH, os.path.isdir) - if os_dir is None: - return False, "Directory for OS %s not found in search path" % name else: - os_dir = os.path.sep.join([base_dir, name]) + os_dir = utils.FindFile(name, [base_dir], os.path.isdir) - status, api_versions = _OSOndiskAPIVersion(name, os_dir) + if os_dir is None: + return False, "Directory for OS %s not found in search path" % name + + status, api_versions = _OSOndiskAPIVersion(os_dir) if not status: # push the error up return status, api_versions @@ -1743,7 +1791,7 @@ def _TryOSFromDisk(name, base_dir=None): os_files[constants.OS_VARIANTS_FILE] = '' for filename in os_files: - os_files[filename] = os.path.sep.join([os_dir, filename]) + os_files[filename] = utils.PathJoin(os_dir, filename) try: st = os.stat(os_files[filename]) @@ -1910,19 +1958,15 @@ def BlockdevSnapshot(disk): @return: snapshot disk path """ - if disk.children: - if len(disk.children) == 1: - # only one child, let's recurse on it - return BlockdevSnapshot(disk.children[0]) - else: - # more than one child, choose one that matches - for child in disk.children: - if child.size == disk.size: - # return implies breaking the loop - return BlockdevSnapshot(child) + if disk.dev_type == constants.LD_DRBD8: + if not disk.children: + _Fail("DRBD device '%s' without backing storage cannot be snapshotted", + disk.unique_id) + return BlockdevSnapshot(disk.children[0]) elif disk.dev_type == constants.LD_LV: r_dev = _RecursiveFindBD(disk) if r_dev is not None: + # FIXME: choose a saner value for the snapshot size # let's stay on the safe side and ask for the full size, for now return r_dev.Snapshot(disk.size) else: @@ -1932,7 +1976,7 @@ def BlockdevSnapshot(disk): disk.unique_id, disk.dev_type) -def ExportSnapshot(disk, dest_node, instance, cluster_name, idx): +def ExportSnapshot(disk, dest_node, instance, cluster_name, idx, debug): """Export a block device snapshot to a remote node. @type disk: L{objects.Disk} @@ -1946,16 +1990,17 @@ def ExportSnapshot(disk, dest_node, instance, cluster_name, idx): @type idx: int @param idx: the index of the disk in the instance's disk list, used to export to the OS scripts environment + @type debug: integer + @param debug: debug level, passed to the OS scripts @rtype: None """ inst_os = OSFromDisk(instance.os) - export_env = OSEnvironment(instance, inst_os) + export_env = OSEnvironment(instance, inst_os, debug) export_script = inst_os.export_script - logfile = "%s/exp-%s-%s-%s.log" % (constants.LOG_OS_DIR, inst_os.name, - instance.name, int(time.time())) + logfile = _InstanceLogName("export", inst_os.name, instance.name) if not os.path.exists(constants.LOG_OS_DIR): os.mkdir(constants.LOG_OS_DIR, 0750) real_disk = _RecursiveFindBD(disk) @@ -1967,7 +2012,7 @@ def ExportSnapshot(disk, dest_node, instance, cluster_name, idx): export_env['EXPORT_DEVICE'] = real_disk.dev_path export_env['EXPORT_INDEX'] = str(idx) - destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new") + destdir = utils.PathJoin(constants.EXPORT_DIR, instance.name + ".new") destfile = disk.physical_id[1] # the target command is built out of three individual commands, @@ -1978,8 +2023,8 @@ def ExportSnapshot(disk, dest_node, instance, cluster_name, idx): comprcmd = "gzip" - destcmd = utils.BuildShellCmd("mkdir -p %s && cat > %s/%s", - destdir, destdir, destfile) + destcmd = utils.BuildShellCmd("mkdir -p %s && cat > %s", + destdir, utils.PathJoin(destdir, destfile)) remotecmd = _GetSshRunner(cluster_name).BuildCmd(dest_node, constants.GANETI_RUNAS, destcmd) @@ -2007,8 +2052,8 @@ def FinalizeExport(instance, snap_disks): @rtype: None """ - destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new") - finaldestdir = os.path.join(constants.EXPORT_DIR, instance.name) + destdir = utils.PathJoin(constants.EXPORT_DIR, instance.name + ".new") + finaldestdir = utils.PathJoin(constants.EXPORT_DIR, instance.name) config = objects.SerializableConfigParser() @@ -2051,7 +2096,7 @@ def FinalizeExport(instance, snap_disks): config.set(constants.INISECT_INS, 'disk_count' , '%d' % disk_total) - utils.WriteFile(os.path.join(destdir, constants.EXPORT_CONF_FILE), + utils.WriteFile(utils.PathJoin(destdir, constants.EXPORT_CONF_FILE), data=config.Dumps()) shutil.rmtree(finaldestdir, True) shutil.move(destdir, finaldestdir) @@ -2068,7 +2113,7 @@ def ExportInfo(dest): export info """ - cff = os.path.join(dest, constants.EXPORT_CONF_FILE) + cff = utils.PathJoin(dest, constants.EXPORT_CONF_FILE) config = objects.SerializableConfigParser() config.read(cff) @@ -2080,7 +2125,7 @@ def ExportInfo(dest): return config.Dumps() -def ImportOSIntoInstance(instance, src_node, src_images, cluster_name): +def ImportOSIntoInstance(instance, src_node, src_images, cluster_name, debug): """Import an os image into an instance. @type instance: L{objects.Instance} @@ -2089,16 +2134,17 @@ def ImportOSIntoInstance(instance, src_node, src_images, cluster_name): @param src_node: source node for the disk images @type src_images: list of string @param src_images: absolute paths of the disk images + @type debug: integer + @param debug: debug level, passed to the OS scripts @rtype: list of boolean @return: each boolean represent the success of importing the n-th disk """ inst_os = OSFromDisk(instance.os) - import_env = OSEnvironment(instance, inst_os) + import_env = OSEnvironment(instance, inst_os, debug) import_script = inst_os.import_script - logfile = "%s/import-%s-%s-%s.log" % (constants.LOG_OS_DIR, instance.os, - instance.name, int(time.time())) + logfile = _InstanceLogName("import", instance.os, instance.name) if not os.path.exists(constants.LOG_OS_DIR): os.mkdir(constants.LOG_OS_DIR, 0750) @@ -2149,7 +2195,7 @@ def RemoveExport(export): @rtype: None """ - target = os.path.join(constants.EXPORT_DIR, export) + target = utils.PathJoin(constants.EXPORT_DIR, export) try: shutil.rmtree(target) @@ -2211,6 +2257,8 @@ def _TransformFileStorageDir(file_storage_dir): @return: the normalized path if valid, None otherwise """ + if not constants.ENABLE_FILE_STORAGE: + _Fail("File storage disabled at configure time") cfg = _GetConfig() file_storage_dir = os.path.normpath(file_storage_dir) base_file_storage_dir = cfg.GetFileStorageDir() @@ -2603,8 +2651,6 @@ class HooksRunner(object): on the master side. """ - RE_MASK = re.compile("^[a-zA-Z0-9_-]+$") - def __init__(self, hooks_base_dir=None): """Constructor for hooks runner. @@ -2615,57 +2661,9 @@ class HooksRunner(object): """ if hooks_base_dir is None: hooks_base_dir = constants.HOOKS_BASE_DIR - self._BASE_DIR = hooks_base_dir - - @staticmethod - def ExecHook(script, env): - """Exec one hook script. - - @type script: str - @param script: the full path to the script - @type env: dict - @param env: the environment with which to exec the script - @rtype: tuple (success, message) - @return: a tuple of success and message, where success - indicates the succes of the operation, and message - which will contain the error details in case we - failed - - """ - # exec the process using subprocess and log the output - fdstdin = None - try: - fdstdin = open("/dev/null", "r") - child = subprocess.Popen([script], stdin=fdstdin, stdout=subprocess.PIPE, - stderr=subprocess.STDOUT, close_fds=True, - shell=False, cwd="/", env=env) - output = "" - try: - output = child.stdout.read(4096) - child.stdout.close() - except EnvironmentError, err: - output += "Hook script error: %s" % str(err) - - while True: - try: - result = child.wait() - break - except EnvironmentError, err: - if err.errno == errno.EINTR: - continue - raise - finally: - # try not to leak fds - for fd in (fdstdin, ): - if fd is not None: - try: - fd.close() - except EnvironmentError, err: - # just log the error - #logging.exception("Error while closing fd %s", fd) - pass - - return result == 0, utils.SafeEncode(output.strip()) + # yeah, _BASE_DIR is not valid for attributes, we use it like a + # constant + self._BASE_DIR = hooks_base_dir # pylint: disable-msg=C0103 def RunHooks(self, hpath, phase, env): """Run the scripts in the hooks directory. @@ -2696,34 +2694,35 @@ class HooksRunner(object): else: _Fail("Unknown hooks phase '%s'", phase) - rr = [] subdir = "%s-%s.d" % (hpath, suffix) - dir_name = "%s/%s" % (self._BASE_DIR, subdir) - try: - dir_contents = utils.ListVisibleFiles(dir_name) - except OSError: - # FIXME: must log output in case of failures - return rr - - # we use the standard python sort order, - # so 00name is the recommended naming scheme - dir_contents.sort() - for relname in dir_contents: - fname = os.path.join(dir_name, relname) - if not (os.path.isfile(fname) and os.access(fname, os.X_OK) and - self.RE_MASK.match(relname) is not None): + dir_name = utils.PathJoin(self._BASE_DIR, subdir) + + results = [] + + if not os.path.isdir(dir_name): + # for non-existing/non-dirs, we simply exit instead of logging a + # warning at every operation + return results + + runparts_results = utils.RunParts(dir_name, env=env, reset_env=True) + + for (relname, relstatus, runresult) in runparts_results: + if relstatus == constants.RUNPARTS_SKIP: rrval = constants.HKR_SKIP output = "" - else: - result, output = self.ExecHook(fname, env) - if not result: + elif relstatus == constants.RUNPARTS_ERR: + rrval = constants.HKR_FAIL + output = "Hook script execution error: %s" % runresult + elif relstatus == constants.RUNPARTS_RUN: + if runresult.failed: rrval = constants.HKR_FAIL else: rrval = constants.HKR_SUCCESS - rr.append(("%s/%s" % (subdir, relname), rrval, output)) + output = utils.SafeEncode(runresult.output.strip()) + results.append(("%s/%s" % (subdir, relname), rrval, output)) - return rr + return results class IAllocatorRunner(object): @@ -2733,7 +2732,8 @@ class IAllocatorRunner(object): the master side. """ - def Run(self, name, idata): + @staticmethod + def Run(name, idata): """Run an iallocator script. @type name: str @@ -2789,7 +2789,7 @@ class DevCacheManager(object): if dev_path.startswith(cls._DEV_PREFIX): dev_path = dev_path[len(cls._DEV_PREFIX):] dev_path = dev_path.replace("/", "_") - fpath = "%s/bdev_%s" % (cls._ROOT_DIR, dev_path) + fpath = utils.PathJoin(cls._ROOT_DIR, "bdev_%s" % dev_path) return fpath @classmethod