import random
import logging
import tempfile
+import zlib
+import base64
from ganeti import errors
from ganeti import utils
def _GetConfig():
- return ssconf.SimpleConfigReader()
+ """Simple wrapper to return a SimpleStore.
+
+ @rtype: L{ssconf.SimpleStore}
+ @return: a SimpleStore instance
+
+ """
+ return ssconf.SimpleStore()
def _GetSshRunner(cluster_name):
+ """Simple wrapper to return an SshRunner.
+
+ @type cluster_name: str
+ @param cluster_name: the cluster name, which is needed
+ by the SshRunner constructor
+ @rtype: L{ssh.SshRunner}
+ @return: an SshRunner instance
+
+ """
return ssh.SshRunner(cluster_name)
-def _CleanDirectory(path, exclude=[]):
+def _Decompress(data):
+ """Unpacks data compressed by the RPC client.
+
+ @type data: list or tuple
+ @param data: Data sent by RPC client
+ @rtype: str
+ @return: Decompressed data
+
+ """
+ assert isinstance(data, (list, tuple))
+ assert len(data) == 2
+ (encoding, content) = data
+ if encoding == constants.RPC_ENCODING_NONE:
+ return content
+ elif encoding == constants.RPC_ENCODING_ZLIB_BASE64:
+ return zlib.decompress(base64.b64decode(content))
+ else:
+ raise AssertionError("Unknown data encoding")
+
+
+def _CleanDirectory(path, exclude=None):
"""Removes all regular files in a directory.
- @param exclude: List of files to be excluded.
+ @type path: str
+ @param path: the directory to clean
@type exclude: list
+ @param exclude: list of files to be excluded, defaults
+ to the empty list
"""
if not os.path.isdir(path):
return
-
- # Normalize excluded paths
- exclude = [os.path.normpath(i) for i in exclude]
+ if exclude is None:
+ exclude = []
+ else:
+ # Normalize excluded paths
+ 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))
def JobQueuePurge():
- """Removes job queue files and archived jobs
+ """Removes job queue files and archived jobs.
+
+ @rtype: None
"""
_CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
for consumption here or from the node daemon.
@rtype: tuple
- @return: (master_netdev, master_ip, master_name)
+ @return: (master_netdev, master_ip, master_name) if we have a good
+ configuration, otherwise (None, None, None)
"""
try:
master_node = cfg.GetMasterNode()
except errors.ConfigurationError, err:
logging.exception("Cluster configuration incomplete")
- return (None, None)
+ return (None, None, None)
return (master_netdev, master_ip, master_node)
"""Activate local node as master node.
The function will always try activate the IP address of the master
- (if someone else has it, then it won't). Then, if the start_daemons
- parameter is True, it will also start the master daemons
- (ganet-masterd and ganeti-rapi).
+ (unless someone else has it). It will also start the master daemons,
+ based on the start_daemons parameter.
+
+ @type start_daemons: boolean
+ @param start_daemons: whther to also start the master
+ daemons (ganeti-masterd and ganeti-rapi)
+ @rtype: None
"""
ok = True
"""Deactivate this node as master.
The function will always try to deactivate the IP address of the
- master. Then, if the stop_daemons parameter is True, it will also
- stop the master daemons (ganet-masterd and ganeti-rapi).
+ master. It will also stop the master daemons depending on the
+ stop_daemons parameter.
+
+ @type stop_daemons: boolean
+ @param stop_daemons: whether to also stop the master daemons
+ (ganeti-masterd and ganeti-rapi)
+ @rtype: None
"""
master_netdev, master_ip, _ = GetMasterInfo()
- adds the ssh private key to the user
- adds the ssh public key to the users' authorized_keys file
+ @type dsa: str
+ @param dsa: the DSA private key to write
+ @type dsapub: str
+ @param dsapub: the DSA public key to write
+ @type rsa: str
+ @param rsa: the RSA private key to write
+ @type rsapub: str
+ @param rsapub: the RSA public key to write
+ @type sshkey: str
+ @param sshkey: the SSH private key to write
+ @type sshpub: str
+ @param sshpub: the SSH public key to write
+ @rtype: boolean
+ @return: the success of the operation
+
"""
sshd_keys = [(constants.SSH_HOST_RSA_PRIV, rsa, 0600),
(constants.SSH_HOST_RSA_PUB, rsapub, 0644),
def LeaveCluster():
- """Cleans up the current node and prepares it to be removed from the cluster.
+ """Cleans up and remove the current node.
+
+ This function cleans up and prepares the current node to be removed
+ from the cluster.
+
+ If processing is successful, then it raises an
+ L{errors.QuitGanetiException} which is used as a special case to
+ shutdown the node daemon.
"""
_CleanDirectory(constants.DATA_DIR)
- node-net-test: list of nodes we should check node daemon port
connectivity with
- hypervisor: list with hypervisors to run the verify for
+ @rtype: dict
+ @return: a dictionary with the same keys as the input dict, and
+ values representing the result of the checks
"""
result = {}
- if 'hypervisor' in what:
- result['hypervisor'] = my_dict = {}
- for hv_name in what['hypervisor']:
- my_dict[hv_name] = hypervisor.GetHypervisor(hv_name).Verify()
+ if constants.NV_HYPERVISOR in what:
+ result[constants.NV_HYPERVISOR] = tmp = {}
+ for hv_name in what[constants.NV_HYPERVISOR]:
+ tmp[hv_name] = hypervisor.GetHypervisor(hv_name).Verify()
- if 'filelist' in what:
- result['filelist'] = utils.FingerprintFiles(what['filelist'])
+ if constants.NV_FILELIST in what:
+ result[constants.NV_FILELIST] = utils.FingerprintFiles(
+ what[constants.NV_FILELIST])
- if 'nodelist' in what:
- result['nodelist'] = {}
- random.shuffle(what['nodelist'])
- for node in what['nodelist']:
+ if constants.NV_NODELIST in what:
+ result[constants.NV_NODELIST] = tmp = {}
+ random.shuffle(what[constants.NV_NODELIST])
+ for node in what[constants.NV_NODELIST]:
success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
if not success:
- result['nodelist'][node] = message
- if 'node-net-test' in what:
- result['node-net-test'] = {}
+ tmp[node] = message
+
+ if constants.NV_NODENETTEST in what:
+ result[constants.NV_NODENETTEST] = tmp = {}
my_name = utils.HostInfo().name
my_pip = my_sip = None
- for name, pip, sip in what['node-net-test']:
+ for name, pip, sip in what[constants.NV_NODENETTEST]:
if name == my_name:
my_pip = pip
my_sip = sip
break
if not my_pip:
- result['node-net-test'][my_name] = ("Can't find my own"
- " primary/secondary IP"
- " in the node list")
+ tmp[my_name] = ("Can't find my own primary/secondary IP"
+ " in the node list")
else:
port = utils.GetNodeDaemonPort()
- for name, pip, sip in what['node-net-test']:
+ for name, pip, sip in what[constants.NV_NODENETTEST]:
fail = []
if not utils.TcpPing(pip, port, source=my_pip):
fail.append("primary")
if not utils.TcpPing(sip, port, source=my_sip):
fail.append("secondary")
if fail:
- result['node-net-test'][name] = ("failure using the %s"
- " interface(s)" %
- " and ".join(fail))
+ tmp[name] = ("failure using the %s interface(s)" %
+ " and ".join(fail))
+
+ if constants.NV_LVLIST in what:
+ result[constants.NV_LVLIST] = GetVolumeList(what[constants.NV_LVLIST])
+
+ if constants.NV_INSTANCELIST in what:
+ result[constants.NV_INSTANCELIST] = GetInstanceList(
+ what[constants.NV_INSTANCELIST])
+
+ if constants.NV_VGLIST in what:
+ result[constants.NV_VGLIST] = ListVolumeGroups()
+
+ if constants.NV_VERSION in what:
+ result[constants.NV_VERSION] = constants.PROTOCOL_VERSION
+
+ if constants.NV_HVINFO in what:
+ hyper = hypervisor.GetHypervisor(what[constants.NV_HVINFO])
+ result[constants.NV_HVINFO] = hyper.GetNodeInfo()
return result
def GetVolumeList(vg_name):
"""Compute list of logical volumes and their size.
- Returns:
- dictionary of all partions (key) with their size (in MiB), inactive
- and online status:
- {'test1': ('20.06', True, True)}
+ @type vg_name: str
+ @param vg_name: the volume group whose LVs we should list
+ @rtype: dict
+ @return:
+ dictionary of all partions (key) with value being a tuple of
+ their size (in MiB), inactive and online status::
+
+ {'test1': ('20.06', True, True)}
+
+ in case of errors, a string is returned with the error
+ details.
"""
lvs = {}
def ListVolumeGroups():
"""List the volume groups and their size.
- Returns:
- Dictionary with keys volume name and values the size of the volume
+ @rtype: dict
+ @return: dictionary with keys volume name and values the
+ size of the volume
"""
return utils.ListVolumeGroups()
def NodeVolumes():
"""List all volumes on this node.
+ @rtype: list
+ @return:
+ A list of dictionaries, each having four keys:
+ - name: the logical volume name,
+ - size: the size of the logical volume
+ - dev: the physical device on which the LV lives
+ - vg: the volume group to which it belongs
+
+ In case of errors, we return an empty list and log the
+ error.
+
+ Note that since a logical volume can live on multiple physical
+ volumes, the resulting list might include a logical volume
+ multiple times.
+
"""
result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
"--separator=|",
if result.failed:
logging.error("Failed to list logical volumes, lvs output: %s",
result.output)
- return {}
+ return []
def parse_dev(dev):
if '(' in dev:
def BridgesExist(bridges_list):
"""Check if a list of bridges exist on the current node.
- Returns:
- True if all of them exist, false otherwise
+ @rtype: boolean
+ @return: C{True} if all of them exist, C{False} otherwise
"""
for bridge in bridges_list:
@rtype: list
@return: a list of all running instances on the current node
- - instance1.example.com
- - instance2.example.com
+ - instance1.example.com
+ - instance2.example.com
"""
results = []
def GetAllInstancesInfo(hypervisor_list):
"""Gather data about all instances.
- This is the equivalent of `GetInstanceInfo()`, except that it
+ This is the equivalent of L{GetInstanceInfo}, except that it
computes data for all instances at once, thus being faster if one
needs data about more than one instance.
@type hypervisor_list: list
@param hypervisor_list: list of hypervisors to query for instance data
- @rtype: dict of dicts
+ @rtype: dict
@return: dictionary of instance: data, with data having the following keys:
- memory: memory size of instance (int)
- state: xen state of instance (string)
- time: cpu time of instance (float)
- - vcpuus: the number of vcpus
+ - vcpus: the number of vcpus
"""
output = {}
@type instance: L{objects.Instance}
@param instance: Instance whose OS is to be installed
+ @rtype: boolean
+ @return: the success of the operation
"""
inst_os = OSFromDisk(instance.os)
- create_script = inst_os.create_script
create_env = OSEnvironment(instance)
logfile = "%s/add-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
instance.name, int(time.time()))
- if not os.path.exists(constants.LOG_OS_DIR):
- os.mkdir(constants.LOG_OS_DIR, 0750)
-
- command = utils.BuildShellCmd("cd %s && %s &>%s",
- inst_os.path, create_script, logfile)
- result = utils.RunCmd(command, env=create_env)
+ result = utils.RunCmd([inst_os.create_script], env=create_env,
+ cwd=inst_os.path, output=logfile,)
if result.failed:
logging.error("os create command '%s' returned error: %s, logfile: %s,"
- " output: %s", command, result.fail_reason, logfile,
+ " output: %s", result.cmd, result.fail_reason, logfile,
result.output)
return False
def RunRenameInstance(instance, old_name):
"""Run the OS rename script for an instance.
- @type instance: objects.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
+ @rtype: boolean
+ @return: the success of the operation
"""
inst_os = OSFromDisk(instance.os)
- script = inst_os.rename_script
rename_env = OSEnvironment(instance)
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()))
- if not os.path.exists(constants.LOG_OS_DIR):
- os.mkdir(constants.LOG_OS_DIR, 0750)
- command = utils.BuildShellCmd("cd %s && %s &>%s",
- inst_os.path, script, logfile)
-
- result = utils.RunCmd(command, env=rename_env)
+ result = utils.RunCmd([inst_os.rename_script], env=rename_env,
+ cwd=inst_os.path, output=logfile)
if result.failed:
logging.error("os create command '%s' returned error: %s output: %s",
- command, result.fail_reason, result.output)
+ result.cmd, result.fail_reason, result.output)
return False
return True
def _GetVGInfo(vg_name):
"""Get informations about the volume group.
- Args:
- vg_name: the volume group
-
- Returns:
- { 'vg_size' : xxx, 'vg_free' : xxx, 'pv_count' : xxx }
- where
- vg_size is the total size of the volume group in MiB
- vg_free is the free size of the volume group in MiB
- pv_count are the number of physical disks in that vg
+ @type vg_name: str
+ @param vg_name: the volume group which we query
+ @rtype: dict
+ @return:
+ A dictionary with the following keys:
+ - C{vg_size} is the total size of the volume group in MiB
+ - C{vg_free} is the free size of the volume group in MiB
+ - C{pv_count} are the number of physical disks in that VG
- If an error occurs during gathering of data, we return the same dict
- with keys all set to None.
+ If an error occurs during gathering of data, we return the same dict
+ with keys all set to None.
"""
retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])
return retdic
-def _GatherBlockDevs(instance):
+def _SymlinkBlockDev(instance_name, device_path, device_name):
+ """Set up symlinks to a instance's block device.
+
+ This is an auxiliary function run when an instance is start (on the primary
+ node) or when an instance is migrated (on the target node).
+
+ Args:
+ instance_name: the name of the target instance
+ device_path: path of the physical block device, on the node
+ device_name: 'virtual' name of the device
+
+ Returns:
+ absolute path to the disk's symlink
+
+ """
+ link_basename = "%s-%s" % (instance_name, device_name)
+ link_name = os.path.join(constants.DISK_LINKS_DIR, link_basename)
+ try:
+ os.symlink(device_path, link_name)
+ except OSError, e:
+ if e.errno == errno.EEXIST:
+ if (not os.path.islink(link_name) or
+ os.readlink(link_name) != device_path):
+ os.remove(link_name)
+ os.symlink(device_path, link_name)
+ else:
+ raise
+
+ return link_name
+
+
+def _GatherAndLinkBlockDevs(instance):
"""Set up an instance's block device(s).
This is run on the primary node at instance startup. The block
devices must be already assembled.
+ @type instance: L{objects.Instance}
+ @param instance: the instance whose disks we shoul assemble
+ @rtype: list
+ @return: list of (disk_object, device_path)
+
"""
block_devices = []
- for disk in instance.disks:
+ for idx, disk in enumerate(instance.disks):
device = _RecursiveFindBD(disk)
if device is None:
raise errors.BlockDeviceError("Block device '%s' is not set up." %
str(disk))
device.Open()
- block_devices.append((disk, device))
+ try:
+ link_name = _SymlinkBlockDev(instance.name, device.dev_path,
+ "disk%d" % idx)
+ except OSError, e:
+ raise errors.BlockDeviceError("Cannot create block device symlink: %s" %
+ e.strerror)
+
+ block_devices.append((disk, link_name))
+
return block_devices
def StartInstance(instance, extra_args):
"""Start an instance.
- @type instance: instance object
+ @type instance: L{objects.Instance}
@param instance: the instance object
@rtype: boolean
@return: whether the startup was successful or not
if instance.name in running_instances:
return True
- block_devices = _GatherBlockDevs(instance)
+ block_devices = _GatherAndLinkBlockDevs(instance)
hyper = hypervisor.GetHypervisor(instance.hypervisor)
try:
def ShutdownInstance(instance):
"""Shut an instance down.
- @type instance: instance object
+ @note: this functions uses polling with a hardcoded timeout.
+
+ @type instance: L{objects.Instance}
@param instance: the instance object
@rtype: boolean
@return: whether the startup was successful or not
return False
# test every 10secs for 2min
- shutdown_ok = False
time.sleep(1)
for dummy in range(11):
def RebootInstance(instance, reboot_type, extra_args):
"""Reboot an instance.
- Args:
- instance - name of instance to reboot
- reboot_type - how to reboot [soft,hard,full]
+ @type instance: L{objects.Instance}
+ @param instance: the instance object to reboot
+ @type reboot_type: str
+ @param reboot_type: the type of reboot, one the following
+ constants:
+ - L{constants.INSTANCE_REBOOT_SOFT}: only reboot the
+ instance OS, do not recreate the VM
+ - L{constants.INSTANCE_REBOOT_HARD}: tear down and
+ restart the VM (at the hypervisor level)
+ - the other reboot type (L{constants.INSTANCE_REBOOT_HARD})
+ is not accepted here, since that mode is handled
+ differently
+ @rtype: boolean
+ @return: the success of the operation
"""
running_instances = GetInstanceList([instance.hypervisor])
def MigrateInstance(instance, target, live):
"""Migrates an instance to another node.
- @type instance: C{objects.Instance}
+ @type instance: L{objects.Instance}
@param instance: the instance definition
@type target: string
@param target: the target node name
def CreateBlockDevice(disk, size, owner, on_primary, info):
"""Creates a block device for an instance.
- Args:
- disk: a ganeti.objects.Disk object
- size: the size of the physical underlying device
- owner: a string with the name of the instance
- on_primary: a boolean indicating if it is the primary node or not
- info: string that will be sent to the physical device creation
-
- Returns:
- the new unique_id of the device (this can sometime be
- computed only after creation), or None. On secondary nodes,
- it's not required to return anything.
+ @type disk: L{objects.Disk}
+ @param disk: the object describing the disk we should create
+ @type size: int
+ @param size: the size of the physical underlying device, in MiB
+ @type owner: str
+ @param owner: the name of the instance for which disk is created,
+ used for device cache data
+ @type on_primary: boolean
+ @param on_primary: indicates if it is the primary node or not
+ @type info: string
+ @param info: string that will be sent to the physical device
+ creation, used for example to set (LVM) tags on LVs
+
+ @return: the new unique_id of the device (this can sometime be
+ computed only after creation), or None. On secondary nodes,
+ it's not required to return anything.
"""
clist = []
def RemoveBlockDevice(disk):
"""Remove a block device.
- This is intended to be called recursively.
+ @note: This is intended to be called recursively.
+
+ @type disk: L{objects.Disk}
+ @param disk: the disk object we should remove
+ @rtype: boolean
+ @return: the success of the operation
"""
try:
- # since we are removing the device, allow a partial match
- # this allows removal of broken mirrors
- rdev = _RecursiveFindBD(disk, allow_partial=True)
+ rdev = _RecursiveFindBD(disk)
except errors.BlockDeviceError, err:
# probably can't attach
logging.info("Can't attach to device %s in remove", disk)
This is run on the primary and secondary nodes for an instance.
- This function is called recursively.
-
- Args:
- disk: a objects.Disk object
- as_primary: if we should make the block device read/write
-
- Returns:
- the assembled device or None (in case no device was assembled)
+ @note: this function is called recursively.
- If the assembly is not successful, an exception is raised.
+ @type disk: L{objects.Disk}
+ @param disk: the disk we try to assemble
+ @type owner: str
+ @param owner: the name of the instance which owns the disk
+ @type as_primary: boolean
+ @param as_primary: if we should make the block device
+ read/write
+
+ @return: the assembled device or None (in case no device
+ was assembled)
+ @raise errors.BlockDeviceError: in case there is an error
+ during the activation of the children or the device
+ itself
"""
children = []
This is a wrapper over _RecursiveAssembleBD.
- Returns:
- a /dev path for primary nodes
- True for secondary nodes
+ @rtype: str or boolean
+ @return: a C{/dev/...} path for primary nodes, and
+ C{True} for secondary nodes
"""
result = _RecursiveAssembleBD(disk, owner, as_primary)
def ShutdownBlockDevice(disk):
"""Shut down a block device.
- First, if the device is assembled (can `Attach()`), then the device
- is shutdown. Then the children of the device are shutdown.
+ First, if the device is assembled (Attach() is successfull), then
+ the device is shutdown. Then the children of the device are
+ shutdown.
This function is called recursively. Note that we don't cache the
children or such, as oppossed to assemble, shutdown of different
devices doesn't require that the upper device was active.
+ @type disk: L{objects.Disk}
+ @param disk: the description of the disk we should
+ shutdown
+ @rtype: boolean
+ @return: the success of the operation
+
"""
r_dev = _RecursiveFindBD(disk)
if r_dev is not None:
def MirrorAddChildren(parent_cdev, new_cdevs):
"""Extend a mirrored block device.
+ @type parent_cdev: L{objects.Disk}
+ @param parent_cdev: the disk to which we should add children
+ @type new_cdevs: list of L{objects.Disk}
+ @param new_cdevs: the list of children which we should add
+ @rtype: boolean
+ @return: the success of the operation
+
"""
- parent_bdev = _RecursiveFindBD(parent_cdev, allow_partial=True)
+ parent_bdev = _RecursiveFindBD(parent_cdev)
if parent_bdev is None:
logging.error("Can't find parent device")
return False
def MirrorRemoveChildren(parent_cdev, new_cdevs):
"""Shrink a mirrored block device.
+ @type parent_cdev: L{objects.Disk}
+ @param parent_cdev: the disk from which we should remove children
+ @type new_cdevs: list of L{objects.Disk}
+ @param new_cdevs: the list of children which we should remove
+ @rtype: boolean
+ @return: the success of the operation
+
"""
parent_bdev = _RecursiveFindBD(parent_cdev)
if parent_bdev is None:
def GetMirrorStatus(disks):
"""Get the mirroring status of a list of devices.
- Args:
- disks: list of `objects.Disk`
-
- Returns:
- list of (mirror_done, estimated_time) tuples, which
- are the result of bdev.BlockDevice.CombinedSyncStatus()
+ @type disks: list of L{objects.Disk}
+ @param disks: the list of disks which we should query
+ @rtype: disk
+ @return:
+ a list of (mirror_done, estimated_time) tuples, which
+ are the result of L{bdev.BlockDev.CombinedSyncStatus}
+ @raise errors.BlockDeviceError: if any of the disks cannot be
+ found
"""
stats = []
return stats
-def _RecursiveFindBD(disk, allow_partial=False):
+def _RecursiveFindBD(disk):
"""Check if a device is activated.
If so, return informations about the real device.
- Args:
- disk: the objects.Disk instance
- allow_partial: don't abort the find if a child of the
- device can't be found; this is intended to be
- used when repairing mirrors
+ @type disk: L{objects.Disk}
+ @param disk: the disk object we need to find
- Returns:
- None if the device can't be found
- otherwise the device instance
+ @return: None if the device can't be found,
+ otherwise the device instance
"""
children = []
def FindBlockDevice(disk):
"""Check if a device is activated.
- If so, return informations about the real device.
+ If it is, return informations about the real device.
- Args:
- disk: the objects.Disk instance
- Returns:
- None if the device can't be found
- (device_path, major, minor, sync_percent, estimated_time, is_degraded)
+ @type disk: L{objects.Disk}
+ @param disk: the disk to find
+ @rtype: None or tuple
+ @return: None if the disk cannot be found, otherwise a
+ tuple (device_path, major, minor, sync_percent,
+ estimated_time, is_degraded)
"""
rbd = _RecursiveFindBD(disk)
This allows the master to overwrite(!) a file. It will only perform
the operation if the file belongs to a list of configuration files.
+ @type file_name: str
+ @param file_name: the target file name
+ @type data: str
+ @param data: the new contents of the file
+ @type mode: int
+ @param mode: the mode to give the file (can be None)
+ @type uid: int
+ @param uid: the owner of the file (can be -1 for default)
+ @type gid: int
+ @param gid: the group of the file (can be -1 for default)
+ @type atime: float
+ @param atime: the atime to set on the file (can be None)
+ @type mtime: float
+ @param mtime: the mtime to set on the file (can be None)
+ @rtype: boolean
+ @return: the success of the operation; errors are logged
+ in the node daemon log
+
"""
if not os.path.isabs(file_name):
logging.error("Filename passed to UploadFile is not absolute: '%s'",
" upload targets: '%s'", file_name)
return False
- utils.WriteFile(file_name, data=data, mode=mode, uid=uid, gid=gid,
+ raw_data = _Decompress(data)
+
+ utils.WriteFile(file_name, data=raw_data, mode=mode, uid=uid, gid=gid,
atime=atime, mtime=mtime)
return True
+def WriteSsconfFiles(values):
+ """Update all ssconf files.
+
+ Wrapper around the SimpleStore.WriteFiles.
+
+ """
+ ssconf.SimpleStore().WriteFiles(values)
+
+
def _ErrnoOrStr(err):
"""Format an EnvironmentError exception.
- If the `err` argument has an errno attribute, it will be looked up
- and converted into a textual EXXXX description. Otherwise the string
- representation of the error will be returned.
+ If the L{err} argument has an errno attribute, it will be looked up
+ and converted into a textual C{E...} description. Otherwise the
+ string representation of the error will be returned.
+
+ @type err: L{EnvironmentError}
+ @param err: the exception to format
"""
if hasattr(err, 'errno'):
def _OSOndiskVersion(name, 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
+ This function will try to read the API version of the OS given by
the 'name' parameter and residing in the 'os_dir' directory.
- Return value will be either an integer denoting the version or None in the
- case when this is not a valid OS name.
+ @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
+ @rtype: int or None
+ @return:
+ Either an integer denoting the version or None in the
+ case when this is not a valid OS name.
+ @raise errors.InvalidOS: if the OS cannot be found
"""
api_file = os.path.sep.join([os_dir, "ganeti_api_version"])
def DiagnoseOS(top_dirs=None):
"""Compute the validity for all OSes.
- Returns an OS object for each name in all the given top directories
- (if not given defaults to constants.OS_SEARCH_PATH)
-
- Returns:
- list of OS objects
+ @type top_dirs: list
+ @param top_dirs: the list of directories in which to
+ search (if not given defaults to
+ L{constants.OS_SEARCH_PATH})
+ @rtype: list of L{objects.OS}
+ @return: an OS object for each name in all the given
+ directories
"""
if top_dirs is None:
This function will return an OS instance if the given name is a
valid OS name. Otherwise, it will raise an appropriate
- `errors.InvalidOS` exception, detailing why this is not a valid
- OS.
+ L{errors.InvalidOS} exception, detailing why this is not a valid OS.
@type base_dir: string
@keyword base_dir: Base directory containing OS installations.
Defaults to a search in all the OS_SEARCH_PATH dirs.
+ @rtype: L{objects.OS}
+ @return: the OS instance if we find a valid one
+ @raise errors.InvalidOS: if we don't find a valid OS
"""
-
if base_dir is None:
os_dir = utils.FindFile(name, constants.OS_SEARCH_PATH, os.path.isdir)
if os_dir is None:
def OSEnvironment(instance, debug=0):
"""Calculate the environment for an os script.
- @type instance: instance object
+ @type instance: L{objects.Instance}
@param instance: target instance for the os script run
@type debug: integer
- @param debug: debug level (0 or 1, for os api 10)
+ @param debug: debug level (0 or 1, for OS Api 10)
@rtype: dict
@return: dict of environment variables
+ @raise errors.BlockDeviceError: if the block device
+ cannot be found
"""
result = {}
"""Grow a stack of block devices.
This function is called recursively, with the childrens being the
- first one resize.
+ first ones to resize.
- Args:
- disk: the disk to be grown
-
- Returns: a tuple of (status, result), with:
- status: the result (true/false) of the operation
- result: the error message if the operation failed, otherwise not used
+ @type disk: L{objects.Disk}
+ @param disk: the disk to be grown
+ @rtype: (status, result)
+ @return: a tuple with the status of the operation
+ (True/False), and the errors message if status
+ is False
"""
r_dev = _RecursiveFindBD(disk)
(disk.unique_id, disk.dev_type))
-def ExportSnapshot(disk, dest_node, instance, cluster_name):
+def ExportSnapshot(disk, dest_node, instance, cluster_name, idx):
"""Export a block device snapshot to a remote node.
- Args:
- disk: the snapshot block device
- dest_node: the node to send the image to
- instance: instance being exported
-
- Returns:
- True if successful, False otherwise.
+ @type disk: L{objects.Disk}
+ @param disk: the description of the disk to export
+ @type dest_node: str
+ @param dest_node: the destination node to export to
+ @type instance: L{objects.Instance}
+ @param instance: the instance object to whom the disk belongs
+ @type cluster_name: str
+ @param cluster_name: the cluster name, needed for SSH hostalias
+ @type idx: int
+ @param idx: the index of the disk in the instance's disk list,
+ used to export to the OS scripts environment
+ @rtype: boolean
+ @return: the success of the operation
"""
export_env = OSEnvironment(instance)
real_disk.Open()
export_env['EXPORT_DEVICE'] = real_disk.dev_path
+ export_env['EXPORT_INDEX'] = str(idx)
destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new")
destfile = disk.physical_id[1]
def FinalizeExport(instance, snap_disks):
"""Write out the export configuration information.
- Args:
- instance: instance configuration
- snap_disks: snapshot block devices
+ @type instance: L{objects.Instance}
+ @param instance: the instance which we export, used for
+ saving configuration
+ @type snap_disks: list of L{objects.Disk}
+ @param snap_disks: list of snapshot block devices, which
+ will be used to get the actual name of the dump file
- Returns:
- False in case of error, True otherwise.
+ @rtype: boolean
+ @return: the success of the operation
"""
destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new")
instance.beparams[constants.BE_VCPUS])
config.set(constants.INISECT_INS, 'disk_template', instance.disk_template)
- nic_count = 0
+ nic_total = 0
for nic_count, nic in enumerate(instance.nics):
+ nic_total += 1
config.set(constants.INISECT_INS, 'nic%d_mac' %
nic_count, '%s' % nic.mac)
config.set(constants.INISECT_INS, 'nic%d_ip' % nic_count, '%s' % nic.ip)
config.set(constants.INISECT_INS, 'nic%d_bridge' % nic_count,
'%s' % nic.bridge)
# TODO: redundant: on load can read nics until it doesn't exist
- config.set(constants.INISECT_INS, 'nic_count' , '%d' % nic_count)
+ config.set(constants.INISECT_INS, 'nic_count' , '%d' % nic_total)
- disk_count = 0
+ disk_total = 0
for disk_count, disk in enumerate(snap_disks):
if disk:
+ disk_total += 1
config.set(constants.INISECT_INS, 'disk%d_ivname' % disk_count,
('%s' % disk.iv_name))
config.set(constants.INISECT_INS, 'disk%d_dump' % disk_count,
('%s' % disk.physical_id[1]))
config.set(constants.INISECT_INS, 'disk%d_size' % disk_count,
('%d' % disk.size))
- config.set(constants.INISECT_INS, 'disk_count' , '%d' % disk_count)
- cff = os.path.join(destdir, constants.EXPORT_CONF_FILE)
- cfo = open(cff, 'w')
- try:
- config.write(cfo)
- finally:
- cfo.close()
+ config.set(constants.INISECT_INS, 'disk_count' , '%d' % disk_total)
+ utils.WriteFile(os.path.join(destdir, constants.EXPORT_CONF_FILE),
+ data=config.Dumps())
shutil.rmtree(finaldestdir, True)
shutil.move(destdir, finaldestdir)
def ExportInfo(dest):
"""Get export configuration information.
- Args:
- dest: directory containing the export
+ @type dest: str
+ @param dest: directory containing the export
- Returns:
- A serializable config file containing the export info.
+ @rtype: L{objects.SerializableConfigParser}
+ @return: a serializable config file containing the
+ export info
"""
cff = os.path.join(dest, constants.EXPORT_CONF_FILE)
return config
-def ImportOSIntoInstance(instance, os_disk, swap_disk, src_node, src_image,
- cluster_name):
+def ImportOSIntoInstance(instance, src_node, src_images, cluster_name):
"""Import an os image into an instance.
- Args:
- instance: the instance object
- os_disk: the instance-visible name of the os device
- swap_disk: the instance-visible name of the swap device
- src_node: node holding the source image
- src_image: path to the source image on src_node
-
- Returns:
- False in case of error, True otherwise.
+ @type instance: L{objects.Instance}
+ @param instance: instance to import the disks into
+ @type src_node: string
+ @param src_node: source node for the disk images
+ @type src_images: list of string
+ @param src_images: absolute paths of the disk images
+ @rtype: list of boolean
+ @return: each boolean represent the success of importing the n-th disk
"""
- # TODO(ultrotter): Import/Export still to be converted to OS API 10
- logging.error("Import/Export still to be converted to OS API 10")
- return False
-
+ import_env = OSEnvironment(instance)
inst_os = OSFromDisk(instance.os)
import_script = inst_os.import_script
- os_device = instance.FindDisk(os_disk)
- if os_device is None:
- logging.error("Can't find this device-visible name '%s'", os_disk)
- return False
-
- swap_device = instance.FindDisk(swap_disk)
- if swap_device is None:
- logging.error("Can't find this device-visible name '%s'", swap_disk)
- return False
-
- real_os_dev = _RecursiveFindBD(os_device)
- if real_os_dev is None:
- raise errors.BlockDeviceError("Block device '%s' is not set up" %
- str(os_device))
- real_os_dev.Open()
-
- real_swap_dev = _RecursiveFindBD(swap_device)
- if real_swap_dev is None:
- raise errors.BlockDeviceError("Block device '%s' is not set up" %
- str(swap_device))
- real_swap_dev.Open()
-
logfile = "%s/import-%s-%s-%s.log" % (constants.LOG_OS_DIR, instance.os,
instance.name, int(time.time()))
if not os.path.exists(constants.LOG_OS_DIR):
os.mkdir(constants.LOG_OS_DIR, 0750)
- destcmd = utils.BuildShellCmd('cat %s', src_image)
- remotecmd = _GetSshRunner(cluster_name).BuildCmd(src_node,
- constants.GANETI_RUNAS,
- destcmd)
-
comprcmd = "gunzip"
- impcmd = utils.BuildShellCmd("(cd %s; %s -i %s -b %s -s %s &>%s)",
- inst_os.path, import_script, instance.name,
- real_os_dev.dev_path, real_swap_dev.dev_path,
- logfile)
-
- command = '|'.join([utils.ShellQuoteArgs(remotecmd), comprcmd, impcmd])
- env = {'HYPERVISOR': instance.hypervisor}
-
- result = utils.RunCmd(command, env=env)
-
- if result.failed:
- logging.error("os import command '%s' returned error: %s"
- " output: %s", command, result.fail_reason, result.output)
- return False
+ impcmd = utils.BuildShellCmd("(cd %s; %s >%s 2>&1)", inst_os.path,
+ import_script, logfile)
+
+ final_result = []
+ for idx, image in enumerate(src_images):
+ if image:
+ destcmd = utils.BuildShellCmd('cat %s', image)
+ remotecmd = _GetSshRunner(cluster_name).BuildCmd(src_node,
+ constants.GANETI_RUNAS,
+ destcmd)
+ command = '|'.join([utils.ShellQuoteArgs(remotecmd), comprcmd, impcmd])
+ import_env['IMPORT_DEVICE'] = import_env['DISK_%d_PATH' % idx]
+ import_env['IMPORT_INDEX'] = str(idx)
+ result = utils.RunCmd(command, env=import_env)
+ if result.failed:
+ logging.error("Disk import command '%s' returned error: %s"
+ " output: %s", command, result.fail_reason,
+ result.output)
+ final_result.append(False)
+ else:
+ final_result.append(True)
+ else:
+ final_result.append(True)
- return True
+ return final_result
def ListExports():
"""Return a list of exports currently available on this machine.
+ @rtype: list
+ @return: list of the exports
+
"""
if os.path.isdir(constants.EXPORT_DIR):
return utils.ListVisibleFiles(constants.EXPORT_DIR)
def RemoveExport(export):
"""Remove an existing export from the node.
- Args:
- export: the name of the export to remove
-
- Returns:
- False in case of error, True otherwise.
+ @type export: str
+ @param export: the name of the export to remove
+ @rtype: boolean
+ @return: the success of the operation
"""
target = os.path.join(constants.EXPORT_DIR, export)
def RenameBlockDevices(devlist):
"""Rename a list of block devices.
- The devlist argument is a list of tuples (disk, new_logical,
- new_physical). The return value will be a combined boolean result
- (True only if all renames succeeded).
+ @type devlist: list of tuples
+ @param devlist: list of tuples of the form (disk,
+ new_logical_id, new_physical_id); disk is an
+ L{objects.Disk} object describing the current disk,
+ and new logical_id/physical_id is the name we
+ rename it to
+ @rtype: boolean
+ @return: True if all renames succeeded, False otherwise
"""
result = True
default file_storage_dir stored in SimpleStore. Only paths under that
directory are allowed.
- Args:
- file_storage_dir: string with path
+ @type file_storage_dir: str
+ @param file_storage_dir: the path to check
- Returns:
- normalized file_storage_dir (string) if valid, None otherwise
+ @return: the normalized path if valid, None otherwise
"""
cfg = _GetConfig()
def CreateFileStorageDir(file_storage_dir):
"""Create file storage directory.
- Args:
- file_storage_dir: string containing the path
+ @type file_storage_dir: str
+ @param file_storage_dir: directory to create
- Returns:
- tuple with first element a boolean indicating wheter dir
- creation was successful or not
+ @rtype: tuple
+ @return: tuple with first element a boolean indicating wheter dir
+ creation was successful or not
"""
file_storage_dir = _TransformFileStorageDir(file_storage_dir)
Remove it only if it's empty. If not log an error and return.
- Args:
- file_storage_dir: string containing the path
-
- Returns:
- tuple with first element a boolean indicating wheter dir
- removal was successful or not
+ @type file_storage_dir: str
+ @param file_storage_dir: the directory we should cleanup
+ @rtype: tuple (success,)
+ @return: tuple of one element, C{success}, denoting
+ whether the operation was successfull
"""
file_storage_dir = _TransformFileStorageDir(file_storage_dir)
def RenameFileStorageDir(old_file_storage_dir, new_file_storage_dir):
"""Rename the file storage directory.
- Args:
- old_file_storage_dir: string containing the old path
- new_file_storage_dir: string containing the new path
-
- Returns:
- tuple with first element a boolean indicating wheter dir
- rename was successful or not
+ @type old_file_storage_dir: str
+ @param old_file_storage_dir: the current path
+ @type new_file_storage_dir: str
+ @param new_file_storage_dir: the name we should rename to
+ @rtype: tuple (success,)
+ @return: tuple of one element, C{success}, denoting
+ whether the operation was successful
"""
old_file_storage_dir = _TransformFileStorageDir(old_file_storage_dir)
def _IsJobQueueFile(file_name):
"""Checks whether the given filename is in the queue directory.
+ @type file_name: str
+ @param file_name: the file name we should check
+ @rtype: boolean
+ @return: whether the file is under the queue directory
+
"""
queue_dir = os.path.normpath(constants.QUEUE_DIR)
result = (os.path.commonprefix([queue_dir, file_name]) == queue_dir)
def JobQueueUpdate(file_name, content):
"""Updates a file in the queue directory.
+ This is just a wrapper over L{utils.WriteFile}, with proper
+ checking.
+
+ @type file_name: str
+ @param file_name: the job file name
+ @type content: str
+ @param content: the new job contents
+ @rtype: boolean
+ @return: the success of the operation
+
"""
if not _IsJobQueueFile(file_name):
return False
# Write and replace the file atomically
- utils.WriteFile(file_name, data=content)
+ utils.WriteFile(file_name, data=_Decompress(content))
return True
def JobQueueRename(old, new):
"""Renames a job queue file.
+ This is just a wrapper over os.rename with proper checking.
+
+ @type old: str
+ @param old: the old (actual) file name
+ @type new: str
+ @param new: the desired file name
+ @rtype: boolean
+ @return: the success of the operation
+
"""
if not (_IsJobQueueFile(old) and _IsJobQueueFile(new)):
return False
- os.rename(old, new)
+ utils.RenameFile(old, new, mkdir=True)
return True
This will set or unset the queue drain flag.
- @type drain_flag: bool
+ @type drain_flag: boolean
@param drain_flag: if True, will set the drain flag, otherwise reset it.
+ @rtype: boolean
+ @return: always True
+ @warning: the function always returns True
"""
if drain_flag:
def CloseBlockDevices(disks):
"""Closes the given block devices.
- This means they will be switched to secondary mode (in case of DRBD).
+ This means they will be switched to secondary mode (in case of
+ DRBD).
+
+ @type disks: list of L{objects.Disk}
+ @param disks: the list of disks to be closed
+ @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
"""
bdevs = []
@param hvname: the hypervisor name
@type hvparams: dict
@param hvparams: the hypervisor parameters to be validated
- @rtype: tuple (bool, str)
- @return: tuple of (success, message)
+ @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
"""
try:
return (False, str(err))
+def DemoteFromMC():
+ """Demotes the current node from master candidate role.
+
+ """
+ # try to ensure we're not the master by mistake
+ master, myself = ssconf.GetMasterAndMyself()
+ if master == myself:
+ return (False, "ssconf status shows I'm the master node, will not demote")
+ pid_file = utils.DaemonPidFileName(constants.MASTERD_PID)
+ if utils.IsProcessAlive(utils.ReadPidFile(pid_file)):
+ return (False, "The master daemon is running, will not demote")
+ try:
+ utils.CreateBackup(constants.CLUSTER_CONF_FILE)
+ except EnvironmentError, err:
+ if err.errno != errno.ENOENT:
+ return (False, "Error while backing up cluster file: %s" % str(err))
+ utils.RemoveFile(constants.CLUSTER_CONF_FILE)
+ return (True, "Done")
+
+
class HooksRunner(object):
"""Hook runner.
- This class is instantiated on the node side (ganeti-noded) and not on
- the master side.
+ This class is instantiated on the node side (ganeti-noded) and not
+ on the master side.
"""
RE_MASK = re.compile("^[a-zA-Z0-9_-]+$")
def __init__(self, hooks_base_dir=None):
"""Constructor for hooks runner.
- Args:
- - hooks_base_dir: if not None, this overrides the
- constants.HOOKS_BASE_DIR (useful for unittests)
+ @type hooks_base_dir: str or None
+ @param hooks_base_dir: if not None, this overrides the
+ L{constants.HOOKS_BASE_DIR} (useful for unittests)
"""
if hooks_base_dir is None:
def ExecHook(script, env):
"""Exec one hook script.
- Args:
- - script: the full path to the script
- - env: the environment with which to exec the 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
def RunHooks(self, hpath, phase, env):
"""Run the scripts in the hooks directory.
- This method will not be usually overriden by child opcodes.
+ @type hpath: str
+ @param hpath: the path to the hooks directory which
+ holds the scripts
+ @type phase: str
+ @param phase: either L{constants.HOOKS_PHASE_PRE} or
+ L{constants.HOOKS_PHASE_POST}
+ @type env: dict
+ @param env: dictionary with the environment for the hook
+ @rtype: list
+ @return: list of 3-element tuples:
+ - script path
+ - script result, either L{constants.HKR_SUCCESS} or
+ L{constants.HKR_FAIL}
+ - output of the script
+
+ @raise errors.ProgrammerError: for invalid input
+ parameters
"""
if phase == constants.HOOKS_PHASE_PRE:
try:
dir_contents = utils.ListVisibleFiles(dir_name)
except OSError, err:
- # must log
+ # FIXME: must log output in case of failures
return rr
# we use the standard python sort order,
def Run(self, name, idata):
"""Run an iallocator script.
- Return value: tuple of:
+ @type name: str
+ @param name: the iallocator script name
+ @type idata: str
+ @param idata: the allocator input data
+
+ @rtype: tuple
+ @return: four element tuple of:
- run status (one of the IARUN_ constants)
- stdout
- stderr
- - fail reason (as from utils.RunResult)
+ - fail reason (as from L{utils.RunResult})
"""
alloc_script = utils.FindFile(name, constants.IALLOCATOR_SEARCH_PATH,
"""Converts a /dev/name path to the cache file name.
This replaces slashes with underscores and strips the /dev
- prefix. It then returns the full path to the cache file
+ prefix. It then returns the full path to the cache file.
+
+ @type dev_path: str
+ @param dev_path: the C{/dev/} path name
+ @rtype: str
+ @return: the converted path name
"""
if dev_path.startswith(cls._DEV_PREFIX):
def UpdateCache(cls, dev_path, owner, on_primary, iv_name):
"""Updates the cache information for a given device.
+ @type dev_path: str
+ @param dev_path: the pathname of the device
+ @type owner: str
+ @param owner: the owner (instance name) of the device
+ @type on_primary: bool
+ @param on_primary: whether this is the primary
+ node nor not
+ @type iv_name: str
+ @param iv_name: the instance-visible name of the
+ device, as in objects.Disk.iv_name
+
+ @rtype: None
+
"""
if dev_path is None:
logging.error("DevCacheManager.UpdateCache got a None dev_path")
def RemoveCache(cls, dev_path):
"""Remove data for a dev_path.
+ This is just a wrapper over L{utils.RemoveFile} with a converted
+ path name and logging.
+
+ @type dev_path: str
+ @param dev_path: the pathname of the device
+
+ @rtype: None
+
"""
if dev_path is None:
logging.error("DevCacheManager.RemoveCache got a None dev_path")
projects / ganeti-local / blobdiff