opcodes.py 35.8 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, 2011 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
22
23
24
25
26
#
# 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.


"""OpCodes module

This module implements the data structures which define the cluster
operations - the so-called opcodes.

Iustin Pop's avatar
Iustin Pop committed
27
28
Every operation which modifies the cluster state is expressed via
opcodes.
Iustin Pop's avatar
Iustin Pop committed
29
30
31
32
33
34
35

"""

# this are practically structures, so disable the message about too
# few public methods:
# pylint: disable-msg=R0903

36
import logging
37
import re
38
import operator
39

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
from ganeti import constants
from ganeti import errors
from ganeti import ht


# Common opcode attributes

#: output fields for a query operation
_POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString))

#: the shutdown timeout
_PShutdownTimeout = ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
                     ht.TPositiveInt)

#: the force parameter
_PForce = ("force", False, ht.TBool)

#: a required instance name (for single-instance LUs)
_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString)

#: Whether to ignore offline nodes
_PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool)

#: a required node name (for single-node LUs)
_PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString)

#: a required node group name (for single-group LUs)
_PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString)

#: Migration type (live/non-live)
_PMigrationMode = ("mode", None,
                   ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)))

#: Obsolete 'live' migration mode (boolean)
_PMigrationLive = ("live", None, ht.TMaybeBool)

#: Tag type
_PTagKind = ("kind", ht.NoDefault, ht.TElemOf(constants.VALID_TAG_TYPES))

#: List of tag strings
_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString))

82
83
84
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")

85
86
87
88
89
90
#: Utility function for L{OpClusterSetParams}
_TestClusterOsList = ht.TOr(ht.TNone,
  ht.TListOf(ht.TAnd(ht.TList, ht.TIsLength(2),
    ht.TMap(ht.WithDesc("GetFirstItem")(operator.itemgetter(0)),
            ht.TElemOf(constants.DDMS_VALUES)))))

91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

def _NameToId(name):
  """Convert an opcode class name to an OP_ID.

  @type name: string
  @param name: the class name, as OpXxxYyy
  @rtype: string
  @return: the name in the OP_XXXX_YYYY format

  """
  if not name.startswith("Op"):
    return None
  # Note: (?<=[a-z])(?=[A-Z]) would be ideal, since it wouldn't
  # consume any input, and hence we would just have all the elements
  # in the list, one by one; but it seems that split doesn't work on
  # non-consuming input, hence we have to process the input string a
  # bit
  name = _OPID_RE.sub(r"\1,\2", name)
  elems = name.split(",")
  return "_".join(n.upper() for n in elems)

112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

def RequireFileStorage():
  """Checks that file storage is enabled.

  While it doesn't really fit into this module, L{utils} was deemed too large
  of a dependency to be imported for just one or two functions.

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


127
128
129
@ht.WithDesc("CheckFileStorage")
def _CheckFileStorage(value):
  """Ensures file storage is enabled if used.
130
131

  """
132
  if value == constants.DT_FILE:
133
134
135
136
    RequireFileStorage()
  return True


137
138
139
140
_CheckDiskTemplate = ht.TAnd(ht.TElemOf(constants.DISK_TEMPLATES),
                             _CheckFileStorage)


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
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,
                               errors.ECODE_INVAL)
  if storage_type == constants.ST_FILE:
    RequireFileStorage()
  return True


#: Storage type parameter
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType)


class _AutoOpParamSlots(type):
  """Meta class for opcode definitions.

  """
  def __new__(mcs, name, bases, attrs):
    """Called when a class should be created.

    @param mcs: The meta class
    @param name: Name of created class
    @param bases: Base classes
    @type attrs: dict
    @param attrs: Class attributes

    """
    assert "__slots__" not in attrs, \
      "Class '%s' defines __slots__ when it should use OP_PARAMS" % name
173
    assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
174

175
    attrs["OP_ID"] = _NameToId(name)
176
177
178
179
180
181
182
183
184
185
186
187
188
189

    # Always set OP_PARAMS to avoid duplicates in BaseOpCode.GetAllParams
    params = attrs.setdefault("OP_PARAMS", [])

    # Use parameter names as slots
    slots = [pname for (pname, _, _) in params]

    assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
      "Class '%s' uses unknown field in OP_DSC_FIELD" % name

    attrs["__slots__"] = slots

    return type.__new__(mcs, name, bases, attrs)

190

Iustin Pop's avatar
Iustin Pop committed
191
class BaseOpCode(object):
192
193
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
194
195
196
  This object serves as a parent class for OpCode without any custom
  field handling.

197
  """
198
199
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
200
201
  __metaclass__ = _AutoOpParamSlots

Iustin Pop's avatar
Iustin Pop committed
202
  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
203
204
205
206
207
208
209
210
    """Constructor for BaseOpCode.

    The constructor takes only keyword arguments and will set
    attributes on this object based on the passed arguments. As such,
    it means that you should not pass arguments which are not in the
    __slots__ attribute for this class.

    """
211
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
212
    for key in kwargs:
213
      if key not in slots:
214
        raise TypeError("Object %s doesn't support the parameter '%s'" %
215
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
216
217
      setattr(self, key, kwargs[key])

218
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
219
220
221
222
223
224
225
226
227
    """Generic serializer.

    This method just returns the contents of the instance as a
    dictionary.

    @rtype:  C{dict}
    @return: the instance attributes and their values

    """
228
    state = {}
229
    for name in self._all_slots():
230
231
232
233
234
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
235
236
237
238
239
240
241
242
243
    """Generic unserializer.

    This method just restores from the serialized state the attributes
    of the current instance.

    @param state: the serialized opcode data
    @type state:  C{dict}

    """
244
245
246
247
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

248
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
249
      if name not in state and hasattr(self, name):
250
251
252
253
254
        delattr(self, name)

    for name in state:
      setattr(self, name, state[name])

255
256
257
258
259
260
261
262
263
264
  @classmethod
  def _all_slots(cls):
    """Compute the list of all declared slots for a class.

    """
    slots = []
    for parent in cls.__mro__:
      slots.extend(getattr(parent, "__slots__", []))
    return slots

265
266
267
268
269
270
271
272
273
274
  @classmethod
  def GetAllParams(cls):
    """Compute list of all parameters for an opcode.

    """
    slots = []
    for parent in cls.__mro__:
      slots.extend(getattr(parent, "OP_PARAMS", []))
    return slots

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
  def Validate(self, set_defaults):
    """Validate opcode parameters, optionally setting default values.

    @type set_defaults: bool
    @param set_defaults: Whether to set default values
    @raise errors.OpPrereqError: When a parameter value doesn't match
                                 requirements

    """
    for (attr_name, default, test) in self.GetAllParams():
      assert test == ht.NoType or callable(test)

      if not hasattr(self, attr_name):
        if default == ht.NoDefault:
          raise errors.OpPrereqError("Required parameter '%s.%s' missing" %
                                     (self.OP_ID, attr_name),
                                     errors.ECODE_INVAL)
        elif set_defaults:
          if callable(default):
            dval = default()
          else:
            dval = default
          setattr(self, attr_name, dval)

      if test == ht.NoType:
        # no tests here
        continue

      if set_defaults or hasattr(self, attr_name):
        attr_val = getattr(self, attr_name)
        if not test(attr_val):
          logging.error("OpCode %s, parameter %s, has invalid type %s/value %s",
                        self.OP_ID, attr_name, type(attr_val), attr_val)
          raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
                                     (self.OP_ID, attr_name),
                                     errors.ECODE_INVAL)

312

Iustin Pop's avatar
Iustin Pop committed
313
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
314
315
316
317
318
319
  """Abstract OpCode.

  This is the root of the actual OpCode hierarchy. All clases derived
  from this class should override OP_ID.

  @cvar OP_ID: The ID of this opcode. This should be unique amongst all
320
               children of this class.
321
322
323
  @cvar OP_DSC_FIELD: The name of a field whose value will be included in the
                      string returned by Summary(); see the docstring of that
                      method for details).
324
325
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
326
327
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
328
329
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
330
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
331
332

  """
333
334
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
335
  WITH_LU = True
336
337
338
339
340
341
  OP_PARAMS = [
    ("dry_run", None, ht.TMaybeBool),
    ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt)),
    ("priority", constants.OP_PRIO_DEFAULT,
     ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID)),
    ]
342
343
344
345

  def __getstate__(self):
    """Specialized getstate for opcodes.

Iustin Pop's avatar
Iustin Pop committed
346
347
348
349
350
351
352
    This method adds to the state dictionary the OP_ID of the class,
    so that on unload we can identify the correct class for
    instantiating the opcode.

    @rtype:   C{dict}
    @return:  the state as a dictionary

353
    """
Iustin Pop's avatar
Iustin Pop committed
354
    data = BaseOpCode.__getstate__(self)
355
356
357
358
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
359
  def LoadOpCode(cls, data):
360
361
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
362
363
364
365
366
367
368
    The method identifies the correct opcode class from the dict-form
    by looking for a OP_ID key, if this is not found, or its value is
    not available in this module as a child of this class, we fail.

    @type data:  C{dict}
    @param data: the serialized opcode

369
370
371
372
373
374
375
    """
    if not isinstance(data, dict):
      raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
    if "OP_ID" not in data:
      raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
    op_id = data["OP_ID"]
    op_class = None
Iustin Pop's avatar
Iustin Pop committed
376
377
378
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
379
380
381
382
383
384
385
386
      raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
                       op_id)
    op = op_class()
    new_data = data.copy()
    del new_data["OP_ID"]
    op.__setstate__(new_data)
    return op

387
388
389
  def Summary(self):
    """Generates a summary description of this opcode.

390
391
392
393
394
    The summary is the value of the OP_ID attribute (without the "OP_"
    prefix), plus the value of the OP_DSC_FIELD attribute, if one was
    defined; this field should allow to easily identify the operation
    (for an instance creation job, e.g., it would be the instance
    name).
395

396
    """
397
    assert self.OP_ID is not None and len(self.OP_ID) > 3
398
399
400
401
402
    # all OP_ID start with OP_, we remove that
    txt = self.OP_ID[3:]
    field_name = getattr(self, "OP_DSC_FIELD", None)
    if field_name:
      field_value = getattr(self, field_name, None)
403
404
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
405
406
407
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
408

409
410
# cluster opcodes

411
class OpClusterPostInit(OpCode):
412
413
414
415
416
417
418
419
  """Post cluster initialization.

  This opcode does not touch the cluster at all. Its purpose is to run hooks
  after the cluster has been initialized.

  """


420
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
421
422
423
424
425
426
  """Destroy the cluster.

  This opcode has no other parameters. All the state is irreversibly
  lost after the execution of this opcode.

  """
Iustin Pop's avatar
Iustin Pop committed
427
428


429
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
430
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
431
432


433
class OpClusterVerify(OpCode):
Iustin Pop's avatar
Iustin Pop committed
434
435
436
437
438
439
440
441
442
  """Verify the cluster state.

  @type skip_checks: C{list}
  @ivar skip_checks: steps to be skipped from the verify process; this
                     needs to be a subset of
                     L{constants.VERIFY_OPTIONAL_CHECKS}; currently
                     only L{constants.VERIFY_NPLUSONE_MEM} can be passed

  """
443
444
445
446
447
448
449
  OP_PARAMS = [
    ("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),
    ]
Iustin Pop's avatar
Iustin Pop committed
450
451


452
class OpClusterVerifyDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
453
454
455
456
  """Verify the cluster disks.

  Parameters: none

457
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
458
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
459
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
460
    - list of instances with degraded disks (that should be activated)
461
462
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
463

464
465
466
467
  In normal operation, all lists should be empty. A non-empty instance
  list (3rd element of the result) is still ok (errors were fixed) but
  non-empty node list means some node is down, and probably there are
  unfixable drbd errors.
Iustin Pop's avatar
Iustin Pop committed
468
469
470
471
472
473
474

  Note that only instances that are drbd-based are taken into
  consideration. This might need to be revisited in the future.

  """


475
class OpClusterRepairDiskSizes(OpCode):
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
  """Verify the disk sizes of the instances and fixes configuration
  mimatches.

  Parameters: optional instances list, in case we want to restrict the
  checks to only a subset of the instances.

  Result: a list of tuples, (instance, disk, new-size) for changed
  configurations.

  In normal operation, the list should be empty.

  @type instances: list
  @ivar instances: the list of instances to check, or empty for all instances

  """
491
492
493
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
494
495


496
class OpClusterConfigQuery(OpCode):
497
  """Query cluster configuration values."""
498
499
500
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
501
502


503
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
504
505
506
507
508
509
510
511
  """Rename the cluster.

  @type name: C{str}
  @ivar name: The new name of the cluster. The name and/or the master IP
              address will be changed to match the new name and its IP
              address.

  """
512
  OP_DSC_FIELD = "name"
513
514
515
  OP_PARAMS = [
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ]
516
517


518
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
519
520
521
522
523
524
  """Change the parameters of the cluster.

  @type vg_name: C{str} or C{None}
  @ivar vg_name: The new volume group name or None to disable LVM usage.

  """
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
  OP_PARAMS = [
    ("vg_name", None, ht.TMaybeString),
    ("enabled_hypervisors", None,
     ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
            ht.TNone)),
    ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
                              ht.TNone)),
    ("beparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
                            ht.TNone)),
    ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
                              ht.TNone)),
    ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone)),
    ("uid_pool", None, ht.NoType),
    ("add_uids", None, ht.NoType),
    ("remove_uids", None, ht.NoType),
    ("maintain_node_health", None, ht.TMaybeBool),
    ("prealloc_wipe_disks", None, ht.TMaybeBool),
Michael Hanselmann's avatar
Michael Hanselmann committed
543
544
    ("nicparams", None, ht.TMaybeDict),
    ("ndparams", None, ht.TMaybeDict),
545
546
547
548
    ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone)),
    ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone)),
    ("master_netdev", None, ht.TOr(ht.TString, ht.TNone)),
    ("reserved_lvs", None, ht.TOr(ht.TListOf(ht.TNonEmptyString), ht.TNone)),
549
550
    ("hidden_os", None, _TestClusterOsList),
    ("blacklisted_os", None, _TestClusterOsList),
551
    ]
552
553


554
class OpClusterRedistConf(OpCode):
555
556
557
558
  """Force a full push of the cluster configuration.

  """

Michael Hanselmann's avatar
Michael Hanselmann committed
559
560
561
562
563
564
565
566
567

class OpQuery(OpCode):
  """Query for resources/items.

  @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
  @ivar fields: List of fields to retrieve
  @ivar filter: Query filter

  """
568
569
570
571
572
  OP_PARAMS = [
    ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY)),
    ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ("filter", None, ht.TOr(ht.TNone,
                            ht.TListOf(ht.TOr(ht.TNonEmptyString, ht.TList)))),
Michael Hanselmann's avatar
Michael Hanselmann committed
573
574
575
576
577
578
579
580
581
582
    ]


class OpQueryFields(OpCode):
  """Query for available resource/item fields.

  @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
  @ivar fields: List of fields to retrieve

  """
583
584
585
  OP_PARAMS = [
    ("what", ht.NoDefault, ht.TElemOf(constants.QR_OP_QUERY)),
    ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString))),
Michael Hanselmann's avatar
Michael Hanselmann committed
586
587
588
    ]


589
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
590
  """Interact with OOB."""
591
  OP_PARAMS = [
592
    ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
593
594
    ("command", None, ht.TElemOf(constants.OOB_COMMANDS)),
    ("timeout", constants.OOB_TIMEOUT, ht.TInt),
595
596
    ("ignore_status", False, ht.TBool),
    ("force_master", False, ht.TBool),
René Nussbaumer's avatar
René Nussbaumer committed
597
598
599
    ]


600
601
# node opcodes

602
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
603
604
605
606
607
608
609
  """Remove a node.

  @type node_name: C{str}
  @ivar node_name: The name of the node to remove. If the node still has
                   instances on it, the operation will fail.

  """
610
  OP_DSC_FIELD = "node_name"
611
612
613
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
614
615


Iustin Pop's avatar
Iustin Pop committed
616
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
  """Add a node to the cluster.

  @type node_name: C{str}
  @ivar node_name: The name of the node to add. This can be a short name,
                   but it will be expanded to the FQDN.
  @type primary_ip: IP address
  @ivar primary_ip: The primary IP of the node. This will be ignored when the
                    opcode is submitted, but will be filled during the node
                    add (so it will be visible in the job query).
  @type secondary_ip: IP address
  @ivar secondary_ip: The secondary IP of the node. This needs to be passed
                      if the cluster has been initialized in 'dual-network'
                      mode, otherwise it must not be given.
  @type readd: C{bool}
  @ivar readd: Whether to re-add an existing node to the cluster. If
               this is not passed, then the operation will abort if the node
               name is already in the cluster; use this parameter to 'repair'
               a node that had its configuration broken, or was reinstalled
               without removal from the cluster.
636
637
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
638
639
640
641
  @type vm_capable: C{bool}
  @ivar vm_capable: The vm_capable node attribute
  @type master_capable: C{bool}
  @ivar master_capable: The master_capable node attribute
Iustin Pop's avatar
Iustin Pop committed
642
643

  """
644
  OP_DSC_FIELD = "node_name"
645
646
647
648
649
650
651
652
  OP_PARAMS = [
    _PNodeName,
    ("primary_ip", None, ht.NoType),
    ("secondary_ip", None, ht.TMaybeString),
    ("readd", False, ht.TBool),
    ("group", None, ht.TMaybeString),
    ("master_capable", None, ht.TMaybeBool),
    ("vm_capable", None, ht.TMaybeBool),
Michael Hanselmann's avatar
Michael Hanselmann committed
653
    ("ndparams", None, ht.TMaybeDict),
654
    ]
Iustin Pop's avatar
Iustin Pop committed
655
656


657
class OpNodeQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
658
  """Compute the list of nodes."""
659
660
661
662
663
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
664
665


666
class OpNodeQueryvols(OpCode):
667
  """Get list of volumes on node."""
668
669
670
671
  OP_PARAMS = [
    _POutputFields,
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
672
673


674
class OpNodeQueryStorage(OpCode):
675
  """Get information on storage for node(s)."""
676
677
678
679
680
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("name", None, ht.TMaybeString),
681
682
683
    ]


684
class OpNodeModifyStorage(OpCode):
685
  """Modifies the properies of a storage unit"""
686
687
688
689
690
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ("changes", ht.NoDefault, ht.TDict),
691
692
693
    ]


694
695
696
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_DSC_FIELD = "node_name"
697
698
699
700
701
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ("ignore_consistency", False, ht.TBool),
702
703
704
    ]


705
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
706
707
  """Change the parameters of a node."""
  OP_DSC_FIELD = "node_name"
708
709
710
711
712
713
714
715
716
717
  OP_PARAMS = [
    _PNodeName,
    _PForce,
    ("master_candidate", None, ht.TMaybeBool),
    ("offline", None, ht.TMaybeBool),
    ("drained", None, ht.TMaybeBool),
    ("auto_promote", False, ht.TBool),
    ("master_capable", None, ht.TMaybeBool),
    ("vm_capable", None, ht.TMaybeBool),
    ("secondary_ip", None, ht.TMaybeString),
Michael Hanselmann's avatar
Michael Hanselmann committed
718
    ("ndparams", None, ht.TMaybeDict),
719
    ("powered", None, ht.TMaybeBool),
Iustin Pop's avatar
Iustin Pop committed
720
721
    ]

Iustin Pop's avatar
Iustin Pop committed
722

723
class OpNodePowercycle(OpCode):
Iustin Pop's avatar
Iustin Pop committed
724
725
  """Tries to powercycle a node."""
  OP_DSC_FIELD = "node_name"
726
727
728
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
729
730
    ]

731

732
class OpNodeMigrate(OpCode):
733
734
  """Migrate all instances from a node."""
  OP_DSC_FIELD = "node_name"
735
736
737
738
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
739
740
741
    ]


742
class OpNodeEvacStrategy(OpCode):
743
744
  """Compute the evacuation strategy for a list of nodes."""
  OP_DSC_FIELD = "nodes"
745
746
747
748
749
  OP_PARAMS = [
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ("remote_node", None, ht.TMaybeString),
    ("iallocator", None, ht.TMaybeString),
    ]
750
751


Iustin Pop's avatar
Iustin Pop committed
752
753
# instance opcodes

754
class OpInstanceCreate(OpCode):
755
756
757
758
759
760
761
  """Create an instance.

  @ivar instance_name: Instance name
  @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
  @ivar source_handshake: Signed handshake from source (remote import only)
  @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
  @ivar source_instance_name: Previous name of instance (remote import only)
762
763
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
764
765

  """
766
  OP_DSC_FIELD = "instance_name"
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
  OP_PARAMS = [
    _PInstanceName,
    ("beparams", ht.EmptyDict, ht.TDict),
    ("disks", ht.NoDefault, ht.TListOf(ht.TDict)),
    ("disk_template", ht.NoDefault, _CheckDiskTemplate),
    ("file_driver", None, ht.TOr(ht.TNone, ht.TElemOf(constants.FILE_DRIVER))),
    ("file_storage_dir", None, ht.TMaybeString),
    ("force_variant", False, ht.TBool),
    ("hvparams", ht.EmptyDict, ht.TDict),
    ("hypervisor", None, ht.TMaybeString),
    ("iallocator", None, ht.TMaybeString),
    ("identify_defaults", False, ht.TBool),
    ("ip_check", True, ht.TBool),
    ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES)),
    ("name_check", True, ht.TBool),
    ("nics", ht.NoDefault, ht.TListOf(ht.TDict)),
    ("no_install", None, ht.TMaybeBool),
    ("osparams", ht.EmptyDict, ht.TDict),
    ("os_type", None, ht.TMaybeString),
    ("pnode", None, ht.TMaybeString),
    ("snode", None, ht.TMaybeString),
    ("source_handshake", None, ht.TOr(ht.TList, ht.TNone)),
    ("source_instance_name", None, ht.TMaybeString),
    ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
     ht.TPositiveInt),
    ("source_x509_ca", None, ht.TMaybeString),
    ("src_node", None, ht.TMaybeString),
    ("src_path", None, ht.TMaybeString),
    ("start", True, ht.TBool),
    ("wait_for_sync", True, ht.TBool),
797
    ]
Iustin Pop's avatar
Iustin Pop committed
798
799


800
class OpInstanceReinstall(OpCode):
Iustin Pop's avatar
Iustin Pop committed
801
  """Reinstall an instance's OS."""
802
  OP_DSC_FIELD = "instance_name"
803
804
805
806
  OP_PARAMS = [
    _PInstanceName,
    ("os_type", None, ht.TMaybeString),
    ("force_variant", False, ht.TBool),
Michael Hanselmann's avatar
Michael Hanselmann committed
807
    ("osparams", None, ht.TMaybeDict),
808
    ]
809
810


811
class OpInstanceRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
812
  """Remove an instance."""
813
  OP_DSC_FIELD = "instance_name"
814
815
816
817
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_failures", False, ht.TBool),
818
    ]
Iustin Pop's avatar
Iustin Pop committed
819
820


821
class OpInstanceRename(OpCode):
822
  """Rename an instance."""
823
824
825
826
827
  OP_PARAMS = [
    _PInstanceName,
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ("ip_check", False, ht.TBool),
    ("name_check", True, ht.TBool),
828
    ]
829
830


831
class OpInstanceStartup(OpCode):
Iustin Pop's avatar
Iustin Pop committed
832
  """Startup an instance."""
833
  OP_DSC_FIELD = "instance_name"
834
835
836
837
838
839
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
    ("hvparams", ht.EmptyDict, ht.TDict),
    ("beparams", ht.EmptyDict, ht.TDict),
840
    ]
Iustin Pop's avatar
Iustin Pop committed
841
842


843
class OpInstanceShutdown(OpCode):
Iustin Pop's avatar
Iustin Pop committed
844
  """Shutdown an instance."""
845
  OP_DSC_FIELD = "instance_name"
846
847
848
849
  OP_PARAMS = [
    _PInstanceName,
    _PIgnoreOfflineNodes,
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt),
850
    ]
Iustin Pop's avatar
Iustin Pop committed
851
852


853
class OpInstanceReboot(OpCode):
854
  """Reboot an instance."""
855
  OP_DSC_FIELD = "instance_name"
856
857
858
859
860
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_secondaries", False, ht.TBool),
    ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES)),
861
    ]
862
863


864
class OpInstanceReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
865
  """Replace the disks of an instance."""
866
  OP_DSC_FIELD = "instance_name"
867
868
869
870
871
872
873
  OP_PARAMS = [
    _PInstanceName,
    ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES)),
    ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt)),
    ("remote_node", None, ht.TMaybeString),
    ("iallocator", None, ht.TMaybeString),
    ("early_release", False, ht.TBool),
874
    ]
Iustin Pop's avatar
Iustin Pop committed
875
876


877
class OpInstanceFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
878
  """Failover an instance."""
879
  OP_DSC_FIELD = "instance_name"
880
881
882
883
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_consistency", False, ht.TBool),
884
    ]
Iustin Pop's avatar
Iustin Pop committed
885
886


887
class OpInstanceMigrate(OpCode):
888
889
890
891
892
  """Migrate an instance.

  This migrates (without shutting down an instance) to its secondary
  node.

Iustin Pop's avatar
Iustin Pop committed
893
  @ivar instance_name: the name of the instance
894
  @ivar mode: the migration mode (live, non-live or None for auto)
895
896

  """
Iustin Pop's avatar
Iustin Pop committed
897
  OP_DSC_FIELD = "instance_name"
898
899
900
901
902
903
  OP_PARAMS = [
    _PInstanceName,
    _PMigrationMode,
    _PMigrationLive,
    ("cleanup", False, ht.TBool),
    ]
904
905


906
class OpInstanceMove(OpCode):
907
908
909
910
911
912
913
914
915
916
  """Move an instance.

  This move (with shutting down an instance and data copying) to an
  arbitrary node.

  @ivar instance_name: the name of the instance
  @ivar target_node: the destination node

  """
  OP_DSC_FIELD = "instance_name"
917
918
919
920
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("target_node", ht.NoDefault, ht.TNonEmptyString),
Balazs Lecz's avatar
Balazs Lecz committed
921
    ]
922
923


924
class OpInstanceConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
925
  """Connect to an instance's console."""
926
  OP_DSC_FIELD = "instance_name"
927
928
929
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
930
931


932
class OpInstanceActivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
933
  """Activate an instance's disks."""
934
  OP_DSC_FIELD = "instance_name"
935
936
937
938
  OP_PARAMS = [
    _PInstanceName,
    ("ignore_size", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
939
940


941
class OpInstanceDeactivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
942
  """Deactivate an instance's disks."""
943
  OP_DSC_FIELD = "instance_name"
944
  OP_PARAMS = [
945
946
    _PInstanceName,
    _PForce,
947
    ]
Iustin Pop's avatar
Iustin Pop committed
948
949


950
class OpInstanceRecreateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
951
952
  """Deactivate an instance's disks."""
  OP_DSC_FIELD = "instance_name"
953
954
955
956
  OP_PARAMS = [
    _PInstanceName,
    ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt)),
    ]
Iustin Pop's avatar
Iustin Pop committed
957
958


959
class OpInstanceQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
960
  """Compute the list of instances."""
961
962
963
964
965
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
966
967


968
class OpInstanceQueryData(OpCode):
Iustin Pop's avatar
Iustin Pop committed
969
  """Compute the run-time status of instances."""
970
971
972
973
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("static", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
974
975


976
class OpInstanceSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
977
  """Change the parameters of an instance."""
978
  OP_DSC_FIELD = "instance_name"
979
980
981
982
983
984
985
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    ("nics", ht.EmptyList, ht.TList),
    ("disks", ht.EmptyList, ht.TList),
    ("beparams", ht.EmptyDict, ht.TDict),
    ("hvparams", ht.EmptyDict, ht.TDict),
986
    ("disk_template", None, ht.TOr(ht.TNone, _CheckDiskTemplate)),
987
988
989
    ("remote_node", None, ht.TMaybeString),
    ("os_name", None, ht.TMaybeString),
    ("force_variant", False, ht.TBool),
Michael Hanselmann's avatar
Michael Hanselmann committed
990
    ("osparams", None, ht.TMaybeDict),
991
    ]
Iustin Pop's avatar
Iustin Pop committed
992
993


Iustin Pop's avatar
Iustin Pop committed
994
class OpInstanceGrowDisk(OpCode):
Iustin Pop's avatar
Iustin Pop committed
995
  """Grow a disk of an instance."""
996
  OP_DSC_FIELD = "instance_name"
997
998
999
1000
1001
  OP_PARAMS = [
    _PInstanceName,
    ("disk", ht.NoDefault, ht.TInt),
    ("amount", ht.NoDefault, ht.TInt),
    ("wait_for_sync", True, ht.TBool),
1002
    ]
Iustin Pop's avatar
Iustin Pop committed
1003
1004


1005
1006
# Node group opcodes

Iustin Pop's avatar
Iustin Pop committed
1007
class OpGroupAdd(OpCode):
1008
1009
  """Add a node group to the cluster."""
  OP_DSC_FIELD = "group_name"
1010
1011
  OP_PARAMS = [
    _PGroupName,
Michael Hanselmann's avatar
Michael Hanselmann committed
1012
    ("ndparams", None, ht.TMaybeDict),
1013
1014
    ("alloc_policy", None,
     ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1015
    ]
1016
1017


1018
class OpGroupAssignNodes(OpCode):
1019
1020
1021
1022
1023
1024
1025
1026
1027
  """Assign nodes to a node group."""
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    _PForce,
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ]


1028
class OpGroupQuery(OpCode):
1029
  """Compute the list of node groups."""
1030
1031
1032
1033
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
1034
1035


1036
class OpGroupSetParams(OpCode):
1037
1038
  """Change the parameters of a node group."""
  OP_DSC_FIELD = "group_name"
1039
1040
  OP_PARAMS = [
    _PGroupName,
Michael Hanselmann's avatar
Michael Hanselmann committed
1041
    ("ndparams", None, ht.TMaybeDict),
1042
1043
    ("alloc_policy", None, ht.TOr(ht.TNone,
                                  ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1044
1045
1046
    ]


1047
class OpGroupRemove(OpCode):
1048
1049
  """Remove a node group from the cluster."""
  OP_DSC_FIELD = "group_name"
1050
1051
1052
  OP_PARAMS = [
    _PGroupName,
    ]
1053
1054


1055
class OpGroupRename(OpCode):
1056
1057
  """Rename a node group in the cluster."""
  OP_DSC_FIELD = "old_name"
1058
1059
1060
1061
  OP_PARAMS = [
    ("old_name", ht.NoDefault, ht.TNonEmptyString),
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ]
1062
1063


Iustin Pop's avatar
Iustin Pop committed
1064
# OS opcodes
1065
class OpOsDiagnose(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1066
  """Compute the list of guest operating systems."""
1067
1068
1069
1070
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
Iustin Pop's avatar
Iustin Pop committed
1071

1072

Iustin Pop's avatar
Iustin Pop committed
1073
# Exports opcodes
1074
class OpBackupQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1075
  """Compute the list of exported images."""
1076
1077
1078
1079
  OP_PARAMS = [
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
1080

1081

1082
class OpBackupPrepare(OpCode):
1083
1084
1085
1086
1087
1088
1089
  """Prepares an instance export.

  @ivar instance_name: Instance name
  @ivar mode: Export mode (one of L{constants.EXPORT_MODES})

  """
  OP_DSC_FIELD = "instance_name"
1090
1091
1092
  OP_PARAMS = [
    _PInstanceName,
    ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES)),
1093
1094
1095
    ]


1096
class OpBackupExport(OpCode):
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
  """Export an instance.

  For local exports, the export destination is the node name. For remote
  exports, the export destination is a list of tuples, each consisting of
  hostname/IP address, port, HMAC and HMAC salt. The HMAC is calculated using
  the cluster domain secret over the value "${index}:${hostname}:${port}". The
  destination X509 CA must be a signed certificate.

  @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
  @ivar target_node: Export destination
  @ivar x509_key_name: X509 key to use (remote export only)
  @ivar destination_x509_ca: Destination X509 CA in PEM format (remote export
                             only)

  """
1112
  OP_DSC_FIELD = "instance_name"
1113
1114
1115
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1116
1117
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
1118
1119
1120
1121
1122
1123
1124
    ("target_node", ht.NoDefault, ht.TOr(ht.TNonEmptyString, ht.TList)),
    ("shutdown", True, ht.TBool),
    ("remove_instance", False, ht.TBool),
    ("ignore_remove_failures", False, ht.TBool),
    ("mode", constants.EXPORT_MODE_LOCAL, ht.TElemOf(constants.EXPORT_MODES)),
    ("x509_key_name", None, ht.TOr(ht.TList, ht.TNone)),
    ("destination_x509_ca", None, ht.TMaybeString),
1125
    ]
1126

Michael Hanselmann's avatar
Michael Hanselmann committed
1127

1128
class OpBackupRemove(OpCode):
1129
  """Remove an instance's export."""
1130
  OP_DSC_FIELD = "instance_name"
1131
1132
1133
  OP_PARAMS = [
    _PInstanceName,
    ]
1134

Michael Hanselmann's avatar
Michael Hanselmann committed
1135

1136
# Tags opcodes
Iustin Pop's avatar
Iustin Pop committed
1137
class OpTagsGet(OpCode):
1138
  """Returns the tags of the given object."""
1139
  OP_DSC_FIELD = "name"
1140
1141
1142
1143
1144
  OP_PARAMS = [
    _PTagKind,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1145
1146


1147
class OpTagsSearch(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1148
  """Searches the tags in the cluster for a given pattern."""
1149
  OP_DSC_FIELD = "pattern"
1150
1151
1152
  OP_PARAMS = [
    ("pattern", ht.NoDefault, ht.TNonEmptyString),
    ]
Iustin Pop's avatar
Iustin Pop committed
1153
1154


Iustin Pop's avatar
Iustin Pop committed
1155
class OpTagsSet(OpCode):
1156
  """Add a list of tags on a given object."""
1157
1158
1159
1160
1161
1162
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1163
1164


Iustin Pop's avatar
Iustin Pop committed
1165
class OpTagsDel(OpCode):
1166
  """Remove a list of tags from a given object."""
1167
1168
1169
1170
1171
1172
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195

# Test opcodes
class OpTestDelay(OpCode):
  """Sleeps for a configured amount of time.

  This is used just for debugging and testing.

  Parameters:
    - duration: the time to sleep
    - on_master: if true, sleep on the master
    - on_nodes: list of nodes in which to sleep

  If the on_master parameter is true, it will execute a sleep on the
  master (before any node sleep).

  If the on_nodes list is not empty, it will sleep on those nodes
  (after the sleep on the master, if that is enabled).

  As an additional feature, the case of duration < 0 will be reported
  as an execution error, so this opcode can be used as a failure
  generator. The case of duration == 0 will not be treated specially.

  """
1196
  OP_DSC_FIELD = "duration"
1197
1198
1199
1200
1201
1202
  OP_PARAMS = [
    ("duration", ht.NoDefault, ht.TFloat),
    ("on_master", True, ht.TBool),
    ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("repeat", 0, ht.TPositiveInt)
    ]
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215


class OpTestAllocator(OpCode):
  """Allocator framework testing.

  This opcode has two modes:
    - gather and return allocator input for a given mode (allocate new
      or replace secondary) and a given instance definition (direction
      'in')
    - run a selected allocator for a given operation (as above) and
      return the allocator output (direction 'out')

  """
1216
  OP_DSC_FIELD = "allocator"
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
  OP_PARAMS = [
    ("direction", ht.NoDefault,
     ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS)),
    ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES)),
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ("nics", ht.NoDefault, ht.TOr(ht.TNone, ht.TListOf(
      ht.TDictOf(ht.TElemOf(["mac", "ip", "bridge"]),
               ht.TOr(ht.TNone, ht.TNonEmptyString))))),
    ("disks", ht.NoDefault, ht.TOr(ht.TNone, ht.TList)),
    ("hypervisor", None, ht.TMaybeString),
    ("allocator", None, ht.TMaybeString),
    ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("mem_size", None, ht.TOr(ht.TNone, ht.TPositiveInt)),
    ("vcpus", None, ht.TOr(ht.TNone, ht.TPositiveInt)),
    ("os", None, ht.TMaybeString),
    ("disk_template", None, ht.TMaybeString),
    ("evac_nodes", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString))),
1234
    ]