cmdlib.py 247 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

# pylint: disable-msg=W0613,W0201

import os
import os.path
import time
import re
import platform
31
import logging
32
import copy
Iustin Pop's avatar
Iustin Pop committed
33 34 35 36 37

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
38
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
39 40
from ganeti import constants
from ganeti import objects
41
from ganeti import serializer
42
from ganeti import ssconf
43 44


Iustin Pop's avatar
Iustin Pop committed
45
class LogicalUnit(object):
46
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
47 48

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

  Note that all commands require root permissions.
Iustin Pop's avatar
Iustin Pop committed
58 59 60 61 62

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

Iustin Pop's avatar
Iustin Pop committed
65
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
66 67
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
68
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
69 70 71
    validity.

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

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

97 98 99 100 101
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
102
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
103 104 105 106
    return self.__ssh

  ssh = property(fget=__GetSSH)

107 108 109 110 111 112 113 114 115
  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
116
      - CheckPrereq is run after we have acquired locks (and possible
117 118 119 120 121 122 123 124
        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

125 126 127 128 129 130 131 132 133 134 135
  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:
136 137 138 139 140

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

Guido Trotter's avatar
Guido Trotter committed
142 143 144 145
    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.

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

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

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

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

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

    """
    raise NotImplementedError

236 237 238 239 240 241 242 243 244
  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.

245 246 247 248 249 250 251 252
    @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
253 254 255 256

    """
    return lu_result

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

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

293
    If should be called in DeclareLocks in a way similar to::
294

295 296
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
297

298 299 300
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

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

    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)
321 322 323

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
324 325 326 327 328 329 330 331 332 333 334 335

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


336
def _GetWantedNodes(lu, nodes):
337
  """Returns list of checked and expanded node names.
338

339 340 341 342 343 344 345
  @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
346 347

  """
348
  if not isinstance(nodes, list):
349
    raise errors.OpPrereqError("Invalid argument type 'nodes'")
350

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

355 356 357 358 359 360
  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)
361

362
  return utils.NiceSort(wanted)
363 364 365


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

368 369 370 371 372 373 374 375
  @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
376 377 378 379 380 381 382 383 384

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

  if instances:
    wanted = []

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

  else:
391 392
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
393 394 395


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

Iustin Pop's avatar
Iustin Pop committed
398
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
399
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
400
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
401
  @param dynamic: dynamic fields set
402 403

  """
Iustin Pop's avatar
Iustin Pop committed
404
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
405 406
  f.Extend(static)
  f.Extend(dynamic)
407

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


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

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


440 441 442 443 444 445 446 447 448 449 450 451
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)


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

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

  if nics:
    nic_count = len(nics)
509
    for idx, (ip, bridge, mac) in enumerate(nics):
510 511 512 513
      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
514
      env["INSTANCE_NIC%d_MAC" % idx] = mac
515 516 517 518 519
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
520 521 522 523 524 525 526 527 528 529
  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

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

534 535 536
  return env


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

540 541 542 543 544 545 546 547 548 549 550
  @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

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


575 576 577 578 579 580 581
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
582
               ", ".join(node.name for node in mod_list))
583 584 585 586 587 588 589 590
    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))


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

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


Iustin Pop's avatar
Iustin Pop committed
605 606 607 608 609 610 611 612 613 614 615
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
616
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
617 618

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
619
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
620 621

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

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

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


Guido Trotter's avatar
Guido Trotter committed
645
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
646 647 648
  """Verifies the cluster status.

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

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

666
    Test list:
667

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

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

Iustin Pop's avatar
Iustin Pop committed
685
    """
686
    node = nodeinfo.name
687 688 689 690 691 692

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

701 702 703
    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
704 705
      return True

706
    # node seems compatible, we can actually try to look into its results
Iustin Pop's avatar
Iustin Pop committed
707 708

    bad = False
709 710 711 712 713 714 715 716

    # 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
717 718 719 720 721
    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
722
        bad = True
723 724 725 726 727 728
      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
729 730 731

    # checks config file checksum

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

759 760 761
    # checks ssh to any

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

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

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

    # check used drbd list
790 791 792 793 794 795 796 797
    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:
798 799
            feedback_fn("  - ERROR: drbd minor %d of instance %s is"
                        " not active" % (minor, iname))
800 801 802
            bad = True
        for minor in used_minors:
          if minor not in drbd_map:
803 804
            feedback_fn("  - ERROR: unallocated drbd minor %d is in use" %
                        minor)
805
            bad = True
806

Iustin Pop's avatar
Iustin Pop committed
807 808
    return bad

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

834
    if instanceconfig.admin_up:
835 836 837
      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
838 839 840 841 842 843 844 845 846 847 848
        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

849
    return bad
Iustin Pop's avatar
Iustin Pop committed
850 851 852 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

  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

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

Iustin Pop's avatar
Iustin Pop committed
913 914 915
  def CheckPrereq(self):
    """Check prerequisites.

916 917
    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
918 919

    """
920 921 922
    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
923

Guido Trotter's avatar
Guido Trotter committed
924 925 926
  def BuildHooksEnv(self):
    """Build hooks env.

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

    """
    all_nodes = self.cfg.GetNodeList()
932 933 934 935 936 937
    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
938 939
    return env, [], all_nodes

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

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

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

    # FIXME: verify OS list
    # do local checksums
967 968 969
    master_files = [constants.CLUSTER_CONF_FILE]

    file_names = ssconf.SimpleStore().GetFileList()
970
    file_names.append(constants.SSL_CERT_FILE)
971
    file_names.append(constants.RAPI_CERT_FILE)
972 973
    file_names.extend(master_files)

Iustin Pop's avatar
Iustin Pop committed
974 975 976 977
    local_checksums = utils.FingerprintFiles(file_names)

    feedback_fn("* Gathering data (%d nodes)" % len(nodelist))
    node_verify_param = {
978
      constants.NV_FILELIST: file_names,
979 980
      constants.NV_NODELIST: [node.name for node in nodeinfo
                              if not node.offline],
981 982
      constants.NV_HYPERVISOR: hypervisors,
      constants.NV_NODENETTEST: [(node.name, node.primary_ip,
983 984
                                  node.secondary_ip) for node in nodeinfo
                                 if not node.offline],
985 986 987
      constants.NV_INSTANCELIST: hypervisors,
      constants.NV_VERSION: None,
      constants.NV_HVINFO: self.cfg.GetHypervisorType(),
Iustin Pop's avatar
Iustin Pop committed
988
      }
989 990 991 992
    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
993 994
    all_nvinfo = self.rpc.call_node_verify(nodelist, node_verify_param,
                                           self.cfg.GetClusterName())
Iustin Pop's avatar
Iustin Pop committed
995

996
    cluster = self.cfg.GetClusterInfo()
997
    master_node = self.cfg.GetMasterNode()
998 999
    all_drbd_map = self.cfg.ComputeDRBDMap()

1000 1001
    for node_i in nodeinfo:
      node = node_i.name
1002 1003
      nresult = all_nvinfo[node].data

1004 1005 1006 1007 1008
      if node_i.offline:
        feedback_fn("* Skipping offline node %s" % (node,))
        n_offline.append(node)
        continue

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

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

1025 1026
      node_drbd = {}
      for minor, instance in all_drbd_map[node].items():
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
        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)
1037
      result = self._VerifyNode(node_i, file_names, local_checksums,
1038
                                nresult, feedback_fn, master_files,
1039
                                node_drbd, vg_name)
Iustin Pop's avatar
Iustin Pop committed
1040 1041
      bad = bad or result

1042
      lvdata = nresult.get(constants.NV_LVLIST, "Missing LV data")
1043 1044 1045
      if vg_name is None:
        node_volume[node] = {}
      elif isinstance(lvdata, basestring):
1046
        feedback_fn("  - ERROR: LVM problem on node %s: %s" %
1047
                    (node, utils.SafeEncode(lvdata)))
1048