cmdlib.py 386 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, 2009, 2010 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
39
40
41
import socket
import tempfile
import shutil
42
import itertools
Iustin Pop's avatar
Iustin Pop committed
43
44
45
46
47

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
48
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
49
50
from ganeti import constants
from ganeti import objects
51
from ganeti import serializer
52
from ganeti import ssconf
53
from ganeti import uidpool
54
from ganeti import compat
55
from ganeti import masterd
56
from ganeti import netutils
57
from ganeti import ht
58
59

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

Iustin Pop's avatar
Iustin Pop committed
61
62
63
# Common opcode attributes

#: output fields for a query operation
64
_POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString))
Iustin Pop's avatar
Iustin Pop committed
65
66
67
68


#: the shutdown timeout
_PShutdownTimeout = ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
69
                     ht.TPositiveInt)
Iustin Pop's avatar
Iustin Pop committed
70
71

#: the force parameter
72
_PForce = ("force", False, ht.TBool)
Iustin Pop's avatar
Iustin Pop committed
73
74

#: a required instance name (for single-instance LUs)
75
_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString)
Iustin Pop's avatar
Iustin Pop committed
76

77
78
#: Whether to ignore offline nodes
_PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool)
Iustin Pop's avatar
Iustin Pop committed
79
80

#: a required node name (for single-node LUs)
81
_PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString)
Iustin Pop's avatar
Iustin Pop committed
82

83
#: the migration type (live/non-live)
84
85
_PMigrationMode = ("mode", None,
                   ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)))
86

87
#: the obsolete 'live' mode (boolean)
88
_PMigrationLive = ("live", None, ht.TMaybeBool)
89

Iustin Pop's avatar
Iustin Pop committed
90

91
# End types
Iustin Pop's avatar
Iustin Pop committed
92
class LogicalUnit(object):
93
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
94
95

  Subclasses must follow these rules:
96
    - implement ExpandNames
97
98
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
99
100
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
101
    - optionally redefine their run requirements:
102
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
103
104

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

106
107
  @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
108
109
  @cvar _OP_PARAMS: a list of opcode attributes, their defaults values
      they should get if not already defined, and types they must match
110

Iustin Pop's avatar
Iustin Pop committed
111
112
113
  """
  HPATH = None
  HTYPE = None
Iustin Pop's avatar
Iustin Pop committed
114
  _OP_PARAMS = []
115
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
116

Iustin Pop's avatar
Iustin Pop committed
117
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
118
119
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
120
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
121
122
123
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
124
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
125
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
126
127
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
128
    self.rpc = rpc
129
    # Dicts used to declare locking needs to mcpu
130
    self.needed_locks = None
131
    self.acquired_locks = {}
132
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
133
134
    self.add_locks = {}
    self.remove_locks = {}
135
136
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
137
    self.__ssh = None
138
    # logging
139
    self.Log = processor.Log # pylint: disable-msg=C0103
Iustin Pop's avatar
Iustin Pop committed
140
141
    self.LogWarning = processor.LogWarning # pylint: disable-msg=C0103
    self.LogInfo = processor.LogInfo # pylint: disable-msg=C0103
142
    self.LogStep = processor.LogStep # pylint: disable-msg=C0103
143
144
    # support for dry-run
    self.dry_run_result = None
145
146
147
148
    # 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
149

150
    # Tasklets
151
    self.tasklets = None
152

Iustin Pop's avatar
Iustin Pop committed
153
154
155
    # The new kind-of-type-system
    op_id = self.op.OP_ID
    for attr_name, aval, test in self._OP_PARAMS:
156
      if not hasattr(op, attr_name):
157
        if aval == ht.NoDefault:
Iustin Pop's avatar
Iustin Pop committed
158
159
160
161
162
163
164
165
166
          raise errors.OpPrereqError("Required parameter '%s.%s' missing" %
                                     (op_id, attr_name), errors.ECODE_INVAL)
        else:
          if callable(aval):
            dval = aval()
          else:
            dval = aval
          setattr(self.op, attr_name, dval)
      attr_val = getattr(op, attr_name)
167
      if test == ht.NoType:
Iustin Pop's avatar
Iustin Pop committed
168
169
        # no tests here
        continue
170
      if not callable(test):
Iustin Pop's avatar
Iustin Pop committed
171
        raise errors.ProgrammerError("Validation for parameter '%s.%s' failed,"
172
                                     " given type is not a proper type (%s)" %
Iustin Pop's avatar
Iustin Pop committed
173
                                     (op_id, attr_name, test))
174
      if not test(attr_val):
175
176
        logging.error("OpCode %s, parameter %s, has invalid type %s/value %s",
                      self.op.OP_ID, attr_name, type(attr_val), attr_val)
Iustin Pop's avatar
Iustin Pop committed
177
178
        raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
                                   (op_id, attr_name), errors.ECODE_INVAL)
179

180
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
181

182
183
184
185
186
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
187
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
188
189
190
191
    return self.__ssh

  ssh = property(fget=__GetSSH)

192
193
194
195
196
197
198
199
200
  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
201
      - CheckPrereq is run after we have acquired locks (and possible
202
203
204
205
206
207
208
209
        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

210
211
212
213
214
215
216
217
218
219
220
  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:
221
222
223
224
225

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

Guido Trotter's avatar
Guido Trotter committed
227
228
229
230
    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.

231
232
233
234
    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.

235
236
237
238
239
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
240
        locking.LEVEL_INSTANCE: ['instance1.example.com'],
241
242
243
      }
      # Acquire just two nodes
      self.needed_locks = {
244
        locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
245
246
247
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
248
249
250
251
252
253
254
255
256
257

    """
    # 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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
  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
276
277
278
279
280
281
282
283
284
285
286
287
  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
288
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
289
290

    """
291
    if self.tasklets is not None:
292
      for (idx, tl) in enumerate(self.tasklets):
293
294
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
295
296
        tl.CheckPrereq()
    else:
297
      pass
Iustin Pop's avatar
Iustin Pop committed
298
299
300
301
302
303
304
305
306

  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.

    """
307
    if self.tasklets is not None:
308
      for (idx, tl) in enumerate(self.tasklets):
309
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
310
311
312
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327

  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.

328
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
329
330
331
332
333
334
335

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

    """
    raise NotImplementedError

336
337
338
339
340
341
342
343
344
  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.

345
346
347
348
349
350
351
352
    @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
353
354

    """
355
356
357
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
358
359
    return lu_result

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
  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"
375
376
377
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
378

379
  def _LockInstancesNodes(self, primary_only=False):
380
381
382
383
384
385
386
387
388
389
390
391
392
    """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.

393
    If should be called in DeclareLocks in a way similar to::
394

395
396
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
397

398
399
400
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

401
402
403
404
405
406
407
408
409
410
    """
    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 = []
411
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
412
413
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
414
415
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
416
417
418
419
420

    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)
421
422
423

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
424

Iustin Pop's avatar
Iustin Pop committed
425
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
426
427
428
429
430
431
432
433
434
  """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

435
436
437
438
439
440
441
442
  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
443

444
445
446
447
448
449
450
451
452
453
454
455
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

  """
456
457
458
459
460
461
462
  def __init__(self, lu):
    self.lu = lu

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

463
464
465
466
467
468
469
470
471
472
473
474
475
476
  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.

    """
477
    pass
478
479
480
481
482
483
484
485
486
487
488
489

  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


490
def _GetWantedNodes(lu, nodes):
491
  """Returns list of checked and expanded node names.
492

493
494
495
496
497
498
  @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
499
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
500
501

  """
502
503
504
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
505

Iustin Pop's avatar
Iustin Pop committed
506
  wanted = [_ExpandNodeName(lu.cfg, name) for name in nodes]
507
  return utils.NiceSort(wanted)
508
509
510


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

513
514
515
516
517
518
519
520
  @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
521
522
523

  """
  if instances:
524
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
525
  else:
526
527
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
528
529


530
531
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
532
533
534
535
536
537
538
539
  """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
540
541
542
543
544
545
  @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
546
547
548
549
550
551
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
552
553
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
554
555
556
557
558
559
560
561
562
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


563
def _CheckOutputFields(static, dynamic, selected):
564
565
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
566
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
567
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
568
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
569
  @param dynamic: dynamic fields set
570
571

  """
Iustin Pop's avatar
Iustin Pop committed
572
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
573
574
  f.Extend(static)
  f.Extend(dynamic)
575

Iustin Pop's avatar
Iustin Pop committed
576
577
  delta = f.NonMatching(selected)
  if delta:
578
    raise errors.OpPrereqError("Unknown output fields selected: %s"
579
                               % ",".join(delta), errors.ECODE_INVAL)
580
581


582
583
584
585
586
587
588
589
590
591
592
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"
593
           " cluster level: %s" % utils.CommaJoin(used_globals))
594
595
596
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


597
def _CheckNodeOnline(lu, node, msg=None):
598
599
600
601
  """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
602
  @param msg: if passed, should be a message to replace the default one
603
  @raise errors.OpPrereqError: if the node is offline
604
605

  """
606
607
  if msg is None:
    msg = "Can't use offline node"
608
  if lu.cfg.GetNodeInfo(node).offline:
609
    raise errors.OpPrereqError("%s: %s" % (msg, node), errors.ECODE_STATE)
610
611


612
613
614
615
616
617
618
619
620
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:
621
    raise errors.OpPrereqError("Can't use drained node %s" % node,
622
623
624
625
626
627
628
629
630
631
632
633
634
635
                               errors.ECODE_STATE)


def _CheckNodeVmCapable(lu, node):
  """Ensure that a given node is vm capable.

  @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 not vm capable

  """
  if not lu.cfg.GetNodeInfo(node).vm_capable:
    raise errors.OpPrereqError("Can't use non-vm_capable node %s" % node,
                               errors.ECODE_STATE)
636
637


Iustin Pop's avatar
Iustin Pop committed
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
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)


656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
def _CheckNodeHasSecondaryIP(lu, node, secondary_ip, prereq):
  """Ensure that a node has the given secondary ip.

  @type lu: L{LogicalUnit}
  @param lu: the LU on behalf of which we make the check
  @type node: string
  @param node: the node to check
  @type secondary_ip: string
  @param secondary_ip: the ip to check
  @type prereq: boolean
  @param prereq: whether to throw a prerequisite or an execute error
  @raise errors.OpPrereqError: if the node doesn't have the ip, and prereq=True
  @raise errors.OpExecError: if the node doesn't have the ip, and prereq=False

  """
  result = lu.rpc.call_node_has_ip_address(node, secondary_ip)
  result.Raise("Failure checking secondary ip on node %s" % node,
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
  if not result.payload:
    msg = ("Node claims it doesn't have the secondary ip you gave (%s),"
           " please fix and re-run this command" % secondary_ip)
    if prereq:
      raise errors.OpPrereqError(msg, errors.ECODE_ENVIRON)
    else:
      raise errors.OpExecError(msg)


683
684
685
686
687
688
689
690
691
692
693
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)


694
695
696
697
698
699
700
701
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)
702
703
  if template == constants.DT_FILE:
    _RequireFileStorage()
704
  return True
705
706
707
708
709
710
711
712


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,
713
                               errors.ECODE_INVAL)
714
715
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()
716
  return True
717

718

719
720
721
722
723
724
725
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

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

726

727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
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)


743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
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")


770
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
771
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
772
                          bep, hvp, hypervisor_name):
773
774
775
776
777
778
779
780
781
782
783
784
  """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
785
786
  @type status: boolean
  @param status: the should_run status of the instance
787
788
789
790
791
  @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
792
793
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
794
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
795
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
796
797
  @type disks: list
  @param disks: the list of (size, mode) pairs
798
799
800
801
  @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
802
803
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
804
805
  @rtype: dict
  @return: the hook environment for this instance
806

807
  """
808
809
810
811
  if status:
    str_status = "up"
  else:
    str_status = "down"
812
  env = {
813
    "OP_TARGET": name,
814
815
816
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
817
    "INSTANCE_OS_TYPE": os_type,
818
    "INSTANCE_STATUS": str_status,
819
820
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
821
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
822
    "INSTANCE_HYPERVISOR": hypervisor_name,
823
824
825
826
  }

  if nics:
    nic_count = len(nics)
827
    for idx, (ip, mac, mode, link) in enumerate(nics):
828
829
830
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
831
      env["INSTANCE_NIC%d_MAC" % idx] = mac
832
833
834
835
      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
836
837
838
839
840
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
841
842
843
844
845
846
847
848
849
850
  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

851
852
853
854
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

855
856
  return env

857

858
def _NICListToTuple(lu, nics):
859
860
  """Build a list of nic information tuples.

861
862
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
863
864
865
866
867
868
869
870

  @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 = []
871
  cluster = lu.cfg.GetClusterInfo()
872
873
874
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
875
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
876
877
878
879
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
880

881

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

885
886
887
888
889
890
891
892
893
894
895
  @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

896
  """
897
898
899
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
900
901
902
903
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
904
    'os_type': instance.os,
905
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
906
907
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
908
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
909
910
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
911
912
    'bep': bep,
    'hvp': hvp,
913
    'hypervisor_name': instance.hypervisor,
914
915
916
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
917
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
918
919


Guido Trotter's avatar
Guido Trotter committed
920
def _AdjustCandidatePool(lu, exceptions):
921
922
923
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
924
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
925
926
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
927
               utils.CommaJoin(node.name for node in mod_list))
928
929
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
930
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
931
932
933
934
935
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


936
937
938
939
940
941
942
943
944
945
946
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


947
def _CheckNicsBridgesExist(lu, target_nics, target_node):
948
949
950
  """Check that the brigdes needed by a list of nics exist.

  """
951
952
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
953
954
955
956
  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)
957
    result.Raise("Error checking bridges on destination node '%s'" %
958
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
959
960
961


def _CheckInstanceBridgesExist(lu, instance, node=None):
962
963
964
  """Check that the brigdes needed by an instance exist.

  """
965
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
966
    node = instance.primary_node
967
  _CheckNicsBridgesExist(lu, instance.nics, node)
968
969


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

Iustin Pop's avatar
Iustin Pop committed
973
974
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
975
976
977
978
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
979
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
980
    return
981
982
  variant = objects.OS.GetVariant(name)
  if not variant:
983
984
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
985

Iustin Pop's avatar
Iustin Pop committed
986
  if variant not in os_obj.supported_variants:
987
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
988
989


990
991
992
993
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


994
995
996
997
998
999
1000
1001
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)


1002
1003
1004
1005
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
1006
1007
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
1008
1009


1010
1011
1012
1013
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
1014
1015
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
1016
1017


1018
1019
1020
1021
1022
1023
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
1024
1025
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
1026
1027
1028
1029

  return []


1030
1031
1032
1033
1034
1035
1036
1037
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,
1038
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
1039
1040
1041
1042
1043
1044
1045
1046

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

  return faulty


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
def _CheckIAllocatorOrNode(lu, iallocator_slot, node_slot):
  """Check the sanity of iallocator and node arguments and use the
  cluster-wide iallocator if appropriate.

  Check that at most one of (iallocator, node) is specified. If none is
  specified, then the LU's opcode's iallocator slot is filled with the
  cluster-wide default iallocator.

  @type iallocator_slot: string
  @param iallocator_slot: the name of the opcode iallocator slot
  @type node_slot: string
  @param node_slot: the name of the opcode target node slot

  """
  node = getattr(lu.op, node_slot, None)
  iallocator = getattr(lu.op, iallocator_slot, None)

  if node is not None and iallocator is not None:
    raise errors.OpPrereqError("Do not specify both, iallocator and node.",
                               errors.ECODE_INVAL)
  elif node is None and iallocator is None:
    default_iallocator = lu.cfg.GetDefaultIAllocator()
    if default_iallocator:
      setattr(lu.op, iallocator_slot, default_iallocator)
    else:
      raise errors.OpPrereqError("No iallocator or node given and no"
                                 " cluster-wide default iallocator found."
                                 " Please specify either an iallocator or a"
                                 " node, or set a cluster-wide default"
                                 " iallocator.")


1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
class LUPostInitCluster(LogicalUnit):
  """Logical unit for running hooks after cluster initialization.

  """
  HPATH = "cluster-init"
  HTYPE = constants.HTYPE_CLUSTER

  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


1101
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1102
1103
1104
  """Logical unit for destroying the cluster.

  """
1105
1106
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
1107

1108
1109
1110
1111
1112
1113
1114
  def BuildHooksEnv(self):
    """Build hooks env.

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

Iustin Pop's avatar
Iustin Pop committed
1115
1116
1117
1118
1119
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
1120
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
1121
1122

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1123
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
1124
1125

    nodelist = self.cfg.GetNodeList()
1126
    if len(nodelist) != 1 or nodelist[0] != master:
1127
      raise errors.OpPrereqError("There are still %d node(s) in"
1128
1129
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
1130
1131
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
1132
      raise errors.OpPrereqError("There are still %d instance(s) in"
1133
1134
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
1135
1136
1137
1138
1139

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1140
    master = self.cfg.GetMasterNode()
Luca Bigliardi's avatar
Luca Bigliardi committed
1141
1142
1143
1144
1145
1146

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

1150
    result = self.rpc.call_node_stop_master(master, False)
1151
    result.Raise("Could not disable the master role")
1152

Iustin Pop's avatar
Iustin Pop committed
1153
    return master
Iustin Pop's avatar
Iustin Pop committed
1154
1155


1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
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))

1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
  (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)
1185

1186
  raise errors.ProgrammerError("Unhandled certificate error code %r" % errcode)
1187
1188


Guido Trotter's avatar
Guido Trotter committed
1189
class LUVerifyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1190
1191
1192
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
1193
1194
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
1195
  _OP_PARAMS = [
1196
1197
1198
1199
1200
    ("skip_checks", ht.EmptyList,
     ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS))),
    ("verbose", False, ht.TBool),
    ("error_codes", False, ht.TBool),
    ("debug_simulate_errors", False, ht.TBool),
1201
    ]
1202
1203
  REQ_BGL = False

1204
1205
1206
1207
1208
  TCLUSTER = "cluster"
  TNODE = "node"
  TINSTANCE = "instance"

  ECLUSTERCFG = (TCLUSTER, "ECLUSTERCFG")
1209
  ECLUSTERCERT = (TCLUSTER, "ECLUSTERCERT")
1210
1211
1212
1213
  EINSTANCEBADNODE = (TINSTANCE, "EINSTANCEBADNODE")
  EINSTANCEDOWN = (TINSTANCE, "EINSTANCEDOWN")
  EINSTANCELAYOUT = (TINSTANCE, "EINSTANCELAYOUT")
  EINSTANCEMISSINGDISK = (TINSTANCE, "EINSTANCEMISSINGDISK")
1214
  EINSTANCEFAULTYDISK = (TINSTANCE, "EINSTANCEFAULTYDISK")
1215
1216
  EINSTANCEWRONGNODE = (TINSTANCE, "EINSTANCEWRONGNODE")
  ENODEDRBD = (TNODE, "ENODEDRBD")
1217
  ENODEDRBDHELPER = (TNODE, "ENODEDRBDHELPER")
1218
1219
1220
1221
1222
1223
  ENODEFILECHECK = (TNODE, "ENODEFILECHECK")
  ENODEHOOKS = (TNODE, "ENODEHOOKS")
  ENODEHV = (TNODE, "ENODEHV")
  ENODELVM = (TNODE, "ENODELVM")
  ENODEN1 = (TNODE, "ENODEN1")
  ENODENET = (TNODE, "ENODENET")
1224
  ENODEOS = (TNODE, "ENODEOS")
1225
1226
1227
1228
1229
  ENODEORPHANINSTANCE = (TNODE, "ENODEORPHANINSTANCE")
  ENODEORPHANLV = (TNODE, "ENODEORPHANLV")
  ENODERPC = (TNODE, "ENODERPC")
  ENODESSH = (TNODE, "ENODESSH")
  ENODEVERSION = (TNODE, "ENODEVERSION")
1230
  ENODESETUP = (TNODE, "ENODESETUP")
1231
  ENODETIME = (TNODE, "ENODETIME")
1232

1233
1234
1235
1236
  ETYPE_FIELD = "code"
  ETYPE_ERROR = "ERROR"
  ETYPE_WARNING = "WARNING"

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

1240
1241
    @type name: string
    @ivar name: the node name to which this object refers
Iustin Pop's avatar
Iustin Pop committed
1242
    @ivar volumes: a structure as returned from
Iustin Pop's avatar
Iustin Pop committed
1243
        L{ganeti.backend.GetVolumeList} (runtime)
Iustin Pop's avatar
Iustin Pop committed
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
    @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)
1261
1262
1263
1264
    @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
1265
1266
    @type vm_capable: boolean
    @ivar vm_capable: whether the node can host instances
Iustin Pop's avatar
Iustin Pop committed
1267
1268

    """
Iustin Pop's avatar