cmdlib.py 310 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
    - implement ExpandNames
53 54
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
55 56
    - 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
  @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
65 66 67 68
  """
  HPATH = None
  HTYPE = None
  _OP_REQP = []
69
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
70

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

Michael Hanselmann's avatar
Michael Hanselmann committed
74
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
75 76 77
    validity.

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

99
    # Tasklets
100
    self.tasklets = None
101

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

108
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
109

110 111 112 113 114
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
115
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
116 117 118 119
    return self.__ssh

  ssh = property(fget=__GetSSH)

120 121 122 123 124 125 126 127 128
  def CheckArguments(self):
    """Check syntactic validity for the opcode arguments.

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

      - ExpandNames is left as as purely a lock-related function
Michael Hanselmann's avatar
Michael Hanselmann committed
129
      - CheckPrereq is run after we have acquired locks (and possible
130 131 132 133 134 135 136 137
        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

138 139 140 141 142 143 144 145 146 147 148
  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:
149 150 151 152 153

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

Guido Trotter's avatar
Guido Trotter committed
155 156 157 158
    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.

159 160 161 162
    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.

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

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

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

  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.

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

  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.

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

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

    """
    raise NotImplementedError

Iustin Pop's avatar
Iustin Pop committed
264 265
  # this is valid in this entire class even if added here
  # pylint: disable-msg=R0201
266 267 268 269 270 271 272 273 274
  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.

275 276 277 278 279 280 281 282
    @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
283 284 285 286

    """
    return lu_result

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
  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" %
305
                                 self.op.instance_name, errors.ECODE_NOENT)
306 307 308
    self.needed_locks[locking.LEVEL_INSTANCE] = expanded_name
    self.op.instance_name = expanded_name

309
  def _LockInstancesNodes(self, primary_only=False):
310 311 312 313 314 315 316 317 318 319 320 321 322
    """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.

323
    If should be called in DeclareLocks in a way similar to::
324

325 326
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
327

328 329 330
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

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

    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)
351 352 353

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
354

Iustin Pop's avatar
Iustin Pop committed
355
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
356 357 358 359 360 361 362 363 364
  """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

365 366 367 368 369 370 371 372
  def BuildHooksEnv(self):
    """Empty BuildHooksEnv for NoHooksLu.

    This just raises an error.

    """
    assert False, "BuildHooksEnv called for NoHooksLUs"

Iustin Pop's avatar
Iustin Pop committed
373

374 375 376 377 378 379 380 381 382 383 384 385
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

  """
386 387 388 389 390 391 392
  def __init__(self, lu):
    self.lu = lu

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

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
  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


420
def _GetWantedNodes(lu, nodes):
421
  """Returns list of checked and expanded node names.
422

423 424 425 426 427 428 429
  @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
430 431

  """
432
  if not isinstance(nodes, list):
433 434
    raise errors.OpPrereqError("Invalid argument type 'nodes'",
                               errors.ECODE_INVAL)
435

436 437 438
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
439

440 441 442 443
  wanted = []
  for name in nodes:
    node = lu.cfg.ExpandNodeName(name)
    if node is None:
444 445
      raise errors.OpPrereqError("No such node name '%s'" % name,
                                 errors.ECODE_NOENT)
446
    wanted.append(node)
447

448
  return utils.NiceSort(wanted)
449 450 451


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

454 455 456 457 458 459 460 461
  @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
462 463 464

  """
  if not isinstance(instances, list):
465 466
    raise errors.OpPrereqError("Invalid argument type 'instances'",
                               errors.ECODE_INVAL)
467 468 469 470 471

  if instances:
    wanted = []

    for name in instances:
472
      instance = lu.cfg.ExpandInstanceName(name)
473
      if instance is None:
474 475
        raise errors.OpPrereqError("No such instance name '%s'" % name,
                                   errors.ECODE_NOENT)
476 477 478
      wanted.append(instance)

  else:
479 480
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
481 482 483


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

Iustin Pop's avatar
Iustin Pop committed
486
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
487
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
488
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
489
  @param dynamic: dynamic fields set
490 491

  """
Iustin Pop's avatar
Iustin Pop committed
492
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
493 494
  f.Extend(static)
  f.Extend(dynamic)
495

Iustin Pop's avatar
Iustin Pop committed
496 497
  delta = f.NonMatching(selected)
  if delta:
498
    raise errors.OpPrereqError("Unknown output fields selected: %s"
499
                               % ",".join(delta), errors.ECODE_INVAL)
500 501


502 503 504 505 506 507 508 509 510 511
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)" %
512
                               (name, str(val)), errors.ECODE_INVAL)
513 514 515
  setattr(op, name, val)


516 517 518 519 520 521 522 523 524 525 526
def _CheckGlobalHvParams(params):
  """Validates that given hypervisor params are not global ones.

  This will ensure that instances don't get customised versions of
  global params.

  """
  used_globals = constants.HVC_GLOBALS.intersection(params)
  if used_globals:
    msg = ("The following hypervisor parameters are global and cannot"
           " be customized at instance level, please modify them at"
527
           " cluster level: %s" % utils.CommaJoin(used_globals))
528 529 530
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


531 532 533 534 535
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
536
  @raise errors.OpPrereqError: if the node is offline
537 538 539

  """
  if lu.cfg.GetNodeInfo(node).offline:
540 541
    raise errors.OpPrereqError("Can't use offline node %s" % node,
                               errors.ECODE_INVAL)
542 543


544 545 546 547 548 549 550 551 552
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:
553 554
    raise errors.OpPrereqError("Can't use drained node %s" % node,
                               errors.ECODE_INVAL)
555 556


557
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
558
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
559
                          bep, hvp, hypervisor_name):
560 561 562 563 564 565 566 567 568 569 570 571
  """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
572 573
  @type status: boolean
  @param status: the should_run status of the instance
574 575 576 577 578
  @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
579 580
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
581
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
582
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
583 584
  @type disks: list
  @param disks: the list of (size, mode) pairs
585 586 587 588
  @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
589 590
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
591 592
  @rtype: dict
  @return: the hook environment for this instance
593

594
  """
595 596 597 598
  if status:
    str_status = "up"
  else:
    str_status = "down"
599
  env = {
600
    "OP_TARGET": name,
601 602 603
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
604
    "INSTANCE_OS_TYPE": os_type,
605
    "INSTANCE_STATUS": str_status,
606 607
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
608
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
609
    "INSTANCE_HYPERVISOR": hypervisor_name,
610 611 612 613
  }

  if nics:
    nic_count = len(nics)
614
    for idx, (ip, mac, mode, link) in enumerate(nics):
615 616 617
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
618
      env["INSTANCE_NIC%d_MAC" % idx] = mac
619 620 621 622
      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
623 624 625 626 627
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
628 629 630 631 632 633 634 635 636 637
  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

638 639 640 641
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

642 643
  return env

644

645
def _NICListToTuple(lu, nics):
646 647
  """Build a list of nic information tuples.

648 649
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666

  @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
667

668

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

672 673 674 675 676 677 678 679 680 681 682
  @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

683
  """
684 685 686
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
687 688 689 690
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
691
    'os_type': instance.os,
692
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
693 694
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
695
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
696 697
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
698 699
    'bep': bep,
    'hvp': hvp,
700
    'hypervisor_name': instance.hypervisor,
701 702 703
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
704
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
705 706


Guido Trotter's avatar
Guido Trotter committed
707
def _AdjustCandidatePool(lu, exceptions):
708 709 710
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
711
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
712 713
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
714
               utils.CommaJoin(node.name for node in mod_list))
715 716
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
717
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
718 719 720 721 722
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


723 724 725 726 727 728 729 730 731 732 733
def _DecideSelfPromotion(lu, exceptions=None):
  """Decide whether I should promote myself as a master candidate.

  """
  cp_size = lu.cfg.GetClusterInfo().candidate_pool_size
  mc_now, mc_should, _ = lu.cfg.GetMasterCandidateStats(exceptions)
  # the new node will increase mc_max with one, so:
  mc_should = min(mc_should + 1, cp_size)
  return mc_now < mc_should


734 735 736 737 738 739 740 741 742 743 744 745
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)
746
    result.Raise("Error checking bridges on destination node '%s'" %
747
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
748 749 750


def _CheckInstanceBridgesExist(lu, instance, node=None):
751 752 753
  """Check that the brigdes needed by an instance exist.

  """
754
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
755
    node = instance.primary_node
756
  _CheckNicsBridgesExist(lu, instance.nics, node)
757 758


Iustin Pop's avatar
Iustin Pop committed
759
def _CheckOSVariant(os_obj, name):
Guido Trotter's avatar
Guido Trotter committed
760 761
  """Check whether an OS name conforms to the os variants specification.

Iustin Pop's avatar
Iustin Pop committed
762 763
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
764 765 766 767
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
768
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
769 770 771 772
    return
  try:
    variant = name.split("+", 1)[1]
  except IndexError:
773 774
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
775

Iustin Pop's avatar
Iustin Pop committed
776
  if variant not in os_obj.supported_variants:
777
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
778 779


780 781 782 783
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


784 785 786 787 788 789 790 791
def _GetNodeInstances(cfg, node_name):
  """Returns a list of all primary and secondary instances on a node.

  """

  return _GetNodeInstancesInner(cfg, lambda inst: node_name in inst.all_nodes)


792 793 794 795
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
796 797
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
798 799


800 801 802 803
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
804 805
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
806 807


808 809 810 811 812 813
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
814 815
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
816 817 818 819

  return []


820 821 822 823 824 825 826 827
def _FindFaultyInstanceDisks(cfg, rpc, instance, node_name, prereq):
  faulty = []

  for dev in instance.disks:
    cfg.SetDiskID(dev, node_name)

  result = rpc.call_blockdev_getmirrorstatus(node_name, instance.disks)
  result.Raise("Failed to get disk status from node %s" % node_name,
828
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
829 830 831 832 833 834 835 836

  for idx, bdev_status in enumerate(result.payload):
    if bdev_status and bdev_status.ldisk_status == constants.LDS_FAULTY:
      faulty.append(idx)

  return faulty


837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
class LUPostInitCluster(LogicalUnit):
  """Logical unit for running hooks after cluster initialization.

  """
  HPATH = "cluster-init"
  HTYPE = constants.HTYPE_CLUSTER
  _OP_REQP = []

  def BuildHooksEnv(self):
    """Build hooks env.

    """
    env = {"OP_TARGET": self.cfg.GetClusterName()}
    mn = self.cfg.GetMasterNode()
    return env, [], [mn]

  def CheckPrereq(self):
    """No prerequisites to check.

    """
    return True

  def Exec(self, feedback_fn):
    """Nothing to do.

    """
    return True


866
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
867 868 869
  """Logical unit for destroying the cluster.

  """
870 871
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
872 873
  _OP_REQP = []

874 875 876 877 878 879 880
  def BuildHooksEnv(self):
    """Build hooks env.

    """
    env = {"OP_TARGET": self.cfg.GetClusterName()}
    return env, [], []

Iustin Pop's avatar
Iustin Pop committed
881 882 883 884 885
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
886
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
887 888

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
889
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
890 891

    nodelist = self.cfg.GetNodeList()
892
    if len(nodelist) != 1 or nodelist[0] != master:
893
      raise errors.OpPrereqError("There are still %d node(s) in"
894 895
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
896 897
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
898
      raise errors.OpPrereqError("There are still %d instance(s) in"
899 900
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
901 902 903 904 905

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
906
    master = self.cfg.GetMasterNode()
907
    modify_ssh_setup = self.cfg.GetClusterInfo().modify_ssh_setup
Luca Bigliardi's avatar
Luca Bigliardi committed
908 909 910 911 912 913

    # Run post hooks on master node before it's removed
    hm = self.proc.hmclass(self.rpc.call_hooks_runner, self)
    try:
      hm.RunPhase(constants.HOOKS_PHASE_POST, [master])
    except:
Iustin Pop's avatar
Iustin Pop committed
914
      # pylint: disable-msg=W0702
Luca Bigliardi's avatar
Luca Bigliardi committed
915 916
      self.LogWarning("Errors occurred running hooks on %s" % master)

917
    result = self.rpc.call_node_stop_master(master, False)
918
    result.Raise("Could not disable the master role")
919 920 921 922 923 924

    if modify_ssh_setup:
      priv_key, pub_key, _ = ssh.GetUserFiles(constants.GANETI_RUNAS)
      utils.CreateBackup(priv_key)
      utils.CreateBackup(pub_key)

Iustin Pop's avatar
Iustin Pop committed
925
    return master
Iustin Pop's avatar
Iustin Pop committed
926 927


Guido Trotter's avatar
Guido Trotter committed
928
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
929 930 931
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
932 933
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
934
  _OP_REQP = ["skip_checks", "verbose", "error_codes", "debug_simulate_errors"]
935 936
  REQ_BGL = False

937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
  TCLUSTER = "cluster"
  TNODE = "node"
  TINSTANCE = "instance"

  ECLUSTERCFG = (TCLUSTER, "ECLUSTERCFG")
  EINSTANCEBADNODE = (TINSTANCE, "EINSTANCEBADNODE")
  EINSTANCEDOWN = (TINSTANCE, "EINSTANCEDOWN")
  EINSTANCELAYOUT = (TINSTANCE, "EINSTANCELAYOUT")
  EINSTANCEMISSINGDISK = (TINSTANCE, "EINSTANCEMISSINGDISK")
  EINSTANCEMISSINGDISK = (TINSTANCE, "EINSTANCEMISSINGDISK")
  EINSTANCEWRONGNODE = (TINSTANCE, "EINSTANCEWRONGNODE")
  ENODEDRBD = (TNODE, "ENODEDRBD")
  ENODEFILECHECK = (TNODE, "ENODEFILECHECK")
  ENODEHOOKS = (TNODE, "ENODEHOOKS")
  ENODEHV = (TNODE, "ENODEHV")
  ENODELVM = (TNODE, "ENODELVM")
  ENODEN1 = (TNODE, "ENODEN1")
  ENODENET = (TNODE, "ENODENET")
  ENODEORPHANINSTANCE = (TNODE, "ENODEORPHANINSTANCE")
  ENODEORPHANLV = (TNODE, "ENODEORPHANLV")
  ENODERPC = (TNODE, "ENODERPC")
  ENODESSH = (TNODE, "ENODESSH")
  ENODEVERSION = (TNODE, "ENODEVERSION")
960
  ENODESETUP = (TNODE, "ENODESETUP")
961
  ENODETIME = (TNODE, "ENODETIME")
962

963 964 965 966
  ETYPE_FIELD = "code"
  ETYPE_ERROR = "ERROR"
  ETYPE_WARNING = "WARNING"

967 968 969 970 971
  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
972
    self.share_locks = dict.fromkeys(locking.LEVELS, 1)
Iustin Pop's avatar
Iustin Pop committed
973

974 975 976 977 978 979 980 981 982
  def _Error(self, ecode, item, msg, *args, **kwargs):
    """Format an error message.

    Based on the opcode's error_codes parameter, either format a
    parseable error code, or a simpler error string.

    This must be called only from Exec and functions called from Exec.

    """
983
    ltype = kwargs.get(self.ETYPE_FIELD, self.ETYPE_ERROR)
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
    itype, etxt = ecode
    # first complete the msg
    if args:
      msg = msg % args
    # then format the whole message
    if self.op.error_codes:
      msg = "%s:%s:%s:%s:%s" % (ltype, etxt, itype, item, msg)
    else:
      if item:
        item = " " + item
      else:
        item = ""
      msg = "%s: %s%s: %s" % (ltype, itype, item, msg)
    # and finally report it via the feedback_fn
    self._feedback_fn("  - %s" % msg)

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
  def _ErrorIf(self, cond, *args, **kwargs):
    """Log an error message if the passed condition is True.

    """
    cond = bool(cond) or self.op.debug_simulate_errors
    if cond:
      self._Error(*args, **kwargs)
    # do not mark the operation as failed for WARN cases only
    if kwargs.get(self.ETYPE_FIELD, self.ETYPE_ERROR) == self.ETYPE_ERROR:
      self.bad = self.bad or cond

1011
  def _VerifyNode(self, nodeinfo, file_list, local_cksum,
1012
                  node_result, master_files, drbd_map, vg_name):
Iustin Pop's avatar
Iustin Pop committed
1013 1014
    """Run multiple tests against a node.

1015
    Test list:
1016

Iustin Pop's avatar
Iustin Pop committed
1017
      - compares ganeti version
Michael Hanselmann's avatar
Michael Hanselmann committed
1018
      - checks vg existence and size > 20G
Iustin Pop's avatar
Iustin Pop committed
1019 1020 1021
      - checks config file checksum
      - checks ssh to other nodes

1022 1023
    @type nodeinfo: L{objects.Node}
    @param nodeinfo: the node to check
1024 1025 1026
    @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
1027
    @param master_files: list of files that only masters should have
1028 1029 1030
    @param drbd_map: the useddrbd minors for this node, in
        form of minor: (instance, must_exist) which correspond to instances
        and their running status
1031
    @param vg_name: Ganeti Volume Group (result of self.cfg.GetVGName())
1032

Iustin Pop's avatar
Iustin Pop committed
1033
    """
1034
    node = nodeinfo.name
Iustin Pop's avatar
Iustin Pop committed
1035
    _ErrorIf = self._ErrorIf # pylint: disable-msg=C0103
1036 1037

    # main result, node_result should be a non-empty dict
1038 1039
    test = not node_result or not isinstance(node_result, dict)
    _ErrorIf(test, self.ENODERPC, node,
1040
                  "unable to verify node: no data returned")
1041 1042
    if test:
      return
1043

Iustin Pop's avatar
Iustin Pop committed
1044 1045
    # compares ganeti version
    local_version = constants.PROTOCOL_VERSION
1046
    remote_version = node_result.get('version', None)
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
    test = not (remote_version and
                isinstance(remote_version, (list, tuple)) and
                len(remote_version) == 2)
    _ErrorIf(test, self.ENODERPC, node,
             "connection to node returned invalid data")
    if test:
      return

    test = local_version != remote_version[0]
    _ErrorIf(test, self.ENODEVERSION, node,
             "incompatible protocol versions: master %s,"
             " node %s", local_version, remote_version[0])
    if test:
      return
Iustin Pop's avatar
Iustin Pop committed
1061

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

1064
    # full package version
1065 1066
    self._ErrorIf(constants.RELEASE_VERSION != remote_version[1],
                  self.ENODEVERSION, node,
1067 1068
                  "software version mismatch: master %s, node %s",
                  constants.RELEASE_VERSION, remote_version[1],