cmdlib.py 353 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

Iustin Pop's avatar
Iustin Pop committed
24
# pylint: disable-msg=W0201,C0302
25
26
27

# W0201 since most LU attributes are defined in CheckPrereq or similar
# functions
Iustin Pop's avatar
Iustin Pop committed
28

Iustin Pop's avatar
Iustin Pop committed
29
30
# C0302: since we have waaaay to many lines in this module

Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35
import os
import os.path
import time
import re
import platform
36
import logging
37
import copy
38
import OpenSSL
Iustin Pop's avatar
Iustin Pop committed
39
40
41
42
43

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
44
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
45
46
from ganeti import constants
from ganeti import objects
47
from ganeti import serializer
48
from ganeti import ssconf
49
from ganeti import uidpool
50
from ganeti import compat
51
52
53
from ganeti import masterd

import ganeti.masterd.instance # pylint: disable-msg=W0611
54
55


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# need to define these here before the actual LUs

def _EmptyList():
  """Returns an empty list.

  """
  return []


def _EmptyDict():
  """Returns an empty dict.

  """
  return {}


Iustin Pop's avatar
Iustin Pop committed
72
class LogicalUnit(object):
73
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
74
75

  Subclasses must follow these rules:
76
    - implement ExpandNames
77
78
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
79
80
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
81
    - optionally redefine their run requirements:
82
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
83
84

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

86
87
  @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)
88
89
  @cvar _OP_DEFS: a list of opcode attributes and the defaults values
      they should get if not already existing
90

Iustin Pop's avatar
Iustin Pop committed
91
92
93
94
  """
  HPATH = None
  HTYPE = None
  _OP_REQP = []
95
  _OP_DEFS = []
96
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
97

Iustin Pop's avatar
Iustin Pop committed
98
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
99
100
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
101
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
102
103
104
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
105
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
106
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
107
108
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
109
    self.rpc = rpc
110
    # Dicts used to declare locking needs to mcpu
111
    self.needed_locks = None
112
    self.acquired_locks = {}
113
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
114
115
    self.add_locks = {}
    self.remove_locks = {}
116
117
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
118
    self.__ssh = None
119
    # logging
Iustin Pop's avatar
Iustin Pop committed
120
121
    self.LogWarning = processor.LogWarning # pylint: disable-msg=C0103
    self.LogInfo = processor.LogInfo # pylint: disable-msg=C0103
122
    self.LogStep = processor.LogStep # pylint: disable-msg=C0103
123
124
    # support for dry-run
    self.dry_run_result = None
125
126
127
128
    # support for generic debug attribute
    if (not hasattr(self.op, "debug_level") or
        not isinstance(self.op.debug_level, int)):
      self.op.debug_level = 0
129

130
    # Tasklets
131
    self.tasklets = None
132

133
134
135
136
137
138
139
140
    for aname, aval in self._OP_DEFS:
      if not hasattr(self.op, aname):
        if callable(aval):
          dval = aval()
        else:
          dval = aval
        setattr(self.op, aname, dval)

Iustin Pop's avatar
Iustin Pop committed
141
142
143
    for attr_name in self._OP_REQP:
      attr_val = getattr(op, attr_name, None)
      if attr_val is None:
144
        raise errors.OpPrereqError("Required parameter '%s' missing" %
145
                                   attr_name, errors.ECODE_INVAL)
146

147
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
148

149
150
151
152
153
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
154
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
155
156
157
158
    return self.__ssh

  ssh = property(fget=__GetSSH)

159
160
161
162
163
164
165
166
167
  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
168
      - CheckPrereq is run after we have acquired locks (and possible
169
170
171
172
173
174
175
176
        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

177
178
179
180
181
182
183
184
185
186
187
  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:
188
189
190
191
192

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

Guido Trotter's avatar
Guido Trotter committed
194
195
196
197
    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.

198
199
200
201
    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.

202
203
204
205
206
207
208
209
210
211
212
213
214
    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
215
216
217
218
219
220
221
222
223
224

    """
    # 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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
  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
243
244
245
246
247
248
249
250
251
252
253
254
  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
255
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
256
257

    """
258
    if self.tasklets is not None:
259
      for (idx, tl) in enumerate(self.tasklets):
260
261
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
262
263
        tl.CheckPrereq()
    else:
264
      pass
Iustin Pop's avatar
Iustin Pop committed
265
266
267
268
269
270
271
272
273

  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.

    """
274
    if self.tasklets is not None:
275
      for (idx, tl) in enumerate(self.tasklets):
276
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
277
278
279
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

  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.

295
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
296
297
298
299
300
301
302

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

    """
    raise NotImplementedError

303
304
305
306
307
308
309
310
311
  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.

312
313
314
315
316
317
318
319
    @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
320
321

    """
322
323
324
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
325
326
    return lu_result

327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
  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"
342
343
344
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
345

346
  def _LockInstancesNodes(self, primary_only=False):
347
348
349
350
351
352
353
354
355
356
357
358
359
    """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.

360
    If should be called in DeclareLocks in a way similar to::
361

362
363
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
364

365
366
367
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

368
369
370
371
372
373
374
375
376
377
    """
    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 = []
378
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
379
380
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
381
382
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
383
384
385
386
387

    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)
388
389
390

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
391

Iustin Pop's avatar
Iustin Pop committed
392
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
393
394
395
396
397
398
399
400
401
  """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

402
403
404
405
406
407
408
409
  def BuildHooksEnv(self):
    """Empty BuildHooksEnv for NoHooksLu.

    This just raises an error.

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

Iustin Pop's avatar
Iustin Pop committed
410

411
412
413
414
415
416
417
418
419
420
421
422
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

  """
423
424
425
426
427
428
429
  def __init__(self, lu):
    self.lu = lu

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

430
431
432
433
434
435
436
437
438
439
440
441
442
443
  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.

    """
444
    pass
445
446
447
448
449
450
451
452
453
454
455
456

  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


457
def _GetWantedNodes(lu, nodes):
458
  """Returns list of checked and expanded node names.
459

460
461
462
463
464
465
  @type lu: L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type nodes: list
  @param nodes: list of node names or None for all nodes
  @rtype: list
  @return: the list of nodes, sorted
Iustin Pop's avatar
Iustin Pop committed
466
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
467
468

  """
469
  if not isinstance(nodes, list):
470
471
    raise errors.OpPrereqError("Invalid argument type 'nodes'",
                               errors.ECODE_INVAL)
472

473
474
475
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
476

Iustin Pop's avatar
Iustin Pop committed
477
  wanted = [_ExpandNodeName(lu.cfg, name) for name in nodes]
478
  return utils.NiceSort(wanted)
479
480
481


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

484
485
486
487
488
489
490
491
  @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
492
493
494

  """
  if not isinstance(instances, list):
495
496
    raise errors.OpPrereqError("Invalid argument type 'instances'",
                               errors.ECODE_INVAL)
497
498

  if instances:
499
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
500
  else:
501
502
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
503
504


505
506
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
507
508
509
510
511
512
513
514
  """Return the new version of a parameter dictionary.

  @type old_params: dict
  @param old_params: old parameters
  @type update_dict: dict
  @param update_dict: dict containing new parameter values, or
      constants.VALUE_DEFAULT to reset the parameter to its default
      value
515
516
517
518
519
520
  @param use_default: boolean
  @type use_default: whether to recognise L{constants.VALUE_DEFAULT}
      values as 'to be deleted' values
  @param use_none: boolean
  @type use_none: whether to recognise C{None} values as 'to be
      deleted' values
521
522
523
524
525
526
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
527
528
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
529
530
531
532
533
534
535
536
537
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


538
def _CheckOutputFields(static, dynamic, selected):
539
540
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
541
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
542
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
543
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
544
  @param dynamic: dynamic fields set
545
546

  """
Iustin Pop's avatar
Iustin Pop committed
547
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
548
549
  f.Extend(static)
  f.Extend(dynamic)
550

Iustin Pop's avatar
Iustin Pop committed
551
552
  delta = f.NonMatching(selected)
  if delta:
553
    raise errors.OpPrereqError("Unknown output fields selected: %s"
554
                               % ",".join(delta), errors.ECODE_INVAL)
555
556


557
558
559
560
561
562
563
564
565
566
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)" %
567
                               (name, str(val)), errors.ECODE_INVAL)
568
569
570
  setattr(op, name, val)


571
572
573
574
575
576
577
578
579
580
581
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"
582
           " cluster level: %s" % utils.CommaJoin(used_globals))
583
584
585
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


586
587
588
589
590
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
591
  @raise errors.OpPrereqError: if the node is offline
592
593
594

  """
  if lu.cfg.GetNodeInfo(node).offline:
595
596
    raise errors.OpPrereqError("Can't use offline node %s" % node,
                               errors.ECODE_INVAL)
597
598


599
600
601
602
603
604
605
606
607
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:
608
609
    raise errors.OpPrereqError("Can't use drained node %s" % node,
                               errors.ECODE_INVAL)
610
611


Iustin Pop's avatar
Iustin Pop committed
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
def _CheckNodeHasOS(lu, node, os_name, force_variant):
  """Ensure that a node supports a given OS.

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

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


630
631
632
633
634
635
636
637
638
639
640
def _RequireFileStorage():
  """Checks that file storage is enabled.

  @raise errors.OpPrereqError: when file storage is disabled

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


641
642
643
644
645
646
647
648
def _CheckDiskTemplate(template):
  """Ensure a given disk template is valid.

  """
  if template not in constants.DISK_TEMPLATES:
    msg = ("Invalid disk template name '%s', valid templates are: %s" %
           (template, utils.CommaJoin(constants.DISK_TEMPLATES)))
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)
649
650
651
652
653
654
655
656
657
658
  if template == constants.DT_FILE:
    _RequireFileStorage()


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

  """
  if storage_type not in constants.VALID_STORAGE_TYPES:
    raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
659
                               errors.ECODE_INVAL)
660
661
662
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()

663

664
665
666
667
668
669
670
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

  """
  return utils.ReadOneLineFile(constants.CLUSTER_DOMAIN_SECRET_FILE,
                               strict=True)

671

672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
def _CheckInstanceDown(lu, instance, reason):
  """Ensure that an instance is not running."""
  if instance.admin_up:
    raise errors.OpPrereqError("Instance %s is marked to be up, %s" %
                               (instance.name, reason), errors.ECODE_STATE)

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

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


688
689
690
691
692
693
694
695
696
697
698
699
def _CheckExportMode(mode):
  """Ensures that a given export mode is valid.

  @param mode: the export mode to check
  @raise errors.OpPrereqError: when the export mode is not valid

  """
  if mode not in constants.EXPORT_MODES:
    raise errors.OpPrereqError("Invalid export mode %r" % mode,
                               errors.ECODE_INVAL)


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
def _ExpandItemName(fn, name, kind):
  """Expand an item name.

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

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


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


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


727
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
728
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
729
                          bep, hvp, hypervisor_name):
730
731
732
733
734
735
736
737
738
739
740
741
  """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
742
743
  @type status: boolean
  @param status: the should_run status of the instance
744
745
746
747
748
  @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
749
750
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
751
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
752
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
753
754
  @type disks: list
  @param disks: the list of (size, mode) pairs
755
756
757
758
  @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
759
760
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
761
762
  @rtype: dict
  @return: the hook environment for this instance
763

764
  """
765
766
767
768
  if status:
    str_status = "up"
  else:
    str_status = "down"
769
  env = {
770
    "OP_TARGET": name,
771
772
773
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
774
    "INSTANCE_OS_TYPE": os_type,
775
    "INSTANCE_STATUS": str_status,
776
777
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
778
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
779
    "INSTANCE_HYPERVISOR": hypervisor_name,
780
781
782
783
  }

  if nics:
    nic_count = len(nics)
784
    for idx, (ip, mac, mode, link) in enumerate(nics):
785
786
787
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
788
      env["INSTANCE_NIC%d_MAC" % idx] = mac
789
790
791
792
      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
793
794
795
796
797
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
798
799
800
801
802
803
804
805
806
807
  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

808
809
810
811
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

812
813
  return env

814

815
def _NICListToTuple(lu, nics):
816
817
  """Build a list of nic information tuples.

818
819
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
820
821
822
823
824
825
826
827

  @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 = []
828
  cluster = lu.cfg.GetClusterInfo()
829
830
831
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
832
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
833
834
835
836
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
837

838

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

842
843
844
845
846
847
848
849
850
851
852
  @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

853
  """
854
855
856
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
857
858
859
860
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
861
    'os_type': instance.os,
862
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
863
864
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
865
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
866
867
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
868
869
    'bep': bep,
    'hvp': hvp,
870
    'hypervisor_name': instance.hypervisor,
871
872
873
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
874
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
875
876


Guido Trotter's avatar
Guido Trotter committed
877
def _AdjustCandidatePool(lu, exceptions):
878
879
880
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
881
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
882
883
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
884
               utils.CommaJoin(node.name for node in mod_list))
885
886
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
887
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
888
889
890
891
892
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


893
894
895
896
897
898
899
900
901
902
903
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


904
def _CheckNicsBridgesExist(lu, target_nics, target_node):
905
906
907
  """Check that the brigdes needed by a list of nics exist.

  """
908
909
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
910
911
912
913
  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)
914
    result.Raise("Error checking bridges on destination node '%s'" %
915
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
916
917
918


def _CheckInstanceBridgesExist(lu, instance, node=None):
919
920
921
  """Check that the brigdes needed by an instance exist.

  """
922
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
923
    node = instance.primary_node
924
  _CheckNicsBridgesExist(lu, instance.nics, node)
925
926


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

Iustin Pop's avatar
Iustin Pop committed
930
931
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
932
933
934
935
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
936
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
937
938
939
940
    return
  try:
    variant = name.split("+", 1)[1]
  except IndexError:
941
942
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
943

Iustin Pop's avatar
Iustin Pop committed
944
  if variant not in os_obj.supported_variants:
945
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
946
947


948
949
950
951
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


952
953
954
955
956
957
958
959
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)


960
961
962
963
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
964
965
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
966
967


968
969
970
971
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
972
973
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
974
975


976
977
978
979
980
981
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
982
983
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
984
985
986
987

  return []


988
989
990
991
992
993
994
995
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,
996
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
997
998
999
1000
1001
1002
1003
1004

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

  return faulty


1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
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 Exec(self, feedback_fn):
    """Nothing to do.

    """
    return True


1028
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1029
1030
1031
  """Logical unit for destroying the cluster.

  """
1032
1033
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
1034
1035
  _OP_REQP = []

1036
1037
1038
1039
1040
1041
1042
  def BuildHooksEnv(self):
    """Build hooks env.

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

Iustin Pop's avatar
Iustin Pop committed
1043
1044
1045
1046
1047
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
1048
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
1049
1050

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1051
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
1052
1053

    nodelist = self.cfg.GetNodeList()
1054
    if len(nodelist) != 1 or nodelist[0] != master:
1055
      raise errors.OpPrereqError("There are still %d node(s) in"
1056
1057
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
1058
1059
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
1060
      raise errors.OpPrereqError("There are still %d instance(s) in"
1061
1062
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
1063
1064
1065
1066
1067

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1068
    master = self.cfg.GetMasterNode()
1069
    modify_ssh_setup = self.cfg.GetClusterInfo().modify_ssh_setup
Luca Bigliardi's avatar
Luca Bigliardi committed
1070
1071
1072
1073
1074
1075

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

1079
    result = self.rpc.call_node_stop_master(master, False)
1080
    result.Raise("Could not disable the master role")
1081
1082
1083
1084
1085
1086

    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
1087
    return master
Iustin Pop's avatar
Iustin Pop committed
1088
1089


1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
def _VerifyCertificate(filename):
  """Verifies a certificate for LUVerifyCluster.

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

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

1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
  (errcode, msg) = \
    utils.VerifyX509Certificate(cert, constants.SSL_CERT_EXPIRATION_WARN,
                                constants.SSL_CERT_EXPIRATION_ERROR)

  if msg:
    fnamemsg = "While verifying %s: %s" % (filename, msg)
  else:
    fnamemsg = None

  if errcode is None:
    return (None, fnamemsg)
  elif errcode == utils.CERT_WARNING:
    return (LUVerifyCluster.ETYPE_WARNING, fnamemsg)
  elif errcode == utils.CERT_ERROR:
    return (LUVerifyCluster.ETYPE_ERROR, fnamemsg)
1119

1120
  raise errors.ProgrammerError("Unhandled certificate error code %r" % errcode)
1121
1122


Guido Trotter's avatar
Guido Trotter committed
1123
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1124
1125
1126
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
1127
1128
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
1129
  _OP_REQP = ["skip_checks", "verbose", "error_codes", "debug_simulate_errors"]
1130
1131
  REQ_BGL = False

1132
1133
1134
1135
1136
  TCLUSTER = "cluster"
  TNODE = "node"
  TINSTANCE = "instance"

  ECLUSTERCFG = (TCLUSTER, "ECLUSTERCFG")
1137
  ECLUSTERCERT = (TCLUSTER, "ECLUSTERCERT")
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
  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")
1151
  ENODEOS = (TNODE, "ENODEOS")
1152
1153
1154
1155
1156
  ENODEORPHANINSTANCE = (TNODE, "ENODEORPHANINSTANCE")
  ENODEORPHANLV = (TNODE, "ENODEORPHANLV")
  ENODERPC = (TNODE, "ENODERPC")
  ENODESSH = (TNODE, "ENODESSH")
  ENODEVERSION = (TNODE, "ENODEVERSION")
1157
  ENODESETUP = (TNODE, "ENODESETUP")
1158
  ENODETIME = (TNODE, "ENODETIME")
1159

1160
1161
1162
1163
  ETYPE_FIELD = "code"
  ETYPE_ERROR = "ERROR"
  ETYPE_WARNING = "WARNING"

Iustin Pop's avatar
Iustin Pop committed
1164
1165
1166
  class NodeImage(object):
    """A class representing the logical and physical status of a node.

1167
1168
    @type name: string
    @ivar name: the node name to which this object refers
Iustin Pop's avatar
Iustin Pop committed
1169
    @ivar volumes: a structure as returned from
Iustin Pop's avatar
Iustin Pop committed
1170
        L{ganeti.backend.GetVolumeList} (runtime)
Iustin Pop's avatar
Iustin Pop committed
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
    @ivar instances: a list of running instances (runtime)
    @ivar pinst: list of configured primary instances (config)
    @ivar sinst: list of configured secondary instances (config)
    @ivar sbp: diction of {secondary-node: list of instances} of all peers
        of this node (config)
    @ivar mfree: free memory, as reported by hypervisor (runtime)
    @ivar dfree: free disk, as reported by the node (runtime)
    @ivar offline: the offline status (config)
    @type rpc_fail: boolean
    @ivar rpc_fail: whether the RPC verify call was successfull (overall,
        not whether the individual keys were correct) (runtime)
    @type lvm_fail: boolean
    @ivar lvm_fail: whether the RPC call didn't return valid LVM data
    @type hyp_fail: boolean
    @ivar hyp_fail: whether the RPC call didn't return the instance list
    @type ghost: boolean
    @ivar ghost: whether this is a known node or not (config)
1188
1189
1190
1191
    @type os_fail: boolean
    @ivar os_fail: whether the RPC call didn't return valid OS data
    @type oslist: list
    @ivar oslist: list of OSes as diagnosed by DiagnoseOS
Iustin Pop's avatar
Iustin Pop committed
1192
1193

    """
1194
1195
    def __init__(self, offline=False, name=None):
      self.name = name
Iustin Pop's avatar
Iustin Pop committed
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
      self.volumes = {}
      self.instances = []
      self.pinst = []
      self.sinst = []
      self.sbp = {}
      self.mfree = 0
      self.dfree = 0
      self.offline = offline
      self.rpc_fail = False
      self.lvm_fail = False
      self.hyp_fail = False
      self.ghost = False
1208
1209
      self.os_fail = False
      self.oslist = {}
Iustin Pop's avatar
Iustin Pop committed
1210

1211
1212
1213
1214
1215
  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
1216
    self.share_locks = dict.fromkeys(locking.LEVELS, 1)
Iustin Pop's avatar
Iustin Pop committed
1217

1218
1219
1220
1221
1222
1223
1224
1225
1226
  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.

    """
1227
    ltype = kwargs.get(self.ETYPE_FIELD, self.ETYPE_ERROR)
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
    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)

1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
  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

Iustin Pop's avatar
Iustin Pop committed
1255
  def _VerifyNode(self, ninfo, nresult):
Iustin Pop's avatar
Iustin Pop committed
1256
1257
    """Run multiple tests against a node.

1258
    Test list:
1259

Iustin Pop's avatar
Iustin Pop committed
1260
      - compares ganeti version
Michael Hanselmann's avatar
Michael Hanselmann committed
1261
      - checks vg existence and size > 20G
Iustin Pop's avatar
Iustin Pop committed
1262
1263
1264
      - checks config file checksum
      - checks ssh to other nodes

Iustin Pop's avatar
Iustin Pop committed
1265
1266
1267
1268
1269
1270
    @type ninfo: L{objects.Node}
    @param ninfo: the node to check
    @param nresult: the results from the node
    @rtype: boolean
    @return: whether overall this call was successful (and we can expect
         reasonable values in the respose)
1271

Iustin Pop's avatar
Iustin Pop committed
1272
    """
Iustin Pop's avatar
Iustin Pop committed
1273
    node = ninfo.name
Iustin Pop's avatar
Iustin Pop committed
1274
    _ErrorIf = self._ErrorIf # pylint: disable-msg=C0103
1275

Iustin Pop's avatar
Iustin Pop committed
1276
1277
    # main result, nresult should be a non-empty dict
    test = not nresult or not isinstance(nresult, dict)
1278
    _ErrorIf(test, self.ENODERPC, node,
1279
                  "unable to verify node: no data returned")
1280
    if test:
Iustin Pop's avatar