opcodes.py 36.6 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
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
37
import logging

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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
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))


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
    assert "OP_ID" in attrs, "Class '%s' is missing OP_ID attribute" % name

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

156

Iustin Pop's avatar
Iustin Pop committed
157
class BaseOpCode(object):
158
159
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
160
161
162
  This object serves as a parent class for OpCode without any custom
  field handling.

163
  """
164
165
166
  __metaclass__ = _AutoOpParamSlots

  OP_ID = None
Iustin Pop's avatar
Iustin Pop committed
167
168

  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
169
170
171
172
173
174
175
176
    """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.

    """
177
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
178
    for key in kwargs:
179
      if key not in slots:
180
        raise TypeError("Object %s doesn't support the parameter '%s'" %
181
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
182
183
      setattr(self, key, kwargs[key])

184
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
185
186
187
188
189
190
191
192
193
    """Generic serializer.

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

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

    """
194
    state = {}
195
    for name in self._all_slots():
196
197
198
199
200
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
201
202
203
204
205
206
207
208
209
    """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}

    """
210
211
212
213
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

214
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
215
      if name not in state and hasattr(self, name):
216
217
218
219
220
        delattr(self, name)

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

221
222
223
224
225
226
227
228
229
230
  @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

231
232
233
234
235
236
237
238
239
240
  @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

241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
  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)

278

Iustin Pop's avatar
Iustin Pop committed
279
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
280
281
282
283
284
285
  """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
286
               children of this class.
287
288
289
  @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).
290
291
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
292
293
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
294
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
295
296

  """
297
  OP_ID = "OP_ABSTRACT"
298
299
300
301
302
303
  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)),
    ]
304
305
306
307

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

Iustin Pop's avatar
Iustin Pop committed
308
309
310
311
312
313
314
    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

315
    """
Iustin Pop's avatar
Iustin Pop committed
316
    data = BaseOpCode.__getstate__(self)
317
318
319
320
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
321
  def LoadOpCode(cls, data):
322
323
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
324
325
326
327
328
329
330
    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

331
332
333
334
335
336
337
    """
    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
338
339
340
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
341
342
343
344
345
346
347
348
      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

349
350
351
  def Summary(self):
    """Generates a summary description of this opcode.

352
353
354
355
356
    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).

357
358
359
360
361
362
    """
    # 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)
363
364
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
365
366
367
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
368

369
370
# cluster opcodes

371
372
373
374
375
376
377
378
379
380
class OpPostInitCluster(OpCode):
  """Post cluster initialization.

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

  """
  OP_ID = "OP_CLUSTER_POST_INIT"


Iustin Pop's avatar
Iustin Pop committed
381
class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
382
383
384
385
386
387
  """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
388
389
390
391
  OP_ID = "OP_CLUSTER_DESTROY"


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
392
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
393
394
395
396
  OP_ID = "OP_CLUSTER_QUERY"


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
397
398
399
400
401
402
403
404
405
  """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

  """
Iustin Pop's avatar
Iustin Pop committed
406
  OP_ID = "OP_CLUSTER_VERIFY"
407
408
409
410
411
412
413
  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
414
415


Iustin Pop's avatar
Iustin Pop committed
416
417
418
419
420
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

421
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
422
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
423
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
424
    - list of instances with degraded disks (that should be activated)
425
426
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
427

428
429
430
431
  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
432
433
434
435
436
437
438
439

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

  """
  OP_ID = "OP_CLUSTER_VERIFY_DISKS"


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
class OpRepairDiskSizes(OpCode):
  """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

  """
  OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES"
457
458
459
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
460
461


462
463
464
class OpQueryConfigValues(OpCode):
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
465
466
467
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
468
469


470
class OpRenameCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
471
472
473
474
475
476
477
478
  """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.

  """
479
  OP_ID = "OP_CLUSTER_RENAME"
480
  OP_DSC_FIELD = "name"
481
482
483
  OP_PARAMS = [
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ]
484
485


486
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
487
488
489
490
491
492
  """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.

  """
493
  OP_ID = "OP_CLUSTER_SET_PARAMS"
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
  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),
    ("nicparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("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)),
528
    ]
529
530


531
532
533
534
535
536
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"

Michael Hanselmann's avatar
Michael Hanselmann committed
537
538
539
540
541
542
543
544
545
546

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

  """
  OP_ID = "OP_QUERY"
547
548
549
550
551
  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
552
553
554
555
556
557
558
559
560
561
562
    ]


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

  """
  OP_ID = "OP_QUERY_FIELDS"
563
564
565
  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
566
567
568
    ]


569
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
570
  """Interact with OOB."""
571
  OP_ID = "OP_OOB_COMMAND"
572
573
574
575
  OP_PARAMS = [
    _PNodeName,
    ("command", None, ht.TElemOf(constants.OOB_COMMANDS)),
    ("timeout", constants.OOB_TIMEOUT, ht.TInt),
René Nussbaumer's avatar
René Nussbaumer committed
576
577
578
    ]


579
580
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
581
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
582
583
584
585
586
587
588
  """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.

  """
Iustin Pop's avatar
Iustin Pop committed
589
  OP_ID = "OP_NODE_REMOVE"
590
  OP_DSC_FIELD = "node_name"
591
592
593
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
594
595
596


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
  """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.
616
617
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
618
619
620
621
  @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
622
623

  """
Iustin Pop's avatar
Iustin Pop committed
624
  OP_ID = "OP_NODE_ADD"
625
  OP_DSC_FIELD = "node_name"
626
627
628
629
630
631
632
633
634
635
  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),
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ]
Iustin Pop's avatar
Iustin Pop committed
636
637
638
639
640


class OpQueryNodes(OpCode):
  """Compute the list of nodes."""
  OP_ID = "OP_NODE_QUERY"
641
642
643
644
645
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
646
647


648
649
650
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
651
652
653
654
  OP_PARAMS = [
    _POutputFields,
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
655
656


657
658
659
class OpQueryNodeStorage(OpCode):
  """Get information on storage for node(s)."""
  OP_ID = "OP_NODE_QUERY_STORAGE"
660
661
662
663
664
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("name", None, ht.TMaybeString),
665
666
667
    ]


668
class OpModifyNodeStorage(OpCode):
669
  """Modifies the properies of a storage unit"""
670
  OP_ID = "OP_NODE_MODIFY_STORAGE"
671
672
673
674
675
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ("changes", ht.NoDefault, ht.TDict),
676
677
678
    ]


679
680
681
682
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_ID = "OP_REPAIR_NODE_STORAGE"
  OP_DSC_FIELD = "node_name"
683
684
685
686
687
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ("ignore_consistency", False, ht.TBool),
688
689
690
    ]


Iustin Pop's avatar
Iustin Pop committed
691
692
693
694
class OpSetNodeParams(OpCode):
  """Change the parameters of a node."""
  OP_ID = "OP_NODE_SET_PARAMS"
  OP_DSC_FIELD = "node_name"
695
696
697
698
699
700
701
702
703
704
705
706
  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),
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("powered", None, ht.TMaybeBool),
Iustin Pop's avatar
Iustin Pop committed
707
708
    ]

Iustin Pop's avatar
Iustin Pop committed
709
710
711
712
713

class OpPowercycleNode(OpCode):
  """Tries to powercycle a node."""
  OP_ID = "OP_NODE_POWERCYCLE"
  OP_DSC_FIELD = "node_name"
714
715
716
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
717
718
    ]

719

720
721
722
723
class OpMigrateNode(OpCode):
  """Migrate all instances from a node."""
  OP_ID = "OP_NODE_MIGRATE"
  OP_DSC_FIELD = "node_name"
724
725
726
727
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
728
729
730
    ]


731
732
733
734
class OpNodeEvacuationStrategy(OpCode):
  """Compute the evacuation strategy for a list of nodes."""
  OP_ID = "OP_NODE_EVAC_STRATEGY"
  OP_DSC_FIELD = "nodes"
735
736
737
738
739
  OP_PARAMS = [
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ("remote_node", None, ht.TMaybeString),
    ("iallocator", None, ht.TMaybeString),
    ]
740
741


Iustin Pop's avatar
Iustin Pop committed
742
743
744
# instance opcodes

class OpCreateInstance(OpCode):
745
746
747
748
749
750
751
  """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)
752
753
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
754
755

  """
Iustin Pop's avatar
Iustin Pop committed
756
  OP_ID = "OP_INSTANCE_CREATE"
757
  OP_DSC_FIELD = "instance_name"
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
  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),
788
    ]
Iustin Pop's avatar
Iustin Pop committed
789
790


791
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
792
  """Reinstall an instance's OS."""
793
  OP_ID = "OP_INSTANCE_REINSTALL"
794
  OP_DSC_FIELD = "instance_name"
795
796
797
798
799
800
  OP_PARAMS = [
    _PInstanceName,
    ("os_type", None, ht.TMaybeString),
    ("force_variant", False, ht.TBool),
    ("osparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ]
801
802


Iustin Pop's avatar
Iustin Pop committed
803
804
805
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
806
  OP_DSC_FIELD = "instance_name"
807
808
809
810
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_failures", False, ht.TBool),
811
    ]
Iustin Pop's avatar
Iustin Pop committed
812
813


814
815
816
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
817
818
819
820
821
  OP_PARAMS = [
    _PInstanceName,
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ("ip_check", False, ht.TBool),
    ("name_check", True, ht.TBool),
822
    ]
823
824


Iustin Pop's avatar
Iustin Pop committed
825
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
826
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
827
  OP_ID = "OP_INSTANCE_STARTUP"
828
  OP_DSC_FIELD = "instance_name"
829
830
831
832
833
834
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
    ("hvparams", ht.EmptyDict, ht.TDict),
    ("beparams", ht.EmptyDict, ht.TDict),
835
    ]
Iustin Pop's avatar
Iustin Pop committed
836
837
838


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
839
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
840
  OP_ID = "OP_INSTANCE_SHUTDOWN"
841
  OP_DSC_FIELD = "instance_name"
842
843
844
845
  OP_PARAMS = [
    _PInstanceName,
    _PIgnoreOfflineNodes,
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt),
846
    ]
Iustin Pop's avatar
Iustin Pop committed
847
848


849
850
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
851
  OP_ID = "OP_INSTANCE_REBOOT"
852
  OP_DSC_FIELD = "instance_name"
853
854
855
856
857
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_secondaries", False, ht.TBool),
    ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES)),
858
    ]
859
860


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


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


886
887
888
889
890
891
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

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

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
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
907
908
909
910
911
912
913
914
915
916
917
class OpMoveInstance(OpCode):
  """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_ID = "OP_INSTANCE_MOVE"
  OP_DSC_FIELD = "instance_name"
918
919
920
921
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("target_node", ht.NoDefault, ht.TNonEmptyString),
Balazs Lecz's avatar
Balazs Lecz committed
922
    ]
923
924


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


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
935
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
936
  OP_ID = "OP_INSTANCE_ACTIVATE_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 OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
945
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
946
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
947
  OP_DSC_FIELD = "instance_name"
948
949
950
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
951
952


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


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


class OpQueryInstanceData(OpCode):
  """Compute the run-time status of instances."""
  OP_ID = "OP_INSTANCE_QUERY_DATA"
976
977
978
979
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("static", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
980
981


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


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


1013
1014
# Node group opcodes

1015
1016
1017
1018
class OpAddGroup(OpCode):
  """Add a node group to the cluster."""
  OP_ID = "OP_GROUP_ADD"
  OP_DSC_FIELD = "group_name"
1019
1020
1021
1022
1023
  OP_PARAMS = [
    _PGroupName,
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("alloc_policy", None,
     ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1024
    ]
1025
1026


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


1036
1037
1038
1039
class OpSetGroupParams(OpCode):
  """Change the parameters of a node group."""
  OP_ID = "OP_GROUP_SET_PARAMS"
  OP_DSC_FIELD = "group_name"
1040
1041
1042
1043
1044
  OP_PARAMS = [
    _PGroupName,
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("alloc_policy", None, ht.TOr(ht.TNone,
                                  ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1045
1046
1047
    ]


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


1057
1058
1059
1060
class OpRenameGroup(OpCode):
  """Rename a node group in the cluster."""
  OP_ID = "OP_GROUP_RENAME"
  OP_DSC_FIELD = "old_name"
1061
1062
1063
1064
  OP_PARAMS = [
    ("old_name", ht.NoDefault, ht.TNonEmptyString),
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ]
1065
1066


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

1076

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

1086

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

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

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


Iustin Pop's avatar
Iustin Pop committed
1102
class OpExportInstance(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)

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

Michael Hanselmann's avatar
Michael Hanselmann committed
1134

1135
1136
1137
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
1138
  OP_DSC_FIELD = "instance_name"
1139
1140
1141
  OP_PARAMS = [
    _PInstanceName,
    ]
1142

Michael Hanselmann's avatar
Michael Hanselmann committed
1143

1144
1145
1146
1147
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
1148
  OP_DSC_FIELD = "name"
1149
1150
1151
1152
1153
  OP_PARAMS = [
    _PTagKind,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1154
1155


Iustin Pop's avatar
Iustin Pop committed
1156
1157
1158
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
1159
  OP_DSC_FIELD = "pattern"
1160
1161
1162
  OP_PARAMS = [
    ("pattern", ht.NoDefault, ht.TNonEmptyString),
    ]
Iustin Pop's avatar
Iustin Pop committed
1163
1164


1165
1166
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
1167
  OP_ID = "OP_TAGS_SET"
1168
1169
1170
1171
1172
1173
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1174
1175


1176
1177
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
1178
  OP_ID = "OP_TAGS_DEL"
1179
1180
1181
1182
1183
1184
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208

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

  """
  OP_ID = "OP_TEST_DELAY"
1209
  OP_DSC_FIELD = "duration"
1210
1211
1212
1213
1214
1215
  OP_PARAMS = [
    ("duration", ht.NoDefault, ht.TFloat),
    ("on_master", True, ht.TBool),
    ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("repeat", 0, ht.TPositiveInt)
    ]
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229


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

  """
  OP_ID = "OP_TEST_ALLOCATOR"
1230
  OP_DSC_FIELD = "allocator"
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
  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))),
1248
    ]
Iustin Pop's avatar
Iustin Pop committed
1249

1250

1251
1252
1253
1254
1255
class OpTestJobqueue(OpCode):
  """Utility opcode to test some aspects of the job queue.

  """
  OP_ID = "OP_TEST_JQUEUE"
1256
1257
1258
1259
1260
  OP_PARAMS = [
    ("notify_waitlock", False, ht.TBool),
    ("notify_exec", False, ht.TBool),
    ("log_messages", ht.EmptyList, ht.TListOf(ht.TString)),
    ("fail", False, ht.TBool),
1261
1262
1263
    ]


1264
1265
1266
1267
1268
class OpTestDummy(OpCode):
  """Utility opcode used by unittests.

  """
  OP_ID = "OP_TEST_DUMMY"
1269
1270
1271
1272
  OP_PARAMS = [
    ("result", ht.NoDefault, ht.NoType),
    ("messages", ht.NoDefault, ht.NoType),
    ("fail", ht.NoDefault, ht.NoType),
1273
1274
1275
    ]


Michael Hanselmann's avatar
Michael Hanselmann committed
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
def _GetOpList():
  """Returns list of all defined opcodes.

  Does not eliminate duplicates by C{OP_ID}.

  """
  return [v for v in globals().values()
          if (isinstance(v, type) and issubclass(v, OpCode) and
              hasattr(v, "OP_ID"))]


OP_MAPPING = dict((v.OP_ID, v) for v in _GetOpList())