cmdlib.py 339 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
36
import OpenSSL
Iustin Pop's avatar
Iustin Pop committed
37 38 39 40 41

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


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

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

  Note that all commands require root permissions.
Iustin Pop's avatar
Iustin Pop committed
63

64 65 66
  @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
67 68 69 70
  """
  HPATH = None
  HTYPE = None
  _OP_REQP = []
71
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
72

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

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

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

105
    # Tasklets
106
    self.tasklets = None
107

Iustin Pop's avatar
Iustin Pop committed
108 109 110
    for attr_name in self._OP_REQP:
      attr_val = getattr(op, attr_name, None)
      if attr_val is None:
111
        raise errors.OpPrereqError("Required parameter '%s' missing" %
112
                                   attr_name, errors.ECODE_INVAL)
113

114
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
115

116 117 118 119 120
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
121
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
122 123 124 125
    return self.__ssh

  ssh = property(fget=__GetSSH)

126 127 128 129 130 131 132 133 134
  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
135
      - CheckPrereq is run after we have acquired locks (and possible
136 137 138 139 140 141 142 143
        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

144 145 146 147 148 149 150 151 152 153 154
  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:
155 156 157 158 159

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

Guido Trotter's avatar
Guido Trotter committed
161 162 163 164
    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.

165 166 167 168
    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.

169 170 171 172 173 174 175 176 177 178 179 180 181
    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
182 183 184 185 186 187 188 189 190 191

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

    """
225
    if self.tasklets is not None:
226
      for (idx, tl) in enumerate(self.tasklets):
227 228
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
229 230 231
        tl.CheckPrereq()
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
232 233 234 235 236 237 238 239 240

  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.

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

  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.

262
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
263 264 265 266 267 268 269

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

    """
    raise NotImplementedError

270 271 272 273 274 275 276 277 278
  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.

279 280 281 282 283 284 285 286
    @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
287 288

    """
289 290 291
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
292 293
    return lu_result

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
  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"
309 310 311
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
312

313
  def _LockInstancesNodes(self, primary_only=False):
314 315 316 317 318 319 320 321 322 323 324 325 326
    """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.

327
    If should be called in DeclareLocks in a way similar to::
328

329 330
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
331

332 333 334
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

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

    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)
355 356 357

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
358

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

369 370 371 372 373 374 375 376
  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
377

378 379 380 381 382 383 384 385 386 387 388 389
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

  """
390 391 392 393 394 395 396
  def __init__(self, lu):
    self.lu = lu

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

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
  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


424
def _GetWantedNodes(lu, nodes):
425
  """Returns list of checked and expanded node names.
426

427 428 429 430 431 432
  @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
Iustin Pop's avatar
Iustin Pop committed
433
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
434 435

  """
436
  if not isinstance(nodes, list):
437 438
    raise errors.OpPrereqError("Invalid argument type 'nodes'",
                               errors.ECODE_INVAL)
439

440 441 442
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
443

Iustin Pop's avatar
Iustin Pop committed
444
  wanted = [_ExpandNodeName(lu.cfg, name) for name in nodes]
445
  return utils.NiceSort(wanted)
446 447 448


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

451 452 453 454 455 456 457 458
  @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
459 460 461

  """
  if not isinstance(instances, list):
462 463
    raise errors.OpPrereqError("Invalid argument type 'instances'",
                               errors.ECODE_INVAL)
464 465

  if instances:
466
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
467
  else:
468 469
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
470 471 472


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

Iustin Pop's avatar
Iustin Pop committed
475
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
476
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
477
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
478
  @param dynamic: dynamic fields set
479 480

  """
Iustin Pop's avatar
Iustin Pop committed
481
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
482 483
  f.Extend(static)
  f.Extend(dynamic)
484

Iustin Pop's avatar
Iustin Pop committed
485 486
  delta = f.NonMatching(selected)
  if delta:
487
    raise errors.OpPrereqError("Unknown output fields selected: %s"
488
                               % ",".join(delta), errors.ECODE_INVAL)
489 490


491 492 493 494 495 496 497 498 499 500
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)" %
501
                               (name, str(val)), errors.ECODE_INVAL)
502 503 504
  setattr(op, name, val)


505 506 507 508 509 510 511 512 513 514 515
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"
516
           " cluster level: %s" % utils.CommaJoin(used_globals))
517 518 519
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


520 521 522 523 524
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
525
  @raise errors.OpPrereqError: if the node is offline
526 527 528

  """
  if lu.cfg.GetNodeInfo(node).offline:
529 530
    raise errors.OpPrereqError("Can't use offline node %s" % node,
                               errors.ECODE_INVAL)
531 532


533 534 535 536 537 538 539 540 541
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:
542 543
    raise errors.OpPrereqError("Can't use drained node %s" % node,
                               errors.ECODE_INVAL)
544 545


Iustin Pop's avatar
Iustin Pop committed
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
def _CheckNodeHasOS(lu, node, os_name, force_variant):
  """Ensure that a node supports a given OS.

  @param lu: the LU on behalf of which we make the check
  @param node: the node to check
  @param os_name: the OS to query about
  @param force_variant: whether to ignore variant errors
  @raise errors.OpPrereqError: if the node is not supporting the OS

  """
  result = lu.rpc.call_os_get(node, os_name)
  result.Raise("OS '%s' not in supported OS list for node %s" %
               (os_name, node),
               prereq=True, ecode=errors.ECODE_INVAL)
  if not force_variant:
    _CheckOSVariant(result.payload, os_name)


564 565 566 567 568 569 570 571 572 573 574
def _RequireFileStorage():
  """Checks that file storage is enabled.

  @raise errors.OpPrereqError: when file storage is disabled

  """
  if not constants.ENABLE_FILE_STORAGE:
    raise errors.OpPrereqError("File storage disabled at configure time",
                               errors.ECODE_INVAL)


575 576 577 578 579 580 581 582
def _CheckDiskTemplate(template):
  """Ensure a given disk template is valid.

  """
  if template not in constants.DISK_TEMPLATES:
    msg = ("Invalid disk template name '%s', valid templates are: %s" %
           (template, utils.CommaJoin(constants.DISK_TEMPLATES)))
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)
583 584 585 586 587 588 589 590 591 592
  if template == constants.DT_FILE:
    _RequireFileStorage()


def _CheckStorageType(storage_type):
  """Ensure a given storage type is valid.

  """
  if storage_type not in constants.VALID_STORAGE_TYPES:
    raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
593
                               errors.ECODE_INVAL)
594 595 596
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()

597 598


599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
def _CheckInstanceDown(lu, instance, reason):
  """Ensure that an instance is not running."""
  if instance.admin_up:
    raise errors.OpPrereqError("Instance %s is marked to be up, %s" %
                               (instance.name, reason), errors.ECODE_STATE)

  pnode = instance.primary_node
  ins_l = lu.rpc.call_instance_list([pnode], [instance.hypervisor])[pnode]
  ins_l.Raise("Can't contact node %s for instance information" % pnode,
              prereq=True, ecode=errors.ECODE_ENVIRON)

  if instance.name in ins_l.payload:
    raise errors.OpPrereqError("Instance %s is running, %s" %
                               (instance.name, reason), errors.ECODE_STATE)


615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
def _ExpandItemName(fn, name, kind):
  """Expand an item name.

  @param fn: the function to use for expansion
  @param name: requested item name
  @param kind: text description ('Node' or 'Instance')
  @return: the resolved (full) name
  @raise errors.OpPrereqError: if the item is not found

  """
  full_name = fn(name)
  if full_name is None:
    raise errors.OpPrereqError("%s '%s' not known" % (kind, name),
                               errors.ECODE_NOENT)
  return full_name


def _ExpandNodeName(cfg, name):
  """Wrapper over L{_ExpandItemName} for nodes."""
  return _ExpandItemName(cfg.ExpandNodeName, name, "Node")


def _ExpandInstanceName(cfg, name):
  """Wrapper over L{_ExpandItemName} for instance."""
  return _ExpandItemName(cfg.ExpandInstanceName, name, "Instance")


642
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
643
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
644
                          bep, hvp, hypervisor_name):
645 646 647 648 649 650 651 652 653 654 655 656
  """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
657 658
  @type status: boolean
  @param status: the should_run status of the instance
659 660 661 662 663
  @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
664 665
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
666
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
667
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
668 669
  @type disks: list
  @param disks: the list of (size, mode) pairs
670 671 672 673
  @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
674 675
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
676 677
  @rtype: dict
  @return: the hook environment for this instance
678

679
  """
680 681 682 683
  if status:
    str_status = "up"
  else:
    str_status = "down"
684
  env = {
685
    "OP_TARGET": name,
686 687 688
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
689
    "INSTANCE_OS_TYPE": os_type,
690
    "INSTANCE_STATUS": str_status,
691 692
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
693
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
694
    "INSTANCE_HYPERVISOR": hypervisor_name,
695 696 697 698
  }

  if nics:
    nic_count = len(nics)
699
    for idx, (ip, mac, mode, link) in enumerate(nics):
700 701 702
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
703
      env["INSTANCE_NIC%d_MAC" % idx] = mac
704 705 706 707
      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
708 709 710 711 712
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
713 714 715 716 717 718 719 720 721 722
  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

723 724 725 726
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

727 728
  return env

729

730
def _NICListToTuple(lu, nics):
731 732
  """Build a list of nic information tuples.

733 734
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

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

753

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

757 758 759 760 761 762 763 764 765 766 767
  @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

768
  """
769 770 771
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
772 773 774 775
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
776
    'os_type': instance.os,
777
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
778 779
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
780
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
781 782
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
783 784
    'bep': bep,
    'hvp': hvp,
785
    'hypervisor_name': instance.hypervisor,
786 787 788
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
789
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
790 791


Guido Trotter's avatar
Guido Trotter committed
792
def _AdjustCandidatePool(lu, exceptions):
793 794 795
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
796
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
797 798
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
799
               utils.CommaJoin(node.name for node in mod_list))
800 801
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
802
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
803 804 805 806 807
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


808 809 810 811 812 813 814 815 816 817 818
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


819 820 821 822 823 824 825 826 827 828 829 830
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)
831
    result.Raise("Error checking bridges on destination node '%s'" %
832
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
833 834 835


def _CheckInstanceBridgesExist(lu, instance, node=None):
836 837 838
  """Check that the brigdes needed by an instance exist.

  """
839
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
840
    node = instance.primary_node
841
  _CheckNicsBridgesExist(lu, instance.nics, node)
842 843


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

Iustin Pop's avatar
Iustin Pop committed
847 848
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
849 850 851 852
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
853
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
854 855 856 857
    return
  try:
    variant = name.split("+", 1)[1]
  except IndexError:
858 859
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
860

Iustin Pop's avatar
Iustin Pop committed
861
  if variant not in os_obj.supported_variants:
862
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
863 864


865 866 867 868
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


869 870 871 872 873 874 875 876
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)


877 878 879 880
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
881 882
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
883 884


885 886 887 888
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
889 890
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
891 892


893 894 895 896 897 898
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
899 900
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
901 902 903 904

  return []


905 906 907 908 909 910 911 912
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,
913
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
914 915 916 917 918 919 920 921

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

  return faulty


922 923 924 925 926 927 928
def _FormatTimestamp(secs):
  """Formats a Unix timestamp with the local timezone.

  """
  return time.strftime("%F %T %Z", time.gmtime(secs))


929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
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


958
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
959 960 961
  """Logical unit for destroying the cluster.

  """
962 963
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
964 965
  _OP_REQP = []

966 967 968 969 970 971 972
  def BuildHooksEnv(self):
    """Build hooks env.

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

Iustin Pop's avatar
Iustin Pop committed
973 974 975 976 977
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
978
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
979 980

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
981
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
982 983

    nodelist = self.cfg.GetNodeList()
984
    if len(nodelist) != 1 or nodelist[0] != master:
985
      raise errors.OpPrereqError("There are still %d node(s) in"
986 987
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
988 989
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
990
      raise errors.OpPrereqError("There are still %d instance(s) in"
991 992
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
993 994 995 996 997

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
998
    master = self.cfg.GetMasterNode()
999
    modify_ssh_setup = self.cfg.GetClusterInfo().modify_ssh_setup
Luca Bigliardi's avatar
Luca Bigliardi committed
1000 1001 1002 1003 1004 1005

    # 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
1006
      # pylint: disable-msg=W0702
Luca Bigliardi's avatar
Luca Bigliardi committed
1007 1008
      self.LogWarning("Errors occurred running hooks on %s" % master)

1009
    result = self.rpc.call_node_stop_master(master, False)
1010
    result.Raise("Could not disable the master role")
1011 1012 1013 1014 1015 1016

    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
1017
    return master
Iustin Pop's avatar
Iustin Pop committed
1018 1019


1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
def _VerifyCertificateInner(filename, expired, not_before, not_after, now,
                            warn_days=constants.SSL_CERT_EXPIRATION_WARN,
                            error_days=constants.SSL_CERT_EXPIRATION_ERROR):
  """Verifies certificate details for LUVerifyCluster.

  """
  if expired:
    msg = "Certificate %s is expired" % filename

    if not_before is not None and not_after is not None:
      msg += (" (valid from %s to %s)" %
              (_FormatTimestamp(not_before),
               _FormatTimestamp(not_after)))
    elif not_before is not None:
      msg += " (valid from %s)" % _FormatTimestamp(not_before)
    elif not_after is not None:
      msg += " (valid until %s)" % _FormatTimestamp(not_after)

    return (LUVerifyCluster.ETYPE_ERROR, msg)

  elif not_before is not None and not_before > now:
    return (LUVerifyCluster.ETYPE_WARNING,
            "Certificate %s not yet valid (valid from %s)" %
            (filename, _FormatTimestamp(not_before)))

  elif not_after is not None:
    remaining_days = int((not_after - now) / (24 * 3600))

    msg = ("Certificate %s expires in %d days" % (filename, remaining_days))

    if remaining_days <= error_days:
      return (LUVerifyCluster.ETYPE_ERROR, msg)

    if remaining_days <= warn_days:
      return (LUVerifyCluster.ETYPE_WARNING, msg)

  return (None, None)


def _VerifyCertificate(filename):
  """Verifies a certificate for LUVerifyCluster.

  @type filename: string
  @param filename: Path to PEM file

  """
  try:
    cert = OpenSSL.crypto.load_certificate(OpenSSL.crypto.FILETYPE_PEM,
                                           utils.ReadFile(filename))
  except Exception, err: # pylint: disable-msg=W0703
    return (LUVerifyCluster.ETYPE_ERROR,
            "Failed to load X509 certificate %s: %s" % (filename, err))

  # Depending on the pyOpenSSL version, this can just return (None, None)
  (not_before, not_after) = utils.GetX509CertValidity(cert)

  return _VerifyCertificateInner(filename, cert.has_expired(),
                                 not_before, not_after, time.time())


Guido Trotter's avatar
Guido Trotter committed
1080
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1081 1082 1083
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
1084 1085
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
1086
  _OP_REQP = ["skip_checks", "verbose", "error_codes", "debug_simulate_errors"]
1087 1088
  REQ_BGL = False

1089 1090 1091 1092 1093
  TCLUSTER = "cluster"
  TNODE = "node"
  TINSTANCE = "instance"

  ECLUSTERCFG = (TCLUSTER, "ECLUSTERCFG")
1094
  ECLUSTERCERT = (TCLUSTER, "ECLUSTERCERT")
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
  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")
1113
  ENODESETUP = (TNODE, "ENODESETUP")
1114
  ENODETIME = (TNODE, "ENODETIME")
1115

1116 1117 1118 1119
  ETYPE_FIELD = "code"
  ETYPE_ERROR = "ERROR"
  ETYPE_WARNING = "WARNING"

Iustin Pop's avatar
Iustin Pop committed
1120 1121 1122 1123
  class NodeImage(object):
    """A class representing the logical and physical status of a node.

    @ivar volumes: a structure as returned from
Iustin Pop's avatar
Iustin Pop committed
1124
        L{ganeti.backend.GetVolumeList} (runtime)
Iustin Pop's avatar
Iustin Pop committed
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153