cmdlib.py 261 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
    - implement ExpandNames
50 51
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
52 53
    - 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
  @ivar dry_run_result: the value (if any) that will be returned to the caller
      in dry-run mode (signalled by opcode dry_run parameter)

Iustin Pop's avatar
Iustin Pop committed
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 = {}
83
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
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 90 91
    # logging
    self.LogWarning = processor.LogWarning
    self.LogInfo = processor.LogInfo
92
    self.LogStep = processor.LogStep
93 94
    # support for dry-run
    self.dry_run_result = None
95

96
    # Tasklets
97
    self.tasklets = None
98

Iustin Pop's avatar
Iustin Pop committed
99 100 101
    for attr_name in self._OP_REQP:
      attr_val = getattr(op, attr_name, None)
      if attr_val is None:
102 103
        raise errors.OpPrereqError("Required parameter '%s' missing" %
                                   attr_name)
104

105
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
106

107 108 109 110 111
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
112
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
113 114 115 116
    return self.__ssh

  ssh = property(fget=__GetSSH)

117 118 119 120 121 122 123 124 125
  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
126
      - CheckPrereq is run after we have acquired locks (and possible
127 128 129 130 131 132 133 134
        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

135 136 137 138 139 140 141 142 143 144 145
  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:
146 147 148 149 150

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

Guido Trotter's avatar
Guido Trotter committed
152 153 154 155
    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.

156 157 158 159
    This function can also define a list of tasklets, which then will be
    executed in order instead of the usual LU-level CheckPrereq and Exec
    functions, if those are not defined by the LU.

160 161 162 163 164 165 166 167 168 169 170 171 172
    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
173 174 175 176 177 178 179 180 181 182

    """
    # 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
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
  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
201 202 203 204 205 206 207 208 209 210 211 212
  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
213
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
214 215

    """
216
    if self.tasklets is not None:
217 218 219
      for (idx, tl) in enumerate(self.tasklets):
        logging.info("Checking prerequisites for tasklet %s/%s",
                     idx + 1, len(self.tasklets))
220 221 222
        tl.CheckPrereq()
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
223 224 225 226 227 228 229 230 231

  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.

    """
232
    if self.tasklets is not None:
233 234
      for (idx, tl) in enumerate(self.tasklets):
        logging.info("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
235 236 237
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

  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.

253
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
254 255 256 257 258 259 260

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

    """
    raise NotImplementedError

261 262 263 264 265 266 267 268 269
  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.

270 271 272 273 274 275 276 277
    @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
278 279 280 281

    """
    return lu_result

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
  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

304
  def _LockInstancesNodes(self, primary_only=False):
305 306 307 308 309 310 311 312 313 314 315 316 317
    """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.

318
    If should be called in DeclareLocks in a way similar to::
319

320 321
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
322

323 324 325
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

326 327 328 329 330 331 332 333 334 335
    """
    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 = []
336
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
337 338
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
339 340
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
341 342 343 344 345

    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)
346 347 348

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
349 350 351 352 353 354 355 356 357 358 359 360

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


361 362 363 364 365 366 367 368 369 370 371 372
class Tasklet:
  """Tasklet base class.

  Tasklets are subcomponents for LUs. LUs can consist entirely of tasklets or
  they can mix legacy code with tasklets. Locking needs to be done in the LU,
  tasklets know nothing about locks.

  Subclasses must follow these rules:
    - Implement CheckPrereq
    - Implement Exec

  """
373 374 375 376 377 378 379
  def __init__(self, lu):
    self.lu = lu

    # Shortcuts
    self.cfg = lu.cfg
    self.rpc = lu.rpc

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
  def CheckPrereq(self):
    """Check prerequisites for this tasklets.

    This method should check whether the prerequisites for the execution of
    this tasklet 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 parameters to their canonical form if it
    hasn't been done before.

    """
    raise NotImplementedError

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

    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


407
def _GetWantedNodes(lu, nodes):
408
  """Returns list of checked and expanded node names.
409

410 411 412 413 414 415 416
  @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
417 418

  """
419
  if not isinstance(nodes, list):
420
    raise errors.OpPrereqError("Invalid argument type 'nodes'")
421

422 423 424
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
425

426 427 428 429 430 431
  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)
432

433
  return utils.NiceSort(wanted)
434 435 436


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

439 440 441 442 443 444 445 446
  @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
447 448 449 450 451 452 453 454 455

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

  if instances:
    wanted = []

    for name in instances:
456
      instance = lu.cfg.ExpandInstanceName(name)
457 458 459 460 461
      if instance is None:
        raise errors.OpPrereqError("No such instance name '%s'" % name)
      wanted.append(instance)

  else:
462 463
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
464 465 466


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

Iustin Pop's avatar
Iustin Pop committed
469
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
470
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
471
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
472
  @param dynamic: dynamic fields set
473 474

  """
Iustin Pop's avatar
Iustin Pop committed
475
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
476 477
  f.Extend(static)
  f.Extend(dynamic)
478

Iustin Pop's avatar
Iustin Pop committed
479 480
  delta = f.NonMatching(selected)
  if delta:
481
    raise errors.OpPrereqError("Unknown output fields selected: %s"
Iustin Pop's avatar
Iustin Pop committed
482
                               % ",".join(delta))
483 484


485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
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
504
  @raise errors.OpPrereqError: if the node is offline
505 506 507 508 509 510

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


511 512 513 514 515 516 517 518 519 520 521 522
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)


523
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
524
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
525
                          bep, hvp, hypervisor_name):
526 527 528 529 530 531 532 533 534 535 536 537
  """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
538 539
  @type status: boolean
  @param status: the should_run status of the instance
540 541 542 543 544
  @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
545 546
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
547
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
548
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
549 550
  @type disks: list
  @param disks: the list of (size, mode) pairs
551 552 553 554
  @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
555 556
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
557 558
  @rtype: dict
  @return: the hook environment for this instance
559

560
  """
561 562 563 564
  if status:
    str_status = "up"
  else:
    str_status = "down"
565
  env = {
566
    "OP_TARGET": name,
567 568 569
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
570
    "INSTANCE_OS_TYPE": os_type,
571
    "INSTANCE_STATUS": str_status,
572 573
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
574
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
575
    "INSTANCE_HYPERVISOR": hypervisor_name,
576 577 578 579
  }

  if nics:
    nic_count = len(nics)
580
    for idx, (ip, mac, mode, link) in enumerate(nics):
581 582 583
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
584
      env["INSTANCE_NIC%d_MAC" % idx] = mac
585 586 587 588
      env["INSTANCE_NIC%d_MODE" % idx] = mode
      env["INSTANCE_NIC%d_LINK" % idx] = link
      if mode == constants.NIC_MODE_BRIDGED:
        env["INSTANCE_NIC%d_BRIDGE" % idx] = link
589 590 591 592 593
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
594 595 596 597 598 599 600 601 602 603
  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

604 605 606 607
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

608 609
  return env

610
def _NICListToTuple(lu, nics):
611 612
  """Build a list of nic information tuples.

613 614
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631

  @type lu:  L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type nics: list of L{objects.NIC}
  @param nics: list of nics to convert to hooks tuples

  """
  hooks_nics = []
  c_nicparams = lu.cfg.GetClusterInfo().nicparams[constants.PP_DEFAULT]
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
    filled_params = objects.FillDict(c_nicparams, nic.nicparams)
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
632

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

636 637 638 639 640 641 642 643 644 645 646
  @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

647
  """
648 649 650
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
651 652 653 654
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
655
    'os_type': instance.os,
656
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
657 658
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
659
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
660 661
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
662 663
    'bep': bep,
    'hvp': hvp,
664
    'hypervisor_name': instance.hypervisor,
665 666 667 668 669 670
  }
  if override:
    args.update(override)
  return _BuildInstanceHookEnv(**args)


671 672 673 674 675 676 677
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
678
               ", ".join(node.name for node in mod_list))
679 680 681 682 683 684 685 686
    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))


687 688 689 690 691 692 693 694 695 696 697 698
def _CheckNicsBridgesExist(lu, target_nics, target_node,
                               profile=constants.PP_DEFAULT):
  """Check that the brigdes needed by a list of nics exist.

  """
  c_nicparams = lu.cfg.GetClusterInfo().nicparams[profile]
  paramslist = [objects.FillDict(c_nicparams, nic.nicparams)
                for nic in target_nics]
  brlist = [params[constants.NIC_LINK] for params in paramslist
            if params[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED]
  if brlist:
    result = lu.rpc.call_bridges_exist(target_node, brlist)
699 700
    result.Raise("Error checking bridges on destination node '%s'" %
                 target_node, prereq=True)
701 702 703


def _CheckInstanceBridgesExist(lu, instance, node=None):
704 705 706
  """Check that the brigdes needed by an instance exist.

  """
707
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
708
    node = instance.primary_node
709
  _CheckNicsBridgesExist(lu, instance.nics, node)
710 711


712 713 714 715 716 717 718 719 720 721 722 723 724
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
  instances = []

  for (_, inst) in cfg.GetAllInstancesInfo().iteritems():
    if node_name in inst.secondary_nodes:
      instances.append(inst)

  return instances


Iustin Pop's avatar
Iustin Pop committed
725 726 727 728 729 730 731 732 733 734 735
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
736
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
737 738

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
739
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
740 741

    nodelist = self.cfg.GetNodeList()
742
    if len(nodelist) != 1 or nodelist[0] != master:
743 744
      raise errors.OpPrereqError("There are still %d node(s) in"
                                 " this cluster." % (len(nodelist) - 1))
745 746
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
747 748
      raise errors.OpPrereqError("There are still %d instance(s) in"
                                 " this cluster." % len(instancelist))
Iustin Pop's avatar
Iustin Pop committed
749 750 751 752 753

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
754
    master = self.cfg.GetMasterNode()
755
    result = self.rpc.call_node_stop_master(master, False)
756
    result.Raise("Could not disable the master role")
757 758 759
    priv_key, pub_key, _ = ssh.GetUserFiles(constants.GANETI_RUNAS)
    utils.CreateBackup(priv_key)
    utils.CreateBackup(pub_key)
Iustin Pop's avatar
Iustin Pop committed
760
    return master
Iustin Pop's avatar
Iustin Pop committed
761 762


Guido Trotter's avatar
Guido Trotter committed
763
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
764 765 766
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
767 768
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
769
  _OP_REQP = ["skip_checks"]
770 771 772 773 774 775 776
  REQ_BGL = False

  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
777
    self.share_locks = dict.fromkeys(locking.LEVELS, 1)
Iustin Pop's avatar
Iustin Pop committed
778

779
  def _VerifyNode(self, nodeinfo, file_list, local_cksum,
780
                  node_result, feedback_fn, master_files,
781
                  drbd_map, vg_name):
Iustin Pop's avatar
Iustin Pop committed
782 783
    """Run multiple tests against a node.

784
    Test list:
785

Iustin Pop's avatar
Iustin Pop committed
786
      - compares ganeti version
Michael Hanselmann's avatar
Michael Hanselmann committed
787
      - checks vg existence and size > 20G
Iustin Pop's avatar
Iustin Pop committed
788 789 790
      - checks config file checksum
      - checks ssh to other nodes

791 792
    @type nodeinfo: L{objects.Node}
    @param nodeinfo: the node to check
793 794 795 796
    @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
797
    @param master_files: list of files that only masters should have
798 799 800
    @param drbd_map: the useddrbd minors for this node, in
        form of minor: (instance, must_exist) which correspond to instances
        and their running status
801
    @param vg_name: Ganeti Volume Group (result of self.cfg.GetVGName())
802

Iustin Pop's avatar
Iustin Pop committed
803
    """
804
    node = nodeinfo.name
805 806 807 808 809 810

    # 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
811 812
    # compares ganeti version
    local_version = constants.PROTOCOL_VERSION
813
    remote_version = node_result.get('version', None)
814 815
    if not (remote_version and isinstance(remote_version, (list, tuple)) and
            len(remote_version) == 2):
816
      feedback_fn("  - ERROR: connection to %s failed" % (node))
Iustin Pop's avatar
Iustin Pop committed
817 818
      return True

819 820 821
    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
822 823
      return True

824
    # node seems compatible, we can actually try to look into its results
Iustin Pop's avatar
Iustin Pop committed
825 826

    bad = False
827 828 829 830 831 832 833 834

    # 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
835 836 837 838 839
    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
840
        bad = True
841 842 843 844 845 846
      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
847 848 849

    # checks config file checksum

850 851
    remote_cksum = node_result.get(constants.NV_FILELIST, None)
    if not isinstance(remote_cksum, dict):
Iustin Pop's avatar
Iustin Pop committed
852 853 854 855
      bad = True
      feedback_fn("  - ERROR: node hasn't returned file checksum data")
    else:
      for file_name in file_list:
856 857
        node_is_mc = nodeinfo.master_candidate
        must_have_file = file_name not in master_files
Iustin Pop's avatar
Iustin Pop committed
858
        if file_name not in remote_cksum:
859 860 861
          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
862
        elif remote_cksum[file_name] != local_cksum[file_name]:
863 864 865 866 867 868
          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
869 870
            feedback_fn("  - ERROR: file '%s' should not exist on non master"
                        " candidates (and the file is outdated)" % file_name)
871 872 873 874 875
        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
876

877 878 879
    # checks ssh to any

    if constants.NV_NODELIST not in node_result:
Iustin Pop's avatar
Iustin Pop committed
880
      bad = True
881
      feedback_fn("  - ERROR: node hasn't returned node ssh connectivity data")
Iustin Pop's avatar
Iustin Pop committed
882
    else:
883
      if node_result[constants.NV_NODELIST]:
Iustin Pop's avatar
Iustin Pop committed
884
        bad = True
885
        for node in node_result[constants.NV_NODELIST]:
886
          feedback_fn("  - ERROR: ssh communication with node '%s': %s" %
887 888 889
                          (node, node_result[constants.NV_NODELIST][node]))

    if constants.NV_NODENETTEST not in node_result:
890 891 892
      bad = True
      feedback_fn("  - ERROR: node hasn't returned node tcp connectivity data")
    else:
893
      if node_result[constants.NV_NODENETTEST]:
894
        bad = True
895
        nlist = utils.NiceSort(node_result[constants.NV_NODENETTEST].keys())
896 897
        for node in nlist:
          feedback_fn("  - ERROR: tcp communication with node '%s': %s" %
898
                          (node, node_result[constants.NV_NODENETTEST][node]))
899

900
    hyp_result = node_result.get(constants.NV_HYPERVISOR, None)
901 902 903 904 905
    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))
906 907

    # check used drbd list
908 909 910 911 912 913 914 915
    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:
916 917
            feedback_fn("  - ERROR: drbd minor %d of instance %s is"
                        " not active" % (minor, iname))
918 919 920
            bad = True
        for minor in used_minors:
          if minor not in drbd_map:
921 922
            feedback_fn("  - ERROR: unallocated drbd minor %d is in use" %
                        minor)
923
            bad = True
924

Iustin Pop's avatar
Iustin Pop committed
925 926
    return bad

927
  def _VerifyInstance(self, instance, instanceconfig, node_vol_is,
928
                      node_instance, feedback_fn, n_offline):
Iustin Pop's avatar
Iustin Pop committed
929 930 931 932 933 934 935 936 937 938 939 940 941 942
    """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:
943 944 945
      if node in n_offline:
        # ignore missing volumes on offline nodes
        continue
Iustin Pop's avatar
Iustin Pop committed
946 947 948 949 950 951
      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

952
    if instanceconfig.admin_up:
953 954 955
      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
956 957 958 959 960 961 962 963 964 965 966
        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

967
    return bad
Iustin Pop's avatar
Iustin Pop committed
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000

  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

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
  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
1022
          bep = self.cfg.GetClusterInfo().FillBE(instance_cfg[instance])
1023
          if bep[constants.BE_AUTO_BALANCE]:
1024
            needed_mem += bep[constants.BE_MEMORY]
1025
        if nodeinfo['mfree'] < needed_mem:
Michael Hanselmann's avatar
Michael Hanselmann committed
1026
          feedback_fn("  - ERROR: not enough memory on node %s to accommodate"
1027 1028 1029 1030
                      " failovers should node %s fail" % (node, prinode))
          bad = True
    return bad

Iustin Pop's avatar
Iustin Pop committed
1031 1032 1033
  def CheckPrereq(self):
    """Check prerequisites.

1034 1035
    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
1036 1037

    """
1038 1039 1040
    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
1041

Guido Trotter's avatar
Guido Trotter committed
1042 1043 1044
  def BuildHooksEnv(self):
    """Build hooks env.

Michael Hanselmann's avatar
Michael Hanselmann committed
1045
    Cluster-Verify hooks just ran in the post phase and their failure makes
Guido Trotter's avatar
Guido Trotter committed
1046 1047 1048 1049
    the output be logged in the verify output and the verification to fail.

    """
    all_nodes = self.cfg.GetNodeList()
1050 1051 1052 1053 1054 1055
    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
1056 1057
    return env, [], all_nodes

Iustin Pop's avatar
Iustin Pop committed
1058 1059 1060 1061 1062 1063
  def Exec(self, feedback_fn):
    """Verify integrity of cluster, performing various test on nodes.

    """
    bad = False
    feedback_fn("* Verifying global settings")
1064 1065
    for msg in self.cfg.VerifyConfig():
      feedback_fn("  - ERROR: %s" % msg)
Iustin Pop's avatar
Iustin Pop committed
1066 1067

    vg_name = self.cfg.GetVGName()
1068
    hypervisors = self.cfg.GetClusterInfo().enabled_hypervisors
Iustin Pop's avatar
Iustin Pop committed
1069
    nodelist = utils.NiceSort(self.cfg.GetNodeList())
1070
    nodeinfo = [self.cfg.GetNodeInfo(nname) for nname in nodelist]
Iustin Pop's avatar
Iustin Pop committed
1071
    instancelist = utils.NiceSort(self.cfg.GetInstanceList())
1072 1073
    instanceinfo = dict((iname, self.cfg.GetInstanceInfo(iname))
                        for iname in instancelist)
1074
    i_non_redundant = [] # Non redundant instances
1075
    i_non_a_balanced = [] # Non auto-balanced instances
1076
    n_offline = [] # List of offline nodes
1077
    n_drained = [] # List of nodes being drained
Iustin Pop's avatar
Iustin Pop committed
1078 1079
    node_volume = {}
    node_instance = {}
1080
    node_info = {}
Guido Trotter's avatar
Guido Trotter committed
1081
    instance_cfg = {}
Iustin Pop's avatar
Iustin Pop committed
1082 1083 1084

    # FIXME: verify OS list
    # do local checksums