cmdlib.py 304 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
        raise errors.OpPrereqError("Required parameter '%s' missing" %
103
                                   attr_name, errors.ECODE_INVAL)
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
      for (idx, tl) in enumerate(self.tasklets):
218
219
        logging.debug("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
      for (idx, tl) in enumerate(self.tasklets):
234
        logging.debug("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
  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" %
300
                                 self.op.instance_name, errors.ECODE_NOENT)
301
302
303
    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
421
    raise errors.OpPrereqError("Invalid argument type 'nodes'",
                               errors.ECODE_INVAL)
422

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

427
428
429
430
  wanted = []
  for name in nodes:
    node = lu.cfg.ExpandNodeName(name)
    if node is None:
431
432
      raise errors.OpPrereqError("No such node name '%s'" % name,
                                 errors.ECODE_NOENT)
433
    wanted.append(node)
434

435
  return utils.NiceSort(wanted)
436
437
438


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

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

  """
  if not isinstance(instances, list):
452
453
    raise errors.OpPrereqError("Invalid argument type 'instances'",
                               errors.ECODE_INVAL)
454
455
456
457
458

  if instances:
    wanted = []

    for name in instances:
459
      instance = lu.cfg.ExpandInstanceName(name)
460
      if instance is None:
461
462
        raise errors.OpPrereqError("No such instance name '%s'" % name,
                                   errors.ECODE_NOENT)
463
464
465
      wanted.append(instance)

  else:
466
467
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
468
469
470


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

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

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

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


489
490
491
492
493
494
495
496
497
498
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)" %
499
                               (name, str(val)), errors.ECODE_INVAL)
500
501
502
503
504
505
506
507
  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
508
  @raise errors.OpPrereqError: if the node is offline
509
510
511

  """
  if lu.cfg.GetNodeInfo(node).offline:
512
513
    raise errors.OpPrereqError("Can't use offline node %s" % node,
                               errors.ECODE_INVAL)
514
515


516
517
518
519
520
521
522
523
524
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:
525
526
    raise errors.OpPrereqError("Can't use drained node %s" % node,
                               errors.ECODE_INVAL)
527
528


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

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

  if nics:
    nic_count = len(nics)
586
    for idx, (ip, mac, mode, link) in enumerate(nics):
587
588
589
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
590
      env["INSTANCE_NIC%d_MAC" % idx] = mac
591
592
593
594
      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
595
596
597
598
599
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
600
601
602
603
604
605
606
607
608
609
  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

610
611
612
613
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

614
615
  return env

616

617
def _NICListToTuple(lu, nics):
618
619
  """Build a list of nic information tuples.

620
621
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638

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

640

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

644
645
646
647
648
649
650
651
652
653
654
  @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

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


Guido Trotter's avatar
Guido Trotter committed
679
def _AdjustCandidatePool(lu, exceptions):
680
681
682
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
683
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
684
685
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
Iustin Pop's avatar
Iustin Pop committed
686
               ", ".join(node.name for node in mod_list))
687
688
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
689
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
690
691
692
693
694
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


695
696
697
698
699
700
701
702
703
704
705
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


706
707
708
709
710
711
712
713
714
715
716
717
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)
718
    result.Raise("Error checking bridges on destination node '%s'" %
719
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
720
721
722


def _CheckInstanceBridgesExist(lu, instance, node=None):
723
724
725
  """Check that the brigdes needed by an instance exist.

  """
726
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
727
    node = instance.primary_node
728
  _CheckNicsBridgesExist(lu, instance.nics, node)
729
730


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

Iustin Pop's avatar
Iustin Pop committed
734
735
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
736
737
738
739
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
740
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
741
742
743
744
    return
  try:
    variant = name.split("+", 1)[1]
  except IndexError:
745
746
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
747

Iustin Pop's avatar
Iustin Pop committed
748
  if variant not in os_obj.supported_variants:
749
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
750
751


752
753
754
755
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


756
757
758
759
760
761
762
763
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)


764
765
766
767
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
768
769
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
770
771


772
773
774
775
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
776
777
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
778
779


780
781
782
783
784
785
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
786
787
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
788
789
790
791

  return []


792
793
794
795
796
797
798
799
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,
800
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
801
802
803
804
805
806
807
808

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

  return faulty


809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
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


838
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
839
840
841
  """Logical unit for destroying the cluster.

  """
842
843
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
844
845
  _OP_REQP = []

846
847
848
849
850
851
852
  def BuildHooksEnv(self):
    """Build hooks env.

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

Iustin Pop's avatar
Iustin Pop committed
853
854
855
856
857
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
858
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
859
860

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
861
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
862
863

    nodelist = self.cfg.GetNodeList()
864
    if len(nodelist) != 1 or nodelist[0] != master:
865
      raise errors.OpPrereqError("There are still %d node(s) in"
866
867
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
868
869
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
870
      raise errors.OpPrereqError("There are still %d instance(s) in"
871
872
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
873
874
875
876
877

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
878
    master = self.cfg.GetMasterNode()
879
    modify_ssh_setup = self.cfg.GetClusterInfo().modify_ssh_setup
Luca Bigliardi's avatar
Luca Bigliardi committed
880
881
882
883
884
885
886
887

    # 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:
      self.LogWarning("Errors occurred running hooks on %s" % master)

888
    result = self.rpc.call_node_stop_master(master, False)
889
    result.Raise("Could not disable the master role")
890
891
892
893
894
895

    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
896
    return master
Iustin Pop's avatar
Iustin Pop committed
897
898


Guido Trotter's avatar
Guido Trotter committed
899
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
900
901
902
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
903
904
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
905
  _OP_REQP = ["skip_checks", "verbose", "error_codes", "debug_simulate_errors"]
906
907
  REQ_BGL = False

908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
  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")
931
  ENODESETUP = (TNODE, "ENODESETUP")
932

933
934
935
936
  ETYPE_FIELD = "code"
  ETYPE_ERROR = "ERROR"
  ETYPE_WARNING = "WARNING"

937
938
939
940
941
  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
942
    self.share_locks = dict.fromkeys(locking.LEVELS, 1)
Iustin Pop's avatar
Iustin Pop committed
943

944
945
946
947
948
949
950
951
952
  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.

    """
953
    ltype = kwargs.get(self.ETYPE_FIELD, self.ETYPE_ERROR)
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
    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)

970
971
972
973
974
975
976
977
978
979
980
  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

981
  def _VerifyNode(self, nodeinfo, file_list, local_cksum,
982
                  node_result, master_files, drbd_map, vg_name):
Iustin Pop's avatar
Iustin Pop committed
983
984
    """Run multiple tests against a node.

985
    Test list:
986

Iustin Pop's avatar
Iustin Pop committed
987
      - compares ganeti version
Michael Hanselmann's avatar
Michael Hanselmann committed
988
      - checks vg existence and size > 20G
Iustin Pop's avatar
Iustin Pop committed
989
990
991
      - checks config file checksum
      - checks ssh to other nodes

992
993
    @type nodeinfo: L{objects.Node}
    @param nodeinfo: the node to check
994
995
996
    @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
997
    @param master_files: list of files that only masters should have
998
999
1000
    @param drbd_map: the useddrbd minors for this node, in
        form of minor: (instance, must_exist) which correspond to instances
        and their running status
1001
    @param vg_name: Ganeti Volume Group (result of self.cfg.GetVGName())
1002

Iustin Pop's avatar
Iustin Pop committed
1003
    """
1004
    node = nodeinfo.name
1005
    _ErrorIf = self._ErrorIf
1006
1007

    # main result, node_result should be a non-empty dict
1008
1009
    test = not node_result or not isinstance(node_result, dict)
    _ErrorIf(test, self.ENODERPC, node,
1010
                  "unable to verify node: no data returned")
1011
1012
    if test:
      return
1013

Iustin Pop's avatar
Iustin Pop committed
1014
1015
    # compares ganeti version
    local_version = constants.PROTOCOL_VERSION
1016
    remote_version = node_result.get('version', None)
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
    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
1031

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

1034
    # full package version
1035
1036
    self._ErrorIf(constants.RELEASE_VERSION != remote_version[1],
                  self.ENODEVERSION, node,
1037
1038
                  "software version mismatch: master %s, node %s",
                  constants.RELEASE_VERSION, remote_version[1],
1039
                  code=self.ETYPE_WARNING)
1040
1041

    # checks vg existence and size > 20G
1042
1043
    if vg_name is not None:
      vglist = node_result.get(constants.NV_VGLIST, None)
1044
1045
1046
      test = not vglist
      _ErrorIf(test, self.ENODELVM, node, "unable to check volume groups")
      if not test:
1047
1048
        vgstatus = utils.CheckVolumeGroupSize(vglist, vg_name,
                                              constants.MIN_VG_SIZE)
1049
        _ErrorIf(vgstatus, self.ENODELVM, node, vgstatus)
Iustin Pop's avatar
Iustin Pop committed
1050
1051
1052

    # checks config file checksum

1053
    remote_cksum = node_result.get(constants.NV_FILELIST, None)
1054
1055
1056
1057
    test = not isinstance(remote_cksum, dict)
    _ErrorIf(test, self.ENODEFILECHECK, node,
             "node hasn't returned file checksum data")
    if not test:
Iustin Pop's avatar
Iustin Pop committed
1058
      for file_name in file_list:
1059
        node_is_mc = nodeinfo.master_candidate
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
        must_have = (file_name not in master_files) or node_is_mc
        # missing
        test1 = file_name not in remote_cksum
        # invalid checksum
        test2 = not test1 and remote_cksum[file_name] != local_cksum[file_name]
        # existing and good
        test3 = not test1 and remote_cksum[file_name] == local_cksum[file_name]
        _ErrorIf(test1 and must_have, self.ENODEFILECHECK, node,
                 "file '%s' missing", file_name)
        _ErrorIf(test2 and must_have, self.ENODEFILECHECK, node,
                 "file '%s' has wrong checksum", file_name)
        # not candidate and this is not a must-have file
        _ErrorIf(test2 and not must_have, self.ENODEFILECHECK, node,
                 "file '%s' should not exist on non master"
                 " candidates (and the file is outdated)", file_name)
        # all good, except non-master/non-must have combination
        _ErrorIf(test3 and not must_have, self.ENODEFILECHECK, node,
                 "file '%s' should not exist"
                 " on non master candidates", file_name)
Iustin Pop's avatar
Iustin Pop committed
1079

1080
1081
    # checks ssh to any

1082
1083
1084
1085
    test = constants.NV_NODELIST not in node_result
    _ErrorIf(test, self.ENODESSH, node,
             "node hasn't returned node ssh connectivity data")
    if not test:
1086
      if node_result[constants.NV_NODELIST]:
1087
        for a_node, a_msg in node_result[constants.NV_NODELIST].items():
1088
1089
          _ErrorIf(True, self.ENODESSH, node,
                   "ssh communication with node '%s': %s", a_node, a_msg)
1090

1091
1092
1093
1094
    test = constants.NV_NODENETTEST not in node_result
    _ErrorIf(test, self.ENODENET, node,
             "node hasn't returned node tcp connectivity data")
    if not test:
1095
1096
      if node_result[constants.NV_NODENETTEST]:
        nlist = utils.NiceSort(node_result[constants.NV_NODENETTEST].keys())
1097
        for anode in nlist:
1098
1099
1100
          _ErrorIf(True, self.ENODENET, node,
                   "tcp communication with node '%s': %s",
                   anode, node_result[constants.NV_NODENETTEST][anode])
1101

1102
    hyp_result = node_result.get(constants.NV_HYPERVISOR, None)
1103
1104
    if isinstance(hyp_result, dict):
      for hv_name, hv_result in hyp_result.iteritems():
1105
1106
1107
        test = hv_result is not None
        _ErrorIf(test, self.ENODEHV, node,
                 "hypervisor %s verify failure: '%s'", hv_name, hv_result)
1108
1109

    # check used drbd list
1110
1111
    if vg_name is not None:
      used_minors = node_result.get(constants.NV_DRBDLIST, [])
1112
1113
1114
1115
      test = not isinstance(used_minors, (tuple, list))
      _ErrorIf(test, self.ENODEDRBD, node,
               "cannot parse drbd status file: %s", str(used_minors))
      if not test:
1116
        for minor, (iname, must_exist) in drbd_map.items():
1117
1118
1119
1120
          test = minor not in used_minors and must_exist
          _ErrorIf(test, self.ENODEDRBD, node,
                   "drbd minor %d of instance %s is not active",
                   minor, iname)
1121
        for minor in used_minors:
1122
1123
1124
          test = minor not in drbd_map
          _ErrorIf(test, self.ENODEDRBD, node,
                   "unallocated drbd minor %d is in use", minor)
1125
1126
1127
1128
    test = node_result.get(constants.NV_NODESETUP,
                           ["Missing NODESETUP results"])
    _ErrorIf(test, self.ENODESETUP, node, "node setup error: %s",
             "; ".join(test))
Iustin Pop's avatar
Iustin Pop committed
1129

1130
  def _VerifyInstance(self, instance, instanceconfig, node_vol_is,
1131
                      node_instance, n_offline):
Iustin Pop's avatar
Iustin Pop committed
1132
1133
1134
1135
1136
1137
    """Verify an instance.

    This function checks to see if the required block devices are
    available on the instance's node.

    """
1138
    _ErrorIf = self._ErrorIf
Iustin Pop's avatar
Iustin Pop committed
1139
1140
1141
1142
1143
1144
    node_current = instanceconfig.primary_node

    node_vol_should = {}
    instanceconfig.MapLVsByNode(node_vol_should)

    for node in node_vol_should:
1145
1146
1147
      if node in n_offline:
        # ignore missing volumes on offline nodes
        continue
Iustin Pop's avatar
Iustin Pop committed
1148
      for volume in node_vol_should[node]:
1149
1150
1151
        test = node not in node_vol_is or volume not in node_vol_is[node]
        _ErrorIf(test, self.EINSTANCEMISSINGDISK, instance,
                 "volume %s missing on node %s", volume, node)
Iustin Pop's avatar
Iustin Pop committed
1152

1153
    if instanceconfig.admin_up:
1154
1155
1156
1157
1158
1159
      test = ((node_current not in node_instance or
               not instance in node_instance[node_current]) and
              node_current not in n_offline)
      _ErrorIf(test, self.EINSTANCEDOWN, instance,
               "instance not running on its primary node %s",
               node_current)
Iustin Pop's avatar
Iustin Pop committed
1160
1161
1162

    for node in node_instance:
      if (not node == node_current):
1163
1164
1165
        test = instance in node_instance[node]
        _ErrorIf(test, self.EINSTANCEWRONGNODE, instance,
                 "instance should not run on node %s", node)
Iustin Pop's avatar
Iustin Pop committed
1166

1167
  def _VerifyOrphanVolumes(self, node_vol_should, node_vol_is):
Iustin Pop's avatar
Iustin Pop committed
1168
1169
1170
1171
1172
1173
1174
1175
    """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.

    """
    for node in node_vol_is:
      for volume in node_vol_is[node]:
1176
1177
1178
        test = (node not in node_vol_should or
                volume not in node_vol_should[node])
        self._ErrorIf(test, self.ENODEORPHANLV, node,
1179
                      "volume %s is unknown", volume)
Iustin Pop's avatar
Iustin Pop committed
1180

1181
  def _VerifyOrphanInstances(self, instancelist, node_instance):
Iustin Pop's avatar
Iustin Pop committed
1182
1183
1184
1185
1186
1187
    """Verify the list of running instances.

    This checks what instances are running but unknown to the cluster.

    """
    for node in node_instance:
1188
      for o_inst in node_instance[node]:
1189
1190
        test = o_inst not in instancelist
        self._ErrorIf(test, self.ENODEORPHANINSTANCE, node,
1191
                      "instance %s on node %s should not exist", o_inst, node)
Iustin Pop's avatar
Iustin Pop committed
1192

1193
  def _VerifyNPlusOneMemory(self, node_info, instance_cfg):
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
    """Verify N+1 Memory Resilience.

    Check that if one single node dies we can still start all the instances it
    was primary for.

    """
    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
1212
          bep = self.cfg.GetClusterInfo().FillBE(instance_cfg[instance])
1213
          if bep[constants.BE_AUTO_BALANCE]:
1214
            needed_mem += bep[constants.BE_MEMORY]
1215
1216
        test = nodeinfo['mfree'] < needed_mem
        self._ErrorIf(test, self.ENODEN1, node,
1217
1218
                      "not enough memory on to accommodate"
                      " failovers should peer node %s fail", prinode)
1219

Iustin Pop's avatar
Iustin Pop committed
1220
1221
1222
  def CheckPrereq(self):
    """Check prerequisites.

1223
1224
    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
1225
1226

    """
1227
1228
    self.skip_set = frozenset(self.op.skip_checks)
    if not constants.VERIFY_OPTIONAL_CHECKS.issuperset(self.skip_set):
1229
1230
      raise errors.OpPrereqError("Invalid checks to be skipped specified",
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
1231

Guido Trotter's avatar
Guido Trotter committed
1232
1233
1234
  def BuildHooksEnv(self):
    """Build hooks env.

Michael Hanselmann's avatar
Michael Hanselmann committed
1235
    Cluster-Verify hooks just ran in the post phase and their failure makes
Guido Trotter's avatar
Guido Trotter committed
1236
1237
1238
1239
    the output be logged in the verify output and the verification to fail.

    """
    all_nodes = self.cfg.GetNodeList()
1240
1241
1242
1243
1244
1245
    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
1246
1247
    return env, [], all_nodes