opcodes.py 38 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""OpCodes module

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

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

"""

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

36
import logging
37
import re
38

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


# Common opcode attributes

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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
156
157
158
159
160
161
162
163
164
165

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
166
167
168
169
170
171
172
173

    op_id = _NameToId(name)
    if "OP_ID" in attrs:
      assert attrs["OP_ID"] == op_id, ("Class '%s' defining wrong OP_ID"
                                       " attribute %s, should be %s" %
                                       (name, attrs["OP_ID"], op_id))

    attrs["OP_ID"] = op_id
174
175
176
177
178
179
180
181
182
183
184
185
186
187

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

188

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

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

195
  """
196
197
198
  __metaclass__ = _AutoOpParamSlots

  OP_ID = None
Iustin Pop's avatar
Iustin Pop committed
199
200

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

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

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

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

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

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

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

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

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

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

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

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

273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
  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)

310

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

  """
331
  OP_ID = "OP_CODE"
332
  WITH_LU = True
333
334
335
336
337
338
  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)),
    ]
339
340
341
342

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

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

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

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

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

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

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

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

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

Iustin Pop's avatar
Iustin Pop committed
405

406
407
# cluster opcodes

408
class OpClusterPostInit(OpCode):
409
410
411
412
413
414
415
416
417
  """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"


418
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
419
420
421
422
423
424
  """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
425
426
427
  OP_ID = "OP_CLUSTER_DESTROY"


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


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

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

  """
Iustin Pop's avatar
Iustin Pop committed
443
  OP_ID = "OP_CLUSTER_VERIFY"
444
445
446
447
448
449
450
  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
451
452


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

  Parameters: none

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

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

  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"


477
class OpClusterRepairDiskSizes(OpCode):
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
  """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"
494
495
496
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
497
498


499
class OpClusterConfigQuery(OpCode):
500
501
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
502
503
504
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
505
506


507
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
508
509
510
511
512
513
514
515
  """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.

  """
516
  OP_ID = "OP_CLUSTER_RENAME"
517
  OP_DSC_FIELD = "name"
518
519
520
  OP_PARAMS = [
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ]
521
522


523
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
524
525
526
527
528
529
  """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.

  """
530
  OP_ID = "OP_CLUSTER_SET_PARAMS"
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
  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)),
565
    ]
566
567


568
class OpClusterRedistConf(OpCode):
569
570
571
572
573
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"

Michael Hanselmann's avatar
Michael Hanselmann committed
574
575
576
577
578
579
580
581
582
583

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"
584
585
586
587
588
  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
589
590
591
592
593
594
595
596
597
598
599
    ]


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"
600
601
602
  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
603
604
605
    ]


606
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
607
  """Interact with OOB."""
608
  OP_ID = "OP_OOB_COMMAND"
609
610
611
612
  OP_PARAMS = [
    _PNodeName,
    ("command", None, ht.TElemOf(constants.OOB_COMMANDS)),
    ("timeout", constants.OOB_TIMEOUT, ht.TInt),
René Nussbaumer's avatar
René Nussbaumer committed
613
614
615
    ]


616
617
# node opcodes

618
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
619
620
621
622
623
624
625
  """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
626
  OP_ID = "OP_NODE_REMOVE"
627
  OP_DSC_FIELD = "node_name"
628
629
630
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
631
632


Iustin Pop's avatar
Iustin Pop committed
633
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
  """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.
653
654
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
655
656
657
658
  @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
659
660

  """
Iustin Pop's avatar
Iustin Pop committed
661
  OP_ID = "OP_NODE_ADD"
662
  OP_DSC_FIELD = "node_name"
663
664
665
666
667
668
669
670
671
672
  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
673
674


675
class OpNodeQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
676
677
  """Compute the list of nodes."""
  OP_ID = "OP_NODE_QUERY"
678
679
680
681
682
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
683
684


685
class OpNodeQueryvols(OpCode):
686
687
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
688
689
690
691
  OP_PARAMS = [
    _POutputFields,
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
692
693


694
class OpNodeQueryStorage(OpCode):
695
696
  """Get information on storage for node(s)."""
  OP_ID = "OP_NODE_QUERY_STORAGE"
697
698
699
700
701
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("name", None, ht.TMaybeString),
702
703
704
    ]


705
class OpNodeModifyStorage(OpCode):
706
  """Modifies the properies of a storage unit"""
707
  OP_ID = "OP_NODE_MODIFY_STORAGE"
708
709
710
711
712
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ("changes", ht.NoDefault, ht.TDict),
713
714
715
    ]


716
717
718
719
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_ID = "OP_REPAIR_NODE_STORAGE"
  OP_DSC_FIELD = "node_name"
720
721
722
723
724
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
    ("name", ht.NoDefault, ht.TNonEmptyString),
    ("ignore_consistency", False, ht.TBool),
725
726
727
    ]


728
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
729
730
731
  """Change the parameters of a node."""
  OP_ID = "OP_NODE_SET_PARAMS"
  OP_DSC_FIELD = "node_name"
732
733
734
735
736
737
738
739
740
741
742
743
  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
744
745
    ]

Iustin Pop's avatar
Iustin Pop committed
746

747
class OpNodePowercycle(OpCode):
Iustin Pop's avatar
Iustin Pop committed
748
749
750
  """Tries to powercycle a node."""
  OP_ID = "OP_NODE_POWERCYCLE"
  OP_DSC_FIELD = "node_name"
751
752
753
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
754
755
    ]

756

757
class OpNodeMigrate(OpCode):
758
759
760
  """Migrate all instances from a node."""
  OP_ID = "OP_NODE_MIGRATE"
  OP_DSC_FIELD = "node_name"
761
762
763
764
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
765
766
767
    ]


768
class OpNodeEvacStrategy(OpCode):
769
770
771
  """Compute the evacuation strategy for a list of nodes."""
  OP_ID = "OP_NODE_EVAC_STRATEGY"
  OP_DSC_FIELD = "nodes"
772
773
774
775
776
  OP_PARAMS = [
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ("remote_node", None, ht.TMaybeString),
    ("iallocator", None, ht.TMaybeString),
    ]
777
778


Iustin Pop's avatar
Iustin Pop committed
779
780
# instance opcodes

781
class OpInstanceCreate(OpCode):
782
783
784
785
786
787
788
  """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)
789
790
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
791
792

  """
Iustin Pop's avatar
Iustin Pop committed
793
  OP_ID = "OP_INSTANCE_CREATE"
794
  OP_DSC_FIELD = "instance_name"
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
  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),
825
    ]
Iustin Pop's avatar
Iustin Pop committed
826
827


828
class OpInstanceReinstall(OpCode):
Iustin Pop's avatar
Iustin Pop committed
829
  """Reinstall an instance's OS."""
830
  OP_ID = "OP_INSTANCE_REINSTALL"
831
  OP_DSC_FIELD = "instance_name"
832
833
834
835
836
837
  OP_PARAMS = [
    _PInstanceName,
    ("os_type", None, ht.TMaybeString),
    ("force_variant", False, ht.TBool),
    ("osparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ]
838
839


840
class OpInstanceRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
841
842
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
843
  OP_DSC_FIELD = "instance_name"
844
845
846
847
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_failures", False, ht.TBool),
848
    ]
Iustin Pop's avatar
Iustin Pop committed
849
850


851
class OpInstanceRename(OpCode):
852
853
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
854
855
856
857
858
  OP_PARAMS = [
    _PInstanceName,
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ("ip_check", False, ht.TBool),
    ("name_check", True, ht.TBool),
859
    ]
860
861


862
class OpInstanceStartup(OpCode):
Iustin Pop's avatar
Iustin Pop committed
863
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
864
  OP_ID = "OP_INSTANCE_STARTUP"
865
  OP_DSC_FIELD = "instance_name"
866
867
868
869
870
871
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
    ("hvparams", ht.EmptyDict, ht.TDict),
    ("beparams", ht.EmptyDict, ht.TDict),
872
    ]
Iustin Pop's avatar
Iustin Pop committed
873
874


875
class OpInstanceShutdown(OpCode):
Iustin Pop's avatar
Iustin Pop committed
876
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
877
  OP_ID = "OP_INSTANCE_SHUTDOWN"
878
  OP_DSC_FIELD = "instance_name"
879
880
881
882
  OP_PARAMS = [
    _PInstanceName,
    _PIgnoreOfflineNodes,
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt),
883
    ]
Iustin Pop's avatar
Iustin Pop committed
884
885


886
class OpInstanceReboot(OpCode):
887
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
888
  OP_ID = "OP_INSTANCE_REBOOT"
889
  OP_DSC_FIELD = "instance_name"
890
891
892
893
894
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_secondaries", False, ht.TBool),
    ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES)),
895
    ]
896
897


898
class OpInstanceReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
899
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
900
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
901
  OP_DSC_FIELD = "instance_name"
902
903
904
905
906
907
908
  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),
909
    ]
Iustin Pop's avatar
Iustin Pop committed
910
911


912
class OpInstanceFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
913
914
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
915
  OP_DSC_FIELD = "instance_name"
916
917
918
919
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("ignore_consistency", False, ht.TBool),
920
    ]
Iustin Pop's avatar
Iustin Pop committed
921
922


923
class OpInstanceMigrate(OpCode):
924
925
926
927
928
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
929
  @ivar instance_name: the name of the instance
930
  @ivar mode: the migration mode (live, non-live or None for auto)
931
932
933

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
934
  OP_DSC_FIELD = "instance_name"
935
936
937
938
939
940
  OP_PARAMS = [
    _PInstanceName,
    _PMigrationMode,
    _PMigrationLive,
    ("cleanup", False, ht.TBool),
    ]
941
942


943
class OpInstanceMove(OpCode):
944
945
946
947
948
949
950
951
952
953
954
  """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"
955
956
957
958
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
    ("target_node", ht.NoDefault, ht.TNonEmptyString),
Balazs Lecz's avatar
Balazs Lecz committed
959
    ]
960
961


962
class OpInstanceConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
963
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
964
  OP_ID = "OP_INSTANCE_CONSOLE"
965
  OP_DSC_FIELD = "instance_name"
966
967
968
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
969
970


971
class OpInstanceActivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
972
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
973
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
974
  OP_DSC_FIELD = "instance_name"
975
976
977
978
  OP_PARAMS = [
    _PInstanceName,
    ("ignore_size", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
979
980


981
class OpInstanceDeactivateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
982
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
983
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
984
  OP_DSC_FIELD = "instance_name"
985
986
987
  OP_PARAMS = [
    _PInstanceName
    ]
Iustin Pop's avatar
Iustin Pop committed
988
989


990
class OpInstanceRecreateDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
991
992
993
  """Deactivate an instance's disks."""
  OP_ID = "OP_INSTANCE_RECREATE_DISKS"
  OP_DSC_FIELD = "instance_name"
994
995
996
997
  OP_PARAMS = [
    _PInstanceName,
    ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt)),
    ]
Iustin Pop's avatar
Iustin Pop committed
998
999


1000
class OpInstanceQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1001
1002
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
1003
1004
1005
1006
1007
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
1008
1009


1010
class OpInstanceQueryData(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1011
1012
  """Compute the run-time status of instances."""
  OP_ID = "OP_INSTANCE_QUERY_DATA"
1013
1014
1015
1016
  OP_PARAMS = [
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("static", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
1017
1018


1019
class OpInstanceSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1020
  """Change the parameters of an instance."""
1021
  OP_ID = "OP_INSTANCE_SET_PARAMS"
1022
  OP_DSC_FIELD = "instance_name"
1023
1024
1025
1026
1027
1028
1029
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    ("nics", ht.EmptyList, ht.TList),
    ("disks", ht.EmptyList, ht.TList),
    ("beparams", ht.EmptyDict, ht.TDict),
    ("hvparams", ht.EmptyDict, ht.TDict),
1030
    ("disk_template", None, ht.TOr(ht.TNone, _CheckDiskTemplate)),
1031
1032
1033
1034
    ("remote_node", None, ht.TMaybeString),
    ("os_name", None, ht.TMaybeString),
    ("force_variant", False, ht.TBool),
    ("osparams", None, ht.TOr(ht.TDict, ht.TNone)),
1035
    ]
Iustin Pop's avatar
Iustin Pop committed
1036
1037


Iustin Pop's avatar
Iustin Pop committed
1038
class OpInstanceGrowDisk(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1039
1040
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
1041
  OP_DSC_FIELD = "instance_name"
1042
1043
1044
1045
1046
  OP_PARAMS = [
    _PInstanceName,
    ("disk", ht.NoDefault, ht.TInt),
    ("amount", ht.NoDefault, ht.TInt),
    ("wait_for_sync", True, ht.TBool),
1047
    ]
Iustin Pop's avatar
Iustin Pop committed
1048
1049


1050
1051
# Node group opcodes

Iustin Pop's avatar
Iustin Pop committed
1052
class OpGroupAdd(OpCode):
1053
1054
1055
  """Add a node group to the cluster."""
  OP_ID = "OP_GROUP_ADD"
  OP_DSC_FIELD = "group_name"
1056
1057
1058
1059
1060
  OP_PARAMS = [
    _PGroupName,
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("alloc_policy", None,
     ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1061
    ]
1062
1063


1064
class OpGroupAssignNodes(OpCode):
1065
  """Assign nodes to a node group."""
1066
  OP_ID = "OP_GROUP_ASSIGN_NODES"
1067
1068
1069
1070
1071
1072
1073
1074
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    _PForce,
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString)),
    ]


1075
class OpGroupQuery(OpCode):
1076
1077
  """Compute the list of node groups."""
  OP_ID = "OP_GROUP_QUERY"
1078
1079
1080
1081
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
1082
1083


1084
class OpGroupSetParams(OpCode):
1085
1086
1087
  """Change the parameters of a node group."""
  OP_ID = "OP_GROUP_SET_PARAMS"
  OP_DSC_FIELD = "group_name"
1088
1089
1090
1091
1092
  OP_PARAMS = [
    _PGroupName,
    ("ndparams", None, ht.TOr(ht.TDict, ht.TNone)),
    ("alloc_policy", None, ht.TOr(ht.TNone,
                                  ht.TElemOf(constants.VALID_ALLOC_POLICIES))),
1093
1094
1095
    ]


1096
class OpGroupRemove(OpCode):
1097
1098
1099
  """Remove a node group from the cluster."""
  OP_ID = "OP_GROUP_REMOVE"
  OP_DSC_FIELD = "group_name"
1100
1101
1102
  OP_PARAMS = [
    _PGroupName,
    ]
1103
1104


1105
class OpGroupRename(OpCode):
1106
1107
1108
  """Rename a node group in the cluster."""
  OP_ID = "OP_GROUP_RENAME"
  OP_DSC_FIELD = "old_name"
1109
1110
1111
1112
  OP_PARAMS = [
    ("old_name", ht.NoDefault, ht.TNonEmptyString),
    ("new_name", ht.NoDefault, ht.TNonEmptyString),
    ]
1113
1114


Iustin Pop's avatar
Iustin Pop committed
1115
# OS opcodes
1116
class OpOsDiagnose(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1117
1118
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
1119
1120
1121
1122
  OP_PARAMS = [
    _POutputFields,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ]
Iustin Pop's avatar
Iustin Pop committed
1123

1124

Iustin Pop's avatar
Iustin Pop committed
1125
# Exports opcodes
1126
class OpBackupQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1127
1128
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
1129
1130
1131
1132
  OP_PARAMS = [
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("use_locking", False, ht.TBool),
    ]
Iustin Pop's avatar
Iustin Pop committed
1133

1134

1135
class OpBackupPrepare(OpCode):
1136
1137
1138
1139
1140
1141
1142
1143
  """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"
1144
1145
1146
  OP_PARAMS = [
    _PInstanceName,
    ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES)),
1147
1148
1149
    ]


1150
class OpBackupExport(OpCode):
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
  """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
1166
  OP_ID = "OP_BACKUP_EXPORT"
1167
  OP_DSC_FIELD = "instance_name"
1168
1169
1170
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1171
1172
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
1173
1174
1175
1176
1177
1178
1179
    ("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),
1180
    ]
1181

Michael Hanselmann's avatar
Michael Hanselmann committed
1182

1183
class OpBackupRemove(OpCode):
1184
1185
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
1186
  OP_DSC_FIELD = "instance_name"
1187
1188
1189
  OP_PARAMS = [
    _PInstanceName,
    ]
1190

Michael Hanselmann's avatar
Michael Hanselmann committed
1191

1192
# Tags opcodes
Iustin Pop's avatar
Iustin Pop committed
1193
class OpTagsGet(OpCode):
1194
1195
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
1196
  OP_DSC_FIELD = "name"
1197
1198
1199
1200
1201
  OP_PARAMS = [
    _PTagKind,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1202
1203


1204
class OpTagsSearch(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1205
1206
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
1207
  OP_DSC_FIELD = "pattern"
1208
1209
1210
  OP_PARAMS = [
    ("pattern", ht.NoDefault, ht.TNonEmptyString),
    ]
Iustin Pop's avatar
Iustin Pop committed
1211
1212


Iustin Pop's avatar
Iustin Pop committed
1213
class OpTagsSet(OpCode):
1214
  """Add a list of tags on a given object."""
1215
  OP_ID = "OP_TAGS_SET"
1216
1217
1218
1219
1220
1221
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1222
1223


Iustin Pop's avatar
Iustin Pop committed
1224
class OpTagsDel(OpCode):
1225
  """Remove a list of tags from a given object."""
1226
  OP_ID = "OP_TAGS_DEL"
1227
1228
1229
1230
1231
1232
  OP_PARAMS = [
    _PTagKind,
    _PTags,
    # Name is only meaningful for nodes and instances
    ("name", ht.NoDefault, ht.TMaybeString),
    ]
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256

# 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"
1257
  OP_DSC_FIELD = "duration"
1258
1259
1260
1261
1262
1263
  OP_PARAMS = [
    ("duration", ht.NoDefault, ht.TFloat),
    ("on_master", True, ht.TBool),
    ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString)),
    ("repeat", 0, ht.TPositiveInt)
    ]
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277


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"
1278
  OP_DSC_FIELD = "allocator"
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
  OP_PARAMS = [
    ("direction", ht.NoDefault,
     ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS)),
    ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES)),