opcodes.py 37 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
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
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
294
295
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
296
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
297
298

  """
299
  OP_ID = "OP_ABSTRACT"
300
  WITH_LU = True
301
302
303
304
305
306
  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)),
    ]
307
308
309
310

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

Iustin Pop's avatar
Iustin Pop committed
311
312
313
314
315
316
317
    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

318
    """
Iustin Pop's avatar
Iustin Pop committed
319
    data = BaseOpCode.__getstate__(self)
320
321
322
323
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
324
  def LoadOpCode(cls, data):
325
326
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
327
328
329
330
331
332
333
    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

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

352
353
354
  def Summary(self):
    """Generates a summary description of this opcode.

355
356
357
358
359
    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).

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

Iustin Pop's avatar
Iustin Pop committed
371

372
373
# cluster opcodes

374
class OpClusterPostInit(OpCode):
375
376
377
378
379
380
381
382
383
  """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"


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


394
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
395
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
396
397
398
399
  OP_ID = "OP_CLUSTER_QUERY"


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
400
401
402
403
404
405
406
407
408
  """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
409
  OP_ID = "OP_CLUSTER_VERIFY"
410
411
412
413
414
415
416
  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
417
418


Iustin Pop's avatar
Iustin Pop committed
419
420
421
422
423
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

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

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

  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"


443
class OpClusterRepairDiskSizes(OpCode):
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
  """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"
460
461
462
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
463
464


465
class OpClusterConfigQuery(OpCode):
466
467
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
468
469
470
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
471
472


473
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
474
475
476
477
478
479
480
481
  """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.

  """
482
  OP_ID = "OP_CLUSTER_RENAME"
483
  OP_DSC_FIELD = "name"
484
485
486
  OP_PARAMS = [
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ]
487
488


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

  """
496
  OP_ID = "OP_CLUSTER_SET_PARAMS"
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
528
529
530
  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)),
531
    ]
532
533


534
class OpClusterRedistConf(OpCode):
535
536
537
538
539
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"

Michael Hanselmann's avatar
Michael Hanselmann committed
540
541
542
543
544
545
546
547
548
549

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"
550
551
552
553
554
  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
555
556
557
558
559
560
561
562
563
564
565
    ]


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"
566
567
568
  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
569
570
571
    ]


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


582
583
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
584
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
585
586
587
588
589
590
591
  """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
592
  OP_ID = "OP_NODE_REMOVE"
593
  OP_DSC_FIELD = "node_name"
594
595
596
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
597
598
599


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

  """
Iustin Pop's avatar
Iustin Pop committed
627
  OP_ID = "OP_NODE_ADD"
628
  OP_DSC_FIELD = "node_name"
629
630
631
632
633
634
635
636
637
638
  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
639
640
641
642
643


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


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


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


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


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


Iustin Pop's avatar
Iustin Pop committed
694
695
696
697
class OpSetNodeParams(OpCode):
  """Change the parameters of a node."""
  OP_ID = "OP_NODE_SET_PARAMS"
  OP_DSC_FIELD = "node_name"
698
699
700
701
702
703
704
705
706
707
708
709
  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
710
711
    ]

Iustin Pop's avatar
Iustin Pop committed
712
713
714
715
716

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

722

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


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


Iustin Pop's avatar
Iustin Pop committed
745
746
747
# instance opcodes

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

  """
Iustin Pop's avatar
Iustin Pop committed
759
  OP_ID = "OP_INSTANCE_CREATE"
760
  OP_DSC_FIELD = "instance_name"
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
788
789
790
  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),
791
    ]
Iustin Pop's avatar
Iustin Pop committed
792
793


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


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


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


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


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


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


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


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


889
890
891
892
893
894
class OpMigrateInstance(OpCode):
  """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
899

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


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


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


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
938
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
939
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
940
  OP_DSC_FIELD = "instance_name"
941
942
943
944
  OP_PARAMS = [
    _PInstanceName,
    ("ignore_size", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
945
946
947


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
948
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
949
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
950
  OP_DSC_FIELD = "instance_name"
951
952
953
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
954
955


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


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


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


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


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


1016
1017
# Node group opcodes

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


1030
1031
class OpAssignGroupNodes(OpCode):
  """Assign nodes to a node group."""
1032
  OP_ID = "OP_GROUP_ASSIGN_NODES"
1033
1034
1035
1036
1037
1038
1039
1040
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    _PForce,
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ]


1041
1042
1043
class OpQueryGroups(OpCode):
  """Compute the list of node groups."""
  OP_ID = "OP_GROUP_QUERY"
1044
1045
1046
1047
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
1048
1049


1050
1051
1052
1053
class OpSetGroupParams(OpCode):
  """Change the parameters of a node group."""
  OP_ID = "OP_GROUP_SET_PARAMS"
  OP_DSC_FIELD = "group_name"
1054
1055
1056
1057
1058
  OP_PARAMS = [
    _PGroupName,
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("alloc_policy", None, ht.TOr(ht.TNone,
                                  ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1059
1060
1061
    ]


1062
1063
1064
1065
class OpRemoveGroup(OpCode):
  """Remove a node group from the cluster."""
  OP_ID = "OP_GROUP_REMOVE"
  OP_DSC_FIELD = "group_name"
1066
1067
1068
  OP_PARAMS = [
    _PGroupName,
    ]
1069
1070


1071
1072
1073
1074
class OpRenameGroup(OpCode):
  """Rename a node group in the cluster."""
  OP_ID = "OP_GROUP_RENAME"
  OP_DSC_FIELD = "old_name"
1075
1076
1077
1078
  OP_PARAMS = [
    ("old_name", ht.NoDefault, ht.TNonEmptyString),
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ]
1079
1080


Iustin Pop's avatar
Iustin Pop committed
1081
1082
1083
1084
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
1085
1086
1087
1088
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
Iustin Pop's avatar
Iustin Pop committed
1089

1090

Iustin Pop's avatar
Iustin Pop committed
1091
# Exports opcodes
1092
class OpBackupQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1093
1094
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
1095
1096
1097
1098
  OP_PARAMS = [
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
1099

1100

1101
class OpBackupPrepare(OpCode):
1102
1103
1104
1105
1106
1107
1108
1109
  """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"
1110
1111
1112
  OP_PARAMS = [
    _PInstanceName,
    ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES)),
1113
1114
1115
    ]


1116
class OpBackupExport(OpCode):
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
  """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
1132
  OP_ID = "OP_BACKUP_EXPORT"
1133
  OP_DSC_FIELD = "instance_name"
1134
1135
1136
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1137
1138
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
1139
1140
1141
1142
1143
1144
1145
    ("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),
1146
    ]
1147

Michael Hanselmann's avatar
Michael Hanselmann committed
1148

1149
class OpBackupRemove(OpCode):
1150
1151
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
1152
  OP_DSC_FIELD = "instance_name"
1153
1154
1155
  OP_PARAMS = [
    _PInstanceName,
    ]
1156

Michael Hanselmann's avatar
Michael Hanselmann committed
1157

1158
1159
1160
1161
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
1162
  OP_DSC_FIELD = "name"
1163
1164
1165
1166
1167
  OP_PARAMS = [
    _PTagKind,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1168
1169


Iustin Pop's avatar
Iustin Pop committed
1170
1171
1172
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
1173
  OP_DSC_FIELD = "pattern"
1174
1175
1176
  OP_PARAMS = [
    ("pattern", ht.NoDefault, ht.TNonEmptyString),
    ]
Iustin Pop's avatar
Iustin Pop committed
1177
1178


1179
1180
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
1181
  OP_ID = "OP_TAGS_SET"
1182
1183
1184
1185
1186
1187
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1188
1189


1190
1191
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
1192
  OP_ID = "OP_TAGS_DEL"
1193
1194
1195
1196
1197
1198
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222

# 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"
1223
  OP_DSC_FIELD = "duration"
1224
1225
1226
1227
1228
1229
  OP_PARAMS = [
    ("duration", ht.NoDefault, ht.TFloat),
    ("on_master", True, ht.TBool),
    ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("repeat", 0, ht.TPositiveInt)
    ]
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243


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"
1244
  OP_DSC_FIELD = "allocator"
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
  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))),
1262
    ]
Iustin Pop's avatar
Iustin Pop committed
1263

1264

1265
1266
1267
1268
1269
class OpTestJobqueue(OpCode):
  """Utility opcode to test some aspects of the job queue.

  """
  OP_ID = "OP_TEST_JQUEUE"
1270
1271
1272
1273
1274
  OP_PARAMS = [
    ("notify_waitlock", False, ht.TBool),
    ("notify_exec", False, ht.TBool),
    ("log_messages", ht.EmptyList, ht.TListOf(ht.TString)),
    ("fail", False, ht.TBool),
1275
1276
1277
    ]


1278
1279
1280
1281
1282
class OpTestDummy(OpCode):
  """Utility opcode used by unittests.

  """
  OP_ID = "OP_TEST_DUMMY"
1283
1284
1285
1286
  OP_PARAMS = [
    ("result", ht.NoDefault, ht.NoType),
    ("messages", ht.NoDefault, ht.NoType),
    ("fail", ht.NoDefault, ht.NoType),
1287
    ]
1288
  WITH_LU = False
1289
1290


Michael Hanselmann's avatar
Michael Hanselmann committed
1291
1292
1293
1294
1295
1296
1297
1298
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
1299
              hasattr(v, "OP_ID") and v is not OpCode)]
Michael Hanselmann's avatar
Michael Hanselmann committed
1300
1301
1302


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