cmdlib.py 253 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
# pylint: disable-msg=W0201

# W0201 since most LU attributes are defined in CheckPrereq or similar
# functions
Iustin Pop's avatar
Iustin Pop committed
28 29 30 31 32 33

import os
import os.path
import time
import re
import platform
34
import logging
35
import copy
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
from ganeti import constants
from ganeti import objects
44
from ganeti import serializer
45
from ganeti import ssconf
46 47


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

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

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

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

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

Michael Hanselmann's avatar
Michael Hanselmann committed
71
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
72 73 74
    validity.

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

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

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

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

  ssh = property(fget=__GetSSH)

110 111 112 113 114 115 116 117 118
  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
Michael Hanselmann's avatar
Michael Hanselmann committed
119
      - CheckPrereq is run after we have acquired locks (and possible
120 121 122 123 124 125 126 127
        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

128 129 130 131 132 133 134 135 136 137 138
  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:
139 140 141 142 143

      - 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
144

Guido Trotter's avatar
Guido Trotter committed
145 146 147 148
    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.

149 150 151 152 153 154 155 156 157 158 159 160 161
    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
162 163 164 165 166 167 168 169 170 171

    """
    # 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
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
  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
190 191 192 193 194 195 196 197 198 199 200 201
  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
202
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
203 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

    """
    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.

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

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

    """
    raise NotImplementedError

239 240 241 242 243 244 245 246 247
  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.

248 249 250 251 252 253 254 255
    @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
256 257 258 259

    """
    return lu_result

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
  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

282
  def _LockInstancesNodes(self, primary_only=False):
283 284 285 286 287 288 289 290 291 292 293 294 295
    """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.

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

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

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

304 305 306 307 308 309 310 311 312 313
    """
    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 = []
314
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
315 316
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
317 318
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
319 320 321 322 323

    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)
324 325 326

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
327

Iustin Pop's avatar
Iustin Pop committed
328
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
329 330 331 332 333 334 335 336 337 338
  """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


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

342 343 344 345 346 347 348
  @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
349 350

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

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

358 359 360 361 362 363
  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)
364

365
  return utils.NiceSort(wanted)
366 367 368


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

371 372 373 374 375 376 377 378
  @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
379 380 381 382 383 384 385 386 387

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

  if instances:
    wanted = []

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

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


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

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

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

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


417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
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
436
  @raise errors.OpPrereqError: if the node is offline
437 438 439 440 441 442

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


443 444 445 446 447 448 449 450 451 452 453 454
def _CheckNodeNotDrained(lu, node):
  """Ensure that a given node is not drained.

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

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


455
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
456
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
457
                          bep, hvp, hypervisor_name):
458 459 460 461 462 463 464 465 466 467 468 469
  """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
470 471
  @type status: boolean
  @param status: the should_run status of the instance
472 473 474 475 476 477 478
  @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
Iustin Pop's avatar
Iustin Pop committed
479
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
480
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
481 482
  @type disks: list
  @param disks: the list of (size, mode) pairs
483 484 485 486
  @type bep: dict
  @param bep: the backend parameters for the instance
  @type hvp: dict
  @param hvp: the hypervisor parameters for the instance
Michael Hanselmann's avatar
Michael Hanselmann committed
487 488
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
489 490
  @rtype: dict
  @return: the hook environment for this instance
491

492
  """
493 494 495 496
  if status:
    str_status = "up"
  else:
    str_status = "down"
497
  env = {
498
    "OP_TARGET": name,
499 500 501
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
502
    "INSTANCE_OS_TYPE": os_type,
503
    "INSTANCE_STATUS": str_status,
504 505
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
506
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
507
    "INSTANCE_HYPERVISOR": hypervisor_name,
508 509 510 511
  }

  if nics:
    nic_count = len(nics)
512
    for idx, (ip, bridge, mac) in enumerate(nics):
513 514 515 516
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
      env["INSTANCE_NIC%d_BRIDGE" % idx] = bridge
Iustin Pop's avatar
Iustin Pop committed
517
      env["INSTANCE_NIC%d_MAC" % idx] = mac
518 519 520 521 522
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
523 524 525 526 527 528 529 530 531 532
  if disks:
    disk_count = len(disks)
    for idx, (size, mode) in enumerate(disks):
      env["INSTANCE_DISK%d_SIZE" % idx] = size
      env["INSTANCE_DISK%d_MODE" % idx] = mode
  else:
    disk_count = 0

  env["INSTANCE_DISK_COUNT"] = disk_count

533 534 535 536
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

537 538 539
  return env


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

543 544 545 546 547 548 549 550 551 552 553
  @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

554
  """
555 556 557
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
558 559 560 561
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
562
    'os_type': instance.os,
563
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
564 565
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
566
    'nics': [(nic.ip, nic.bridge, nic.mac) for nic in instance.nics],
Iustin Pop's avatar
Iustin Pop committed
567 568
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
569 570
    'bep': bep,
    'hvp': hvp,
571
    'hypervisor_name': instance.hypervisor,
572 573 574 575 576 577
  }
  if override:
    args.update(override)
  return _BuildInstanceHookEnv(**args)


578 579 580 581 582 583 584
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",
Iustin Pop's avatar
Iustin Pop committed
585
               ", ".join(node.name for node in mod_list))
586 587 588 589 590 591 592 593
    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))


594
def _CheckInstanceBridgesExist(lu, instance):
Michael Hanselmann's avatar
Michael Hanselmann committed
595
  """Check that the bridges needed by an instance exist.
596 597

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
598
  # check bridges existence
599
  brlist = [nic.bridge for nic in instance.nics]
600 601 602 603
  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"
604 605 606 607
                               " exist on destination node '%s'" %
                               (brlist, instance.primary_node))


Iustin Pop's avatar
Iustin Pop committed
608 609 610 611 612 613 614 615 616 617 618
class LUDestroyCluster(NoHooksLU):
  """Logical unit for destroying the cluster.

  """
  _OP_REQP = []

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

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
619
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
620 621

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
622
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
623 624

    nodelist = self.cfg.GetNodeList()
625
    if len(nodelist) != 1 or nodelist[0] != master:
626 627
      raise errors.OpPrereqError("There are still %d node(s) in"
                                 " this cluster." % (len(nodelist) - 1))
628 629
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
630 631
      raise errors.OpPrereqError("There are still %d instance(s) in"
                                 " this cluster." % len(instancelist))
Iustin Pop's avatar
Iustin Pop committed
632 633 634 635 636

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
637
    master = self.cfg.GetMasterNode()
638 639 640
    result = self.rpc.call_node_stop_master(master, False)
    result.Raise()
    if not result.data:
641
      raise errors.OpExecError("Could not disable the master role")
642 643 644
    priv_key, pub_key, _ = ssh.GetUserFiles(constants.GANETI_RUNAS)
    utils.CreateBackup(priv_key)
    utils.CreateBackup(pub_key)
Iustin Pop's avatar
Iustin Pop committed
645
    return master
Iustin Pop's avatar
Iustin Pop committed
646 647


Guido Trotter's avatar
Guido Trotter committed
648
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
649 650 651
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
652 653
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
654
  _OP_REQP = ["skip_checks"]
655 656 657 658 659 660 661 662
  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
663

664
  def _VerifyNode(self, nodeinfo, file_list, local_cksum,
665
                  node_result, feedback_fn, master_files,
666
                  drbd_map, vg_name):
Iustin Pop's avatar
Iustin Pop committed
667 668
    """Run multiple tests against a node.

669
    Test list:
670

Iustin Pop's avatar
Iustin Pop committed
671
      - compares ganeti version
Michael Hanselmann's avatar
Michael Hanselmann committed
672
      - checks vg existence and size > 20G
Iustin Pop's avatar
Iustin Pop committed
673 674 675
      - checks config file checksum
      - checks ssh to other nodes

676 677
    @type nodeinfo: L{objects.Node}
    @param nodeinfo: the node to check
678 679 680 681
    @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
682
    @param master_files: list of files that only masters should have
683 684 685
    @param drbd_map: the useddrbd minors for this node, in
        form of minor: (instance, must_exist) which correspond to instances
        and their running status
686
    @param vg_name: Ganeti Volume Group (result of self.cfg.GetVGName())
687

Iustin Pop's avatar
Iustin Pop committed
688
    """
689
    node = nodeinfo.name
690 691 692 693 694 695

    # 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
696 697
    # compares ganeti version
    local_version = constants.PROTOCOL_VERSION
698
    remote_version = node_result.get('version', None)
699 700
    if not (remote_version and isinstance(remote_version, (list, tuple)) and
            len(remote_version) == 2):
701
      feedback_fn("  - ERROR: connection to %s failed" % (node))
Iustin Pop's avatar
Iustin Pop committed
702 703
      return True

704 705 706
    if local_version != remote_version[0]:
      feedback_fn("  - ERROR: incompatible protocol versions: master %s,"
                  " node %s %s" % (local_version, node, remote_version[0]))
Iustin Pop's avatar
Iustin Pop committed
707 708
      return True

709
    # node seems compatible, we can actually try to look into its results
Iustin Pop's avatar
Iustin Pop committed
710 711

    bad = False
712 713 714 715 716 717 718 719

    # full package version
    if constants.RELEASE_VERSION != remote_version[1]:
      feedback_fn("  - WARNING: software version mismatch: master %s,"
                  " node %s %s" %
                  (constants.RELEASE_VERSION, node, remote_version[1]))

    # checks vg existence and size > 20G
720 721 722 723 724
    if vg_name is not None:
      vglist = node_result.get(constants.NV_VGLIST, None)
      if not vglist:
        feedback_fn("  - ERROR: unable to check volume groups on node %s." %
                        (node,))
Iustin Pop's avatar
Iustin Pop committed
725
        bad = True
726 727 728 729 730 731
      else:
        vgstatus = utils.CheckVolumeGroupSize(vglist, vg_name,
                                              constants.MIN_VG_SIZE)
        if vgstatus:
          feedback_fn("  - ERROR: %s on node %s" % (vgstatus, node))
          bad = True
Iustin Pop's avatar
Iustin Pop committed
732 733 734

    # checks config file checksum

735 736
    remote_cksum = node_result.get(constants.NV_FILELIST, None)
    if not isinstance(remote_cksum, dict):
Iustin Pop's avatar
Iustin Pop committed
737 738 739 740
      bad = True
      feedback_fn("  - ERROR: node hasn't returned file checksum data")
    else:
      for file_name in file_list:
741 742
        node_is_mc = nodeinfo.master_candidate
        must_have_file = file_name not in master_files
Iustin Pop's avatar
Iustin Pop committed
743
        if file_name not in remote_cksum:
744 745 746
          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
747
        elif remote_cksum[file_name] != local_cksum[file_name]:
748 749 750 751 752 753
          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
754 755
            feedback_fn("  - ERROR: file '%s' should not exist on non master"
                        " candidates (and the file is outdated)" % file_name)
756 757 758 759 760
        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
761

762 763 764
    # checks ssh to any

    if constants.NV_NODELIST not in node_result:
Iustin Pop's avatar
Iustin Pop committed
765
      bad = True
766
      feedback_fn("  - ERROR: node hasn't returned node ssh connectivity data")
Iustin Pop's avatar
Iustin Pop committed
767
    else:
768
      if node_result[constants.NV_NODELIST]:
Iustin Pop's avatar
Iustin Pop committed
769
        bad = True
770
        for node in node_result[constants.NV_NODELIST]:
771
          feedback_fn("  - ERROR: ssh communication with node '%s': %s" %
772 773 774
                          (node, node_result[constants.NV_NODELIST][node]))

    if constants.NV_NODENETTEST not in node_result:
775 776 777
      bad = True
      feedback_fn("  - ERROR: node hasn't returned node tcp connectivity data")
    else:
778
      if node_result[constants.NV_NODENETTEST]:
779
        bad = True
780
        nlist = utils.NiceSort(node_result[constants.NV_NODENETTEST].keys())
781 782
        for node in nlist:
          feedback_fn("  - ERROR: tcp communication with node '%s': %s" %
783
                          (node, node_result[constants.NV_NODENETTEST][node]))
784

785
    hyp_result = node_result.get(constants.NV_HYPERVISOR, None)
786 787 788 789 790
    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))
791 792

    # check used drbd list
793 794 795 796 797 798 799 800
    if vg_name is not None:
      used_minors = node_result.get(constants.NV_DRBDLIST, [])
      if not isinstance(used_minors, (tuple, list)):
        feedback_fn("  - ERROR: cannot parse drbd status file: %s" %
                    str(used_minors))
      else:
        for minor, (iname, must_exist) in drbd_map.items():
          if minor not in used_minors and must_exist:
801 802
            feedback_fn("  - ERROR: drbd minor %d of instance %s is"
                        " not active" % (minor, iname))
803 804 805
            bad = True
        for minor in used_minors:
          if minor not in drbd_map:
806 807
            feedback_fn("  - ERROR: unallocated drbd minor %d is in use" %
                        minor)
808
            bad = True
809

Iustin Pop's avatar
Iustin Pop committed
810 811
    return bad

812
  def _VerifyInstance(self, instance, instanceconfig, node_vol_is,
813
                      node_instance, feedback_fn, n_offline):
Iustin Pop's avatar
Iustin Pop committed
814 815 816 817 818 819 820 821 822 823 824 825 826 827
    """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:
828 829 830
      if node in n_offline:
        # ignore missing volumes on offline nodes
        continue
Iustin Pop's avatar
Iustin Pop committed
831 832 833 834 835 836
      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

837
    if instanceconfig.admin_up:
838 839 840
      if ((node_current not in node_instance or
          not instance in node_instance[node_current]) and
          node_current not in n_offline):
Iustin Pop's avatar
Iustin Pop committed
841 842 843 844 845 846 847 848 849 850 851
        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

852
    return bad
Iustin Pop's avatar
Iustin Pop committed
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885

  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

886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
  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
907
          bep = self.cfg.GetClusterInfo().FillBE(instance_cfg[instance])
908
          if bep[constants.BE_AUTO_BALANCE]:
909
            needed_mem += bep[constants.BE_MEMORY]
910
        if nodeinfo['mfree'] < needed_mem:
Michael Hanselmann's avatar
Michael Hanselmann committed
911
          feedback_fn("  - ERROR: not enough memory on node %s to accommodate"
912 913 914 915
                      " failovers should node %s fail" % (node, prinode))
          bad = True
    return bad

Iustin Pop's avatar
Iustin Pop committed
916 917 918
  def CheckPrereq(self):
    """Check prerequisites.

919 920
    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
921 922

    """
923 924 925
    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
926

Guido Trotter's avatar
Guido Trotter committed
927 928 929
  def BuildHooksEnv(self):
    """Build hooks env.

Michael Hanselmann's avatar
Michael Hanselmann committed
930
    Cluster-Verify hooks just ran in the post phase and their failure makes
Guido Trotter's avatar
Guido Trotter committed
931 932 933 934
    the output be logged in the verify output and the verification to fail.

    """
    all_nodes = self.cfg.GetNodeList()
935 936 937 938 939 940
    env = {
      "CLUSTER_TAGS": " ".join(self.cfg.GetClusterInfo().GetTags())
      }
    for node in self.cfg.GetAllNodesInfo().values():
      env["NODE_TAGS_%s" % node.name] = " ".join(node.GetTags())

Guido Trotter's avatar
Guido Trotter committed
941 942
    return env, [], all_nodes

Iustin Pop's avatar
Iustin Pop committed
943 944 945 946 947 948
  def Exec(self, feedback_fn):
    """Verify integrity of cluster, performing various test on nodes.

    """
    bad = False
    feedback_fn("* Verifying global settings")
949 950
    for msg in self.cfg.VerifyConfig():
      feedback_fn("  - ERROR: %s" % msg)
Iustin Pop's avatar
Iustin Pop committed
951 952

    vg_name = self.cfg.GetVGName()
953
    hypervisors = self.cfg.GetClusterInfo().enabled_hypervisors
Iustin Pop's avatar
Iustin Pop committed
954
    nodelist = utils.NiceSort(self.cfg.GetNodeList())
955
    nodeinfo = [self.cfg.GetNodeInfo(nname) for nname in nodelist]
Iustin Pop's avatar
Iustin Pop committed
956
    instancelist = utils.NiceSort(self.cfg.GetInstanceList())
957 958
    instanceinfo = dict((iname, self.cfg.GetInstanceInfo(iname))
                        for iname in instancelist)
959
    i_non_redundant = [] # Non redundant instances
960
    i_non_a_balanced = [] # Non auto-balanced instances
961
    n_offline = [] # List of offline nodes
962
    n_drained = [] # List of nodes being drained
Iustin Pop's avatar
Iustin Pop committed
963 964
    node_volume = {}
    node_instance = {}
965
    node_info = {}
Guido Trotter's avatar
Guido Trotter committed
966
    instance_cfg = {}
Iustin Pop's avatar
Iustin Pop committed
967 968 969

    # FIXME: verify OS list
    # do local checksums
970 971 972
    master_files = [constants.CLUSTER_CONF_FILE]

    file_names = ssconf.SimpleStore().GetFileList()
973
    file_names.append(constants.SSL_CERT_FILE)
974
    file_names.append(constants.RAPI_CERT_FILE)
975 976
    file_names.extend(master_files)

Iustin Pop's avatar
Iustin Pop committed
977 978 979 980
    local_checksums = utils.FingerprintFiles(file_names)

    feedback_fn("* Gathering data (%d nodes)" % len(nodelist))
    node_verify_param = {
981
      constants.NV_FILELIST: file_names,
982 983
      constants.NV_NODELIST: [node.name for node in nodeinfo
                              if not node.offline],
984 985
      constants.NV_HYPERVISOR: hypervisors,
      constants.NV_NODENETTEST: [(node.name, node.primary_ip,
986 987
                                  node.secondary_ip) for node in nodeinfo
                                 if not node.offline],
988 989 990
      constants.NV_INSTANCELIST: hypervisors,
      constants.NV_VERSION: None,
      constants.NV_HVINFO: self.cfg.GetHypervisorType(),
Iustin Pop's avatar
Iustin Pop committed
991
      }
992 993 994 995
    if vg_name is not None:
      node_verify_param[constants.NV_VGLIST] = None
      node_verify_param[constants.NV_LVLIST] = vg_name
      node_verify_param[constants.NV_DRBDLIST] = None
Iustin Pop's avatar
Iustin Pop committed
996 997
    all_nvinfo = self.rpc.call_node_verify(nodelist, node_verify_param,
                                           self.cfg.GetClusterName())
Iustin Pop's avatar
Iustin Pop committed
998

999
    cluster = self.cfg.GetClusterInfo()
1000
    master_node = self.cfg.GetMasterNode()
1001 1002
    all_drbd_map = self.cfg.ComputeDRBDMap()

1003 1004
    for node_i in nodeinfo:
      node = node_i.name
1005 1006
      nresult = all_nvinfo[node].data

1007 1008 1009 1010 1011
      if node_i.offline:
        feedback_fn("* Skipping offline node %s" % (node,))
        n_offline.append(node)
        continue

1012
      if node == master_node:
1013
        ntype = "master"
1014
      elif node_i.master_candidate:
1015
        ntype = "master candidate"
1016 1017 1018
      elif node_i.drained:
        ntype = "drained"
        n_drained.append(node)
1019
      else:
1020
        ntype = "regular"
1021
      feedback_fn("* Verifying node %s (%s)" % (node, ntype))
1022 1023 1024 1025 1026 1027

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

1028 1029
      node_drbd = {}
      for minor, instance in all_drbd_map[node].items():
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
        if instance not in instanceinfo:
          feedback_fn("  - ERROR: ghost instance '%s' in temporary DRBD map" %
                      instance)
          # ghost instance should not be running, but otherwise we
          # don't give double warnings (both ghost instance and
          # unallocated minor in use)
          node_drbd[minor] = (instance, False)
        else:
          instance = instanceinfo[instance]
          node_drbd[minor] = (instance.name, instance.admin_up)
1040
      result = self._VerifyNode(node_i, file_names, local_checksums,
1041
                                nresult, feedback_fn, master_files,
1042
                                node_drbd, vg_name)
Iustin Pop's avatar
Iustin Pop committed
1043 1044
      bad = bad or result

1045
      lvdata = nresult.get(constants.NV_LVLIST, "Missing LV data")