cmdlib.py 307 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
  setattr(op, name, val)


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


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

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


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


544
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
545
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
546
                          bep, hvp, hypervisor_name):
547
548
549
550
551
552
553
554
555
556
557
558
  """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
559
560
  @type status: boolean
  @param status: the should_run status of the instance
561
562
563
564
565
  @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
566
567
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
568
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
569
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
570
571
  @type disks: list
  @param disks: the list of (size, mode) pairs
572
573
574
575
  @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
576
577
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
578
579
  @rtype: dict
  @return: the hook environment for this instance
580

581
  """
582
583
584
585
  if status:
    str_status = "up"
  else:
    str_status = "down"
586
  env = {
587
    "OP_TARGET": name,
588
589
590
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
591
    "INSTANCE_OS_TYPE": os_type,
592
    "INSTANCE_STATUS": str_status,
593
594
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
595
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
596
    "INSTANCE_HYPERVISOR": hypervisor_name,
597
598
599
600
  }

  if nics:
    nic_count = len(nics)
601
    for idx, (ip, mac, mode, link) in enumerate(nics):
602
603
604
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
605
      env["INSTANCE_NIC%d_MAC" % idx] = mac
606
607
608
609
      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
610
611
612
613
614
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
615
616
617
618
619
620
621
622
623
624
  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

625
626
627
628
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

629
630
  return env

631

632
def _NICListToTuple(lu, nics):
633
634
  """Build a list of nic information tuples.

635
636
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653

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

655

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

659
660
661
662
663
664
665
666
667
668
669
  @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

670
  """
671
672
673
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
674
675
676
677
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
678
    'os_type': instance.os,
679
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
680
681
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
682
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
683
684
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
685
686
    'bep': bep,
    'hvp': hvp,
687
    'hypervisor_name': instance.hypervisor,
688
689
690
691
692
693
  }
  if override:
    args.update(override)
  return _BuildInstanceHookEnv(**args)


Guido Trotter's avatar
Guido Trotter committed
694
def _AdjustCandidatePool(lu, exceptions):
695
696
697
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
698
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
699
700
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
701
               utils.CommaJoin(node.name for node in mod_list))
702
703
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
704
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
705
706
707
708
709
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


710
711
712
713
714
715
716
717
718
719
720
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


721
722
723
724
725
726
727
728
729
730
731
732
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)
733
    result.Raise("Error checking bridges on destination node '%s'" %
734
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
735
736
737


def _CheckInstanceBridgesExist(lu, instance, node=None):
738
739
740
  """Check that the brigdes needed by an instance exist.

  """
741
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
742
    node = instance.primary_node
743
  _CheckNicsBridgesExist(lu, instance.nics, node)
744
745


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

Iustin Pop's avatar
Iustin Pop committed
749
750
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
751
752
753
754
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
755
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
756
757
758
759
    return
  try:
    variant = name.split("+", 1)[1]
  except IndexError:
760
761
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
762

Iustin Pop's avatar
Iustin Pop committed
763
  if variant not in os_obj.supported_variants:
764
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
765
766


767
768
769
770
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


771
772
773
774
775
776
777
778
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)


779
780
781
782
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
783
784
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
785
786


787
788
789
790
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
791
792
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
793
794


795
796
797
798
799
800
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
801
802
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
803
804
805
806

  return []


807
808
809
810
811
812
813
814
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,
815
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
816
817
818
819
820
821
822
823

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

  return faulty


824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
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


853
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
854
855
856
  """Logical unit for destroying the cluster.

  """
857
858
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
859
860
  _OP_REQP = []

861
862
863
864
865
866
867
  def BuildHooksEnv(self):
    """Build hooks env.

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

Iustin Pop's avatar
Iustin Pop committed
868
869
870
871
872
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
873
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
874
875

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
876
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
877
878

    nodelist = self.cfg.GetNodeList()
879
    if len(nodelist) != 1 or nodelist[0] != master:
880
      raise errors.OpPrereqError("There are still %d node(s) in"
881
882
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
883
884
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
885
      raise errors.OpPrereqError("There are still %d instance(s) in"
886
887
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
888
889
890
891
892

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
893
    master = self.cfg.GetMasterNode()
894
    modify_ssh_setup = self.cfg.GetClusterInfo().modify_ssh_setup
Luca Bigliardi's avatar
Luca Bigliardi committed
895
896
897
898
899
900
901
902

    # 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)

903
    result = self.rpc.call_node_stop_master(master, False)
904
    result.Raise("Could not disable the master role")
905
906
907
908
909
910

    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
911
    return master
Iustin Pop's avatar
Iustin Pop committed
912
913


Guido Trotter's avatar
Guido Trotter committed
914
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
915
916
917
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
918
919
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
920
  _OP_REQP = ["skip_checks", "verbose", "error_codes", "debug_simulate_errors"]
921
922
  REQ_BGL = False

923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
  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")
946
  ENODESETUP = (TNODE, "ENODESETUP")
947

948
949
950
951
  ETYPE_FIELD = "code"
  ETYPE_ERROR = "ERROR"
  ETYPE_WARNING = "WARNING"

952
953
954
955
956
  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
957
    self.share_locks = dict.fromkeys(locking.LEVELS, 1)
Iustin Pop's avatar
Iustin Pop committed
958

959
960
961
962
963
964
965
966
967
  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.

    """
968
    ltype = kwargs.get(self.ETYPE_FIELD, self.ETYPE_ERROR)
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
    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)

985
986
987
988
989
990
991
992
993
994
995
  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

996
  def _VerifyNode(self, nodeinfo, file_list, local_cksum,
997
                  node_result, master_files, drbd_map, vg_name):
Iustin Pop's avatar
Iustin Pop committed
998
999
    """Run multiple tests against a node.

1000
    Test list:
1001

Iustin Pop's avatar
Iustin Pop committed
1002
      - compares ganeti version
Michael Hanselmann's avatar
Michael Hanselmann committed
1003
      - checks vg existence and size > 20G
Iustin Pop's avatar
Iustin Pop committed
1004
1005
1006
      - checks config file checksum
      - checks ssh to other nodes

1007
1008
    @type nodeinfo: L{objects.Node}
    @param nodeinfo: the node to check
1009
1010
1011
    @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
1012
    @param master_files: list of files that only masters should have
1013
1014
1015
    @param drbd_map: the useddrbd minors for this node, in
        form of minor: (instance, must_exist) which correspond to instances
        and their running status
1016
    @param vg_name: Ganeti Volume Group (result of self.cfg.GetVGName())
1017

Iustin Pop's avatar
Iustin Pop committed
1018
    """
1019
    node = nodeinfo.name
1020
    _ErrorIf = self._ErrorIf
1021
1022

    # main result, node_result should be a non-empty dict
1023
1024
    test = not node_result or not isinstance(node_result, dict)
    _ErrorIf(test, self.ENODERPC, node,
1025
                  "unable to verify node: no data returned")
1026
1027
    if test:
      return
1028

Iustin Pop's avatar
Iustin Pop committed
1029
1030
    # compares ganeti version
    local_version = constants.PROTOCOL_VERSION
1031
    remote_version = node_result.get('version', None)
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
    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
1046

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

1049
    # full package version
1050
1051
    self._ErrorIf(constants.RELEASE_VERSION != remote_version[1],
                  self.ENODEVERSION, node,
1052
1053
                  "software version mismatch: master %s, node %s",
                  constants.RELEASE_VERSION, remote_version[1],
1054
                  code=self.ETYPE_WARNING)
1055
1056

    # checks vg existence and size > 20G
1057
1058
    if vg_name is not None:
      vglist = node_result.get(constants.NV_VGLIST, None)
1059
1060
1061
      test = not vglist
      _ErrorIf(test, self.ENODELVM, node, "unable to check volume groups")
      if not test:
1062
1063
        vgstatus = utils.CheckVolumeGroupSize(vglist, vg_name,
                                              constants.MIN_VG_SIZE)
1064
        _ErrorIf(vgstatus, self.ENODELVM, node, vgstatus)
Iustin Pop's avatar
Iustin Pop committed
1065
1066
1067

    # checks config file checksum

1068
    remote_cksum = node_result.get(constants.NV_FILELIST, None)
1069
1070
1071
1072
    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
1073
      for file_name in file_list:
1074
        node_is_mc = nodeinfo.master_candidate
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
        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
1094

1095
1096
    # checks ssh to any

1097
1098
1099
1100
    test = constants.NV_NODELIST not in node_result
    _ErrorIf(test, self.ENODESSH, node,
             "node hasn't returned node ssh connectivity data")
    if not test:
1101
      if node_result[constants.NV_NODELIST]:
1102
        for a_node, a_msg in node_result[constants.NV_NODELIST].items():
1103
1104
          _ErrorIf(True, self.ENODESSH, node,
                   "ssh communication with node '%s': %s", a_node, a_msg)
1105

1106
1107
1108
1109
    test = constants.NV_NODENETTEST not in node_result
    _ErrorIf(test, self.ENODENET, node,
             "node hasn't returned node tcp connectivity data")
    if not test:
1110
1111
      if node_result[constants.NV_NODENETTEST]:
        nlist = utils.NiceSort(node_result[constants.NV_NODENETTEST].keys())
1112
        for anode in nlist:
1113
1114
1115
          _ErrorIf(True, self.ENODENET, node,
                   "tcp communication with node '%s': %s",
                   anode, node_result[constants.NV_NODENETTEST][anode])
1116

1117
    hyp_result = node_result.get(constants.NV_HYPERVISOR, None)
1118
1119
    if isinstance(hyp_result, dict):
      for hv_name, hv_result in hyp_result.iteritems():
1120
1121
1122
        test = hv_result is not None
        _ErrorIf(test, self.ENODEHV, node,
                 "hypervisor %s verify failure: '%s'", hv_name, hv_result)
1123
1124

    # check used drbd list
1125
1126
    if vg_name is not None:
      used_minors = node_result.get(constants.NV_DRBDLIST, [])
1127
1128
1129
1130
      test = not isinstance(used_minors, (tuple, list))
      _ErrorIf(test, self.ENODEDRBD, node,
               "cannot parse drbd status file: %s", str(used_minors))
      if not test:
1131
        for minor, (iname, must_exist) in drbd_map.items():
1132
1133
1134
1135
          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)
1136
        for minor in used_minors:
1137
1138
1139
          test = minor not in drbd_map
          _ErrorIf(test, self.ENODEDRBD, node,
                   "unallocated drbd minor %d is in use", minor)
1140
1141
1142
1143
    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
1144

1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
    # check pv names
    if vg_name is not None:
      pvlist = node_result.get(constants.NV_PVLIST, None)
      test = pvlist is None
      _ErrorIf(test, self.ENODELVM, node, "Can't get PV list from node")
      if not test:
        # check that ':' is not present in PV names, since it's a
        # special character for lvcreate (denotes the range of PEs to
        # use on the PV)
        for size, pvname, owner_vg in pvlist:
          test = ":" in pvname
          _ErrorIf(test, self.ENODELVM, node, "Invalid character ':' in PV"
                   " '%s' of VG '%s'", pvname, owner_vg)

1159
  def _VerifyInstance(self, instance, instanceconfig, node_vol_is,
1160
                      node_instance, n_offline):
Iustin Pop's avatar
Iustin Pop committed
1161
1162
1163
1164
1165
1166
    """Verify an instance.

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

    """
1167
    _ErrorIf = self._ErrorIf
Iustin Pop's avatar
Iustin Pop committed
1168
1169
1170
1171
1172
1173
    node_current = instanceconfig.primary_node

    node_vol_should = {}
    instanceconfig.MapLVsByNode(node_vol_should)

    for node in node_vol_should:
1174
1175
1176
      if node in n_offline:
        # ignore missing volumes on offline nodes
        continue
Iustin Pop's avatar
Iustin Pop committed
1177
      for volume in node_vol_should[node]:
1178
1179
1180
        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
1181

1182
    if instanceconfig.admin_up:
1183
1184
1185
1186
1187
1188
      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
1189
1190
1191

    for node in node_instance:
      if (not node == node_current):
1192
1193
1194
        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
1195

1196
  def _VerifyOrphanVolumes(self, node_vol_should, node_vol_is):
Iustin Pop's avatar
Iustin Pop committed
1197
1198
1199
1200
1201
1202
1203
1204
    """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]:
1205
1206
1207
        test = (node not in node_vol_should or
                volume not in node_vol_should[node])
        self._ErrorIf(test, self.ENODEORPHANLV, node,
1208
                      "volume %s is unknown", volume)
Iustin Pop's avatar
Iustin Pop committed
1209

1210
  def _VerifyOrphanInstances(self, instancelist, node_instance):
Iustin Pop's avatar
Iustin Pop committed
1211
1212
1213
1214
1215
1216
    """Verify the list of running instances.

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

    """
    for node in node_instance:
1217
      for o_inst in node_instance[node]:
1218
1219
        test = o_inst not in instancelist
        self._ErrorIf(test, self.ENODEORPHANINSTANCE, node,
1220
                      "instance %s on node %s should not exist", o_inst, node)
Iustin Pop's avatar
Iustin Pop committed
1221

1222
  def _VerifyNPlusOneMemory(self, node_info, instance_cfg):
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
    """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
1241
          bep = self.cfg.GetClusterInfo().FillBE(instance_cfg[instance])
1242
          if bep[constants.BE_AUTO_BALANCE]:
1243
            needed_mem += bep[constants.BE_MEMORY]
1244
1245
        test = nodeinfo['mfree'] < needed_mem
        self._ErrorIf(test, self.ENODEN1, node,
1246
1247
                      "not enough memory on to accommodate"
                      " failovers should peer node %s fail", prinode)
1248

Iustin Pop's avatar
Iustin Pop committed
1249
1250
1251
  def CheckPrereq(self):
    """Check prerequisites.

1252
1253
    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
1254
1255

    """
1256
1257
    self.skip_set = frozenset(self.op.skip_checks)
    if not constants.VERIFY_OPTIONAL_CHECKS.issuperset(self.skip_set):
1258
1259
      raise errors.OpPrereqError("Invalid checks to be skipped specified",
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
1260

Guido Trotter's avatar
Guido Trotter committed
1261
1262
1263
  def BuildHooksEnv(self):
    """Build hooks env.

Michael Hanselmann's avatar
Michael Hanselmann committed
1264
    Cluster-Verify hooks just ran in the post phase and their failure makes
Guido Trotter's avatar
Guido Trotter committed
1265
1266
1267
1268
    the output be logged in the verify output and the verification to fail.

    """
    all_nodes = self.cfg.GetNodeList()
1269
1270
1271
1272
1273
1274
    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
1275
1276
    return env, [], all_nodes

Iustin Pop's avatar
Iustin Pop committed
1277
1278
1279
1280
  def Exec(self, feedback_fn):
    """Verify integrity of cluster, performing various test on nodes.

    """
1281
1282
    self.bad = False
    _ErrorIf = self._ErrorIf
1283
1284
    verbose = self.op.verbose
    self._feedback_fn = feedback_fn
Iustin Pop's avatar
Iustin Pop committed
1285
    feedback_fn("* Verifying global settings")
1286
    for msg in self.cfg.VerifyConfig():
1287
      _ErrorIf(True, self.ECLUSTERCFG, None, msg)
Iustin Pop's avatar
Iustin Pop committed
1288
1289

    vg_name = self.cfg.GetVGName()
1290
    hypervisors = self.cfg.GetClusterInfo().enabled_hypervisors
Iustin Pop's avatar
Iustin Pop committed
1291
    nodelist = utils.NiceSort(self.cfg.GetNodeList())
1292
    nodeinfo = [self.cfg.GetNodeInfo(nname) for nname in nodelist]
Iustin Pop's avatar
Iustin Pop committed
1293
    instancelist = utils.NiceSort(self.cfg.GetInstanceList())
1294
1295
    instanceinfo = dict((iname, self.cfg.GetInstanceInfo(iname))
                        for iname in instancelist)
1296
    i_non_redundant = [] # Non redundant instances
1297
    i_non_a_balanced = [] # Non auto-balanced instances
1298
    n_offline = [] # List of offline nodes
1299
    n_drained = [] # List of nodes being drained
Iustin Pop's avatar
Iustin Pop committed
1300
1301
    node_volume = {}
    node_instance = {}
1302
    node_info = {}
Guido Trotter's avatar
Guido Trotter committed
1303
    instance_cfg = {}
Iustin Pop's avatar
Iustin Pop committed
1304
1305
1306

    # FIXME: verify OS list
    # do local checksums
1307
1308
1309
    master_files = [constants.CLUSTER_CONF_FILE]

    file_names = ssconf.SimpleStore().GetFileList()
1310
    file_names.append(constants.SSL_CERT_FILE)
1311
    file_names.append(constants.RAPI_CERT_FILE)
1312
1313
    file_names.extend(master_files)

Iustin Pop's avatar
Iustin Pop committed
1314
1315
1316
1317
    local_checksums = utils.FingerprintFiles(file_names)

    feedback_fn("* Gathering data (%d nodes)" % len(nodelist))
    node_verify_param = {
1318
      constants.NV_FILELIST: file_names,
1319
1320
      constants.NV_NODELIST: [node.name for node in nodeinfo
                              if not node.offline],
1321
1322
      constants.NV_HYPERVISOR: hypervisors,
      constants.NV_NODENETTEST: [(node.name, node.primary_ip,
1323
1324
                                  node.secondary_ip) for node in nodeinfo
                                 if not node.offline],
1325
1326
1327
      constants.NV_INSTANCELIST: hypervisors,
      constants.NV_VERSION: None,
      constants.NV_HVINFO: self.cfg.GetHypervisorType(),
1328
      constants.NV_NODESETUP: None,
Iustin Pop's avatar
Iustin Pop committed
1329
      }
1330
1331
1332
    if vg_name is not None:
      node_verify_param[constants.NV_VGLIST] = None
      node_verify_param[constants.NV_LVLIST] = vg_name
1333
      node_verify_param[constants.NV_PVLIST] = [vg_name]
1334
      node_verify_param[constants.NV_DRBDLIST] = None