cmdlib.py 216 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2 3
#

4
# Copyright (C) 2006, 2007, 2008 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


22
"""Module implementing the master-side code."""
Iustin Pop's avatar
Iustin Pop committed
23 24 25 26 27 28 29 30 31 32

# pylint: disable-msg=W0613,W0201

import os
import os.path
import sha
import time
import tempfile
import re
import platform
33
import logging
34
import copy
35
import random
Iustin Pop's avatar
Iustin Pop committed
36 37 38 39 40

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
41
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
42 43 44
from ganeti import constants
from ganeti import objects
from ganeti import opcodes
45
from ganeti import serializer
46
from ganeti import ssconf
47 48


Iustin Pop's avatar
Iustin Pop committed
49
class LogicalUnit(object):
50
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
51 52

  Subclasses must follow these rules:
53 54
    - implement ExpandNames
    - implement CheckPrereq
Iustin Pop's avatar
Iustin Pop committed
55 56 57
    - implement Exec
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
58
    - optionally redefine their run requirements:
59
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
60 61

  Note that all commands require root permissions.
Iustin Pop's avatar
Iustin Pop committed
62 63 64 65 66

  """
  HPATH = None
  HTYPE = None
  _OP_REQP = []
67
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
68

Iustin Pop's avatar
Iustin Pop committed
69
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
70 71 72 73 74 75
    """Constructor for LogicalUnit.

    This needs to be overriden in derived classes in order to check op
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
76
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
77
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
78 79
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
80
    self.rpc = rpc
81
    # Dicts used to declare locking needs to mcpu
82
    self.needed_locks = None
83
    self.acquired_locks = {}
Guido Trotter's avatar
Guido Trotter committed
84
    self.share_locks = dict(((i, 0) for i in locking.LEVELS))
85 86
    self.add_locks = {}
    self.remove_locks = {}
87 88
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
89
    self.__ssh = None
90 91 92
    # logging
    self.LogWarning = processor.LogWarning
    self.LogInfo = processor.LogInfo
93

Iustin Pop's avatar
Iustin Pop committed
94 95 96
    for attr_name in self._OP_REQP:
      attr_val = getattr(op, attr_name, None)
      if attr_val is None:
97 98
        raise errors.OpPrereqError("Required parameter '%s' missing" %
                                   attr_name)
99
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
100

101 102 103 104 105
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
106
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
107 108 109 110
    return self.__ssh

  ssh = property(fget=__GetSSH)

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
  def CheckArguments(self):
    """Check syntactic validity for the opcode arguments.

    This method is for doing a simple syntactic check and ensure
    validity of opcode parameters, without any cluster-related
    checks. While the same can be accomplished in ExpandNames and/or
    CheckPrereq, doing these separate is better because:

      - ExpandNames is left as as purely a lock-related function
      - CheckPrereq is run after we have aquired locks (and possible
        waited for them)

    The function is allowed to change the self.op attribute so that
    later methods can no longer worry about missing parameters.

    """
    pass

129 130 131 132 133 134 135 136 137 138 139
  def ExpandNames(self):
    """Expand names for this LU.

    This method is called before starting to execute the opcode, and it should
    update all the parameters of the opcode to their canonical form (e.g. a
    short node name must be fully expanded after this method has successfully
    completed). This way locking, hooks, logging, ecc. can work correctly.

    LUs which implement this method must also populate the self.needed_locks
    member, as a dict with lock levels as keys, and a list of needed lock names
    as values. Rules:
140 141 142 143 144

      - use an empty dict if you don't need any lock
      - if you don't need any lock at a particular level omit that level
      - don't put anything for the BGL level
      - if you want all locks at a level use locking.ALL_SET as a value
145

Guido Trotter's avatar
Guido Trotter committed
146 147 148 149
    If you need to share locks (rather than acquire them exclusively) at one
    level you can modify self.share_locks, setting a true value (usually 1) for
    that level. By default locks are not shared.

150 151 152 153 154 155 156 157 158 159 160 161 162
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
        locking.LEVEL_INSTANCE: ['instance1.example.tld'],
      }
      # Acquire just two nodes
      self.needed_locks = {
        locking.LEVEL_NODE: ['node1.example.tld', 'node2.example.tld'],
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
163 164 165 166 167 168 169 170 171 172

    """
    # The implementation of this method is mandatory only if the new LU is
    # concurrent, so that old LUs don't need to be changed all at the same
    # time.
    if self.REQ_BGL:
      self.needed_locks = {} # Exclusive LUs don't need locks.
    else:
      raise NotImplementedError

Guido Trotter's avatar
Guido Trotter committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
  def DeclareLocks(self, level):
    """Declare LU locking needs for a level

    While most LUs can just declare their locking needs at ExpandNames time,
    sometimes there's the need to calculate some locks after having acquired
    the ones before. This function is called just before acquiring locks at a
    particular level, but after acquiring the ones at lower levels, and permits
    such calculations. It can be used to modify self.needed_locks, and by
    default it does nothing.

    This function is only called if you have something already set in
    self.needed_locks for the level.

    @param level: Locking level which is going to be locked
    @type level: member of ganeti.locking.LEVELS

    """

Iustin Pop's avatar
Iustin Pop committed
191 192 193 194 195 196 197 198 199 200 201 202
  def CheckPrereq(self):
    """Check prerequisites for this LU.

    This method should check that the prerequisites for the execution
    of this LU are fulfilled. It can do internode communication, but
    it should be idempotent - no cluster or system changes are
    allowed.

    The method should raise errors.OpPrereqError in case something is
    not fulfilled. Its return value is ignored.

    This method should also update all the parameters of the opcode to
203
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

    """
    raise NotImplementedError

  def Exec(self, feedback_fn):
    """Execute the LU.

    This method should implement the actual work. It should raise
    errors.OpExecError for failures that are somewhat dealt with in
    code, or expected.

    """
    raise NotImplementedError

  def BuildHooksEnv(self):
    """Build hooks environment for this LU.

    This method should return a three-node tuple consisting of: a dict
    containing the environment that will be used for running the
    specific hook for this LU, a list of node names on which the hook
    should run before the execution, and a list of node names on which
    the hook should run after the execution.

    The keys of the dict must not have 'GANETI_' prefixed as this will
    be handled in the hooks runner. Also note additional keys will be
    added by the hooks runner. If the LU doesn't define any
    environment, an empty dict (and not None) should be returned.

232
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
233 234 235 236 237 238 239

    Note that if the HPATH for a LU class is None, this function will
    not be called.

    """
    raise NotImplementedError

240 241 242 243 244 245 246 247 248
  def HooksCallBack(self, phase, hook_results, feedback_fn, lu_result):
    """Notify the LU about the results of its hooks.

    This method is called every time a hooks phase is executed, and notifies
    the Logical Unit about the hooks' result. The LU can then use it to alter
    its result based on the hooks.  By default the method does nothing and the
    previous result is passed back unchanged but any LU can define it if it
    wants to use the local cluster hook-scripts somehow.

249 250 251 252 253 254 255 256
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
    @param hook_results: the results of the multi-node hooks rpc call
    @param feedback_fn: function used send feedback back to the caller
    @param lu_result: the previous Exec result this LU had, or None
        in the PRE phase
    @return: the new Exec result, based on the previous result
        and hook results
257 258 259 260

    """
    return lu_result

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  def _ExpandAndLockInstance(self):
    """Helper function to expand and lock an instance.

    Many LUs that work on an instance take its name in self.op.instance_name
    and need to expand it and then declare the expanded name for locking. This
    function does it, and then updates self.op.instance_name to the expanded
    name. It also initializes needed_locks as a dict, if this hasn't been done
    before.

    """
    if self.needed_locks is None:
      self.needed_locks = {}
    else:
      assert locking.LEVEL_INSTANCE not in self.needed_locks, \
        "_ExpandAndLockInstance called with instance-level locks set"
    expanded_name = self.cfg.ExpandInstanceName(self.op.instance_name)
    if expanded_name is None:
      raise errors.OpPrereqError("Instance '%s' not known" %
                                  self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = expanded_name
    self.op.instance_name = expanded_name

283
  def _LockInstancesNodes(self, primary_only=False):
284 285 286 287 288 289 290 291 292 293 294 295 296
    """Helper function to declare instances' nodes for locking.

    This function should be called after locking one or more instances to lock
    their nodes. Its effect is populating self.needed_locks[locking.LEVEL_NODE]
    with all primary or secondary nodes for instances already locked and
    present in self.needed_locks[locking.LEVEL_INSTANCE].

    It should be called from DeclareLocks, and for safety only works if
    self.recalculate_locks[locking.LEVEL_NODE] is set.

    In the future it may grow parameters to just lock some instance's nodes, or
    to just lock primaries or secondary nodes, if needed.

297
    If should be called in DeclareLocks in a way similar to::
298

299 300
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
301

302 303 304
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

305 306 307 308 309 310 311 312 313 314
    """
    assert locking.LEVEL_NODE in self.recalculate_locks, \
      "_LockInstancesNodes helper function called with no nodes to recalculate"

    # TODO: check if we're really been called with the instance locks held

    # For now we'll replace self.needed_locks[locking.LEVEL_NODE], but in the
    # future we might want to have different behaviors depending on the value
    # of self.recalculate_locks[locking.LEVEL_NODE]
    wanted_nodes = []
315
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
316 317
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
318 319
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
320 321 322 323 324

    if self.recalculate_locks[locking.LEVEL_NODE] == constants.LOCKS_REPLACE:
      self.needed_locks[locking.LEVEL_NODE] = wanted_nodes
    elif self.recalculate_locks[locking.LEVEL_NODE] == constants.LOCKS_APPEND:
      self.needed_locks[locking.LEVEL_NODE].extend(wanted_nodes)
325 326 327

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
328 329 330 331 332 333 334 335 336 337 338 339

class NoHooksLU(LogicalUnit):
  """Simple LU which runs no hooks.

  This LU is intended as a parent for other LogicalUnits which will
  run no hooks, in order to reduce duplicate code.

  """
  HPATH = None
  HTYPE = None


340
def _GetWantedNodes(lu, nodes):
341
  """Returns list of checked and expanded node names.
342

343 344 345 346 347 348 349
  @type lu: L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type nodes: list
  @param nodes: list of node names or None for all nodes
  @rtype: list
  @return: the list of nodes, sorted
  @raise errors.OpProgrammerError: if the nodes parameter is wrong type
350 351

  """
352
  if not isinstance(nodes, list):
353
    raise errors.OpPrereqError("Invalid argument type 'nodes'")
354

355 356 357
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
358

359 360 361 362 363 364
  wanted = []
  for name in nodes:
    node = lu.cfg.ExpandNodeName(name)
    if node is None:
      raise errors.OpPrereqError("No such node name '%s'" % name)
    wanted.append(node)
365

366
  return utils.NiceSort(wanted)
367 368 369


def _GetWantedInstances(lu, instances):
370
  """Returns list of checked and expanded instance names.
371

372 373 374 375 376 377 378 379
  @type lu: L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type instances: list
  @param instances: list of instance names or None for all instances
  @rtype: list
  @return: the list of instances, sorted
  @raise errors.OpPrereqError: if the instances parameter is wrong type
  @raise errors.OpPrereqError: if any of the passed instances is not found
380 381 382 383 384 385 386 387 388

  """
  if not isinstance(instances, list):
    raise errors.OpPrereqError("Invalid argument type 'instances'")

  if instances:
    wanted = []

    for name in instances:
389
      instance = lu.cfg.ExpandInstanceName(name)
390 391 392 393 394
      if instance is None:
        raise errors.OpPrereqError("No such instance name '%s'" % name)
      wanted.append(instance)

  else:
395 396
    wanted = lu.cfg.GetInstanceList()
  return utils.NiceSort(wanted)
397 398 399


def _CheckOutputFields(static, dynamic, selected):
400 401
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
402
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
403
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
404
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
405
  @param dynamic: dynamic fields set
406 407

  """
Iustin Pop's avatar
Iustin Pop committed
408
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
409 410
  f.Extend(static)
  f.Extend(dynamic)
411

Iustin Pop's avatar
Iustin Pop committed
412 413
  delta = f.NonMatching(selected)
  if delta:
414
    raise errors.OpPrereqError("Unknown output fields selected: %s"
Iustin Pop's avatar
Iustin Pop committed
415
                               % ",".join(delta))
416 417


418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
def _CheckBooleanOpField(op, name):
  """Validates boolean opcode parameters.

  This will ensure that an opcode parameter is either a boolean value,
  or None (but that it always exists).

  """
  val = getattr(op, name, None)
  if not (val is None or isinstance(val, bool)):
    raise errors.OpPrereqError("Invalid boolean parameter '%s' (%s)" %
                               (name, str(val)))
  setattr(op, name, val)


def _CheckNodeOnline(lu, node):
  """Ensure that a given node is online.

  @param lu: the LU on behalf of which we make the check
  @param node: the node to check
  @raise errors.OpPrereqError: if the nodes is offline

  """
  if lu.cfg.GetNodeInfo(node).offline:
    raise errors.OpPrereqError("Can't use offline node %s" % node)


444
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
445
                          memory, vcpus, nics):
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
  """Builds instance related env variables for hooks

  This builds the hook environment from individual variables.

  @type name: string
  @param name: the name of the instance
  @type primary_node: string
  @param primary_node: the name of the instance's primary node
  @type secondary_nodes: list
  @param secondary_nodes: list of secondary nodes as strings
  @type os_type: string
  @param os_type: the name of the instance's OS
  @type status: string
  @param status: the desired status of the instances
  @type memory: string
  @param memory: the memory size of the instance
  @type vcpus: string
  @param vcpus: the count of VCPUs the instance has
  @type nics: list
  @param nics: list of tuples (ip, bridge, mac) representing
      the NICs the instance  has
  @rtype: dict
  @return: the hook environment for this instance
469

470 471
  """
  env = {
472
    "OP_TARGET": name,
473 474 475
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
476
    "INSTANCE_OS_TYPE": os_type,
477 478 479 480 481 482 483
    "INSTANCE_STATUS": status,
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
  }

  if nics:
    nic_count = len(nics)
484
    for idx, (ip, bridge, mac) in enumerate(nics):
485 486 487 488
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
      env["INSTANCE_NIC%d_BRIDGE" % idx] = bridge
489
      env["INSTANCE_NIC%d_HWADDR" % idx] = mac
490 491 492 493 494 495 496 497
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

  return env


Iustin Pop's avatar
Iustin Pop committed
498
def _BuildInstanceHookEnvByObject(lu, instance, override=None):
499 500
  """Builds instance related env variables for hooks from an object.

501 502 503 504 505 506 507 508 509 510 511
  @type lu: L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type instance: L{objects.Instance}
  @param instance: the instance for which we should build the
      environment
  @type override: dict
  @param override: dictionary with key/values that will override
      our values
  @rtype: dict
  @return: the hook environment dictionary

512
  """
Iustin Pop's avatar
Iustin Pop committed
513
  bep = lu.cfg.GetClusterInfo().FillBE(instance)
514 515 516 517
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
518
    'os_type': instance.os,
519
    'status': instance.os,
Iustin Pop's avatar
Iustin Pop committed
520 521
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
522
    'nics': [(nic.ip, nic.bridge, nic.mac) for nic in instance.nics],
523 524 525 526 527 528
  }
  if override:
    args.update(override)
  return _BuildInstanceHookEnv(**args)


529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
def _AdjustCandidatePool(lu):
  """Adjust the candidate pool after node operations.

  """
  mod_list = lu.cfg.MaintainCandidatePool()
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
               ", ".join(mod_list))
    for name in mod_list:
      lu.context.ReaddNode(name)
  mc_now, mc_max = lu.cfg.GetMasterCandidateStats()
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


545
def _CheckInstanceBridgesExist(lu, instance):
546 547 548 549 550
  """Check that the brigdes needed by an instance exist.

  """
  # check bridges existance
  brlist = [nic.bridge for nic in instance.nics]
551 552 553 554
  result = lu.rpc.call_bridges_exist(instance.primary_node, brlist)
  result.Raise()
  if not result.data:
    raise errors.OpPrereqError("One or more target bridges %s does not"
555 556 557 558
                               " exist on destination node '%s'" %
                               (brlist, instance.primary_node))


Iustin Pop's avatar
Iustin Pop committed
559 560 561 562 563 564 565 566 567 568 569 570 571 572
class LUDestroyCluster(NoHooksLU):
  """Logical unit for destroying the cluster.

  """
  _OP_REQP = []

  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

    Any errors are signalled by raising errors.OpPrereqError.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
573
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
574 575

    nodelist = self.cfg.GetNodeList()
576
    if len(nodelist) != 1 or nodelist[0] != master:
577 578
      raise errors.OpPrereqError("There are still %d node(s) in"
                                 " this cluster." % (len(nodelist) - 1))
579 580
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
581 582
      raise errors.OpPrereqError("There are still %d instance(s) in"
                                 " this cluster." % len(instancelist))
Iustin Pop's avatar
Iustin Pop committed
583 584 585 586 587

  def Exec(self, feedback_fn):
    """Destroys the cluster.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
588
    master = self.cfg.GetMasterNode()
589 590 591
    result = self.rpc.call_node_stop_master(master, False)
    result.Raise()
    if not result.data:
592
      raise errors.OpExecError("Could not disable the master role")
593 594 595
    priv_key, pub_key, _ = ssh.GetUserFiles(constants.GANETI_RUNAS)
    utils.CreateBackup(priv_key)
    utils.CreateBackup(pub_key)
Iustin Pop's avatar
Iustin Pop committed
596
    return master
Iustin Pop's avatar
Iustin Pop committed
597 598


Guido Trotter's avatar
Guido Trotter committed
599
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
600 601 602
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
603 604
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
605
  _OP_REQP = ["skip_checks"]
606 607 608 609 610 611 612 613
  REQ_BGL = False

  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
    self.share_locks = dict(((i, 1) for i in locking.LEVELS))
Iustin Pop's avatar
Iustin Pop committed
614

615 616
  def _VerifyNode(self, nodeinfo, file_list, local_cksum,
                  node_result, feedback_fn, master_files):
Iustin Pop's avatar
Iustin Pop committed
617 618
    """Run multiple tests against a node.

619
    Test list:
620

Iustin Pop's avatar
Iustin Pop committed
621 622 623 624 625
      - compares ganeti version
      - checks vg existance and size > 20G
      - checks config file checksum
      - checks ssh to other nodes

626 627
    @type nodeinfo: L{objects.Node}
    @param nodeinfo: the node to check
628 629 630 631
    @param file_list: required list of files
    @param local_cksum: dictionary of local files and their checksums
    @param node_result: the results from the node
    @param feedback_fn: function used to accumulate results
632
    @param master_files: list of files that only masters should have
633

Iustin Pop's avatar
Iustin Pop committed
634
    """
635
    node = nodeinfo.name
636 637 638 639 640 641

    # main result, node_result should be a non-empty dict
    if not node_result or not isinstance(node_result, dict):
      feedback_fn("  - ERROR: unable to verify node %s." % (node,))
      return True

Iustin Pop's avatar
Iustin Pop committed
642 643
    # compares ganeti version
    local_version = constants.PROTOCOL_VERSION
644
    remote_version = node_result.get('version', None)
Iustin Pop's avatar
Iustin Pop committed
645
    if not remote_version:
646
      feedback_fn("  - ERROR: connection to %s failed" % (node))
Iustin Pop's avatar
Iustin Pop committed
647 648 649 650 651 652 653 654 655 656
      return True

    if local_version != remote_version:
      feedback_fn("  - ERROR: sw version mismatch: master %s, node(%s) %s" %
                      (local_version, node, remote_version))
      return True

    # checks vg existance and size > 20G

    bad = False
657
    vglist = node_result.get(constants.NV_VGLIST, None)
Iustin Pop's avatar
Iustin Pop committed
658 659 660 661 662
    if not vglist:
      feedback_fn("  - ERROR: unable to check volume groups on node %s." %
                      (node,))
      bad = True
    else:
663 664
      vgstatus = utils.CheckVolumeGroupSize(vglist, self.cfg.GetVGName(),
                                            constants.MIN_VG_SIZE)
Iustin Pop's avatar
Iustin Pop committed
665 666 667 668 669 670
      if vgstatus:
        feedback_fn("  - ERROR: %s on node %s" % (vgstatus, node))
        bad = True

    # checks config file checksum

671 672
    remote_cksum = node_result.get(constants.NV_FILELIST, None)
    if not isinstance(remote_cksum, dict):
Iustin Pop's avatar
Iustin Pop committed
673 674 675 676
      bad = True
      feedback_fn("  - ERROR: node hasn't returned file checksum data")
    else:
      for file_name in file_list:
677 678
        node_is_mc = nodeinfo.master_candidate
        must_have_file = file_name not in master_files
Iustin Pop's avatar
Iustin Pop committed
679
        if file_name not in remote_cksum:
680 681 682
          if node_is_mc or must_have_file:
            bad = True
            feedback_fn("  - ERROR: file '%s' missing" % file_name)
Iustin Pop's avatar
Iustin Pop committed
683
        elif remote_cksum[file_name] != local_cksum[file_name]:
684 685 686 687 688 689 690 691 692 693 694 695 696
          if node_is_mc or must_have_file:
            bad = True
            feedback_fn("  - ERROR: file '%s' has wrong checksum" % file_name)
          else:
            # not candidate and this is not a must-have file
            bad = True
            feedback_fn("  - ERROR: non master-candidate has old/wrong file"
                        " '%s'" % file_name)
        else:
          # all good, except non-master/non-must have combination
          if not node_is_mc and not must_have_file:
            feedback_fn("  - ERROR: file '%s' should not exist on non master"
                        " candidates" % file_name)
Iustin Pop's avatar
Iustin Pop committed
697

698 699 700
    # checks ssh to any

    if constants.NV_NODELIST not in node_result:
Iustin Pop's avatar
Iustin Pop committed
701
      bad = True
702
      feedback_fn("  - ERROR: node hasn't returned node ssh connectivity data")
Iustin Pop's avatar
Iustin Pop committed
703
    else:
704
      if node_result[constants.NV_NODELIST]:
Iustin Pop's avatar
Iustin Pop committed
705
        bad = True
706
        for node in node_result[constants.NV_NODELIST]:
707
          feedback_fn("  - ERROR: ssh communication with node '%s': %s" %
708 709 710
                          (node, node_result[constants.NV_NODELIST][node]))

    if constants.NV_NODENETTEST not in node_result:
711 712 713
      bad = True
      feedback_fn("  - ERROR: node hasn't returned node tcp connectivity data")
    else:
714
      if node_result[constants.NV_NODENETTEST]:
715
        bad = True
716
        nlist = utils.NiceSort(node_result[constants.NV_NODENETTEST].keys())
717 718
        for node in nlist:
          feedback_fn("  - ERROR: tcp communication with node '%s': %s" %
719
                          (node, node_result[constants.NV_NODENETTEST][node]))
720

721
    hyp_result = node_result.get(constants.NV_HYPERVISOR, None)
722 723 724 725 726
    if isinstance(hyp_result, dict):
      for hv_name, hv_result in hyp_result.iteritems():
        if hv_result is not None:
          feedback_fn("  - ERROR: hypervisor %s verify failure: '%s'" %
                      (hv_name, hv_result))
Iustin Pop's avatar
Iustin Pop committed
727 728
    return bad

729 730
  def _VerifyInstance(self, instance, instanceconfig, node_vol_is,
                      node_instance, feedback_fn):
Iustin Pop's avatar
Iustin Pop committed
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
    """Verify an instance.

    This function checks to see if the required block devices are
    available on the instance's node.

    """
    bad = False

    node_current = instanceconfig.primary_node

    node_vol_should = {}
    instanceconfig.MapLVsByNode(node_vol_should)

    for node in node_vol_should:
      for volume in node_vol_should[node]:
        if node not in node_vol_is or volume not in node_vol_is[node]:
          feedback_fn("  - ERROR: volume %s missing on node %s" %
                          (volume, node))
          bad = True

    if not instanceconfig.status == 'down':
752 753
      if (node_current not in node_instance or
          not instance in node_instance[node_current]):
Iustin Pop's avatar
Iustin Pop committed
754 755 756 757 758 759 760 761 762 763 764
        feedback_fn("  - ERROR: instance %s not running on node %s" %
                        (instance, node_current))
        bad = True

    for node in node_instance:
      if (not node == node_current):
        if instance in node_instance[node]:
          feedback_fn("  - ERROR: instance %s should not run on node %s" %
                          (instance, node))
          bad = True

765
    return bad
Iustin Pop's avatar
Iustin Pop committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798

  def _VerifyOrphanVolumes(self, node_vol_should, node_vol_is, feedback_fn):
    """Verify if there are any unknown volumes in the cluster.

    The .os, .swap and backup volumes are ignored. All other volumes are
    reported as unknown.

    """
    bad = False

    for node in node_vol_is:
      for volume in node_vol_is[node]:
        if node not in node_vol_should or volume not in node_vol_should[node]:
          feedback_fn("  - ERROR: volume %s on node %s should not exist" %
                      (volume, node))
          bad = True
    return bad

  def _VerifyOrphanInstances(self, instancelist, node_instance, feedback_fn):
    """Verify the list of running instances.

    This checks what instances are running but unknown to the cluster.

    """
    bad = False
    for node in node_instance:
      for runninginstance in node_instance[node]:
        if runninginstance not in instancelist:
          feedback_fn("  - ERROR: instance %s on node %s should not exist" %
                          (runninginstance, node))
          bad = True
    return bad

799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
  def _VerifyNPlusOneMemory(self, node_info, instance_cfg, feedback_fn):
    """Verify N+1 Memory Resilience.

    Check that if one single node dies we can still start all the instances it
    was primary for.

    """
    bad = False

    for node, nodeinfo in node_info.iteritems():
      # This code checks that every node which is now listed as secondary has
      # enough memory to host all instances it is supposed to should a single
      # other node in the cluster fail.
      # FIXME: not ready for failover to an arbitrary node
      # FIXME: does not support file-backed instances
      # WARNING: we currently take into account down instances as well as up
      # ones, considering that even if they're down someone might want to start
      # them even in the event of a node failure.
      for prinode, instances in nodeinfo['sinst-by-pnode'].iteritems():
        needed_mem = 0
        for instance in instances:
Iustin Pop's avatar
Iustin Pop committed
820
          bep = self.cfg.GetClusterInfo().FillBE(instance_cfg[instance])
821
          if bep[constants.BE_AUTO_BALANCE]:
822
            needed_mem += bep[constants.BE_MEMORY]
823 824 825 826 827 828
        if nodeinfo['mfree'] < needed_mem:
          feedback_fn("  - ERROR: not enough memory on node %s to accomodate"
                      " failovers should node %s fail" % (node, prinode))
          bad = True
    return bad

Iustin Pop's avatar
Iustin Pop committed
829 830 831
  def CheckPrereq(self):
    """Check prerequisites.

832 833
    Transform the list of checks we're going to skip into a set and check that
    all its members are valid.
Iustin Pop's avatar
Iustin Pop committed
834 835

    """
836 837 838
    self.skip_set = frozenset(self.op.skip_checks)
    if not constants.VERIFY_OPTIONAL_CHECKS.issuperset(self.skip_set):
      raise errors.OpPrereqError("Invalid checks to be skipped specified")
Iustin Pop's avatar
Iustin Pop committed
839

Guido Trotter's avatar
Guido Trotter committed
840 841 842 843 844 845 846 847 848 849 850 851
  def BuildHooksEnv(self):
    """Build hooks env.

    Cluster-Verify hooks just rone in the post phase and their failure makes
    the output be logged in the verify output and the verification to fail.

    """
    all_nodes = self.cfg.GetNodeList()
    # TODO: populate the environment with useful information for verify hooks
    env = {}
    return env, [], all_nodes

Iustin Pop's avatar
Iustin Pop committed
852 853 854 855 856 857
  def Exec(self, feedback_fn):
    """Verify integrity of cluster, performing various test on nodes.

    """
    bad = False
    feedback_fn("* Verifying global settings")
858 859
    for msg in self.cfg.VerifyConfig():
      feedback_fn("  - ERROR: %s" % msg)
Iustin Pop's avatar
Iustin Pop committed
860 861

    vg_name = self.cfg.GetVGName()
862
    hypervisors = self.cfg.GetClusterInfo().enabled_hypervisors
Iustin Pop's avatar
Iustin Pop committed
863
    nodelist = utils.NiceSort(self.cfg.GetNodeList())
864
    nodeinfo = [self.cfg.GetNodeInfo(nname) for nname in nodelist]
Iustin Pop's avatar
Iustin Pop committed
865
    instancelist = utils.NiceSort(self.cfg.GetInstanceList())
866
    i_non_redundant = [] # Non redundant instances
867
    i_non_a_balanced = [] # Non auto-balanced instances
Iustin Pop's avatar
Iustin Pop committed
868 869
    node_volume = {}
    node_instance = {}
870
    node_info = {}
Guido Trotter's avatar
Guido Trotter committed
871
    instance_cfg = {}
Iustin Pop's avatar
Iustin Pop committed
872 873 874

    # FIXME: verify OS list
    # do local checksums
875 876 877
    master_files = [constants.CLUSTER_CONF_FILE]

    file_names = ssconf.SimpleStore().GetFileList()
878
    file_names.append(constants.SSL_CERT_FILE)
879 880
    file_names.extend(master_files)

Iustin Pop's avatar
Iustin Pop committed
881 882 883 884
    local_checksums = utils.FingerprintFiles(file_names)

    feedback_fn("* Gathering data (%d nodes)" % len(nodelist))
    node_verify_param = {
885 886 887 888 889 890 891 892 893 894
      constants.NV_FILELIST: file_names,
      constants.NV_NODELIST: nodelist,
      constants.NV_HYPERVISOR: hypervisors,
      constants.NV_NODENETTEST: [(node.name, node.primary_ip,
                                  node.secondary_ip) for node in nodeinfo],
      constants.NV_LVLIST: vg_name,
      constants.NV_INSTANCELIST: hypervisors,
      constants.NV_VGLIST: None,
      constants.NV_VERSION: None,
      constants.NV_HVINFO: self.cfg.GetHypervisorType(),
Iustin Pop's avatar
Iustin Pop committed
895
      }
Iustin Pop's avatar
Iustin Pop committed
896 897
    all_nvinfo = self.rpc.call_node_verify(nodelist, node_verify_param,
                                           self.cfg.GetClusterName())
Iustin Pop's avatar
Iustin Pop committed
898

899
    cluster = self.cfg.GetClusterInfo()
900 901 902
    master_node = self.cfg.GetMasterNode()
    for node_i in nodeinfo:
      node = node_i.name
903 904
      nresult = all_nvinfo[node].data

905
      if node == master_node:
906
        ntype = "master"
907
      elif node_i.master_candidate:
908
        ntype = "master candidate"
909
      else:
910
        ntype = "regular"
911
      feedback_fn("* Verifying node %s (%s)" % (node, ntype))
912 913 914 915 916 917

      if all_nvinfo[node].failed or not isinstance(nresult, dict):
        feedback_fn("  - ERROR: connection to %s failed" % (node,))
        bad = True
        continue

918
      result = self._VerifyNode(node_i, file_names, local_checksums,
919
                                nresult, feedback_fn, master_files)
Iustin Pop's avatar
Iustin Pop committed
920 921
      bad = bad or result

922 923
      lvdata = nresult.get(constants.NV_LVLIST, "Missing LV data")
      if isinstance(lvdata, basestring):
924
        feedback_fn("  - ERROR: LVM problem on node %s: %s" %
925
                    (node, lvdata.encode('string_escape')))
926 927
        bad = True
        node_volume[node] = {}
928 929
      elif not isinstance(lvdata, dict):
        feedback_fn("  - ERROR: connection to %s failed (lvlist)" % (node,))
Iustin Pop's avatar
Iustin Pop committed
930 931
        bad = True
        continue
932
      else:
933
        node_volume[node] = lvdata
Iustin Pop's avatar
Iustin Pop committed
934 935

      # node_instance
936 937 938 939
      idata = nresult.get(constants.NV_INSTANCELIST, None)
      if not isinstance(idata, list):
        feedback_fn("  - ERROR: connection to %s failed (instancelist)" %
                    (node,))
Iustin Pop's avatar
Iustin Pop committed
940 941 942
        bad = True
        continue

943
      node_instance[node] = idata
Iustin Pop's avatar
Iustin Pop committed
944

945
      # node_info
946
      nodeinfo = nresult.get(constants.NV_HVINFO, None)
947
      if not isinstance(nodeinfo, dict):
948
        feedback_fn("  - ERROR: connection to %s failed (hvinfo)" % (node,))
949 950 951 952 953 954
        bad = True
        continue

      try:
        node_info[node] = {
          "mfree": int(nodeinfo['memory_free']),
955
          "dfree": int(nresult[constants.NV_VGLIST][vg_name]),
956 957
          "pinst": [],
          "sinst": [],
958 959 960 961 962 963 964
          # dictionary holding all instances this node is secondary for,
          # grouped by their primary node. Each key is a cluster node, and each
          # value is a list of instances which have the key as primary and the
          # current node as secondary.  this is handy to calculate N+1 memory
          # availability if you can only failover from a primary to its
          # secondary.
          "sinst-by-pnode": {},
965 966 967 968 969 970
        }
      except ValueError:
        feedback_fn("  - ERROR: invalid value returned from node %s" % (node,))
        bad = True
        continue

Iustin Pop's avatar
Iustin Pop committed
971 972 973 974 975
    node_vol_should = {}

    for instance in instancelist:
      feedback_fn("* Verifying instance %s" % instance)
      inst_config = self.cfg.GetInstanceInfo(instance)
976 977 978
      result =  self._VerifyInstance(instance, inst_config, node_volume,
                                     node_instance, feedback_fn)
      bad = bad or result
Iustin Pop's avatar
Iustin Pop committed
979 980 981

      inst_config.MapLVsByNode(node_vol_should)

Guido Trotter's avatar
Guido Trotter committed
982 983
      instance_cfg[instance] = inst_config

984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
      pnode = inst_config.primary_node
      if pnode in node_info:
        node_info[pnode]['pinst'].append(instance)
      else:
        feedback_fn("  - ERROR: instance %s, connection to primary node"
                    " %s failed" % (instance, pnode))
        bad = True

      # If the instance is non-redundant we cannot survive losing its primary
      # node, so we are not N+1 compliant. On the other hand we have no disk
      # templates with more than one secondary so that situation is not well
      # supported either.
      # FIXME: does not support file-backed instances
      if len(inst_config.secondary_nodes) == 0:
        i_non_redundant.append(instance)
      elif len(inst_config.secondary_nodes) > 1:
        feedback_fn("  - WARNING: multiple secondaries for instance %s"
                    % instance)

1003
      if not cluster.FillBE(inst_config)[constants.BE_AUTO_BALANCE]:
1004 1005
        i_non_a_balanced.append(instance)

1006 1007 1008
      for snode in inst_config.secondary_nodes:
        if snode in node_info:
          node_info[snode]['sinst'].append(instance)
1009 1010 1011
          if pnode not in node_info[snode]['sinst-by-pnode']:
            node_info[snode]['sinst-by-pnode'][pnode] = []
          node_info[snode]['sinst-by-pnode'][pnode].append(instance)
1012 1013 1014 1015
        else:
          feedback_fn("  - ERROR: instance %s, connection to secondary node"
                      " %s failed" % (instance, snode))

Iustin Pop's avatar
Iustin Pop committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
    feedback_fn("* Verifying orphan volumes")
    result = self._VerifyOrphanVolumes(node_vol_should, node_volume,
                                       feedback_fn)
    bad = bad or result

    feedback_fn("* Verifying remaining instances")
    result = self._VerifyOrphanInstances(instancelist, node_instance,
                                         feedback_fn)
    bad = bad or result

1026 1027 1028 1029
    if constants.VERIFY_NPLUSONE_MEM not in self.skip_set:
      feedback_fn("* Verifying N+1 Memory redundancy")
      result = self._VerifyNPlusOneMemory(node_info, instance_cfg, feedback_fn)
      bad = bad or result
1030 1031 1032 1033 1034 1035

    feedback_fn("* Other Notes")
    if i_non_redundant:
      feedback_fn("  - NOTICE: %d non-redundant instance(s) found."
                  % len(i_non_redundant))

1036 1037 1038 1039
    if i_non_a_balanced:
      feedback_fn("  - NOTICE: %d non-auto-balanced instance(s) found."
                  % len(i_non_a_balanced))

1040
    return not bad
Iustin Pop's avatar
Iustin Pop committed
1041

Guido Trotter's avatar
Guido Trotter committed
1042
  def HooksCallBack(self, phase, hooks_results, feedback_fn, lu_result):
1043 1044 1045
    """Analize the post-hooks' result

    This method analyses the hook result, handles it, and sends some
Guido Trotter's avatar
Guido Trotter committed
1046 1047
    nicely-formatted feedback back to the user.

1048 1049 1050 1051 1052 1053 1054
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
    @param hooks_results: the results of the multi-node hooks rpc call
    @param feedback_fn: function used send feedback back to the caller
    @param lu_result: previous Exec result
    @return: the new Exec result, based on the previous result
        and hook results
Guido Trotter's avatar
Guido Trotter committed
1055 1056

    """
Iustin Pop's avatar
Iustin Pop committed
1057 1058
    # We only really run POST phase hooks, and are only interested in
    # their results
Guido Trotter's avatar
Guido Trotter committed
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
    if phase == constants.HOOKS_PHASE_POST:
      # Used to change hooks' output to proper indentation
      indent_re = re.compile('^', re.M)
      feedback_fn("* Hooks Results")
      if not hooks_results:
        feedback_fn("  - ERROR: general communication failure")
        lu_result = 1
      else:
        for node_name in hooks_results:
          show_node_header = True
          res = hooks_results[node_name]
1070 1071
          if res.failed or res.data is False or not isinstance(res.data, list):
            feedback_fn("    Communication failure in hooks execution")
Guido Trotter's avatar
Guido Trotter committed
1072 1073
            lu_result = 1
            continue
1074
          for script, hkr, output in res.data:
Guido Trotter's avatar
Guido Trotter committed
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
            if hkr == constants.HKR_FAIL:
              # The node header is only shown once, if there are
              # failing hooks on that node
              if show_node_header:
                feedback_fn("  Node %s:" % node_name)
                show_node_header = False
              feedback_fn("    ERROR: Script %s failed, output:" % script)
              output = indent_re.sub('      ', output)
              feedback_fn("%s" % output)
              lu_result = 1

      return lu_result

Iustin Pop's avatar
Iustin Pop committed
1088

Iustin Pop's avatar
Iustin Pop committed
1089 1090 1091 1092 1093
class LUVerifyDisks(NoHooksLU):
  """Verifies the cluster disks status.

  """
  _OP_REQP = []
1094 1095 1096 1097 1098 1099 1100 1101
  REQ_BGL = False

  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
    self.share_locks = dict(((i, 1) for i in locking.LEVELS))
Iustin Pop's avatar
Iustin Pop committed
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114

  def CheckPrereq(self):
    """Check prerequisites.

    This has no prerequisites.

    """
    pass

  def Exec(self, feedback_fn):
    """Verify integrity of cluster disks.

    """
1115
    result = res_nodes, res_nlvm, res_instances, res_missing = [], {}, [], {}
Iustin Pop's avatar
Iustin Pop committed
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136

    vg_name = self.cfg.GetVGName()
    nodes = utils.NiceSort(self.cfg.GetNodeList())
    instances = [self.cfg.GetInstanceInfo(name)
                 for name in self.cfg.GetInstanceList()]

    nv_dict = {}
    for inst in instances:
      inst_lvs = {}
      if (inst.status != "up" or
          inst.disk_template not in constants.DTS_NET_MIRROR):
        continue
      inst.MapLVsByNode(inst_lvs)
      # transform { iname: {node: [vol,],},} to {(node, vol): iname}
      for node, vol_list in inst_lvs.iteritems():
        for vol in vol_list:
          nv_dict[(node, vol)] = inst

    if not nv_dict:
      return result

Iustin Pop's avatar
Iustin Pop committed
1137
    node_lvs = self.rpc.call_volume_list(nodes, vg_name)
Iustin Pop's avatar
Iustin Pop committed
1138 1139 1140 1141 1142

    to_act = set()
    for node