4 # Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Functions used by the node daemon
24 @var _ALLOWED_UPLOAD_FILES: denotes which files are accepted in
25 the L{UploadFile} function
26 @var _ALLOWED_CLEAN_DIRS: denotes which directories are accepted
27 in the L{_CleanDirectory} function
31 # pylint: disable-msg=E1103
33 # E1103: %s %r has no %r member (but some types could not be
34 # inferred), because the _TryOSFromDisk returns either (True, os_obj)
35 # or (False, "string") which confuses pylint
52 from ganeti import errors
53 from ganeti import utils
54 from ganeti import ssh
55 from ganeti import hypervisor
56 from ganeti import constants
57 from ganeti import bdev
58 from ganeti import objects
59 from ganeti import ssconf
60 from ganeti import serializer
61 from ganeti import netutils
62 from ganeti import runtime
65 _BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id"
66 _ALLOWED_CLEAN_DIRS = frozenset([
68 constants.JOB_QUEUE_ARCHIVE_DIR,
70 constants.CRYPTO_KEYS_DIR,
72 _MAX_SSL_CERT_VALIDITY = 7 * 24 * 60 * 60
73 _X509_KEY_FILE = "key"
74 _X509_CERT_FILE = "cert"
75 _IES_STATUS_FILE = "status"
80 class RPCFail(Exception):
81 """Class denoting RPC failure.
83 Its argument is the error message.
88 def _Fail(msg, *args, **kwargs):
89 """Log an error and the raise an RPCFail exception.
91 This exception is then handled specially in the ganeti daemon and
92 turned into a 'failed' return type. As such, this function is a
93 useful shortcut for logging the error and returning it to the master
97 @param msg: the text of the exception
103 if "log" not in kwargs or kwargs["log"]: # if we should log this error
104 if "exc" in kwargs and kwargs["exc"]:
105 logging.exception(msg)
112 """Simple wrapper to return a SimpleStore.
114 @rtype: L{ssconf.SimpleStore}
115 @return: a SimpleStore instance
118 return ssconf.SimpleStore()
121 def _GetSshRunner(cluster_name):
122 """Simple wrapper to return an SshRunner.
124 @type cluster_name: str
125 @param cluster_name: the cluster name, which is needed
126 by the SshRunner constructor
127 @rtype: L{ssh.SshRunner}
128 @return: an SshRunner instance
131 return ssh.SshRunner(cluster_name)
134 def _Decompress(data):
135 """Unpacks data compressed by the RPC client.
137 @type data: list or tuple
138 @param data: Data sent by RPC client
140 @return: Decompressed data
143 assert isinstance(data, (list, tuple))
144 assert len(data) == 2
145 (encoding, content) = data
146 if encoding == constants.RPC_ENCODING_NONE:
148 elif encoding == constants.RPC_ENCODING_ZLIB_BASE64:
149 return zlib.decompress(base64.b64decode(content))
151 raise AssertionError("Unknown data encoding")
154 def _CleanDirectory(path, exclude=None):
155 """Removes all regular files in a directory.
158 @param path: the directory to clean
160 @param exclude: list of files to be excluded, defaults
164 if path not in _ALLOWED_CLEAN_DIRS:
165 _Fail("Path passed to _CleanDirectory not in allowed clean targets: '%s'",
168 if not os.path.isdir(path):
173 # Normalize excluded paths
174 exclude = [os.path.normpath(i) for i in exclude]
176 for rel_name in utils.ListVisibleFiles(path):
177 full_name = utils.PathJoin(path, rel_name)
178 if full_name in exclude:
180 if os.path.isfile(full_name) and not os.path.islink(full_name):
181 utils.RemoveFile(full_name)
184 def _BuildUploadFileList():
185 """Build the list of allowed upload files.
187 This is abstracted so that it's built only once at module import time.
190 allowed_files = set([
191 constants.CLUSTER_CONF_FILE,
193 constants.SSH_KNOWN_HOSTS_FILE,
194 constants.VNC_PASSWORD_FILE,
195 constants.RAPI_CERT_FILE,
196 constants.RAPI_USERS_FILE,
197 constants.CONFD_HMAC_KEY,
198 constants.CLUSTER_DOMAIN_SECRET_FILE,
201 for hv_name in constants.HYPER_TYPES:
202 hv_class = hypervisor.GetHypervisorClass(hv_name)
203 allowed_files.update(hv_class.GetAncillaryFiles())
205 return frozenset(allowed_files)
208 _ALLOWED_UPLOAD_FILES = _BuildUploadFileList()
212 """Removes job queue files and archived jobs.
218 _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
219 _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)
223 """Returns master information.
225 This is an utility function to compute master information, either
226 for consumption here or from the node daemon.
229 @return: master_netdev, master_ip, master_name, primary_ip_family
230 @raise RPCFail: in case of errors
235 master_netdev = cfg.GetMasterNetdev()
236 master_ip = cfg.GetMasterIP()
237 master_node = cfg.GetMasterNode()
238 primary_ip_family = cfg.GetPrimaryIPFamily()
239 except errors.ConfigurationError, err:
240 _Fail("Cluster configuration incomplete: %s", err, exc=True)
241 return (master_netdev, master_ip, master_node, primary_ip_family)
244 def StartMaster(start_daemons, no_voting):
245 """Activate local node as master node.
247 The function will either try activate the IP address of the master
248 (unless someone else has it) or also start the master daemons, based
249 on the start_daemons parameter.
251 @type start_daemons: boolean
252 @param start_daemons: whether to start the master daemons
253 (ganeti-masterd and ganeti-rapi), or (if false) activate the
255 @type no_voting: boolean
256 @param no_voting: whether to start ganeti-masterd without a node vote
257 (if start_daemons is True), but still non-interactively
261 # GetMasterInfo will raise an exception if not able to return data
262 master_netdev, master_ip, _, family = GetMasterInfo()
265 # either start the master and rapi daemons
268 masterd_args = "--no-voting --yes-do-it"
273 "EXTRA_MASTERD_ARGS": masterd_args,
276 result = utils.RunCmd([constants.DAEMON_UTIL, "start-master"], env=env)
278 msg = "Can't start Ganeti master: %s" % result.output
283 if netutils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
284 if netutils.IPAddress.Own(master_ip):
285 # we already have the ip:
286 logging.debug("Master IP already configured, doing nothing")
288 msg = "Someone else has the master ip, not activating"
292 ipcls = netutils.IP4Address
293 if family == netutils.IP6Address.family:
294 ipcls = netutils.IP6Address
296 result = utils.RunCmd(["ip", "address", "add",
297 "%s/%d" % (master_ip, ipcls.iplen),
298 "dev", master_netdev, "label",
299 "%s:0" % master_netdev])
301 msg = "Can't activate master IP: %s" % result.output
305 # we ignore the exit code of the following cmds
306 if ipcls == netutils.IP4Address:
307 utils.RunCmd(["arping", "-q", "-U", "-c 3", "-I", master_netdev, "-s",
308 master_ip, master_ip])
309 elif ipcls == netutils.IP6Address:
311 utils.RunCmd(["ndisc6", "-q", "-r 3", master_ip, master_netdev])
312 except errors.OpExecError:
313 # TODO: Better error reporting
314 logging.warning("Can't execute ndisc6, please install if missing")
317 _Fail("; ".join(err_msgs))
320 def StopMaster(stop_daemons):
321 """Deactivate this node as master.
323 The function will always try to deactivate the IP address of the
324 master. It will also stop the master daemons depending on the
325 stop_daemons parameter.
327 @type stop_daemons: boolean
328 @param stop_daemons: whether to also stop the master daemons
329 (ganeti-masterd and ganeti-rapi)
333 # TODO: log and report back to the caller the error failures; we
334 # need to decide in which case we fail the RPC for this
336 # GetMasterInfo will raise an exception if not able to return data
337 master_netdev, master_ip, _, family = GetMasterInfo()
339 ipcls = netutils.IP4Address
340 if family == netutils.IP6Address.family:
341 ipcls = netutils.IP6Address
343 result = utils.RunCmd(["ip", "address", "del",
344 "%s/%d" % (master_ip, ipcls.iplen),
345 "dev", master_netdev])
347 logging.error("Can't remove the master IP, error: %s", result.output)
348 # but otherwise ignore the failure
351 result = utils.RunCmd([constants.DAEMON_UTIL, "stop-master"])
353 logging.error("Could not stop Ganeti master, command %s had exitcode %s"
355 result.cmd, result.exit_code, result.output)
358 def EtcHostsModify(mode, host, ip):
359 """Modify a host entry in /etc/hosts.
361 @param mode: The mode to operate. Either add or remove entry
362 @param host: The host to operate on
363 @param ip: The ip associated with the entry
366 if mode == constants.ETC_HOSTS_ADD:
368 RPCFail("Mode 'add' needs 'ip' parameter, but parameter not"
370 utils.AddHostToEtcHosts(host, ip)
371 elif mode == constants.ETC_HOSTS_REMOVE:
373 RPCFail("Mode 'remove' does not allow 'ip' parameter, but"
374 " parameter is present")
375 utils.RemoveHostFromEtcHosts(host)
377 RPCFail("Mode not supported")
380 def LeaveCluster(modify_ssh_setup):
381 """Cleans up and remove the current node.
383 This function cleans up and prepares the current node to be removed
386 If processing is successful, then it raises an
387 L{errors.QuitGanetiException} which is used as a special case to
388 shutdown the node daemon.
390 @param modify_ssh_setup: boolean
393 _CleanDirectory(constants.DATA_DIR)
394 _CleanDirectory(constants.CRYPTO_KEYS_DIR)
399 priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
401 utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
403 utils.RemoveFile(priv_key)
404 utils.RemoveFile(pub_key)
405 except errors.OpExecError:
406 logging.exception("Error while processing ssh files")
409 utils.RemoveFile(constants.CONFD_HMAC_KEY)
410 utils.RemoveFile(constants.RAPI_CERT_FILE)
411 utils.RemoveFile(constants.NODED_CERT_FILE)
412 except: # pylint: disable-msg=W0702
413 logging.exception("Error while removing cluster secrets")
415 result = utils.RunCmd([constants.DAEMON_UTIL, "stop", constants.CONFD])
417 logging.error("Command %s failed with exitcode %s and error %s",
418 result.cmd, result.exit_code, result.output)
420 # Raise a custom exception (handled in ganeti-noded)
421 raise errors.QuitGanetiException(True, 'Shutdown scheduled')
424 def GetNodeInfo(vgname, hypervisor_type):
425 """Gives back a hash with different information about the node.
427 @type vgname: C{string}
428 @param vgname: the name of the volume group to ask for disk space information
429 @type hypervisor_type: C{str}
430 @param hypervisor_type: the name of the hypervisor to ask for
433 @return: dictionary with the following keys:
434 - vg_size is the size of the configured volume group in MiB
435 - vg_free is the free size of the volume group in MiB
436 - memory_dom0 is the memory allocated for domain0 in MiB
437 - memory_free is the currently available (free) ram in MiB
438 - memory_total is the total number of ram in MiB
443 vginfo = bdev.LogicalVolume.GetVGInfo([vgname])
444 vg_free = vg_size = None
446 vg_free = int(round(vginfo[0][0], 0))
447 vg_size = int(round(vginfo[0][1], 0))
449 outputarray['vg_size'] = vg_size
450 outputarray['vg_free'] = vg_free
452 hyper = hypervisor.GetHypervisor(hypervisor_type)
453 hyp_info = hyper.GetNodeInfo()
454 if hyp_info is not None:
455 outputarray.update(hyp_info)
457 outputarray["bootid"] = utils.ReadFile(_BOOT_ID_PATH, size=128).rstrip("\n")
462 def VerifyNode(what, cluster_name):
463 """Verify the status of the local node.
465 Based on the input L{what} parameter, various checks are done on the
468 If the I{filelist} key is present, this list of
469 files is checksummed and the file/checksum pairs are returned.
471 If the I{nodelist} key is present, we check that we have
472 connectivity via ssh with the target nodes (and check the hostname
475 If the I{node-net-test} key is present, we check that we have
476 connectivity to the given nodes via both primary IP and, if
477 applicable, secondary IPs.
480 @param what: a dictionary of things to check:
481 - filelist: list of files for which to compute checksums
482 - nodelist: list of nodes we should check ssh communication with
483 - node-net-test: list of nodes we should check node daemon port
485 - hypervisor: list with hypervisors to run the verify for
487 @return: a dictionary with the same keys as the input dict, and
488 values representing the result of the checks
492 my_name = netutils.Hostname.GetSysName()
493 port = netutils.GetDaemonPort(constants.NODED)
494 vm_capable = my_name not in what.get(constants.NV_VMNODES, [])
496 if constants.NV_HYPERVISOR in what and vm_capable:
497 result[constants.NV_HYPERVISOR] = tmp = {}
498 for hv_name in what[constants.NV_HYPERVISOR]:
500 val = hypervisor.GetHypervisor(hv_name).Verify()
501 except errors.HypervisorError, err:
502 val = "Error while checking hypervisor: %s" % str(err)
505 if constants.NV_FILELIST in what:
506 result[constants.NV_FILELIST] = utils.FingerprintFiles(
507 what[constants.NV_FILELIST])
509 if constants.NV_NODELIST in what:
510 result[constants.NV_NODELIST] = tmp = {}
511 random.shuffle(what[constants.NV_NODELIST])
512 for node in what[constants.NV_NODELIST]:
513 success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
517 if constants.NV_NODENETTEST in what:
518 result[constants.NV_NODENETTEST] = tmp = {}
519 my_pip = my_sip = None
520 for name, pip, sip in what[constants.NV_NODENETTEST]:
526 tmp[my_name] = ("Can't find my own primary/secondary IP"
529 for name, pip, sip in what[constants.NV_NODENETTEST]:
531 if not netutils.TcpPing(pip, port, source=my_pip):
532 fail.append("primary")
534 if not netutils.TcpPing(sip, port, source=my_sip):
535 fail.append("secondary")
537 tmp[name] = ("failure using the %s interface(s)" %
540 if constants.NV_MASTERIP in what:
541 # FIXME: add checks on incoming data structures (here and in the
542 # rest of the function)
543 master_name, master_ip = what[constants.NV_MASTERIP]
544 if master_name == my_name:
545 source = constants.IP4_ADDRESS_LOCALHOST
548 result[constants.NV_MASTERIP] = netutils.TcpPing(master_ip, port,
551 if constants.NV_LVLIST in what and vm_capable:
553 val = GetVolumeList(what[constants.NV_LVLIST])
556 result[constants.NV_LVLIST] = val
558 if constants.NV_INSTANCELIST in what and vm_capable:
559 # GetInstanceList can fail
561 val = GetInstanceList(what[constants.NV_INSTANCELIST])
564 result[constants.NV_INSTANCELIST] = val
566 if constants.NV_VGLIST in what and vm_capable:
567 result[constants.NV_VGLIST] = utils.ListVolumeGroups()
569 if constants.NV_PVLIST in what and vm_capable:
570 result[constants.NV_PVLIST] = \
571 bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
572 filter_allocatable=False)
574 if constants.NV_VERSION in what:
575 result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
576 constants.RELEASE_VERSION)
578 if constants.NV_HVINFO in what and vm_capable:
579 hyper = hypervisor.GetHypervisor(what[constants.NV_HVINFO])
580 result[constants.NV_HVINFO] = hyper.GetNodeInfo()
582 if constants.NV_DRBDLIST in what and vm_capable:
584 used_minors = bdev.DRBD8.GetUsedDevs().keys()
585 except errors.BlockDeviceError, err:
586 logging.warning("Can't get used minors list", exc_info=True)
587 used_minors = str(err)
588 result[constants.NV_DRBDLIST] = used_minors
590 if constants.NV_DRBDHELPER in what and vm_capable:
593 payload = bdev.BaseDRBD.GetUsermodeHelper()
594 except errors.BlockDeviceError, err:
595 logging.error("Can't get DRBD usermode helper: %s", str(err))
598 result[constants.NV_DRBDHELPER] = (status, payload)
600 if constants.NV_NODESETUP in what:
601 result[constants.NV_NODESETUP] = tmpr = []
602 if not os.path.isdir("/sys/block") or not os.path.isdir("/sys/class/net"):
603 tmpr.append("The sysfs filesytem doesn't seem to be mounted"
604 " under /sys, missing required directories /sys/block"
605 " and /sys/class/net")
606 if (not os.path.isdir("/proc/sys") or
607 not os.path.isfile("/proc/sysrq-trigger")):
608 tmpr.append("The procfs filesystem doesn't seem to be mounted"
609 " under /proc, missing required directory /proc/sys and"
610 " the file /proc/sysrq-trigger")
612 if constants.NV_TIME in what:
613 result[constants.NV_TIME] = utils.SplitTime(time.time())
615 if constants.NV_OSLIST in what and vm_capable:
616 result[constants.NV_OSLIST] = DiagnoseOS()
621 def GetVolumeList(vg_name):
622 """Compute list of logical volumes and their size.
625 @param vg_name: the volume group whose LVs we should list
628 dictionary of all partions (key) with value being a tuple of
629 their size (in MiB), inactive and online status::
631 {'test1': ('20.06', True, True)}
633 in case of errors, a string is returned with the error
639 result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
640 "--separator=%s" % sep,
641 "-olv_name,lv_size,lv_attr", vg_name])
643 _Fail("Failed to list logical volumes, lvs output: %s", result.output)
645 valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
646 for line in result.stdout.splitlines():
648 match = valid_line_re.match(line)
650 logging.error("Invalid line returned from lvs output: '%s'", line)
652 name, size, attr = match.groups()
653 inactive = attr[4] == '-'
654 online = attr[5] == 'o'
655 virtual = attr[0] == 'v'
657 # we don't want to report such volumes as existing, since they
658 # don't really hold data
660 lvs[name] = (size, inactive, online)
665 def ListVolumeGroups():
666 """List the volume groups and their size.
669 @return: dictionary with keys volume name and values the
673 return utils.ListVolumeGroups()
677 """List all volumes on this node.
681 A list of dictionaries, each having four keys:
682 - name: the logical volume name,
683 - size: the size of the logical volume
684 - dev: the physical device on which the LV lives
685 - vg: the volume group to which it belongs
687 In case of errors, we return an empty list and log the
690 Note that since a logical volume can live on multiple physical
691 volumes, the resulting list might include a logical volume
695 result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
697 "--options=lv_name,lv_size,devices,vg_name"])
699 _Fail("Failed to list logical volumes, lvs output: %s",
703 return dev.split('(')[0]
706 return [parse_dev(x) for x in dev.split(",")]
709 line = [v.strip() for v in line]
710 return [{'name': line[0], 'size': line[1],
711 'dev': dev, 'vg': line[3]} for dev in handle_dev(line[2])]
714 for line in result.stdout.splitlines():
715 if line.count('|') >= 3:
716 all_devs.extend(map_line(line.split('|')))
718 logging.warning("Strange line in the output from lvs: '%s'", line)
722 def BridgesExist(bridges_list):
723 """Check if a list of bridges exist on the current node.
726 @return: C{True} if all of them exist, C{False} otherwise
730 for bridge in bridges_list:
731 if not utils.BridgeExists(bridge):
732 missing.append(bridge)
735 _Fail("Missing bridges %s", utils.CommaJoin(missing))
738 def GetInstanceList(hypervisor_list):
739 """Provides a list of instances.
741 @type hypervisor_list: list
742 @param hypervisor_list: the list of hypervisors to query information
745 @return: a list of all running instances on the current node
746 - instance1.example.com
747 - instance2.example.com
751 for hname in hypervisor_list:
753 names = hypervisor.GetHypervisor(hname).ListInstances()
754 results.extend(names)
755 except errors.HypervisorError, err:
756 _Fail("Error enumerating instances (hypervisor %s): %s",
757 hname, err, exc=True)
762 def GetInstanceInfo(instance, hname):
763 """Gives back the information about an instance as a dictionary.
765 @type instance: string
766 @param instance: the instance name
768 @param hname: the hypervisor type of the instance
771 @return: dictionary with the following keys:
772 - memory: memory size of instance (int)
773 - state: xen state of instance (string)
774 - time: cpu time of instance (float)
779 iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
780 if iinfo is not None:
781 output['memory'] = iinfo[2]
782 output['state'] = iinfo[4]
783 output['time'] = iinfo[5]
788 def GetInstanceMigratable(instance):
789 """Gives whether an instance can be migrated.
791 @type instance: L{objects.Instance}
792 @param instance: object representing the instance to be checked.
795 @return: tuple of (result, description) where:
796 - result: whether the instance can be migrated or not
797 - description: a description of the issue, if relevant
800 hyper = hypervisor.GetHypervisor(instance.hypervisor)
801 iname = instance.name
802 if iname not in hyper.ListInstances():
803 _Fail("Instance %s is not running", iname)
805 for idx in range(len(instance.disks)):
806 link_name = _GetBlockDevSymlinkPath(iname, idx)
807 if not os.path.islink(link_name):
808 logging.warning("Instance %s is missing symlink %s for disk %d",
809 iname, link_name, idx)
812 def GetAllInstancesInfo(hypervisor_list):
813 """Gather data about all instances.
815 This is the equivalent of L{GetInstanceInfo}, except that it
816 computes data for all instances at once, thus being faster if one
817 needs data about more than one instance.
819 @type hypervisor_list: list
820 @param hypervisor_list: list of hypervisors to query for instance data
823 @return: dictionary of instance: data, with data having the following keys:
824 - memory: memory size of instance (int)
825 - state: xen state of instance (string)
826 - time: cpu time of instance (float)
827 - vcpus: the number of vcpus
832 for hname in hypervisor_list:
833 iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
835 for name, _, memory, vcpus, state, times in iinfo:
843 # we only check static parameters, like memory and vcpus,
844 # and not state and time which can change between the
845 # invocations of the different hypervisors
846 for key in 'memory', 'vcpus':
847 if value[key] != output[name][key]:
848 _Fail("Instance %s is running twice"
849 " with different parameters", name)
855 def _InstanceLogName(kind, os_name, instance):
856 """Compute the OS log filename for a given instance and operation.
858 The instance name and os name are passed in as strings since not all
859 operations have these as part of an instance object.
862 @param kind: the operation type (e.g. add, import, etc.)
863 @type os_name: string
864 @param os_name: the os name
865 @type instance: string
866 @param instance: the name of the instance being imported/added/etc.
869 # TODO: Use tempfile.mkstemp to create unique filename
870 base = ("%s-%s-%s-%s.log" %
871 (kind, os_name, instance, utils.TimestampForFilename()))
872 return utils.PathJoin(constants.LOG_OS_DIR, base)
875 def InstanceOsAdd(instance, reinstall, debug):
876 """Add an OS to an instance.
878 @type instance: L{objects.Instance}
879 @param instance: Instance whose OS is to be installed
880 @type reinstall: boolean
881 @param reinstall: whether this is an instance reinstall
883 @param debug: debug level, passed to the OS scripts
887 inst_os = OSFromDisk(instance.os)
889 create_env = OSEnvironment(instance, inst_os, debug)
891 create_env['INSTANCE_REINSTALL'] = "1"
893 logfile = _InstanceLogName("add", instance.os, instance.name)
895 result = utils.RunCmd([inst_os.create_script], env=create_env,
896 cwd=inst_os.path, output=logfile,)
898 logging.error("os create command '%s' returned error: %s, logfile: %s,"
899 " output: %s", result.cmd, result.fail_reason, logfile,
901 lines = [utils.SafeEncode(val)
902 for val in utils.TailFile(logfile, lines=20)]
903 _Fail("OS create script failed (%s), last lines in the"
904 " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
907 def RunRenameInstance(instance, old_name, debug):
908 """Run the OS rename script for an instance.
910 @type instance: L{objects.Instance}
911 @param instance: Instance whose OS is to be installed
912 @type old_name: string
913 @param old_name: previous instance name
915 @param debug: debug level, passed to the OS scripts
917 @return: the success of the operation
920 inst_os = OSFromDisk(instance.os)
922 rename_env = OSEnvironment(instance, inst_os, debug)
923 rename_env['OLD_INSTANCE_NAME'] = old_name
925 logfile = _InstanceLogName("rename", instance.os,
926 "%s-%s" % (old_name, instance.name))
928 result = utils.RunCmd([inst_os.rename_script], env=rename_env,
929 cwd=inst_os.path, output=logfile)
932 logging.error("os create command '%s' returned error: %s output: %s",
933 result.cmd, result.fail_reason, result.output)
934 lines = [utils.SafeEncode(val)
935 for val in utils.TailFile(logfile, lines=20)]
936 _Fail("OS rename script failed (%s), last lines in the"
937 " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
940 def _GetBlockDevSymlinkPath(instance_name, idx):
941 return utils.PathJoin(constants.DISK_LINKS_DIR,
942 "%s:%d" % (instance_name, idx))
945 def _SymlinkBlockDev(instance_name, device_path, idx):
946 """Set up symlinks to a instance's block device.
948 This is an auxiliary function run when an instance is start (on the primary
949 node) or when an instance is migrated (on the target node).
952 @param instance_name: the name of the target instance
953 @param device_path: path of the physical block device, on the node
954 @param idx: the disk index
955 @return: absolute path to the disk's symlink
958 link_name = _GetBlockDevSymlinkPath(instance_name, idx)
960 os.symlink(device_path, link_name)
962 if err.errno == errno.EEXIST:
963 if (not os.path.islink(link_name) or
964 os.readlink(link_name) != device_path):
966 os.symlink(device_path, link_name)
973 def _RemoveBlockDevLinks(instance_name, disks):
974 """Remove the block device symlinks belonging to the given instance.
977 for idx, _ in enumerate(disks):
978 link_name = _GetBlockDevSymlinkPath(instance_name, idx)
979 if os.path.islink(link_name):
983 logging.exception("Can't remove symlink '%s'", link_name)
986 def _GatherAndLinkBlockDevs(instance):
987 """Set up an instance's block device(s).
989 This is run on the primary node at instance startup. The block
990 devices must be already assembled.
992 @type instance: L{objects.Instance}
993 @param instance: the instance whose disks we shoul assemble
995 @return: list of (disk_object, device_path)
999 for idx, disk in enumerate(instance.disks):
1000 device = _RecursiveFindBD(disk)
1002 raise errors.BlockDeviceError("Block device '%s' is not set up." %
1006 link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
1008 raise errors.BlockDeviceError("Cannot create block device symlink: %s" %
1011 block_devices.append((disk, link_name))
1013 return block_devices
1016 def StartInstance(instance):
1017 """Start an instance.
1019 @type instance: L{objects.Instance}
1020 @param instance: the instance object
1024 running_instances = GetInstanceList([instance.hypervisor])
1026 if instance.name in running_instances:
1027 logging.info("Instance %s already running, not starting", instance.name)
1031 block_devices = _GatherAndLinkBlockDevs(instance)
1032 hyper = hypervisor.GetHypervisor(instance.hypervisor)
1033 hyper.StartInstance(instance, block_devices)
1034 except errors.BlockDeviceError, err:
1035 _Fail("Block device error: %s", err, exc=True)
1036 except errors.HypervisorError, err:
1037 _RemoveBlockDevLinks(instance.name, instance.disks)
1038 _Fail("Hypervisor error: %s", err, exc=True)
1041 def InstanceShutdown(instance, timeout):
1042 """Shut an instance down.
1044 @note: this functions uses polling with a hardcoded timeout.
1046 @type instance: L{objects.Instance}
1047 @param instance: the instance object
1048 @type timeout: integer
1049 @param timeout: maximum timeout for soft shutdown
1053 hv_name = instance.hypervisor
1054 hyper = hypervisor.GetHypervisor(hv_name)
1055 iname = instance.name
1057 if instance.name not in hyper.ListInstances():
1058 logging.info("Instance %s not running, doing nothing", iname)
1063 self.tried_once = False
1066 if iname not in hyper.ListInstances():
1070 hyper.StopInstance(instance, retry=self.tried_once)
1071 except errors.HypervisorError, err:
1072 if iname not in hyper.ListInstances():
1073 # if the instance is no longer existing, consider this a
1074 # success and go to cleanup
1077 _Fail("Failed to stop instance %s: %s", iname, err)
1079 self.tried_once = True
1081 raise utils.RetryAgain()
1084 utils.Retry(_TryShutdown(), 5, timeout)
1085 except utils.RetryTimeout:
1086 # the shutdown did not succeed
1087 logging.error("Shutdown of '%s' unsuccessful, forcing", iname)
1090 hyper.StopInstance(instance, force=True)
1091 except errors.HypervisorError, err:
1092 if iname in hyper.ListInstances():
1093 # only raise an error if the instance still exists, otherwise
1094 # the error could simply be "instance ... unknown"!
1095 _Fail("Failed to force stop instance %s: %s", iname, err)
1099 if iname in hyper.ListInstances():
1100 _Fail("Could not shutdown instance %s even by destroy", iname)
1103 hyper.CleanupInstance(instance.name)
1104 except errors.HypervisorError, err:
1105 logging.warning("Failed to execute post-shutdown cleanup step: %s", err)
1107 _RemoveBlockDevLinks(iname, instance.disks)
1110 def InstanceReboot(instance, reboot_type, shutdown_timeout):
1111 """Reboot an instance.
1113 @type instance: L{objects.Instance}
1114 @param instance: the instance object to reboot
1115 @type reboot_type: str
1116 @param reboot_type: the type of reboot, one the following
1118 - L{constants.INSTANCE_REBOOT_SOFT}: only reboot the
1119 instance OS, do not recreate the VM
1120 - L{constants.INSTANCE_REBOOT_HARD}: tear down and
1121 restart the VM (at the hypervisor level)
1122 - the other reboot type (L{constants.INSTANCE_REBOOT_FULL}) is
1123 not accepted here, since that mode is handled differently, in
1124 cmdlib, and translates into full stop and start of the
1125 instance (instead of a call_instance_reboot RPC)
1126 @type shutdown_timeout: integer
1127 @param shutdown_timeout: maximum timeout for soft shutdown
1131 running_instances = GetInstanceList([instance.hypervisor])
1133 if instance.name not in running_instances:
1134 _Fail("Cannot reboot instance %s that is not running", instance.name)
1136 hyper = hypervisor.GetHypervisor(instance.hypervisor)
1137 if reboot_type == constants.INSTANCE_REBOOT_SOFT:
1139 hyper.RebootInstance(instance)
1140 except errors.HypervisorError, err:
1141 _Fail("Failed to soft reboot instance %s: %s", instance.name, err)
1142 elif reboot_type == constants.INSTANCE_REBOOT_HARD:
1144 InstanceShutdown(instance, shutdown_timeout)
1145 return StartInstance(instance)
1146 except errors.HypervisorError, err:
1147 _Fail("Failed to hard reboot instance %s: %s", instance.name, err)
1149 _Fail("Invalid reboot_type received: %s", reboot_type)
1152 def MigrationInfo(instance):
1153 """Gather information about an instance to be migrated.
1155 @type instance: L{objects.Instance}
1156 @param instance: the instance definition
1159 hyper = hypervisor.GetHypervisor(instance.hypervisor)
1161 info = hyper.MigrationInfo(instance)
1162 except errors.HypervisorError, err:
1163 _Fail("Failed to fetch migration information: %s", err, exc=True)
1167 def AcceptInstance(instance, info, target):
1168 """Prepare the node to accept an instance.
1170 @type instance: L{objects.Instance}
1171 @param instance: the instance definition
1172 @type info: string/data (opaque)
1173 @param info: migration information, from the source node
1174 @type target: string
1175 @param target: target host (usually ip), on this node
1178 hyper = hypervisor.GetHypervisor(instance.hypervisor)
1180 hyper.AcceptInstance(instance, info, target)
1181 except errors.HypervisorError, err:
1182 _Fail("Failed to accept instance: %s", err, exc=True)
1185 def FinalizeMigration(instance, info, success):
1186 """Finalize any preparation to accept an instance.
1188 @type instance: L{objects.Instance}
1189 @param instance: the instance definition
1190 @type info: string/data (opaque)
1191 @param info: migration information, from the source node
1192 @type success: boolean
1193 @param success: whether the migration was a success or a failure
1196 hyper = hypervisor.GetHypervisor(instance.hypervisor)
1198 hyper.FinalizeMigration(instance, info, success)
1199 except errors.HypervisorError, err:
1200 _Fail("Failed to finalize migration: %s", err, exc=True)
1203 def MigrateInstance(instance, target, live):
1204 """Migrates an instance to another node.
1206 @type instance: L{objects.Instance}
1207 @param instance: the instance definition
1208 @type target: string
1209 @param target: the target node name
1211 @param live: whether the migration should be done live or not (the
1212 interpretation of this parameter is left to the hypervisor)
1214 @return: a tuple of (success, msg) where:
1215 - succes is a boolean denoting the success/failure of the operation
1216 - msg is a string with details in case of failure
1219 hyper = hypervisor.GetHypervisor(instance.hypervisor)
1222 hyper.MigrateInstance(instance, target, live)
1223 except errors.HypervisorError, err:
1224 _Fail("Failed to migrate instance: %s", err, exc=True)
1227 def BlockdevCreate(disk, size, owner, on_primary, info):
1228 """Creates a block device for an instance.
1230 @type disk: L{objects.Disk}
1231 @param disk: the object describing the disk we should create
1233 @param size: the size of the physical underlying device, in MiB
1235 @param owner: the name of the instance for which disk is created,
1236 used for device cache data
1237 @type on_primary: boolean
1238 @param on_primary: indicates if it is the primary node or not
1240 @param info: string that will be sent to the physical device
1241 creation, used for example to set (LVM) tags on LVs
1243 @return: the new unique_id of the device (this can sometime be
1244 computed only after creation), or None. On secondary nodes,
1245 it's not required to return anything.
1248 # TODO: remove the obsolete 'size' argument
1249 # pylint: disable-msg=W0613
1252 for child in disk.children:
1254 crdev = _RecursiveAssembleBD(child, owner, on_primary)
1255 except errors.BlockDeviceError, err:
1256 _Fail("Can't assemble device %s: %s", child, err)
1257 if on_primary or disk.AssembleOnSecondary():
1258 # we need the children open in case the device itself has to
1261 # pylint: disable-msg=E1103
1263 except errors.BlockDeviceError, err:
1264 _Fail("Can't make child '%s' read-write: %s", child, err)
1268 device = bdev.Create(disk.dev_type, disk.physical_id, clist, disk.size)
1269 except errors.BlockDeviceError, err:
1270 _Fail("Can't create block device: %s", err)
1272 if on_primary or disk.AssembleOnSecondary():
1275 except errors.BlockDeviceError, err:
1276 _Fail("Can't assemble device after creation, unusual event: %s", err)
1277 device.SetSyncSpeed(constants.SYNC_SPEED)
1278 if on_primary or disk.OpenOnSecondary():
1280 device.Open(force=True)
1281 except errors.BlockDeviceError, err:
1282 _Fail("Can't make device r/w after creation, unusual event: %s", err)
1283 DevCacheManager.UpdateCache(device.dev_path, owner,
1284 on_primary, disk.iv_name)
1286 device.SetInfo(info)
1288 return device.unique_id
1291 def _WipeDevice(path, offset, size):
1292 """This function actually wipes the device.
1294 @param path: The path to the device to wipe
1295 @param offset: The offset in MiB in the file
1296 @param size: The size in MiB to write
1299 cmd = [constants.DD_CMD, "if=/dev/zero", "seek=%d" % offset,
1300 "bs=%d" % constants.WIPE_BLOCK_SIZE, "oflag=direct", "of=%s" % path,
1302 result = utils.RunCmd(cmd)
1305 _Fail("Wipe command '%s' exited with error: %s; output: %s", result.cmd,
1306 result.fail_reason, result.output)
1309 def BlockdevWipe(disk, offset, size):
1310 """Wipes a block device.
1312 @type disk: L{objects.Disk}
1313 @param disk: the disk object we want to wipe
1315 @param offset: The offset in MiB in the file
1317 @param size: The size in MiB to write
1321 rdev = _RecursiveFindBD(disk)
1322 except errors.BlockDeviceError:
1326 _Fail("Cannot execute wipe for device %s: device not found", disk.iv_name)
1328 # Do cross verify some of the parameters
1329 if offset > rdev.size:
1330 _Fail("Offset is bigger than device size")
1331 if (offset + size) > rdev.size:
1332 _Fail("The provided offset and size to wipe is bigger than device size")
1334 _WipeDevice(rdev.dev_path, offset, size)
1337 def BlockdevRemove(disk):
1338 """Remove a block device.
1340 @note: This is intended to be called recursively.
1342 @type disk: L{objects.Disk}
1343 @param disk: the disk object we should remove
1345 @return: the success of the operation
1350 rdev = _RecursiveFindBD(disk)
1351 except errors.BlockDeviceError, err:
1352 # probably can't attach
1353 logging.info("Can't attach to device %s in remove", disk)
1355 if rdev is not None:
1356 r_path = rdev.dev_path
1359 except errors.BlockDeviceError, err:
1360 msgs.append(str(err))
1362 DevCacheManager.RemoveCache(r_path)
1365 for child in disk.children:
1367 BlockdevRemove(child)
1368 except RPCFail, err:
1369 msgs.append(str(err))
1372 _Fail("; ".join(msgs))
1375 def _RecursiveAssembleBD(disk, owner, as_primary):
1376 """Activate a block device for an instance.
1378 This is run on the primary and secondary nodes for an instance.
1380 @note: this function is called recursively.
1382 @type disk: L{objects.Disk}
1383 @param disk: the disk we try to assemble
1385 @param owner: the name of the instance which owns the disk
1386 @type as_primary: boolean
1387 @param as_primary: if we should make the block device
1390 @return: the assembled device or None (in case no device
1392 @raise errors.BlockDeviceError: in case there is an error
1393 during the activation of the children or the device
1399 mcn = disk.ChildrenNeeded()
1401 mcn = 0 # max number of Nones allowed
1403 mcn = len(disk.children) - mcn # max number of Nones
1404 for chld_disk in disk.children:
1406 cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
1407 except errors.BlockDeviceError, err:
1408 if children.count(None) >= mcn:
1411 logging.error("Error in child activation (but continuing): %s",
1413 children.append(cdev)
1415 if as_primary or disk.AssembleOnSecondary():
1416 r_dev = bdev.Assemble(disk.dev_type, disk.physical_id, children, disk.size)
1417 r_dev.SetSyncSpeed(constants.SYNC_SPEED)
1419 if as_primary or disk.OpenOnSecondary():
1421 DevCacheManager.UpdateCache(r_dev.dev_path, owner,
1422 as_primary, disk.iv_name)
1429 def BlockdevAssemble(disk, owner, as_primary):
1430 """Activate a block device for an instance.
1432 This is a wrapper over _RecursiveAssembleBD.
1434 @rtype: str or boolean
1435 @return: a C{/dev/...} path for primary nodes, and
1436 C{True} for secondary nodes
1440 result = _RecursiveAssembleBD(disk, owner, as_primary)
1441 if isinstance(result, bdev.BlockDev):
1442 # pylint: disable-msg=E1103
1443 result = result.dev_path
1444 except errors.BlockDeviceError, err:
1445 _Fail("Error while assembling disk: %s", err, exc=True)
1450 def BlockdevShutdown(disk):
1451 """Shut down a block device.
1453 First, if the device is assembled (Attach() is successful), then
1454 the device is shutdown. Then the children of the device are
1457 This function is called recursively. Note that we don't cache the
1458 children or such, as oppossed to assemble, shutdown of different
1459 devices doesn't require that the upper device was active.
1461 @type disk: L{objects.Disk}
1462 @param disk: the description of the disk we should
1468 r_dev = _RecursiveFindBD(disk)
1469 if r_dev is not None:
1470 r_path = r_dev.dev_path
1473 DevCacheManager.RemoveCache(r_path)
1474 except errors.BlockDeviceError, err:
1475 msgs.append(str(err))
1478 for child in disk.children:
1480 BlockdevShutdown(child)
1481 except RPCFail, err:
1482 msgs.append(str(err))
1485 _Fail("; ".join(msgs))
1488 def BlockdevAddchildren(parent_cdev, new_cdevs):
1489 """Extend a mirrored block device.
1491 @type parent_cdev: L{objects.Disk}
1492 @param parent_cdev: the disk to which we should add children
1493 @type new_cdevs: list of L{objects.Disk}
1494 @param new_cdevs: the list of children which we should add
1498 parent_bdev = _RecursiveFindBD(parent_cdev)
1499 if parent_bdev is None:
1500 _Fail("Can't find parent device '%s' in add children", parent_cdev)
1501 new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
1502 if new_bdevs.count(None) > 0:
1503 _Fail("Can't find new device(s) to add: %s:%s", new_bdevs, new_cdevs)
1504 parent_bdev.AddChildren(new_bdevs)
1507 def BlockdevRemovechildren(parent_cdev, new_cdevs):
1508 """Shrink a mirrored block device.
1510 @type parent_cdev: L{objects.Disk}
1511 @param parent_cdev: the disk from which we should remove children
1512 @type new_cdevs: list of L{objects.Disk}
1513 @param new_cdevs: the list of children which we should remove
1517 parent_bdev = _RecursiveFindBD(parent_cdev)
1518 if parent_bdev is None:
1519 _Fail("Can't find parent device '%s' in remove children", parent_cdev)
1521 for disk in new_cdevs:
1522 rpath = disk.StaticDevPath()
1524 bd = _RecursiveFindBD(disk)
1526 _Fail("Can't find device %s while removing children", disk)
1528 devs.append(bd.dev_path)
1530 if not utils.IsNormAbsPath(rpath):
1531 _Fail("Strange path returned from StaticDevPath: '%s'", rpath)
1533 parent_bdev.RemoveChildren(devs)
1536 def BlockdevGetmirrorstatus(disks):
1537 """Get the mirroring status of a list of devices.
1539 @type disks: list of L{objects.Disk}
1540 @param disks: the list of disks which we should query
1543 a list of (mirror_done, estimated_time) tuples, which
1544 are the result of L{bdev.BlockDev.CombinedSyncStatus}
1545 @raise errors.BlockDeviceError: if any of the disks cannot be
1551 rbd = _RecursiveFindBD(dsk)
1553 _Fail("Can't find device %s", dsk)
1555 stats.append(rbd.CombinedSyncStatus())
1560 def _RecursiveFindBD(disk):
1561 """Check if a device is activated.
1563 If so, return information about the real device.
1565 @type disk: L{objects.Disk}
1566 @param disk: the disk object we need to find
1568 @return: None if the device can't be found,
1569 otherwise the device instance
1574 for chdisk in disk.children:
1575 children.append(_RecursiveFindBD(chdisk))
1577 return bdev.FindDevice(disk.dev_type, disk.physical_id, children, disk.size)
1580 def _OpenRealBD(disk):
1581 """Opens the underlying block device of a disk.
1583 @type disk: L{objects.Disk}
1584 @param disk: the disk object we want to open
1587 real_disk = _RecursiveFindBD(disk)
1588 if real_disk is None:
1589 _Fail("Block device '%s' is not set up", disk)
1596 def BlockdevFind(disk):
1597 """Check if a device is activated.
1599 If it is, return information about the real device.
1601 @type disk: L{objects.Disk}
1602 @param disk: the disk to find
1603 @rtype: None or objects.BlockDevStatus
1604 @return: None if the disk cannot be found, otherwise a the current
1609 rbd = _RecursiveFindBD(disk)
1610 except errors.BlockDeviceError, err:
1611 _Fail("Failed to find device: %s", err, exc=True)
1616 return rbd.GetSyncStatus()
1619 def BlockdevGetsize(disks):
1620 """Computes the size of the given disks.
1622 If a disk is not found, returns None instead.
1624 @type disks: list of L{objects.Disk}
1625 @param disks: the list of disk to compute the size for
1627 @return: list with elements None if the disk cannot be found,
1634 rbd = _RecursiveFindBD(cf)
1635 except errors.BlockDeviceError:
1641 result.append(rbd.GetActualSize())
1645 def BlockdevExport(disk, dest_node, dest_path, cluster_name):
1646 """Export a block device to a remote node.
1648 @type disk: L{objects.Disk}
1649 @param disk: the description of the disk to export
1650 @type dest_node: str
1651 @param dest_node: the destination node to export to
1652 @type dest_path: str
1653 @param dest_path: the destination path on the target node
1654 @type cluster_name: str
1655 @param cluster_name: the cluster name, needed for SSH hostalias
1659 real_disk = _OpenRealBD(disk)
1661 # the block size on the read dd is 1MiB to match our units
1662 expcmd = utils.BuildShellCmd("set -e; set -o pipefail; "
1663 "dd if=%s bs=1048576 count=%s",
1664 real_disk.dev_path, str(disk.size))
1666 # we set here a smaller block size as, due to ssh buffering, more
1667 # than 64-128k will mostly ignored; we use nocreat to fail if the
1668 # device is not already there or we pass a wrong path; we use
1669 # notrunc to no attempt truncate on an LV device; we use oflag=dsync
1670 # to not buffer too much memory; this means that at best, we flush
1671 # every 64k, which will not be very fast
1672 destcmd = utils.BuildShellCmd("dd of=%s conv=nocreat,notrunc bs=65536"
1673 " oflag=dsync", dest_path)
1675 remotecmd = _GetSshRunner(cluster_name).BuildCmd(dest_node,
1676 constants.GANETI_RUNAS,
1679 # all commands have been checked, so we're safe to combine them
1680 command = '|'.join([expcmd, utils.ShellQuoteArgs(remotecmd)])
1682 result = utils.RunCmd(["bash", "-c", command])
1685 _Fail("Disk copy command '%s' returned error: %s"
1686 " output: %s", command, result.fail_reason, result.output)
1689 def UploadFile(file_name, data, mode, uid, gid, atime, mtime):
1690 """Write a file to the filesystem.
1692 This allows the master to overwrite(!) a file. It will only perform
1693 the operation if the file belongs to a list of configuration files.
1695 @type file_name: str
1696 @param file_name: the target file name
1698 @param data: the new contents of the file
1700 @param mode: the mode to give the file (can be None)
1702 @param uid: the owner of the file (can be -1 for default)
1704 @param gid: the group of the file (can be -1 for default)
1706 @param atime: the atime to set on the file (can be None)
1708 @param mtime: the mtime to set on the file (can be None)
1712 if not os.path.isabs(file_name):
1713 _Fail("Filename passed to UploadFile is not absolute: '%s'", file_name)
1715 if file_name not in _ALLOWED_UPLOAD_FILES:
1716 _Fail("Filename passed to UploadFile not in allowed upload targets: '%s'",
1719 raw_data = _Decompress(data)
1721 utils.SafeWriteFile(file_name, None,
1722 data=raw_data, mode=mode, uid=uid, gid=gid,
1723 atime=atime, mtime=mtime)
1726 def WriteSsconfFiles(values):
1727 """Update all ssconf files.
1729 Wrapper around the SimpleStore.WriteFiles.
1732 ssconf.SimpleStore().WriteFiles(values)
1735 def _ErrnoOrStr(err):
1736 """Format an EnvironmentError exception.
1738 If the L{err} argument has an errno attribute, it will be looked up
1739 and converted into a textual C{E...} description. Otherwise the
1740 string representation of the error will be returned.
1742 @type err: L{EnvironmentError}
1743 @param err: the exception to format
1746 if hasattr(err, 'errno'):
1747 detail = errno.errorcode[err.errno]
1753 def _OSOndiskAPIVersion(os_dir):
1754 """Compute and return the API version of a given OS.
1756 This function will try to read the API version of the OS residing in
1757 the 'os_dir' directory.
1760 @param os_dir: the directory in which we should look for the OS
1762 @return: tuple (status, data) with status denoting the validity and
1763 data holding either the vaid versions or an error message
1766 api_file = utils.PathJoin(os_dir, constants.OS_API_FILE)
1769 st = os.stat(api_file)
1770 except EnvironmentError, err:
1771 return False, ("Required file '%s' not found under path %s: %s" %
1772 (constants.OS_API_FILE, os_dir, _ErrnoOrStr(err)))
1774 if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1775 return False, ("File '%s' in %s is not a regular file" %
1776 (constants.OS_API_FILE, os_dir))
1779 api_versions = utils.ReadFile(api_file).splitlines()
1780 except EnvironmentError, err:
1781 return False, ("Error while reading the API version file at %s: %s" %
1782 (api_file, _ErrnoOrStr(err)))
1785 api_versions = [int(version.strip()) for version in api_versions]
1786 except (TypeError, ValueError), err:
1787 return False, ("API version(s) can't be converted to integer: %s" %
1790 return True, api_versions
1793 def DiagnoseOS(top_dirs=None):
1794 """Compute the validity for all OSes.
1796 @type top_dirs: list
1797 @param top_dirs: the list of directories in which to
1798 search (if not given defaults to
1799 L{constants.OS_SEARCH_PATH})
1800 @rtype: list of L{objects.OS}
1801 @return: a list of tuples (name, path, status, diagnose, variants,
1802 parameters, api_version) for all (potential) OSes under all
1803 search paths, where:
1804 - name is the (potential) OS name
1805 - path is the full path to the OS
1806 - status True/False is the validity of the OS
1807 - diagnose is the error message for an invalid OS, otherwise empty
1808 - variants is a list of supported OS variants, if any
1809 - parameters is a list of (name, help) parameters, if any
1810 - api_version is a list of support OS API versions
1813 if top_dirs is None:
1814 top_dirs = constants.OS_SEARCH_PATH
1817 for dir_name in top_dirs:
1818 if os.path.isdir(dir_name):
1820 f_names = utils.ListVisibleFiles(dir_name)
1821 except EnvironmentError, err:
1822 logging.exception("Can't list the OS directory %s: %s", dir_name, err)
1824 for name in f_names:
1825 os_path = utils.PathJoin(dir_name, name)
1826 status, os_inst = _TryOSFromDisk(name, base_dir=dir_name)
1829 variants = os_inst.supported_variants
1830 parameters = os_inst.supported_parameters
1831 api_versions = os_inst.api_versions
1834 variants = parameters = api_versions = []
1835 result.append((name, os_path, status, diagnose, variants,
1836 parameters, api_versions))
1841 def _TryOSFromDisk(name, base_dir=None):
1842 """Create an OS instance from disk.
1844 This function will return an OS instance if the given name is a
1847 @type base_dir: string
1848 @keyword base_dir: Base directory containing OS installations.
1849 Defaults to a search in all the OS_SEARCH_PATH dirs.
1851 @return: success and either the OS instance if we find a valid one,
1855 if base_dir is None:
1856 os_dir = utils.FindFile(name, constants.OS_SEARCH_PATH, os.path.isdir)
1858 os_dir = utils.FindFile(name, [base_dir], os.path.isdir)
1861 return False, "Directory for OS %s not found in search path" % name
1863 status, api_versions = _OSOndiskAPIVersion(os_dir)
1866 return status, api_versions
1868 if not constants.OS_API_VERSIONS.intersection(api_versions):
1869 return False, ("API version mismatch for path '%s': found %s, want %s." %
1870 (os_dir, api_versions, constants.OS_API_VERSIONS))
1872 # OS Files dictionary, we will populate it with the absolute path names
1873 os_files = dict.fromkeys(constants.OS_SCRIPTS)
1875 if max(api_versions) >= constants.OS_API_V15:
1876 os_files[constants.OS_VARIANTS_FILE] = ''
1878 if max(api_versions) >= constants.OS_API_V20:
1879 os_files[constants.OS_PARAMETERS_FILE] = ''
1881 del os_files[constants.OS_SCRIPT_VERIFY]
1883 for filename in os_files:
1884 os_files[filename] = utils.PathJoin(os_dir, filename)
1887 st = os.stat(os_files[filename])
1888 except EnvironmentError, err:
1889 return False, ("File '%s' under path '%s' is missing (%s)" %
1890 (filename, os_dir, _ErrnoOrStr(err)))
1892 if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1893 return False, ("File '%s' under path '%s' is not a regular file" %
1896 if filename in constants.OS_SCRIPTS:
1897 if stat.S_IMODE(st.st_mode) & stat.S_IXUSR != stat.S_IXUSR:
1898 return False, ("File '%s' under path '%s' is not executable" %
1902 if constants.OS_VARIANTS_FILE in os_files:
1903 variants_file = os_files[constants.OS_VARIANTS_FILE]
1905 variants = utils.ReadFile(variants_file).splitlines()
1906 except EnvironmentError, err:
1907 return False, ("Error while reading the OS variants file at %s: %s" %
1908 (variants_file, _ErrnoOrStr(err)))
1910 return False, ("No supported os variant found")
1913 if constants.OS_PARAMETERS_FILE in os_files:
1914 parameters_file = os_files[constants.OS_PARAMETERS_FILE]
1916 parameters = utils.ReadFile(parameters_file).splitlines()
1917 except EnvironmentError, err:
1918 return False, ("Error while reading the OS parameters file at %s: %s" %
1919 (parameters_file, _ErrnoOrStr(err)))
1920 parameters = [v.split(None, 1) for v in parameters]
1922 os_obj = objects.OS(name=name, path=os_dir,
1923 create_script=os_files[constants.OS_SCRIPT_CREATE],
1924 export_script=os_files[constants.OS_SCRIPT_EXPORT],
1925 import_script=os_files[constants.OS_SCRIPT_IMPORT],
1926 rename_script=os_files[constants.OS_SCRIPT_RENAME],
1927 verify_script=os_files.get(constants.OS_SCRIPT_VERIFY,
1929 supported_variants=variants,
1930 supported_parameters=parameters,
1931 api_versions=api_versions)
1935 def OSFromDisk(name, base_dir=None):
1936 """Create an OS instance from disk.
1938 This function will return an OS instance if the given name is a
1939 valid OS name. Otherwise, it will raise an appropriate
1940 L{RPCFail} exception, detailing why this is not a valid OS.
1942 This is just a wrapper over L{_TryOSFromDisk}, which doesn't raise
1943 an exception but returns true/false status data.
1945 @type base_dir: string
1946 @keyword base_dir: Base directory containing OS installations.
1947 Defaults to a search in all the OS_SEARCH_PATH dirs.
1948 @rtype: L{objects.OS}
1949 @return: the OS instance if we find a valid one
1950 @raise RPCFail: if we don't find a valid OS
1953 name_only = objects.OS.GetName(name)
1954 status, payload = _TryOSFromDisk(name_only, base_dir)
1962 def OSCoreEnv(os_name, inst_os, os_params, debug=0):
1963 """Calculate the basic environment for an os script.
1966 @param os_name: full operating system name (including variant)
1967 @type inst_os: L{objects.OS}
1968 @param inst_os: operating system for which the environment is being built
1969 @type os_params: dict
1970 @param os_params: the OS parameters
1971 @type debug: integer
1972 @param debug: debug level (0 or 1, for OS Api 10)
1974 @return: dict of environment variables
1975 @raise errors.BlockDeviceError: if the block device
1981 max(constants.OS_API_VERSIONS.intersection(inst_os.api_versions))
1982 result['OS_API_VERSION'] = '%d' % api_version
1983 result['OS_NAME'] = inst_os.name
1984 result['DEBUG_LEVEL'] = '%d' % debug
1987 if api_version >= constants.OS_API_V15:
1988 variant = objects.OS.GetVariant(os_name)
1990 variant = inst_os.supported_variants[0]
1991 result['OS_VARIANT'] = variant
1994 for pname, pvalue in os_params.items():
1995 result['OSP_%s' % pname.upper()] = pvalue
2000 def OSEnvironment(instance, inst_os, debug=0):
2001 """Calculate the environment for an os script.
2003 @type instance: L{objects.Instance}
2004 @param instance: target instance for the os script run
2005 @type inst_os: L{objects.OS}
2006 @param inst_os: operating system for which the environment is being built
2007 @type debug: integer
2008 @param debug: debug level (0 or 1, for OS Api 10)
2010 @return: dict of environment variables
2011 @raise errors.BlockDeviceError: if the block device
2015 result = OSCoreEnv(instance.os, inst_os, instance.osparams, debug=debug)
2017 for attr in ["name", "os", "uuid", "ctime", "mtime"]:
2018 result["INSTANCE_%s" % attr.upper()] = str(getattr(instance, attr))
2020 result['HYPERVISOR'] = instance.hypervisor
2021 result['DISK_COUNT'] = '%d' % len(instance.disks)
2022 result['NIC_COUNT'] = '%d' % len(instance.nics)
2025 for idx, disk in enumerate(instance.disks):
2026 real_disk = _OpenRealBD(disk)
2027 result['DISK_%d_PATH' % idx] = real_disk.dev_path
2028 result['DISK_%d_ACCESS' % idx] = disk.mode
2029 if constants.HV_DISK_TYPE in instance.hvparams:
2030 result['DISK_%d_FRONTEND_TYPE' % idx] = \
2031 instance.hvparams[constants.HV_DISK_TYPE]
2032 if disk.dev_type in constants.LDS_BLOCK:
2033 result['DISK_%d_BACKEND_TYPE' % idx] = 'block'
2034 elif disk.dev_type == constants.LD_FILE:
2035 result['DISK_%d_BACKEND_TYPE' % idx] = \
2036 'file:%s' % disk.physical_id[0]
2039 for idx, nic in enumerate(instance.nics):
2040 result['NIC_%d_MAC' % idx] = nic.mac
2042 result['NIC_%d_IP' % idx] = nic.ip
2043 result['NIC_%d_MODE' % idx] = nic.nicparams[constants.NIC_MODE]
2044 if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
2045 result['NIC_%d_BRIDGE' % idx] = nic.nicparams[constants.NIC_LINK]
2046 if nic.nicparams[constants.NIC_LINK]:
2047 result['NIC_%d_LINK' % idx] = nic.nicparams[constants.NIC_LINK]
2048 if constants.HV_NIC_TYPE in instance.hvparams:
2049 result['NIC_%d_FRONTEND_TYPE' % idx] = \
2050 instance.hvparams[constants.HV_NIC_TYPE]
2053 for source, kind in [(instance.beparams, "BE"), (instance.hvparams, "HV")]:
2054 for key, value in source.items():
2055 result["INSTANCE_%s_%s" % (kind, key)] = str(value)
2060 def BlockdevGrow(disk, amount):
2061 """Grow a stack of block devices.
2063 This function is called recursively, with the childrens being the
2064 first ones to resize.
2066 @type disk: L{objects.Disk}
2067 @param disk: the disk to be grown
2068 @rtype: (status, result)
2069 @return: a tuple with the status of the operation
2070 (True/False), and the errors message if status
2074 r_dev = _RecursiveFindBD(disk)
2076 _Fail("Cannot find block device %s", disk)
2080 except errors.BlockDeviceError, err:
2081 _Fail("Failed to grow block device: %s", err, exc=True)
2084 def BlockdevSnapshot(disk):
2085 """Create a snapshot copy of a block device.
2087 This function is called recursively, and the snapshot is actually created
2088 just for the leaf lvm backend device.
2090 @type disk: L{objects.Disk}
2091 @param disk: the disk to be snapshotted
2093 @return: snapshot disk path
2096 if disk.dev_type == constants.LD_DRBD8:
2097 if not disk.children:
2098 _Fail("DRBD device '%s' without backing storage cannot be snapshotted",
2100 return BlockdevSnapshot(disk.children[0])
2101 elif disk.dev_type == constants.LD_LV:
2102 r_dev = _RecursiveFindBD(disk)
2103 if r_dev is not None:
2104 # FIXME: choose a saner value for the snapshot size
2105 # let's stay on the safe side and ask for the full size, for now
2106 return r_dev.Snapshot(disk.size)
2108 _Fail("Cannot find block device %s", disk)
2110 _Fail("Cannot snapshot non-lvm block device '%s' of type '%s'",
2111 disk.unique_id, disk.dev_type)
2114 def FinalizeExport(instance, snap_disks):
2115 """Write out the export configuration information.
2117 @type instance: L{objects.Instance}
2118 @param instance: the instance which we export, used for
2119 saving configuration
2120 @type snap_disks: list of L{objects.Disk}
2121 @param snap_disks: list of snapshot block devices, which
2122 will be used to get the actual name of the dump file
2127 destdir = utils.PathJoin(constants.EXPORT_DIR, instance.name + ".new")
2128 finaldestdir = utils.PathJoin(constants.EXPORT_DIR, instance.name)
2130 config = objects.SerializableConfigParser()
2132 config.add_section(constants.INISECT_EXP)
2133 config.set(constants.INISECT_EXP, 'version', '0')
2134 config.set(constants.INISECT_EXP, 'timestamp', '%d' % int(time.time()))
2135 config.set(constants.INISECT_EXP, 'source', instance.primary_node)
2136 config.set(constants.INISECT_EXP, 'os', instance.os)
2137 config.set(constants.INISECT_EXP, 'compression', 'gzip')
2139 config.add_section(constants.INISECT_INS)
2140 config.set(constants.INISECT_INS, 'name', instance.name)
2141 config.set(constants.INISECT_INS, 'memory', '%d' %
2142 instance.beparams[constants.BE_MEMORY])
2143 config.set(constants.INISECT_INS, 'vcpus', '%d' %
2144 instance.beparams[constants.BE_VCPUS])
2145 config.set(constants.INISECT_INS, 'disk_template', instance.disk_template)
2146 config.set(constants.INISECT_INS, 'hypervisor', instance.hypervisor)
2149 for nic_count, nic in enumerate(instance.nics):
2151 config.set(constants.INISECT_INS, 'nic%d_mac' %
2152 nic_count, '%s' % nic.mac)
2153 config.set(constants.INISECT_INS, 'nic%d_ip' % nic_count, '%s' % nic.ip)
2154 for param in constants.NICS_PARAMETER_TYPES:
2155 config.set(constants.INISECT_INS, 'nic%d_%s' % (nic_count, param),
2156 '%s' % nic.nicparams.get(param, None))
2157 # TODO: redundant: on load can read nics until it doesn't exist
2158 config.set(constants.INISECT_INS, 'nic_count' , '%d' % nic_total)
2161 for disk_count, disk in enumerate(snap_disks):
2164 config.set(constants.INISECT_INS, 'disk%d_ivname' % disk_count,
2165 ('%s' % disk.iv_name))
2166 config.set(constants.INISECT_INS, 'disk%d_dump' % disk_count,
2167 ('%s' % disk.physical_id[1]))
2168 config.set(constants.INISECT_INS, 'disk%d_size' % disk_count,
2171 config.set(constants.INISECT_INS, 'disk_count' , '%d' % disk_total)
2173 # New-style hypervisor/backend parameters
2175 config.add_section(constants.INISECT_HYP)
2176 for name, value in instance.hvparams.items():
2177 if name not in constants.HVC_GLOBALS:
2178 config.set(constants.INISECT_HYP, name, str(value))
2180 config.add_section(constants.INISECT_BEP)
2181 for name, value in instance.beparams.items():
2182 config.set(constants.INISECT_BEP, name, str(value))
2184 config.add_section(constants.INISECT_OSP)
2185 for name, value in instance.osparams.items():
2186 config.set(constants.INISECT_OSP, name, str(value))
2188 utils.WriteFile(utils.PathJoin(destdir, constants.EXPORT_CONF_FILE),
2189 data=config.Dumps())
2190 shutil.rmtree(finaldestdir, ignore_errors=True)
2191 shutil.move(destdir, finaldestdir)
2194 def ExportInfo(dest):
2195 """Get export configuration information.
2198 @param dest: directory containing the export
2200 @rtype: L{objects.SerializableConfigParser}
2201 @return: a serializable config file containing the
2205 cff = utils.PathJoin(dest, constants.EXPORT_CONF_FILE)
2207 config = objects.SerializableConfigParser()
2210 if (not config.has_section(constants.INISECT_EXP) or
2211 not config.has_section(constants.INISECT_INS)):
2212 _Fail("Export info file doesn't have the required fields")
2214 return config.Dumps()
2218 """Return a list of exports currently available on this machine.
2221 @return: list of the exports
2224 if os.path.isdir(constants.EXPORT_DIR):
2225 return sorted(utils.ListVisibleFiles(constants.EXPORT_DIR))
2227 _Fail("No exports directory")
2230 def RemoveExport(export):
2231 """Remove an existing export from the node.
2234 @param export: the name of the export to remove
2238 target = utils.PathJoin(constants.EXPORT_DIR, export)
2241 shutil.rmtree(target)
2242 except EnvironmentError, err:
2243 _Fail("Error while removing the export: %s", err, exc=True)
2246 def BlockdevRename(devlist):
2247 """Rename a list of block devices.
2249 @type devlist: list of tuples
2250 @param devlist: list of tuples of the form (disk,
2251 new_logical_id, new_physical_id); disk is an
2252 L{objects.Disk} object describing the current disk,
2253 and new logical_id/physical_id is the name we
2256 @return: True if all renames succeeded, False otherwise
2261 for disk, unique_id in devlist:
2262 dev = _RecursiveFindBD(disk)
2264 msgs.append("Can't find device %s in rename" % str(disk))
2268 old_rpath = dev.dev_path
2269 dev.Rename(unique_id)
2270 new_rpath = dev.dev_path
2271 if old_rpath != new_rpath:
2272 DevCacheManager.RemoveCache(old_rpath)
2273 # FIXME: we should add the new cache information here, like:
2274 # DevCacheManager.UpdateCache(new_rpath, owner, ...)
2275 # but we don't have the owner here - maybe parse from existing
2276 # cache? for now, we only lose lvm data when we rename, which
2277 # is less critical than DRBD or MD
2278 except errors.BlockDeviceError, err:
2279 msgs.append("Can't rename device '%s' to '%s': %s" %
2280 (dev, unique_id, err))
2281 logging.exception("Can't rename device '%s' to '%s'", dev, unique_id)
2284 _Fail("; ".join(msgs))
2287 def _TransformFileStorageDir(file_storage_dir):
2288 """Checks whether given file_storage_dir is valid.
2290 Checks wheter the given file_storage_dir is within the cluster-wide
2291 default file_storage_dir stored in SimpleStore. Only paths under that
2292 directory are allowed.
2294 @type file_storage_dir: str
2295 @param file_storage_dir: the path to check
2297 @return: the normalized path if valid, None otherwise
2300 if not constants.ENABLE_FILE_STORAGE:
2301 _Fail("File storage disabled at configure time")
2303 file_storage_dir = os.path.normpath(file_storage_dir)
2304 base_file_storage_dir = cfg.GetFileStorageDir()
2305 if (os.path.commonprefix([file_storage_dir, base_file_storage_dir]) !=
2306 base_file_storage_dir):
2307 _Fail("File storage directory '%s' is not under base file"
2308 " storage directory '%s'", file_storage_dir, base_file_storage_dir)
2309 return file_storage_dir
2312 def CreateFileStorageDir(file_storage_dir):
2313 """Create file storage directory.
2315 @type file_storage_dir: str
2316 @param file_storage_dir: directory to create
2319 @return: tuple with first element a boolean indicating wheter dir
2320 creation was successful or not
2323 file_storage_dir = _TransformFileStorageDir(file_storage_dir)
2324 if os.path.exists(file_storage_dir):
2325 if not os.path.isdir(file_storage_dir):
2326 _Fail("Specified storage dir '%s' is not a directory",
2330 os.makedirs(file_storage_dir, 0750)
2331 except OSError, err:
2332 _Fail("Cannot create file storage directory '%s': %s",
2333 file_storage_dir, err, exc=True)
2336 def RemoveFileStorageDir(file_storage_dir):
2337 """Remove file storage directory.
2339 Remove it only if it's empty. If not log an error and return.
2341 @type file_storage_dir: str
2342 @param file_storage_dir: the directory we should cleanup
2343 @rtype: tuple (success,)
2344 @return: tuple of one element, C{success}, denoting
2345 whether the operation was successful
2348 file_storage_dir = _TransformFileStorageDir(file_storage_dir)
2349 if os.path.exists(file_storage_dir):
2350 if not os.path.isdir(file_storage_dir):
2351 _Fail("Specified Storage directory '%s' is not a directory",
2353 # deletes dir only if empty, otherwise we want to fail the rpc call
2355 os.rmdir(file_storage_dir)
2356 except OSError, err:
2357 _Fail("Cannot remove file storage directory '%s': %s",
2358 file_storage_dir, err)
2361 def RenameFileStorageDir(old_file_storage_dir, new_file_storage_dir):
2362 """Rename the file storage directory.
2364 @type old_file_storage_dir: str
2365 @param old_file_storage_dir: the current path
2366 @type new_file_storage_dir: str
2367 @param new_file_storage_dir: the name we should rename to
2368 @rtype: tuple (success,)
2369 @return: tuple of one element, C{success}, denoting
2370 whether the operation was successful
2373 old_file_storage_dir = _TransformFileStorageDir(old_file_storage_dir)
2374 new_file_storage_dir = _TransformFileStorageDir(new_file_storage_dir)
2375 if not os.path.exists(new_file_storage_dir):
2376 if os.path.isdir(old_file_storage_dir):
2378 os.rename(old_file_storage_dir, new_file_storage_dir)
2379 except OSError, err:
2380 _Fail("Cannot rename '%s' to '%s': %s",
2381 old_file_storage_dir, new_file_storage_dir, err)
2383 _Fail("Specified storage dir '%s' is not a directory",
2384 old_file_storage_dir)
2386 if os.path.exists(old_file_storage_dir):
2387 _Fail("Cannot rename '%s' to '%s': both locations exist",
2388 old_file_storage_dir, new_file_storage_dir)
2391 def _EnsureJobQueueFile(file_name):
2392 """Checks whether the given filename is in the queue directory.
2394 @type file_name: str
2395 @param file_name: the file name we should check
2397 @raises RPCFail: if the file is not valid
2400 queue_dir = os.path.normpath(constants.QUEUE_DIR)
2401 result = (os.path.commonprefix([queue_dir, file_name]) == queue_dir)
2404 _Fail("Passed job queue file '%s' does not belong to"
2405 " the queue directory '%s'", file_name, queue_dir)
2408 def JobQueueUpdate(file_name, content):
2409 """Updates a file in the queue directory.
2411 This is just a wrapper over L{utils.WriteFile}, with proper
2414 @type file_name: str
2415 @param file_name: the job file name
2417 @param content: the new job contents
2419 @return: the success of the operation
2422 _EnsureJobQueueFile(file_name)
2423 getents = runtime.GetEnts()
2425 # Write and replace the file atomically
2426 utils.WriteFile(file_name, data=_Decompress(content), uid=getents.masterd_uid,
2427 gid=getents.masterd_gid)
2430 def JobQueueRename(old, new):
2431 """Renames a job queue file.
2433 This is just a wrapper over os.rename with proper checking.
2436 @param old: the old (actual) file name
2438 @param new: the desired file name
2440 @return: the success of the operation and payload
2443 _EnsureJobQueueFile(old)
2444 _EnsureJobQueueFile(new)
2446 utils.RenameFile(old, new, mkdir=True)
2449 def BlockdevClose(instance_name, disks):
2450 """Closes the given block devices.
2452 This means they will be switched to secondary mode (in case of
2455 @param instance_name: if the argument is not empty, the symlinks
2456 of this instance will be removed
2457 @type disks: list of L{objects.Disk}
2458 @param disks: the list of disks to be closed
2459 @rtype: tuple (success, message)
2460 @return: a tuple of success and message, where success
2461 indicates the succes of the operation, and message
2462 which will contain the error details in case we
2468 rd = _RecursiveFindBD(cf)
2470 _Fail("Can't find device %s", cf)
2477 except errors.BlockDeviceError, err:
2478 msg.append(str(err))
2480 _Fail("Can't make devices secondary: %s", ",".join(msg))
2483 _RemoveBlockDevLinks(instance_name, disks)
2486 def ValidateHVParams(hvname, hvparams):
2487 """Validates the given hypervisor parameters.
2489 @type hvname: string
2490 @param hvname: the hypervisor name
2491 @type hvparams: dict
2492 @param hvparams: the hypervisor parameters to be validated
2497 hv_type = hypervisor.GetHypervisor(hvname)
2498 hv_type.ValidateParameters(hvparams)
2499 except errors.HypervisorError, err:
2500 _Fail(str(err), log=False)
2503 def _CheckOSPList(os_obj, parameters):
2504 """Check whether a list of parameters is supported by the OS.
2506 @type os_obj: L{objects.OS}
2507 @param os_obj: OS object to check
2508 @type parameters: list
2509 @param parameters: the list of parameters to check
2512 supported = [v[0] for v in os_obj.supported_parameters]
2513 delta = frozenset(parameters).difference(supported)
2515 _Fail("The following parameters are not supported"
2516 " by the OS %s: %s" % (os_obj.name, utils.CommaJoin(delta)))
2519 def ValidateOS(required, osname, checks, osparams):
2520 """Validate the given OS' parameters.
2522 @type required: boolean
2523 @param required: whether absence of the OS should translate into
2525 @type osname: string
2526 @param osname: the OS to be validated
2528 @param checks: list of the checks to run (currently only 'parameters')
2529 @type osparams: dict
2530 @param osparams: dictionary with OS parameters
2532 @return: True if the validation passed, or False if the OS was not
2533 found and L{required} was false
2536 if not constants.OS_VALIDATE_CALLS.issuperset(checks):
2537 _Fail("Unknown checks required for OS %s: %s", osname,
2538 set(checks).difference(constants.OS_VALIDATE_CALLS))
2540 name_only = objects.OS.GetName(osname)
2541 status, tbv = _TryOSFromDisk(name_only, None)
2549 if max(tbv.api_versions) < constants.OS_API_V20:
2552 if constants.OS_VALIDATE_PARAMETERS in checks:
2553 _CheckOSPList(tbv, osparams.keys())
2555 validate_env = OSCoreEnv(osname, tbv, osparams)
2556 result = utils.RunCmd([tbv.verify_script] + checks, env=validate_env,
2559 logging.error("os validate command '%s' returned error: %s output: %s",
2560 result.cmd, result.fail_reason, result.output)
2561 _Fail("OS validation script failed (%s), output: %s",
2562 result.fail_reason, result.output, log=False)
2568 """Demotes the current node from master candidate role.
2571 # try to ensure we're not the master by mistake
2572 master, myself = ssconf.GetMasterAndMyself()
2573 if master == myself:
2574 _Fail("ssconf status shows I'm the master node, will not demote")
2576 result = utils.RunCmd([constants.DAEMON_UTIL, "check", constants.MASTERD])
2577 if not result.failed:
2578 _Fail("The master daemon is running, will not demote")
2581 if os.path.isfile(constants.CLUSTER_CONF_FILE):
2582 utils.CreateBackup(constants.CLUSTER_CONF_FILE)
2583 except EnvironmentError, err:
2584 if err.errno != errno.ENOENT:
2585 _Fail("Error while backing up cluster file: %s", err, exc=True)
2587 utils.RemoveFile(constants.CLUSTER_CONF_FILE)
2590 def _GetX509Filenames(cryptodir, name):
2591 """Returns the full paths for the private key and certificate.
2594 return (utils.PathJoin(cryptodir, name),
2595 utils.PathJoin(cryptodir, name, _X509_KEY_FILE),
2596 utils.PathJoin(cryptodir, name, _X509_CERT_FILE))
2599 def CreateX509Certificate(validity, cryptodir=constants.CRYPTO_KEYS_DIR):
2600 """Creates a new X509 certificate for SSL/TLS.
2603 @param validity: Validity in seconds
2604 @rtype: tuple; (string, string)
2605 @return: Certificate name and public part
2608 (key_pem, cert_pem) = \
2609 utils.GenerateSelfSignedX509Cert(netutils.Hostname.GetSysName(),
2610 min(validity, _MAX_SSL_CERT_VALIDITY))
2612 cert_dir = tempfile.mkdtemp(dir=cryptodir,
2613 prefix="x509-%s-" % utils.TimestampForFilename())
2615 name = os.path.basename(cert_dir)
2616 assert len(name) > 5
2618 (_, key_file, cert_file) = _GetX509Filenames(cryptodir, name)
2620 utils.WriteFile(key_file, mode=0400, data=key_pem)
2621 utils.WriteFile(cert_file, mode=0400, data=cert_pem)
2623 # Never return private key as it shouldn't leave the node
2624 return (name, cert_pem)
2626 shutil.rmtree(cert_dir, ignore_errors=True)
2630 def RemoveX509Certificate(name, cryptodir=constants.CRYPTO_KEYS_DIR):
2631 """Removes a X509 certificate.
2634 @param name: Certificate name
2637 (cert_dir, key_file, cert_file) = _GetX509Filenames(cryptodir, name)
2639 utils.RemoveFile(key_file)
2640 utils.RemoveFile(cert_file)
2644 except EnvironmentError, err:
2645 _Fail("Cannot remove certificate directory '%s': %s",
2649 def _GetImportExportIoCommand(instance, mode, ieio, ieargs):
2650 """Returns the command for the requested input/output.
2652 @type instance: L{objects.Instance}
2653 @param instance: The instance object
2654 @param mode: Import/export mode
2655 @param ieio: Input/output type
2656 @param ieargs: Input/output arguments
2659 assert mode in (constants.IEM_IMPORT, constants.IEM_EXPORT)
2666 if ieio == constants.IEIO_FILE:
2667 (filename, ) = ieargs
2669 if not utils.IsNormAbsPath(filename):
2670 _Fail("Path '%s' is not normalized or absolute", filename)
2672 directory = os.path.normpath(os.path.dirname(filename))
2674 if (os.path.commonprefix([constants.EXPORT_DIR, directory]) !=
2675 constants.EXPORT_DIR):
2676 _Fail("File '%s' is not under exports directory '%s'",
2677 filename, constants.EXPORT_DIR)
2680 utils.Makedirs(directory, mode=0750)
2682 quoted_filename = utils.ShellQuote(filename)
2684 if mode == constants.IEM_IMPORT:
2685 suffix = "> %s" % quoted_filename
2686 elif mode == constants.IEM_EXPORT:
2687 suffix = "< %s" % quoted_filename
2689 # Retrieve file size
2691 st = os.stat(filename)
2692 except EnvironmentError, err:
2693 logging.error("Can't stat(2) %s: %s", filename, err)
2695 exp_size = utils.BytesToMebibyte(st.st_size)
2697 elif ieio == constants.IEIO_RAW_DISK:
2700 real_disk = _OpenRealBD(disk)
2702 if mode == constants.IEM_IMPORT:
2703 # we set here a smaller block size as, due to transport buffering, more
2704 # than 64-128k will mostly ignored; we use nocreat to fail if the device
2705 # is not already there or we pass a wrong path; we use notrunc to no
2706 # attempt truncate on an LV device; we use oflag=dsync to not buffer too
2707 # much memory; this means that at best, we flush every 64k, which will
2709 suffix = utils.BuildShellCmd(("| dd of=%s conv=nocreat,notrunc"
2710 " bs=%s oflag=dsync"),
2714 elif mode == constants.IEM_EXPORT:
2715 # the block size on the read dd is 1MiB to match our units
2716 prefix = utils.BuildShellCmd("dd if=%s bs=%s count=%s |",
2718 str(1024 * 1024), # 1 MB
2720 exp_size = disk.size
2722 elif ieio == constants.IEIO_SCRIPT:
2723 (disk, disk_index, ) = ieargs
2725 assert isinstance(disk_index, (int, long))
2727 real_disk = _OpenRealBD(disk)
2729 inst_os = OSFromDisk(instance.os)
2730 env = OSEnvironment(instance, inst_os)
2732 if mode == constants.IEM_IMPORT:
2733 env["IMPORT_DEVICE"] = env["DISK_%d_PATH" % disk_index]
2734 env["IMPORT_INDEX"] = str(disk_index)
2735 script = inst_os.import_script
2737 elif mode == constants.IEM_EXPORT:
2738 env["EXPORT_DEVICE"] = real_disk.dev_path
2739 env["EXPORT_INDEX"] = str(disk_index)
2740 script = inst_os.export_script
2742 # TODO: Pass special environment only to script
2743 script_cmd = utils.BuildShellCmd("( cd %s && %s; )", inst_os.path, script)
2745 if mode == constants.IEM_IMPORT:
2746 suffix = "| %s" % script_cmd
2748 elif mode == constants.IEM_EXPORT:
2749 prefix = "%s |" % script_cmd
2751 # Let script predict size
2752 exp_size = constants.IE_CUSTOM_SIZE
2755 _Fail("Invalid %s I/O mode %r", mode, ieio)
2757 return (env, prefix, suffix, exp_size)
2760 def _CreateImportExportStatusDir(prefix):
2761 """Creates status directory for import/export.
2764 return tempfile.mkdtemp(dir=constants.IMPORT_EXPORT_DIR,
2766 (prefix, utils.TimestampForFilename())))
2769 def StartImportExportDaemon(mode, opts, host, port, instance, ieio, ieioargs):
2770 """Starts an import or export daemon.
2772 @param mode: Import/output mode
2773 @type opts: L{objects.ImportExportOptions}
2774 @param opts: Daemon options
2776 @param host: Remote host for export (None for import)
2778 @param port: Remote port for export (None for import)
2779 @type instance: L{objects.Instance}
2780 @param instance: Instance object
2781 @param ieio: Input/output type
2782 @param ieioargs: Input/output arguments
2785 if mode == constants.IEM_IMPORT:
2788 if not (host is None and port is None):
2789 _Fail("Can not specify host or port on import")
2791 elif mode == constants.IEM_EXPORT:
2794 if host is None or port is None:
2795 _Fail("Host and port must be specified for an export")
2798 _Fail("Invalid mode %r", mode)
2800 if (opts.key_name is None) ^ (opts.ca_pem is None):
2801 _Fail("Cluster certificate can only be used for both key and CA")
2803 (cmd_env, cmd_prefix, cmd_suffix, exp_size) = \
2804 _GetImportExportIoCommand(instance, mode, ieio, ieioargs)
2806 if opts.key_name is None:
2808 key_path = constants.NODED_CERT_FILE
2809 cert_path = constants.NODED_CERT_FILE
2810 assert opts.ca_pem is None
2812 (_, key_path, cert_path) = _GetX509Filenames(constants.CRYPTO_KEYS_DIR,
2814 assert opts.ca_pem is not None
2816 for i in [key_path, cert_path]:
2817 if not os.path.exists(i):
2818 _Fail("File '%s' does not exist" % i)
2820 status_dir = _CreateImportExportStatusDir(prefix)
2822 status_file = utils.PathJoin(status_dir, _IES_STATUS_FILE)
2823 pid_file = utils.PathJoin(status_dir, _IES_PID_FILE)
2824 ca_file = utils.PathJoin(status_dir, _IES_CA_FILE)
2826 if opts.ca_pem is None:
2828 ca = utils.ReadFile(constants.NODED_CERT_FILE)
2833 utils.WriteFile(ca_file, data=ca, mode=0400)
2836 constants.IMPORT_EXPORT_DAEMON,
2838 "--key=%s" % key_path,
2839 "--cert=%s" % cert_path,
2840 "--ca=%s" % ca_file,
2844 cmd.append("--host=%s" % host)
2847 cmd.append("--port=%s" % port)
2850 cmd.append("--compress=%s" % opts.compress)
2853 cmd.append("--magic=%s" % opts.magic)
2855 if exp_size is not None:
2856 cmd.append("--expected-size=%s" % exp_size)
2859 cmd.append("--cmd-prefix=%s" % cmd_prefix)
2862 cmd.append("--cmd-suffix=%s" % cmd_suffix)
2864 logfile = _InstanceLogName(prefix, instance.os, instance.name)
2866 # TODO: Once _InstanceLogName uses tempfile.mkstemp, StartDaemon has
2867 # support for receiving a file descriptor for output
2868 utils.StartDaemon(cmd, env=cmd_env, pidfile=pid_file,
2871 # The import/export name is simply the status directory name
2872 return os.path.basename(status_dir)
2875 shutil.rmtree(status_dir, ignore_errors=True)
2879 def GetImportExportStatus(names):
2880 """Returns import/export daemon status.
2882 @type names: sequence
2883 @param names: List of names
2884 @rtype: List of dicts
2885 @return: Returns a list of the state of each named import/export or None if a
2886 status couldn't be read
2892 status_file = utils.PathJoin(constants.IMPORT_EXPORT_DIR, name,
2896 data = utils.ReadFile(status_file)
2897 except EnvironmentError, err:
2898 if err.errno != errno.ENOENT:
2906 result.append(serializer.LoadJson(data))
2911 def AbortImportExport(name):
2912 """Sends SIGTERM to a running import/export daemon.
2915 logging.info("Abort import/export %s", name)
2917 status_dir = utils.PathJoin(constants.IMPORT_EXPORT_DIR, name)
2918 pid = utils.ReadLockedPidFile(utils.PathJoin(status_dir, _IES_PID_FILE))
2921 logging.info("Import/export %s is running with PID %s, sending SIGTERM",
2923 utils.IgnoreProcessNotFound(os.kill, pid, signal.SIGTERM)
2926 def CleanupImportExport(name):
2927 """Cleanup after an import or export.
2929 If the import/export daemon is still running it's killed. Afterwards the
2930 whole status directory is removed.
2933 logging.info("Finalizing import/export %s", name)
2935 status_dir = utils.PathJoin(constants.IMPORT_EXPORT_DIR, name)
2937 pid = utils.ReadLockedPidFile(utils.PathJoin(status_dir, _IES_PID_FILE))
2940 logging.info("Import/export %s is still running with PID %s",
2942 utils.KillProcess(pid, waitpid=False)
2944 shutil.rmtree(status_dir, ignore_errors=True)
2947 def _FindDisks(nodes_ip, disks):
2948 """Sets the physical ID on disks and returns the block devices.
2951 # set the correct physical ID
2952 my_name = netutils.Hostname.GetSysName()
2954 cf.SetPhysicalID(my_name, nodes_ip)
2959 rd = _RecursiveFindBD(cf)
2961 _Fail("Can't find device %s", cf)
2966 def DrbdDisconnectNet(nodes_ip, disks):
2967 """Disconnects the network on a list of drbd devices.
2970 bdevs = _FindDisks(nodes_ip, disks)
2976 except errors.BlockDeviceError, err:
2977 _Fail("Can't change network configuration to standalone mode: %s",
2981 def DrbdAttachNet(nodes_ip, disks, instance_name, multimaster):
2982 """Attaches the network on a list of drbd devices.
2985 bdevs = _FindDisks(nodes_ip, disks)
2988 for idx, rd in enumerate(bdevs):
2990 _SymlinkBlockDev(instance_name, rd.dev_path, idx)
2991 except EnvironmentError, err:
2992 _Fail("Can't create symlink: %s", err)
2993 # reconnect disks, switch to new master configuration and if
2994 # needed primary mode
2997 rd.AttachNet(multimaster)
2998 except errors.BlockDeviceError, err:
2999 _Fail("Can't change network configuration: %s", err)
3001 # wait until the disks are connected; we need to retry the re-attach
3002 # if the device becomes standalone, as this might happen if the one
3003 # node disconnects and reconnects in a different mode before the
3004 # other node reconnects; in this case, one or both of the nodes will
3005 # decide it has wrong configuration and switch to standalone
3008 all_connected = True
3011 stats = rd.GetProcStatus()
3013 all_connected = (all_connected and
3014 (stats.is_connected or stats.is_in_resync))
3016 if stats.is_standalone:
3017 # peer had different config info and this node became
3018 # standalone, even though this should not happen with the
3019 # new staged way of changing disk configs
3021 rd.AttachNet(multimaster)
3022 except errors.BlockDeviceError, err:
3023 _Fail("Can't change network configuration: %s", err)
3025 if not all_connected:
3026 raise utils.RetryAgain()
3029 # Start with a delay of 100 miliseconds and go up to 5 seconds
3030 utils.Retry(_Attach, (0.1, 1.5, 5.0), 2 * 60)
3031 except utils.RetryTimeout:
3032 _Fail("Timeout in disk reconnecting")
3035 # change to primary mode
3039 except errors.BlockDeviceError, err:
3040 _Fail("Can't change to primary mode: %s", err)
3043 def DrbdWaitSync(nodes_ip, disks):
3044 """Wait until DRBDs have synchronized.
3048 stats = rd.GetProcStatus()
3049 if not (stats.is_connected or stats.is_in_resync):
3050 raise utils.RetryAgain()
3053 bdevs = _FindDisks(nodes_ip, disks)
3059 # poll each second for 15 seconds
3060 stats = utils.Retry(_helper, 1, 15, args=[rd])
3061 except utils.RetryTimeout:
3062 stats = rd.GetProcStatus()
3064 if not (stats.is_connected or stats.is_in_resync):
3065 _Fail("DRBD device %s is not in sync: stats=%s", rd, stats)
3066 alldone = alldone and (not stats.is_in_resync)
3067 if stats.sync_percent is not None:
3068 min_resync = min(min_resync, stats.sync_percent)
3070 return (alldone, min_resync)
3073 def GetDrbdUsermodeHelper():
3074 """Returns DRBD usermode helper currently configured.
3078 return bdev.BaseDRBD.GetUsermodeHelper()
3079 except errors.BlockDeviceError, err:
3083 def PowercycleNode(hypervisor_type):
3084 """Hard-powercycle the node.
3086 Because we need to return first, and schedule the powercycle in the
3087 background, we won't be able to report failures nicely.
3090 hyper = hypervisor.GetHypervisor(hypervisor_type)
3094 # if we can't fork, we'll pretend that we're in the child process
3097 return "Reboot scheduled in 5 seconds"
3098 # ensure the child is running on ram
3101 except Exception: # pylint: disable-msg=W0703
3104 hyper.PowercycleNode()
3107 class HooksRunner(object):
3110 This class is instantiated on the node side (ganeti-noded) and not
3114 def __init__(self, hooks_base_dir=None):
3115 """Constructor for hooks runner.
3117 @type hooks_base_dir: str or None
3118 @param hooks_base_dir: if not None, this overrides the
3119 L{constants.HOOKS_BASE_DIR} (useful for unittests)
3122 if hooks_base_dir is None:
3123 hooks_base_dir = constants.HOOKS_BASE_DIR
3124 # yeah, _BASE_DIR is not valid for attributes, we use it like a
3126 self._BASE_DIR = hooks_base_dir # pylint: disable-msg=C0103
3128 def RunHooks(self, hpath, phase, env):
3129 """Run the scripts in the hooks directory.
3132 @param hpath: the path to the hooks directory which
3135 @param phase: either L{constants.HOOKS_PHASE_PRE} or
3136 L{constants.HOOKS_PHASE_POST}
3138 @param env: dictionary with the environment for the hook
3140 @return: list of 3-element tuples:
3142 - script result, either L{constants.HKR_SUCCESS} or
3143 L{constants.HKR_FAIL}
3144 - output of the script
3146 @raise errors.ProgrammerError: for invalid input
3150 if phase == constants.HOOKS_PHASE_PRE:
3152 elif phase == constants.HOOKS_PHASE_POST:
3155 _Fail("Unknown hooks phase '%s'", phase)
3158 subdir = "%s-%s.d" % (hpath, suffix)
3159 dir_name = utils.PathJoin(self._BASE_DIR, subdir)
3163 if not os.path.isdir(dir_name):
3164 # for non-existing/non-dirs, we simply exit instead of logging a
3165 # warning at every operation
3168 runparts_results = utils.RunParts(dir_name, env=env, reset_env=True)
3170 for (relname, relstatus, runresult) in runparts_results:
3171 if relstatus == constants.RUNPARTS_SKIP:
3172 rrval = constants.HKR_SKIP
3174 elif relstatus == constants.RUNPARTS_ERR:
3175 rrval = constants.HKR_FAIL
3176 output = "Hook script execution error: %s" % runresult
3177 elif relstatus == constants.RUNPARTS_RUN:
3178 if runresult.failed:
3179 rrval = constants.HKR_FAIL
3181 rrval = constants.HKR_SUCCESS
3182 output = utils.SafeEncode(runresult.output.strip())
3183 results.append(("%s/%s" % (subdir, relname), rrval, output))
3188 class IAllocatorRunner(object):
3189 """IAllocator runner.
3191 This class is instantiated on the node side (ganeti-noded) and not on
3196 def Run(name, idata):
3197 """Run an iallocator script.
3200 @param name: the iallocator script name
3202 @param idata: the allocator input data
3205 @return: two element tuple of:
3207 - either error message or stdout of allocator (for success)
3210 alloc_script = utils.FindFile(name, constants.IALLOCATOR_SEARCH_PATH,
3212 if alloc_script is None:
3213 _Fail("iallocator module '%s' not found in the search path", name)
3215 fd, fin_name = tempfile.mkstemp(prefix="ganeti-iallocator.")
3219 result = utils.RunCmd([alloc_script, fin_name])
3221 _Fail("iallocator module '%s' failed: %s, output '%s'",
3222 name, result.fail_reason, result.output)
3226 return result.stdout
3229 class DevCacheManager(object):
3230 """Simple class for managing a cache of block device information.
3233 _DEV_PREFIX = "/dev/"
3234 _ROOT_DIR = constants.BDEV_CACHE_DIR
3237 def _ConvertPath(cls, dev_path):
3238 """Converts a /dev/name path to the cache file name.
3240 This replaces slashes with underscores and strips the /dev
3241 prefix. It then returns the full path to the cache file.
3244 @param dev_path: the C{/dev/} path name
3246 @return: the converted path name
3249 if dev_path.startswith(cls._DEV_PREFIX):
3250 dev_path = dev_path[len(cls._DEV_PREFIX):]
3251 dev_path = dev_path.replace("/", "_")
3252 fpath = utils.PathJoin(cls._ROOT_DIR, "bdev_%s" % dev_path)
3256 def UpdateCache(cls, dev_path, owner, on_primary, iv_name):
3257 """Updates the cache information for a given device.
3260 @param dev_path: the pathname of the device
3262 @param owner: the owner (instance name) of the device
3263 @type on_primary: bool
3264 @param on_primary: whether this is the primary
3267 @param iv_name: the instance-visible name of the
3268 device, as in objects.Disk.iv_name
3273 if dev_path is None:
3274 logging.error("DevCacheManager.UpdateCache got a None dev_path")
3276 fpath = cls._ConvertPath(dev_path)
3282 iv_name = "not_visible"
3283 fdata = "%s %s %s\n" % (str(owner), state, iv_name)
3285 utils.WriteFile(fpath, data=fdata)
3286 except EnvironmentError, err:
3287 logging.exception("Can't update bdev cache for %s: %s", dev_path, err)
3290 def RemoveCache(cls, dev_path):
3291 """Remove data for a dev_path.
3293 This is just a wrapper over L{utils.RemoveFile} with a converted
3294 path name and logging.
3297 @param dev_path: the pathname of the device
3302 if dev_path is None:
3303 logging.error("DevCacheManager.RemoveCache got a None dev_path")
3305 fpath = cls._ConvertPath(dev_path)
3307 utils.RemoveFile(fpath)
3308 except EnvironmentError, err:
3309 logging.exception("Can't update bdev cache for %s: %s", dev_path, err)