# if they need to start using instance attributes
# R0904: Too many public methods
-import os
import logging
import zlib
import base64
from ganeti import ssconf
from ganeti import runtime
from ganeti import compat
+from ganeti import rpc_defs
# Special module generated at build time
from ganeti import _generated_rpc
_TMO_4HRS = 4 * 3600
_TMO_1DAY = 86400
-# Timeout table that will be built later by decorators
-# Guidelines for choosing timeouts:
-# - call used during watcher: timeout -> 1min, _TMO_URGENT
-# - trivial (but be sure it is trivial) (e.g. reading a file): 5min, _TMO_FAST
-# - other calls: 15 min, _TMO_NORMAL
-# - special calls (instance add, etc.): either _TMO_SLOW (1h) or huge timeouts
-
-_TIMEOUTS = {
-}
-
#: Special value to describe an offline host
_OFFLINE = object()
curl.setopt(pycurl.CONNECTTIMEOUT, _RPC_CONNECT_TIMEOUT)
-def _RpcTimeout(secs):
- """Timeout decorator.
-
- When applied to a rpc call_* function, it updates the global timeout
- table with the given function/timeout.
-
- """
- def decorator(f):
- name = f.__name__
- assert name.startswith("call_")
- _TIMEOUTS[name[len("call_"):]] = secs
- return f
- return decorator
-
-
def RunWithRPC(fn):
"""RPC-wrapper decorator.
raise ec(*args) # pylint: disable=W0142
-def _SsconfResolver(node_list,
+def _SsconfResolver(ssconf_ips, node_list, _,
ssc=ssconf.SimpleStore,
nslookup_fn=netutils.Hostname.GetIP):
"""Return addresses for given node names.
+ @type ssconf_ips: bool
+ @param ssconf_ips: Use the ssconf IPs
@type node_list: list
@param node_list: List of node names
@type ssc: class
"""
ss = ssc()
- iplist = ss.GetNodePrimaryIPList()
family = ss.GetPrimaryIPFamily()
- ipmap = dict(entry.split() for entry in iplist)
+
+ if ssconf_ips:
+ iplist = ss.GetNodePrimaryIPList()
+ ipmap = dict(entry.split() for entry in iplist)
+ else:
+ ipmap = {}
result = []
for node in node_list:
"""
self._addresses = addresses
- def __call__(self, hosts):
+ def __call__(self, hosts, _):
"""Returns static addresses for hosts.
"""
return zip(hosts, self._addresses)
-def _CheckConfigNode(name, node):
+def _CheckConfigNode(name, node, accept_offline_node):
"""Checks if a node is online.
@type name: string
if node is None:
# Depend on DNS for name resolution
ip = name
- elif node.offline:
+ elif node.offline and not accept_offline_node:
ip = _OFFLINE
else:
ip = node.primary_ip
return (name, ip)
-def _NodeConfigResolver(single_node_fn, all_nodes_fn, hosts):
+def _NodeConfigResolver(single_node_fn, all_nodes_fn, hosts, opts):
"""Calculate node addresses using configuration.
"""
+ accept_offline_node = (opts is rpc_defs.ACCEPT_OFFLINE_NODE)
+
+ assert accept_offline_node or opts is None, "Unknown option"
+
# Special case for single-host lookups
if len(hosts) == 1:
(name, ) = hosts
- return [_CheckConfigNode(name, single_node_fn(name))]
+ return [_CheckConfigNode(name, single_node_fn(name), accept_offline_node)]
else:
all_nodes = all_nodes_fn()
- return [_CheckConfigNode(name, all_nodes.get(name, None))
+ return [_CheckConfigNode(name, all_nodes.get(name, None),
+ accept_offline_node)
for name in hosts]
def _PrepareRequests(hosts, port, procedure, body, read_timeout):
"""Prepares requests by sorting offline hosts into separate list.
+ @type body: dict
+ @param body: a dictionary with per-host body data
+
"""
results = {}
requests = {}
+ assert isinstance(body, dict)
+ assert len(body) == len(hosts)
+ assert compat.all(isinstance(v, str) for v in body.values())
+ assert frozenset(map(compat.fst, hosts)) == frozenset(body.keys()), \
+ "%s != %s" % (hosts, body.keys())
+
for (name, ip) in hosts:
if ip is _OFFLINE:
# Node is marked as offline
else:
requests[name] = \
http.client.HttpClientRequest(str(ip), port,
- http.HTTP_PUT, str("/%s" % procedure),
+ http.HTTP_POST, str("/%s" % procedure),
headers=_RPC_CLIENT_HEADERS,
- post_data=body,
+ post_data=body[name],
read_timeout=read_timeout,
nicename="%s/%s" % (name, procedure),
curl_config_fn=_ConfigRpcCurl)
return results
- def __call__(self, hosts, procedure, body, read_timeout=None,
- _req_process_fn=http.client.ProcessRequests):
+ def __call__(self, hosts, procedure, body, read_timeout, resolver_opts,
+ _req_process_fn=None):
"""Makes an RPC request to a number of nodes.
@type hosts: sequence
@param hosts: Hostnames
@type procedure: string
@param procedure: Request path
- @type body: string
- @param body: Request body
+ @type body: dictionary
+ @param body: dictionary with request bodies per host
@type read_timeout: int or None
@param read_timeout: Read timeout for request
"""
- if read_timeout is None:
- read_timeout = _TIMEOUTS.get(procedure, None)
-
assert read_timeout is not None, \
"Missing RPC read timeout for procedure '%s'" % procedure
+ if _req_process_fn is None:
+ _req_process_fn = http.client.ProcessRequests
+
(results, requests) = \
- self._PrepareRequests(self._resolver(hosts), self._port, procedure,
- str(body), read_timeout)
+ self._PrepareRequests(self._resolver(hosts, resolver_opts), self._port,
+ procedure, body, read_timeout)
_req_process_fn(requests.values(), lock_monitor_cb=self._lock_monitor_cb)
return self._CombineResults(results, requests, procedure)
-def _EncodeImportExportIO(ieio, ieioargs):
- """Encodes import/export I/O information.
-
- """
- if ieio == constants.IEIO_RAW_DISK:
- assert len(ieioargs) == 1
- return (ieioargs[0].ToDict(), )
-
- if ieio == constants.IEIO_SCRIPT:
- assert len(ieioargs) == 2
- return (ieioargs[0].ToDict(), ieioargs[1])
-
- return ieioargs
-
-
-class RpcRunner(_generated_rpc.RpcClientDefault):
- """RPC runner class.
-
- """
- def __init__(self, context):
- """Initialized the RPC runner.
-
- @type context: C{masterd.GanetiContext}
- @param context: Ganeti context
-
- """
- _generated_rpc.RpcClientDefault.__init__(self)
-
- self._cfg = context.cfg
- self._proc = _RpcProcessor(compat.partial(_NodeConfigResolver,
- self._cfg.GetNodeInfo,
- self._cfg.GetAllNodesInfo),
- netutils.GetDaemonPort(constants.NODED),
- lock_monitor_cb=context.glm.AddToLockMonitor)
-
- def _InstDict(self, instance, hvp=None, bep=None, osp=None):
- """Convert the given instance to a dict.
-
- This is done via the instance's ToDict() method and additionally
- we fill the hvparams with the cluster defaults.
-
- @type instance: L{objects.Instance}
- @param instance: an Instance object
- @type hvp: dict or None
- @param hvp: a dictionary with overridden hypervisor parameters
- @type bep: dict or None
- @param bep: a dictionary with overridden backend parameters
- @type osp: dict or None
- @param osp: a dictionary with overridden os parameters
- @rtype: dict
- @return: the instance dict, with the hvparams filled with the
- cluster defaults
-
- """
- idict = instance.ToDict()
- cluster = self._cfg.GetClusterInfo()
- idict["hvparams"] = cluster.FillHV(instance)
- if hvp is not None:
- idict["hvparams"].update(hvp)
- idict["beparams"] = cluster.FillBE(instance)
- if bep is not None:
- idict["beparams"].update(bep)
- idict["osparams"] = cluster.SimpleFillOS(instance.os, instance.osparams)
- if osp is not None:
- idict["osparams"].update(osp)
- for nic in idict["nics"]:
- nic['nicparams'] = objects.FillDict(
- cluster.nicparams[constants.PP_DEFAULT],
- nic['nicparams'])
- return idict
-
- def _MultiNodeCall(self, node_list, procedure, args, read_timeout=None):
- """Helper for making a multi-node call
-
- """
- body = serializer.DumpJson(args, indent=False)
- return self._proc(node_list, procedure, body, read_timeout=read_timeout)
-
- def _Call(self, node_list, procedure, timeout, args):
- """Entry point for automatically generated RPC wrappers.
+class _RpcClientBase:
+ def __init__(self, resolver, encoder_fn, lock_monitor_cb=None,
+ _req_process_fn=None):
+ """Initializes this class.
"""
- return self._MultiNodeCall(node_list, procedure, args, read_timeout=timeout)
+ proc = _RpcProcessor(resolver,
+ netutils.GetDaemonPort(constants.NODED),
+ lock_monitor_cb=lock_monitor_cb)
+ self._proc = compat.partial(proc, _req_process_fn=_req_process_fn)
+ self._encoder = compat.partial(self._EncodeArg, encoder_fn)
@staticmethod
- def _StaticMultiNodeCall(node_list, procedure, args,
- address_list=None, read_timeout=None):
- """Helper for making a multi-node static call
+ def _EncodeArg(encoder_fn, (argkind, value)):
+ """Encode argument.
"""
- body = serializer.DumpJson(args, indent=False)
-
- if address_list is None:
- resolver = _SsconfResolver
+ if argkind is None:
+ return value
else:
- # Caller provided an address list
- resolver = _StaticResolver(address_list)
-
- proc = _RpcProcessor(resolver,
- netutils.GetDaemonPort(constants.NODED))
- return proc(node_list, procedure, body, read_timeout=read_timeout)
-
- def _SingleNodeCall(self, node, procedure, args, read_timeout=None):
- """Helper for making a single-node call
-
- """
- body = serializer.DumpJson(args, indent=False)
- return self._proc([node], procedure, body, read_timeout=read_timeout)[node]
-
- @classmethod
- def _StaticSingleNodeCall(cls, node, procedure, args, read_timeout=None):
- """Helper for making a single-node static call
-
- """
- body = serializer.DumpJson(args, indent=False)
- proc = _RpcProcessor(_SsconfResolver,
- netutils.GetDaemonPort(constants.NODED))
- return proc([node], procedure, body, read_timeout=read_timeout)[node]
-
- @staticmethod
- def _BlockdevFindPostProc(result):
- if not result.fail_msg and result.payload is not None:
- result.payload = objects.BlockDevStatus.FromDict(result.payload)
- return result
-
- @staticmethod
- def _BlockdevGetMirrorStatusPostProc(result):
- if not result.fail_msg:
- result.payload = [objects.BlockDevStatus.FromDict(i)
- for i in result.payload]
- return result
+ return encoder_fn(argkind)(value)
- @staticmethod
- def _BlockdevGetMirrorStatusMultiPostProc(result):
- for nres in result.values():
- if nres.fail_msg:
- continue
-
- for idx, (success, status) in enumerate(nres.payload):
- if success:
- nres.payload[idx] = (success, objects.BlockDevStatus.FromDict(status))
-
- return result
-
- @staticmethod
- def _OsGetPostProc(result):
- if not result.fail_msg and isinstance(result.payload, dict):
- result.payload = objects.OS.FromDict(result.payload)
- return result
-
- @staticmethod
- def _PrepareFinalizeExportDisks(snap_disks):
- flat_disks = []
-
- for disk in snap_disks:
- if isinstance(disk, bool):
- flat_disks.append(disk)
- else:
- flat_disks.append(disk.ToDict())
-
- return flat_disks
-
- @staticmethod
- def _ImpExpStatusPostProc(result):
- """Post-processor for import/export status.
-
- @rtype: Payload containing list of L{objects.ImportExportStatus} instances
- @return: Returns a list of the state of each named import/export or None if
- a status couldn't be retrieved
+ def _Call(self, cdef, node_list, args):
+ """Entry point for automatically generated RPC wrappers.
"""
- if not result.fail_msg:
- decoded = []
-
- for i in result.payload:
- if i is None:
- decoded.append(None)
- continue
- decoded.append(objects.ImportExportStatus.FromDict(i))
-
- result.payload = decoded
-
- return result
-
- #
- # Begin RPC calls
- #
+ (procedure, _, resolver_opts, timeout, argdefs,
+ prep_fn, postproc_fn, _) = cdef
- @_RpcTimeout(_TMO_URGENT)
- def call_bdev_sizes(self, node_list, devices):
- """Gets the sizes of requested block devices present on a node
-
- This is a multi-node call.
-
- """
- return self._MultiNodeCall(node_list, "bdev_sizes", [devices])
+ if callable(timeout):
+ read_timeout = timeout(args)
+ else:
+ read_timeout = timeout
- @_RpcTimeout(_TMO_URGENT)
- def call_lv_list(self, node_list, vg_name):
- """Gets the logical volumes present in a given volume group.
+ if callable(resolver_opts):
+ req_resolver_opts = resolver_opts(args)
+ else:
+ req_resolver_opts = resolver_opts
- This is a multi-node call.
+ if len(args) != len(argdefs):
+ raise errors.ProgrammerError("Number of passed arguments doesn't match")
- """
- return self._MultiNodeCall(node_list, "lv_list", [vg_name])
+ enc_args = map(self._encoder, zip(map(compat.snd, argdefs), args))
+ if prep_fn is None:
+ # for a no-op prep_fn, we serialise the body once, and then we
+ # reuse it in the dictionary values
+ body = serializer.DumpJson(enc_args)
+ pnbody = dict((n, body) for n in node_list)
+ else:
+ # for a custom prep_fn, we pass the encoded arguments and the
+ # node name to the prep_fn, and we serialise its return value
+ assert callable(prep_fn)
+ pnbody = dict((n, serializer.DumpJson(prep_fn(n, enc_args)))
+ for n in node_list)
+
+ result = self._proc(node_list, procedure, pnbody, read_timeout,
+ req_resolver_opts)
+
+ if postproc_fn:
+ return dict(map(lambda (key, value): (key, postproc_fn(value)),
+ result.items()))
+ else:
+ return result
- @_RpcTimeout(_TMO_URGENT)
- def call_vg_list(self, node_list):
- """Gets the volume group list.
- This is a multi-node call.
+def _ObjectToDict(value):
+ """Converts an object to a dictionary.
- """
- return self._MultiNodeCall(node_list, "vg_list", [])
+ @note: See L{objects}.
- @_RpcTimeout(_TMO_NORMAL)
- def call_storage_list(self, node_list, su_name, su_args, name, fields):
- """Get list of storage units.
+ """
+ return value.ToDict()
- This is a multi-node call.
- """
- return self._MultiNodeCall(node_list, "storage_list",
- [su_name, su_args, name, fields])
+def _ObjectListToDict(value):
+ """Converts a list of L{objects} to dictionaries.
- @_RpcTimeout(_TMO_NORMAL)
- def call_storage_modify(self, node, su_name, su_args, name, changes):
- """Modify a storage unit.
+ """
+ return map(_ObjectToDict, value)
- This is a single-node call.
- """
- return self._SingleNodeCall(node, "storage_modify",
- [su_name, su_args, name, changes])
+def _EncodeNodeToDiskDict(value):
+ """Encodes a dictionary with node name as key and disk objects as values.
- @_RpcTimeout(_TMO_NORMAL)
- def call_storage_execute(self, node, su_name, su_args, name, op):
- """Executes an operation on a storage unit.
+ """
+ return dict((name, _ObjectListToDict(disks))
+ for name, disks in value.items())
- This is a single-node call.
- """
- return self._SingleNodeCall(node, "storage_execute",
- [su_name, su_args, name, op])
+def _PrepareFileUpload(getents_fn, filename):
+ """Loads a file and prepares it for an upload to nodes.
- @_RpcTimeout(_TMO_URGENT)
- def call_bridges_exist(self, node, bridges_list):
- """Checks if a node has all the bridges given.
+ """
+ statcb = utils.FileStatHelper()
+ data = _Compress(utils.ReadFile(filename, preread=statcb))
+ st = statcb.st
- This method checks if all bridges given in the bridges_list are
- present on the remote node, so that an instance that uses interfaces
- on those bridges can be started.
+ if getents_fn is None:
+ getents_fn = runtime.GetEnts
- This is a single-node call.
+ getents = getents_fn()
- """
- return self._SingleNodeCall(node, "bridges_exist", [bridges_list])
+ return [filename, data, st.st_mode, getents.LookupUid(st.st_uid),
+ getents.LookupGid(st.st_gid), st.st_atime, st.st_mtime]
- @_RpcTimeout(_TMO_NORMAL)
- def call_instance_start(self, node, instance, hvp, bep, startup_paused):
- """Starts an instance.
- This is a single-node call.
+def _PrepareFinalizeExportDisks(snap_disks):
+ """Encodes disks for finalizing export.
- """
- idict = self._InstDict(instance, hvp=hvp, bep=bep)
- return self._SingleNodeCall(node, "instance_start", [idict, startup_paused])
+ """
+ flat_disks = []
- @_RpcTimeout(_TMO_NORMAL)
- def call_instance_shutdown(self, node, instance, timeout):
- """Stops an instance.
+ for disk in snap_disks:
+ if isinstance(disk, bool):
+ flat_disks.append(disk)
+ else:
+ flat_disks.append(disk.ToDict())
- This is a single-node call.
+ return flat_disks
- """
- return self._SingleNodeCall(node, "instance_shutdown",
- [self._InstDict(instance), timeout])
- @_RpcTimeout(_TMO_NORMAL)
- def call_migration_info(self, node, instance):
- """Gather the information necessary to prepare an instance migration.
+def _EncodeImportExportIO((ieio, ieioargs)):
+ """Encodes import/export I/O information.
- This is a single-node call.
+ """
+ if ieio == constants.IEIO_RAW_DISK:
+ assert len(ieioargs) == 1
+ return (ieio, (ieioargs[0].ToDict(), ))
- @type node: string
- @param node: the node on which the instance is currently running
- @type instance: C{objects.Instance}
- @param instance: the instance definition
+ if ieio == constants.IEIO_SCRIPT:
+ assert len(ieioargs) == 2
+ return (ieio, (ieioargs[0].ToDict(), ieioargs[1]))
- """
- return self._SingleNodeCall(node, "migration_info",
- [self._InstDict(instance)])
+ return (ieio, ieioargs)
- @_RpcTimeout(_TMO_NORMAL)
- def call_accept_instance(self, node, instance, info, target):
- """Prepare a node to accept an instance.
- This is a single-node call.
+def _EncodeBlockdevRename(value):
+ """Encodes information for renaming block devices.
- @type node: string
- @param node: the target node for the migration
- @type instance: C{objects.Instance}
- @param instance: the instance definition
- @type info: opaque/hypervisor specific (string/data)
- @param info: result for the call_migration_info call
- @type target: string
- @param target: target hostname (usually ip address) (on the node itself)
+ """
+ return [(d.ToDict(), uid) for d, uid in value]
- """
- return self._SingleNodeCall(node, "accept_instance",
- [self._InstDict(instance), info, target])
- @_RpcTimeout(_TMO_NORMAL)
- def call_instance_finalize_migration_dst(self, node, instance, info, success):
- """Finalize any target-node migration specific operation.
+def _AnnotateDParamsDRBD(disk, (drbd_params, data_params, meta_params)):
+ """Annotates just DRBD disks layouts.
- This is called both in case of a successful migration and in case of error
- (in which case it should abort the migration).
+ """
+ assert disk.dev_type == constants.LD_DRBD8
- This is a single-node call.
+ disk.params = objects.FillDict(drbd_params, disk.params)
+ (dev_data, dev_meta) = disk.children
+ dev_data.params = objects.FillDict(data_params, dev_data.params)
+ dev_meta.params = objects.FillDict(meta_params, dev_meta.params)
- @type node: string
- @param node: the target node for the migration
- @type instance: C{objects.Instance}
- @param instance: the instance definition
- @type info: opaque/hypervisor specific (string/data)
- @param info: result for the call_migration_info call
- @type success: boolean
- @param success: whether the migration was a success or a failure
+ return disk
- """
- return self._SingleNodeCall(node, "instance_finalize_migration_dst",
- [self._InstDict(instance), info, success])
- @_RpcTimeout(_TMO_SLOW)
- def call_instance_migrate(self, node, instance, target, live):
- """Migrate an instance.
+def _AnnotateDParamsGeneric(disk, (params, )):
+ """Generic disk parameter annotation routine.
- This is a single-node call.
+ """
+ assert disk.dev_type != constants.LD_DRBD8
- @type node: string
- @param node: the node on which the instance is currently running
- @type instance: C{objects.Instance}
- @param instance: the instance definition
- @type target: string
- @param target: the target node name
- @type live: boolean
- @param live: whether the migration should be done live or not (the
- interpretation of this parameter is left to the hypervisor)
+ disk.params = objects.FillDict(params, disk.params)
- """
- return self._SingleNodeCall(node, "instance_migrate",
- [self._InstDict(instance), target, live])
+ return disk
- @_RpcTimeout(_TMO_SLOW)
- def call_instance_finalize_migration_src(self, node, instance, success, live):
- """Finalize the instance migration on the source node.
- This is a single-node call.
+def AnnotateDiskParams(template, disks, disk_params):
+ """Annotates the disk objects with the disk parameters.
- @type instance: L{objects.Instance}
- @param instance: the instance that was migrated
- @type success: bool
- @param success: whether the migration succeeded or not
- @type live: bool
- @param live: whether the user requested a live migration or not
+ @param template: The disk template used
+ @param disks: The list of disks objects to annotate
+ @param disk_params: The disk paramaters for annotation
+ @returns: A list of disk objects annotated
- """
- return self._SingleNodeCall(node, "instance_finalize_migration_src",
- [self._InstDict(instance), success, live])
+ """
+ ld_params = objects.Disk.ComputeLDParams(template, disk_params)
- @_RpcTimeout(_TMO_SLOW)
- def call_instance_get_migration_status(self, node, instance):
- """Report migration status.
+ if template == constants.DT_DRBD8:
+ annotation_fn = _AnnotateDParamsDRBD
+ elif template == constants.DT_DISKLESS:
+ annotation_fn = lambda disk, _: disk
+ else:
+ annotation_fn = _AnnotateDParamsGeneric
- This is a single-node call that must be executed on the source node.
+ new_disks = []
+ for disk in disks:
+ new_disks.append(annotation_fn(disk.Copy(), ld_params))
- @type instance: L{objects.Instance}
- @param instance: the instance that is being migrated
- @rtype: L{objects.MigrationStatus}
- @return: the status of the current migration (one of
- L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
- progress info that can be retrieved from the hypervisor
+ return new_disks
- """
- result = self._SingleNodeCall(node, "instance_get_migration_status",
- [self._InstDict(instance)])
- if not result.fail_msg and result.payload is not None:
- result.payload = objects.MigrationStatus.FromDict(result.payload)
- return result
- @_RpcTimeout(_TMO_NORMAL)
- def call_instance_reboot(self, node, inst, reboot_type, shutdown_timeout):
- """Reboots an instance.
+#: Generic encoders
+_ENCODERS = {
+ rpc_defs.ED_OBJECT_DICT: _ObjectToDict,
+ rpc_defs.ED_OBJECT_DICT_LIST: _ObjectListToDict,
+ rpc_defs.ED_NODE_TO_DISK_DICT: _EncodeNodeToDiskDict,
+ rpc_defs.ED_COMPRESS: _Compress,
+ rpc_defs.ED_FINALIZE_EXPORT_DISKS: _PrepareFinalizeExportDisks,
+ rpc_defs.ED_IMPEXP_IO: _EncodeImportExportIO,
+ rpc_defs.ED_BLOCKDEV_RENAME: _EncodeBlockdevRename,
+ }
- This is a single-node call.
- """
- return self._SingleNodeCall(node, "instance_reboot",
- [self._InstDict(inst), reboot_type,
- shutdown_timeout])
+class RpcRunner(_RpcClientBase,
+ _generated_rpc.RpcClientDefault,
+ _generated_rpc.RpcClientBootstrap,
+ _generated_rpc.RpcClientDnsOnly,
+ _generated_rpc.RpcClientConfig):
+ """RPC runner class.
- @_RpcTimeout(_TMO_1DAY)
- def call_instance_os_add(self, node, inst, reinstall, debug, osparams=None):
- """Installs an OS on the given instance.
+ """
+ def __init__(self, cfg, lock_monitor_cb, _req_process_fn=None, _getents=None):
+ """Initialized the RPC runner.
- This is a single-node call.
+ @type cfg: L{config.ConfigWriter}
+ @param cfg: Configuration
+ @type lock_monitor_cb: callable
+ @param lock_monitor_cb: Lock monitor callback
"""
- return self._SingleNodeCall(node, "instance_os_add",
- [self._InstDict(inst, osp=osparams),
- reinstall, debug])
-
- @_RpcTimeout(_TMO_SLOW)
- def call_instance_run_rename(self, node, inst, old_name, debug):
- """Run the OS rename script for an instance.
+ self._cfg = cfg
- This is a single-node call.
+ encoders = _ENCODERS.copy()
- """
- return self._SingleNodeCall(node, "instance_run_rename",
- [self._InstDict(inst), old_name, debug])
+ encoders.update({
+ # Encoders requiring configuration object
+ rpc_defs.ED_INST_DICT: self._InstDict,
+ rpc_defs.ED_INST_DICT_HVP_BEP: self._InstDictHvpBep,
+ rpc_defs.ED_INST_DICT_OSP: self._InstDictOsp,
- @_RpcTimeout(_TMO_URGENT)
- def call_instance_info(self, node, instance, hname):
- """Returns information about a single instance.
+ # Encoders annotating disk parameters
+ rpc_defs.ED_DISKS_DICT_DP: self._DisksDictDP,
+ rpc_defs.ED_SINGLE_DISK_DICT_DP: self._SingleDiskDictDP,
- This is a single-node call.
+ # Encoders with special requirements
+ rpc_defs.ED_FILE_DETAILS: compat.partial(_PrepareFileUpload, _getents),
+ })
- @type node: list
- @param node: the list of nodes to query
- @type instance: string
- @param instance: the instance name
- @type hname: string
- @param hname: the hypervisor type of the instance
+ # Resolver using configuration
+ resolver = compat.partial(_NodeConfigResolver, cfg.GetNodeInfo,
+ cfg.GetAllNodesInfo)
- """
- return self._SingleNodeCall(node, "instance_info", [instance, hname])
+ # Pylint doesn't recognize multiple inheritance properly, see
+ # <http://www.logilab.org/ticket/36586> and
+ # <http://www.logilab.org/ticket/35642>
+ # pylint: disable=W0233
+ _RpcClientBase.__init__(self, resolver, encoders.get,
+ lock_monitor_cb=lock_monitor_cb,
+ _req_process_fn=_req_process_fn)
+ _generated_rpc.RpcClientConfig.__init__(self)
+ _generated_rpc.RpcClientBootstrap.__init__(self)
+ _generated_rpc.RpcClientDnsOnly.__init__(self)
+ _generated_rpc.RpcClientDefault.__init__(self)
- @_RpcTimeout(_TMO_NORMAL)
- def call_instance_migratable(self, node, instance):
- """Checks whether the given instance can be migrated.
+ def _InstDict(self, instance, hvp=None, bep=None, osp=None):
+ """Convert the given instance to a dict.
- This is a single-node call.
+ This is done via the instance's ToDict() method and additionally
+ we fill the hvparams with the cluster defaults.
- @param node: the node to query
@type instance: L{objects.Instance}
- @param instance: the instance to check
-
-
- """
- return self._SingleNodeCall(node, "instance_migratable",
- [self._InstDict(instance)])
-
- @_RpcTimeout(_TMO_URGENT)
- def call_all_instances_info(self, node_list, hypervisor_list):
- """Returns information about all instances on the given nodes.
-
- This is a multi-node call.
-
- @type node_list: list
- @param node_list: the list of nodes to query
- @type hypervisor_list: list
- @param hypervisor_list: the hypervisors to query for instances
-
- """
- return self._MultiNodeCall(node_list, "all_instances_info",
- [hypervisor_list])
-
- @_RpcTimeout(_TMO_URGENT)
- def call_instance_list(self, node_list, hypervisor_list):
- """Returns the list of running instances on a given node.
-
- This is a multi-node call.
-
- @type node_list: list
- @param node_list: the list of nodes to query
- @type hypervisor_list: list
- @param hypervisor_list: the hypervisors to query for instances
-
- """
- return self._MultiNodeCall(node_list, "instance_list", [hypervisor_list])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_etc_hosts_modify(self, node, mode, name, ip):
- """Modify hosts file with name
-
- @type node: string
- @param node: The node to call
- @type mode: string
- @param mode: The mode to operate. Currently "add" or "remove"
- @type name: string
- @param name: The host name to be modified
- @type ip: string
- @param ip: The ip of the entry (just valid if mode is "add")
-
- """
- return self._SingleNodeCall(node, "etc_hosts_modify", [mode, name, ip])
-
- @classmethod
- @_RpcTimeout(_TMO_FAST)
- def call_node_start_master_daemons(cls, node, no_voting):
- """Starts master daemons on a node.
-
- This is a single-node call.
-
- """
- return cls._StaticSingleNodeCall(node, "node_start_master_daemons",
- [no_voting])
-
- @classmethod
- @_RpcTimeout(_TMO_FAST)
- def call_node_activate_master_ip(cls, node):
- """Activates master IP on a node.
-
- This is a single-node call.
-
- """
- return cls._StaticSingleNodeCall(node, "node_activate_master_ip", [])
-
- @classmethod
- @_RpcTimeout(_TMO_FAST)
- def call_node_stop_master(cls, node):
- """Deactivates master IP and stops master daemons on a node.
-
- This is a single-node call.
-
- """
- return cls._StaticSingleNodeCall(node, "node_stop_master", [])
-
- @classmethod
- @_RpcTimeout(_TMO_FAST)
- def call_node_deactivate_master_ip(cls, node):
- """Deactivates master IP on a node.
-
- This is a single-node call.
-
- """
- return cls._StaticSingleNodeCall(node, "node_deactivate_master_ip", [])
-
- @classmethod
- @_RpcTimeout(_TMO_FAST)
- def call_node_change_master_netmask(cls, node, netmask):
- """Change master IP netmask.
-
- This is a single-node call.
-
- """
- return cls._StaticSingleNodeCall(node, "node_change_master_netmask",
- [netmask])
-
- @classmethod
- @_RpcTimeout(_TMO_URGENT)
- def call_master_info(cls, node_list):
- """Query master info.
-
- This is a multi-node call.
-
- """
- # TODO: should this method query down nodes?
- return cls._StaticMultiNodeCall(node_list, "master_info", [])
-
- @classmethod
- @_RpcTimeout(_TMO_URGENT)
- def call_version(cls, node_list):
- """Query node version.
-
- This is a multi-node call.
-
- """
- return cls._StaticMultiNodeCall(node_list, "version", [])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_create(self, node, bdev, size, owner, on_primary, info):
- """Request creation of a given block device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_create",
- [bdev.ToDict(), size, owner, on_primary, info])
-
- @_RpcTimeout(_TMO_SLOW)
- def call_blockdev_wipe(self, node, bdev, offset, size):
- """Request wipe at given offset with given size of a block device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_wipe",
- [bdev.ToDict(), offset, size])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_remove(self, node, bdev):
- """Request removal of a given block device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_remove", [bdev.ToDict()])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_rename(self, node, devlist):
- """Request rename of the given block devices.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_rename",
- [[(d.ToDict(), uid) for d, uid in devlist]])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_pause_resume_sync(self, node, disks, pause):
- """Request a pause/resume of given block device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_pause_resume_sync",
- [[bdev.ToDict() for bdev in disks], pause])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_assemble(self, node, disk, owner, on_primary, idx):
- """Request assembling of a given block device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_assemble",
- [disk.ToDict(), owner, on_primary, idx])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_shutdown(self, node, disk):
- """Request shutdown of a given block device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_shutdown", [disk.ToDict()])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_addchildren(self, node, bdev, ndevs):
- """Request adding a list of children to a (mirroring) device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_addchildren",
- [bdev.ToDict(),
- [disk.ToDict() for disk in ndevs]])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_removechildren(self, node, bdev, ndevs):
- """Request removing a list of children from a (mirroring) device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_removechildren",
- [bdev.ToDict(),
- [disk.ToDict() for disk in ndevs]])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_getmirrorstatus(self, node, disks):
- """Request status of a (mirroring) device.
-
- This is a single-node call.
-
- """
- result = self._SingleNodeCall(node, "blockdev_getmirrorstatus",
- [dsk.ToDict() for dsk in disks])
- if not result.fail_msg:
- result.payload = [objects.BlockDevStatus.FromDict(i)
- for i in result.payload]
- return result
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_getmirrorstatus_multi(self, node_list, node_disks):
- """Request status of (mirroring) devices from multiple nodes.
-
- This is a multi-node call.
-
- """
- result = self._MultiNodeCall(node_list, "blockdev_getmirrorstatus_multi",
- [dict((name, [dsk.ToDict() for dsk in disks])
- for name, disks in node_disks.items())])
- for nres in result.values():
- if nres.fail_msg:
- continue
-
- for idx, (success, status) in enumerate(nres.payload):
- if success:
- nres.payload[idx] = (success, objects.BlockDevStatus.FromDict(status))
-
- return result
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_find(self, node, disk):
- """Request identification of a given block device.
-
- This is a single-node call.
-
- """
- result = self._SingleNodeCall(node, "blockdev_find", [disk.ToDict()])
- if not result.fail_msg and result.payload is not None:
- result.payload = objects.BlockDevStatus.FromDict(result.payload)
- return result
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_close(self, node, instance_name, disks):
- """Closes the given block devices.
-
- This is a single-node call.
-
- """
- params = [instance_name, [cf.ToDict() for cf in disks]]
- return self._SingleNodeCall(node, "blockdev_close", params)
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_getsize(self, node, disks):
- """Returns the size of the given disks.
-
- This is a single-node call.
-
- """
- params = [[cf.ToDict() for cf in disks]]
- return self._SingleNodeCall(node, "blockdev_getsize", params)
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_drbd_disconnect_net(self, node_list, nodes_ip, disks):
- """Disconnects the network of the given drbd devices.
-
- This is a multi-node call.
-
- """
- return self._MultiNodeCall(node_list, "drbd_disconnect_net",
- [nodes_ip, [cf.ToDict() for cf in disks]])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_drbd_attach_net(self, node_list, nodes_ip,
- disks, instance_name, multimaster):
- """Disconnects the given drbd devices.
-
- This is a multi-node call.
-
- """
- return self._MultiNodeCall(node_list, "drbd_attach_net",
- [nodes_ip, [cf.ToDict() for cf in disks],
- instance_name, multimaster])
-
- @_RpcTimeout(_TMO_SLOW)
- def call_drbd_wait_sync(self, node_list, nodes_ip, disks):
- """Waits for the synchronization of drbd devices is complete.
-
- This is a multi-node call.
-
- """
- return self._MultiNodeCall(node_list, "drbd_wait_sync",
- [nodes_ip, [cf.ToDict() for cf in disks]])
-
- @_RpcTimeout(_TMO_URGENT)
- def call_drbd_helper(self, node_list):
- """Gets drbd helper.
-
- This is a multi-node call.
-
- """
- return self._MultiNodeCall(node_list, "drbd_helper", [])
-
- @classmethod
- @_RpcTimeout(_TMO_NORMAL)
- def call_upload_file(cls, node_list, file_name, address_list=None):
- """Upload a file.
-
- The node will refuse the operation in case the file is not on the
- approved file list.
-
- This is a multi-node call.
-
- @type node_list: list
- @param node_list: the list of node names to upload to
- @type file_name: str
- @param file_name: the filename to upload
- @type address_list: list or None
- @keyword address_list: an optional list of node addresses, in order
- to optimize the RPC speed
-
- """
- file_contents = utils.ReadFile(file_name)
- data = _Compress(file_contents)
- st = os.stat(file_name)
- getents = runtime.GetEnts()
- params = [file_name, data, st.st_mode, getents.LookupUid(st.st_uid),
- getents.LookupGid(st.st_gid), st.st_atime, st.st_mtime]
- return cls._StaticMultiNodeCall(node_list, "upload_file", params,
- address_list=address_list)
-
- @classmethod
- @_RpcTimeout(_TMO_NORMAL)
- def call_write_ssconf_files(cls, node_list, values):
- """Write ssconf files.
-
- This is a multi-node call.
-
- """
- return cls._StaticMultiNodeCall(node_list, "write_ssconf_files", [values])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_run_oob(self, node, oob_program, command, remote_node, timeout):
- """Runs OOB.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "run_oob", [oob_program, command,
- remote_node, timeout])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_hooks_runner(self, node_list, hpath, phase, env):
- """Call the hooks runner.
-
- Args:
- - op: the OpCode instance
- - env: a dictionary with the environment
-
- This is a multi-node call.
-
- """
- params = [hpath, phase, env]
- return self._MultiNodeCall(node_list, "hooks_runner", params)
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_iallocator_runner(self, node, name, idata):
- """Call an iallocator on a remote node
-
- Args:
- - name: the iallocator name
- - input: the json-encoded input string
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "iallocator_runner", [name, idata])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_grow(self, node, cf_bdev, amount, dryrun):
- """Request a snapshot of the given block device.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_grow",
- [cf_bdev.ToDict(), amount, dryrun])
-
- @_RpcTimeout(_TMO_1DAY)
- def call_blockdev_export(self, node, cf_bdev,
- dest_node, dest_path, cluster_name):
- """Export a given disk to another node.
-
- This is a single-node call.
-
- """
- return self._SingleNodeCall(node, "blockdev_export",
- [cf_bdev.ToDict(), dest_node, dest_path,
- cluster_name])
-
- @_RpcTimeout(_TMO_NORMAL)
- def call_blockdev_snapshot(self, node, cf_bdev):
- """Request a snapshot of the given block device.
-
- This is a single-node call.
+ @param instance: an Instance object
+ @type hvp: dict or None
+ @param hvp: a dictionary with overridden hypervisor parameters
+ @type bep: dict or None
+ @param bep: a dictionary with overridden backend parameters
+ @type osp: dict or None
+ @param osp: a dictionary with overridden os parameters
+ @rtype: dict
+ @return: the instance dict, with the hvparams filled with the
+ cluster defaults
"""
- return self._SingleNodeCall(node, "blockdev_snapshot", [cf_bdev.ToDict()])
-
- @classmethod
- @_RpcTimeout(_TMO_NORMAL)
- def call_node_leave_cluster(cls, node, modify_ssh_setup):
- """Requests a node to clean the cluster information it has.
-
- This will remove the configuration information from the ganeti data
- dir.
+ idict = instance.ToDict()
+ cluster = self._cfg.GetClusterInfo()
+ idict["hvparams"] = cluster.FillHV(instance)
+ if hvp is not None:
+ idict["hvparams"].update(hvp)
+ idict["beparams"] = cluster.FillBE(instance)
+ if bep is not None:
+ idict["beparams"].update(bep)
+ idict["osparams"] = cluster.SimpleFillOS(instance.os, instance.osparams)
+ if osp is not None:
+ idict["osparams"].update(osp)
+ for nic in idict["nics"]:
+ nic["nicparams"] = objects.FillDict(
+ cluster.nicparams[constants.PP_DEFAULT],
+ nic["nicparams"])
+ return idict
- This is a single-node call.
+ def _InstDictHvpBep(self, (instance, hvp, bep)):
+ """Wrapper for L{_InstDict}.
"""
- return cls._StaticSingleNodeCall(node, "node_leave_cluster",
- [modify_ssh_setup])
-
- @_RpcTimeout(None)
- def call_test_delay(self, node_list, duration):
- """Sleep for a fixed time on given node(s).
+ return self._InstDict(instance, hvp=hvp, bep=bep)
- This is a multi-node call.
+ def _InstDictOsp(self, (instance, osparams)):
+ """Wrapper for L{_InstDict}.
"""
- return self._MultiNodeCall(node_list, "test_delay", [duration],
- read_timeout=int(duration + 5))
-
- @_RpcTimeout(_TMO_FAST)
- def call_file_storage_dir_create(self, node, file_storage_dir):
- """Create the given file storage directory.
+ return self._InstDict(instance, osp=osparams)
- This is a single-node call.
+ def _DisksDictDP(self, (disks, instance)):
+ """Wrapper for L{AnnotateDiskParams}.
"""
- return self._SingleNodeCall(node, "file_storage_dir_create",
- [file_storage_dir])
+ diskparams = self._cfg.GetInstanceDiskParams(instance)
+ return [disk.ToDict()
+ for disk in AnnotateDiskParams(instance.disk_template,
+ disks, diskparams)]
- @_RpcTimeout(_TMO_FAST)
- def call_file_storage_dir_remove(self, node, file_storage_dir):
- """Remove the given file storage directory.
-
- This is a single-node call.
+ def _SingleDiskDictDP(self, (disk, instance)):
+ """Wrapper for L{AnnotateDiskParams}.
"""
- return self._SingleNodeCall(node, "file_storage_dir_remove",
- [file_storage_dir])
+ (anno_disk,) = self._DisksDictDP(([disk], instance))
+ return anno_disk
- @_RpcTimeout(_TMO_FAST)
- def call_file_storage_dir_rename(self, node, old_file_storage_dir,
- new_file_storage_dir):
- """Rename file storage directory.
- This is a single-node call.
+class JobQueueRunner(_RpcClientBase, _generated_rpc.RpcClientJobQueue):
+ """RPC wrappers for job queue.
- """
- return self._SingleNodeCall(node, "file_storage_dir_rename",
- [old_file_storage_dir, new_file_storage_dir])
-
- @classmethod
- @_RpcTimeout(_TMO_URGENT)
- def call_jobqueue_update(cls, node_list, address_list, file_name, content):
- """Update job queue.
-
- This is a multi-node call.
+ """
+ def __init__(self, context, address_list):
+ """Initializes this class.
"""
- return cls._StaticMultiNodeCall(node_list, "jobqueue_update",
- [file_name, _Compress(content)],
- address_list=address_list)
-
- @classmethod
- @_RpcTimeout(_TMO_NORMAL)
- def call_jobqueue_purge(cls, node):
- """Purge job queue.
+ if address_list is None:
+ resolver = compat.partial(_SsconfResolver, True)
+ else:
+ # Caller provided an address list
+ resolver = _StaticResolver(address_list)
- This is a single-node call.
+ _RpcClientBase.__init__(self, resolver, _ENCODERS.get,
+ lock_monitor_cb=context.glm.AddToLockMonitor)
+ _generated_rpc.RpcClientJobQueue.__init__(self)
- """
- return cls._StaticSingleNodeCall(node, "jobqueue_purge", [])
- @classmethod
- @_RpcTimeout(_TMO_URGENT)
- def call_jobqueue_rename(cls, node_list, address_list, rename):
- """Rename a job queue file.
+class BootstrapRunner(_RpcClientBase,
+ _generated_rpc.RpcClientBootstrap,
+ _generated_rpc.RpcClientDnsOnly):
+ """RPC wrappers for bootstrapping.
- This is a multi-node call.
+ """
+ def __init__(self):
+ """Initializes this class.
"""
- return cls._StaticMultiNodeCall(node_list, "jobqueue_rename", rename,
- address_list=address_list)
+ # Pylint doesn't recognize multiple inheritance properly, see
+ # <http://www.logilab.org/ticket/36586> and
+ # <http://www.logilab.org/ticket/35642>
+ # pylint: disable=W0233
+ _RpcClientBase.__init__(self, compat.partial(_SsconfResolver, True),
+ _ENCODERS.get)
+ _generated_rpc.RpcClientBootstrap.__init__(self)
+ _generated_rpc.RpcClientDnsOnly.__init__(self)
- @_RpcTimeout(_TMO_NORMAL)
- def call_hypervisor_validate_params(self, node_list, hvname, hvparams):
- """Validate the hypervisor params.
- This is a multi-node call.
+class DnsOnlyRunner(_RpcClientBase, _generated_rpc.RpcClientDnsOnly):
+ """RPC wrappers for calls using only DNS.
- @type node_list: list
- @param node_list: the list of nodes to query
- @type hvname: string
- @param hvname: the hypervisor name
- @type hvparams: dict
- @param hvparams: the hypervisor parameters to be validated
+ """
+ def __init__(self):
+ """Initialize this class.
"""
- cluster = self._cfg.GetClusterInfo()
- hv_full = objects.FillDict(cluster.hvparams.get(hvname, {}), hvparams)
- return self._MultiNodeCall(node_list, "hypervisor_validate_params",
- [hvname, hv_full])
+ _RpcClientBase.__init__(self, compat.partial(_SsconfResolver, False),
+ _ENCODERS.get)
+ _generated_rpc.RpcClientDnsOnly.__init__(self)
- @_RpcTimeout(_TMO_NORMAL)
- def call_import_start(self, node, opts, instance, component,
- dest, dest_args):
- """Starts a listener for an import.
- This is a single-node call.
+class ConfigRunner(_RpcClientBase, _generated_rpc.RpcClientConfig):
+ """RPC wrappers for L{config}.
- @type node: string
- @param node: Node name
- @type instance: C{objects.Instance}
- @param instance: Instance object
- @type component: string
- @param component: which part of the instance is being imported
+ """
+ def __init__(self, context, address_list, _req_process_fn=None,
+ _getents=None):
+ """Initializes this class.
"""
- return self._SingleNodeCall(node, "import_start",
- [opts.ToDict(),
- self._InstDict(instance), component, dest,
- _EncodeImportExportIO(dest, dest_args)])
+ if context:
+ lock_monitor_cb = context.glm.AddToLockMonitor
+ else:
+ lock_monitor_cb = None
- @_RpcTimeout(_TMO_NORMAL)
- def call_export_start(self, node, opts, host, port,
- instance, component, source, source_args):
- """Starts an export daemon.
+ if address_list is None:
+ resolver = compat.partial(_SsconfResolver, True)
+ else:
+ # Caller provided an address list
+ resolver = _StaticResolver(address_list)
- This is a single-node call.
+ encoders = _ENCODERS.copy()
- @type node: string
- @param node: Node name
- @type instance: C{objects.Instance}
- @param instance: Instance object
- @type component: string
- @param component: which part of the instance is being imported
+ encoders.update({
+ rpc_defs.ED_FILE_DETAILS: compat.partial(_PrepareFileUpload, _getents),
+ })
- """
- return self._SingleNodeCall(node, "export_start",
- [opts.ToDict(), host, port,
- self._InstDict(instance),
- component, source,
- _EncodeImportExportIO(source, source_args)])
+ _RpcClientBase.__init__(self, resolver, encoders.get,
+ lock_monitor_cb=lock_monitor_cb,
+ _req_process_fn=_req_process_fn)
+ _generated_rpc.RpcClientConfig.__init__(self)