opcodes.py 36.2 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

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

81
82
83
#: Ignore consistency
_PIgnoreConsistency = ("ignore_consistency", False, ht.TBool)

84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")


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)

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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

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)


def _CheckDiskTemplate(template):
  """Ensure a given disk template is valid.

  """
  if template not in constants.DISK_TEMPLATES:
    # Using str.join directly to avoid importing utils for CommaJoin
    msg = ("Invalid disk template name '%s', valid templates are: %s" %
           (template, ", ".join(constants.DISK_TEMPLATES)))
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)
  if template == constants.DT_FILE:
    RequireFileStorage()
  return True


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
169
    assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
170

171
    attrs["OP_ID"] = _NameToId(name)
172
173
174
175
176
177
178
179
180
181
182
183
184
185

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

186

Iustin Pop's avatar
Iustin Pop committed
187
class BaseOpCode(object):
188
189
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
190
191
192
  This object serves as a parent class for OpCode without any custom
  field handling.

193
  """
194
195
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
196
197
  __metaclass__ = _AutoOpParamSlots

Iustin Pop's avatar
Iustin Pop committed
198
  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
199
200
201
202
203
204
205
206
    """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.

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

214
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
215
216
217
218
219
220
221
222
223
    """Generic serializer.

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

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

    """
224
    state = {}
225
    for name in self._all_slots():
226
227
228
229
230
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
231
232
233
234
235
236
237
238
239
    """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}

    """
240
241
242
243
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

244
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
245
      if name not in state and hasattr(self, name):
246
247
248
249
250
        delattr(self, name)

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

251
252
253
254
255
256
257
258
259
260
  @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

261
262
263
264
265
266
267
268
269
270
  @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

271
272
273
274
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
  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)

308

Iustin Pop's avatar
Iustin Pop committed
309
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
310
311
312
313
314
315
  """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
316
               children of this class.
317
318
319
  @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).
320
321
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
322
323
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
324
325
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
326
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
327
328

  """
329
330
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
331
  WITH_LU = True
332
333
334
335
336
337
  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)),
    ]
338
339
340
341

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

Iustin Pop's avatar
Iustin Pop committed
342
343
344
345
346
347
348
    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

349
    """
Iustin Pop's avatar
Iustin Pop committed
350
    data = BaseOpCode.__getstate__(self)
351
352
353
354
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
355
  def LoadOpCode(cls, data):
356
357
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
358
359
360
361
362
363
364
    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

365
366
367
368
369
370
371
    """
    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
372
373
374
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
375
376
377
378
379
380
381
382
      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

383
384
385
  def Summary(self):
    """Generates a summary description of this opcode.

386
387
388
389
390
    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).
391

392
    """
393
    assert self.OP_ID is not None and len(self.OP_ID) > 3
394
395
396
397
398
    # 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)
399
400
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
401
402
403
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
404

405
406
# cluster opcodes

407
class OpClusterPostInit(OpCode):
408
409
410
411
412
413
414
415
  """Post cluster initialization.

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

  """


416
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
417
418
419
420
421
422
  """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
423
424


425
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
426
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
427
428


429
class OpClusterVerify(OpCode):
Iustin Pop's avatar
Iustin Pop committed
430
431
432
433
434
435
436
437
438
  """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

  """
439
440
441
442
443
444
445
  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
446
447


448
class OpClusterVerifyDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
449
450
451
452
  """Verify the cluster disks.

  Parameters: none

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

460
461
462
463
  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
464
465
466
467
468
469
470

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

  """


471
class OpClusterRepairDiskSizes(OpCode):
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
  """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

  """
487
488
489
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
490
491


492
class OpClusterConfigQuery(OpCode):
493
  """Query cluster configuration values."""
494
495
496
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
497
498


499
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
500
501
502
503
504
505
506
507
  """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.

  """
508
  OP_DSC_FIELD = "name"
509
510
511
  OP_PARAMS = [
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ]
512
513


514
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
515
516
517
518
519
520
  """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.

  """
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
  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
539
540
    ("nicparams", None, ht.TMaybeDict),
    ("ndparams", None, ht.TMaybeDict),
541
542
543
544
545
546
547
548
549
550
551
552
553
554
    ("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)),
    ("hidden_os", None, ht.TOr(ht.TListOf(
          ht.TAnd(ht.TList,
                ht.TIsLength(2),
                ht.TMap(lambda v: v[0], ht.TElemOf(constants.DDMS_VALUES)))),
          ht.TNone)),
    ("blacklisted_os", None, ht.TOr(ht.TListOf(
          ht.TAnd(ht.TList,
                ht.TIsLength(2),
                ht.TMap(lambda v: v[0], ht.TElemOf(constants.DDMS_VALUES)))),
          ht.TNone)),
555
    ]
556
557


558
class OpClusterRedistConf(OpCode):
559
560
561
562
  """Force a full push of the cluster configuration.

  """

Michael Hanselmann's avatar
Michael Hanselmann committed
563
564
565
566
567
568
569
570
571

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

  """
572
573
574
575
576
  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
577
578
579
580
581
582
583
584
585
586
    ]


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

  """
587
588
589
  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
590
591
592
    ]


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


602
603
# node opcodes

604
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
605
606
607
608
609
610
611
  """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.

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


Iustin Pop's avatar
Iustin Pop committed
618
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
  """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.
638
639
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
640
641
642
643
  @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
644
645

  """
646
  OP_DSC_FIELD = "node_name"
647
648
649
650
651
652
653
654
  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
655
    ("ndparams", None, ht.TMaybeDict),
656
    ]
Iustin Pop's avatar
Iustin Pop committed
657
658


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


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


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


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


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


707
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
708
709
  """Change the parameters of a node."""
  OP_DSC_FIELD = "node_name"
710
711
712
713
714
715
716
717
718
719
  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
720
    ("ndparams", None, ht.TMaybeDict),
721
    ("powered", None, ht.TMaybeBool),
Iustin Pop's avatar
Iustin Pop committed
722
723
    ]

Iustin Pop's avatar
Iustin Pop committed
724

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

733

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


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


Iustin Pop's avatar
Iustin Pop committed
754
755
# instance opcodes

756
class OpInstanceCreate(OpCode):
757
758
759
760
761
762
763
  """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)
764
765
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
766
767

  """
768
  OP_DSC_FIELD = "instance_name"
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
797
798
  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),
799
    ]
Iustin Pop's avatar
Iustin Pop committed
800
801


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


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


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


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


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


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


866
class OpInstanceReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
867
  """Replace the disks of an instance."""
868
  OP_DSC_FIELD = "instance_name"
869
870
871
872
873
874
875
  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),
876
    ]
Iustin Pop's avatar
Iustin Pop committed
877
878


879
class OpInstanceFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
880
  """Failover an instance."""
881
  OP_DSC_FIELD = "instance_name"
882
883
884
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
885
    _PIgnoreConsistency,
886
    ]
Iustin Pop's avatar
Iustin Pop committed
887
888


889
class OpInstanceMigrate(OpCode):
890
891
892
893
894
  """Migrate an instance.

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

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

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


908
class OpInstanceMove(OpCode):
909
910
911
912
913
914
915
916
917
918
  """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"
919
920
921
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
Iustin Pop's avatar
Iustin Pop committed
922
    _PIgnoreConsistency,
923
    ("target_node", ht.NoDefault, ht.TNonEmptyString),
Balazs Lecz's avatar
Balazs Lecz committed
924
    ]
925
926


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


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


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


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


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


972
class OpInstanceQueryData(OpCode):
Iustin Pop's avatar
Iustin Pop committed
973
  """Compute the run-time status of instances."""
974
975
976
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("static", False, ht.TBool),
977
    ("use_locking", False, ht.TBool),
978
    ]
Iustin Pop's avatar
Iustin Pop committed
979
980


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


Iustin Pop's avatar
Iustin Pop committed
1000
class OpInstanceGrowDisk(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1001
  """Grow a disk of an instance."""
1002
  OP_DSC_FIELD = "instance_name"
1003
1004
1005
1006
1007
  OP_PARAMS = [
    _PInstanceName,
    ("disk", ht.NoDefault, ht.TInt),
    ("amount", ht.NoDefault, ht.TInt),
    ("wait_for_sync", True, ht.TBool),
1008
    ]
Iustin Pop's avatar
Iustin Pop committed
1009
1010


1011
1012
# Node group opcodes

Iustin Pop's avatar
Iustin Pop committed
1013
class OpGroupAdd(OpCode):
1014
1015
  """Add a node group to the cluster."""
  OP_DSC_FIELD = "group_name"
1016
1017
  OP_PARAMS = [
    _PGroupName,
Michael Hanselmann's avatar
Michael Hanselmann committed
1018
    ("ndparams", None, ht.TMaybeDict),
1019
1020
    ("alloc_policy", None,
     ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1021
    ]
1022
1023


1024
class OpGroupAssignNodes(OpCode):
1025
1026
1027
1028
1029
1030
1031
1032
1033
  """Assign nodes to a node group."""
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    _PForce,
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ]


1034
class OpGroupQuery(OpCode):
1035
  """Compute the list of node groups."""
1036
1037
1038
1039
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
1040
1041


1042
class OpGroupSetParams(OpCode):
1043
1044
  """Change the parameters of a node group."""
  OP_DSC_FIELD = "group_name"
1045
1046
  OP_PARAMS = [
    _PGroupName,
Michael Hanselmann's avatar
Michael Hanselmann committed
1047
    ("ndparams", None, ht.TMaybeDict),
1048
1049
    ("alloc_policy", None, ht.TOr(ht.TNone,
                                  ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1050
1051
1052
    ]


1053
class OpGroupRemove(OpCode):
1054
1055
  """Remove a node group from the cluster."""
  OP_DSC_FIELD = "group_name"
1056
1057
1058
  OP_PARAMS = [
    _PGroupName,
    ]
1059
1060


1061
class OpGroupRename(OpCode):
1062
1063
  """Rename a node group in the cluster."""
  OP_DSC_FIELD = "old_name"
1064
1065
1066
1067
  OP_PARAMS = [
    ("old_name", ht.NoDefault, ht.TNonEmptyString),
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ]
1068
1069


Iustin Pop's avatar
Iustin Pop committed
1070
# OS opcodes
1071
class OpOsDiagnose(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1072
  """Compute the list of guest operating systems."""
1073
1074
1075
1076
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
Iustin Pop's avatar
Iustin Pop committed
1077

1078

Iustin Pop's avatar
Iustin Pop committed
1079
# Exports opcodes
1080
class OpBackupQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1081
  """Compute the list of exported images."""
1082
1083
1084
1085
  OP_PARAMS = [
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
1086

1087

1088
class OpBackupPrepare(OpCode):
1089
1090
1091
1092
1093
1094
1095
  """Prepares an instance export.

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

  """
  OP_DSC_FIELD = "instance_name"
1096
1097
1098
  OP_PARAMS = [
    _PInstanceName,
    ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES)),
1099
1100
1101
    ]


1102
class OpBackupExport(OpCode):
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
  """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)

  """
1118
  OP_DSC_FIELD = "instance_name"
1119
1120
1121
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1122
1123
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
1124
1125
1126
1127
1128
1129
1130
    ("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),
1131
    ]
1132

Michael Hanselmann's avatar
Michael Hanselmann committed
1133

1134
class OpBackupRemove(OpCode):
1135
  """Remove an instance's export."""
1136
  OP_DSC_FIELD = "instance_name"
1137
1138
1139
  OP_PARAMS = [
    _PInstanceName,
    ]
1140

Michael Hanselmann's avatar
Michael Hanselmann committed
1141

1142
# Tags opcodes
Iustin Pop's avatar
Iustin Pop committed
1143
class OpTagsGet(OpCode):
1144
  """Returns the tags of the given object."""
1145
  OP_DSC_FIELD = "name"
1146
1147
1148
1149
1150
  OP_PARAMS = [
    _PTagKind,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1151
1152


1153
class OpTagsSearch(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1154
  """Searches the tags in the cluster for a given pattern."""
1155
  OP_DSC_FIELD = "pattern"
1156
1157
1158
  OP_PARAMS = [
    ("pattern", ht.NoDefault, ht.TNonEmptyString),
    ]
Iustin Pop's avatar
Iustin Pop committed
1159
1160


Iustin Pop's avatar
Iustin Pop committed
1161
class OpTagsSet(OpCode):
1162
  """Add a list of tags on a given object."""
1163
1164
1165
1166
1167
1168
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1169
1170


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

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

  """
1202
  OP_DSC_FIELD = "duration"
1203
1204
1205
1206
1207
1208
  OP_PARAMS = [
    ("duration", ht.NoDefault, ht.TFloat),
    ("on_master", True, ht.TBool),
    ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("repeat", 0, ht.TPositiveInt)
    ]
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221


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

  """
1222
  OP_DSC_FIELD = "allocator"
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
  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",