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

Iustin Pop's avatar
Iustin Pop committed
39
from ganeti import compat
40
41
42
43
44
45
46
47
from ganeti import constants
from ganeti import errors
from ganeti import ht


# Common opcode attributes

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

#: the shutdown timeout
52
53
54
_PShutdownTimeout = \
  ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
   "How long to wait for instance to shut down")
55
56

#: the force parameter
57
_PForce = ("force", False, ht.TBool, "Whether to force the operation")
58
59

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

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

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

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

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

#: Obsolete 'live' migration mode (boolean)
79
80
_PMigrationLive = ("live", None, ht.TMaybeBool,
                   "Legacy setting for live migration, do not use")
81
82

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

#: List of tag strings
86
_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString), None)
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
_PForceVariant = ("force_variant", False, ht.TBool,
                  "Whether to force an unknown OS variant")

_PWaitForSync = ("wait_for_sync", True, ht.TBool,
                 "Whether to wait for the disk to synchronize")

_PIgnoreConsistency = ("ignore_consistency", False, ht.TBool,
                       "Whether to ignore disk consistency")

_PStorageName = ("name", ht.NoDefault, ht.TMaybeString, "Storage name")

_PUseLocking = ("use_locking", False, ht.TBool,
                "Whether to use synchronization")

_PNameCheck = ("name_check", True, ht.TBool, "Whether to check name")

_PNodeGroupAllocPolicy = \
  ("alloc_policy", None,
   ht.TOr(ht.TNone, ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
   "Instance allocation policy")

_PGroupNodeParams = ("ndparams", None, ht.TMaybeDict,
                     "Default node parameters for group")

112
_PQueryWhat = ("what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP),
113
114
               "Resource(s) to query for")

115
116
117
_PEarlyRelease = ("early_release", False, ht.TBool,
                  "Whether to release locks as soon as possible")

118
119
_PIpCheckDoc = "Whether to ensure instance's IP address is inactive"

120
#: Do not remember instance state changes
121
122
_PNoRemember = ("no_remember", False, ht.TBool,
                "Do not remember the state change")
123

Michael Hanselmann's avatar
Michael Hanselmann committed
124
125
126
127
#: Target node for instance migration/failover
_PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
                         "Target node for shared-storage instances")

128
129
130
_PStartupPaused = ("startup_paused", False, ht.TBool,
                   "Pause instance at startup")

131
132
133
134
135
136
137
138
139
_PVerbose = ("verbose", False, ht.TBool, "Verbose mode")

# Parameters for cluster verification
_PDebugSimulateErrors = ("debug_simulate_errors", False, ht.TBool,
                         "Whether to simulate errors (useful for debugging)")
_PErrorCodes = ("error_codes", False, ht.TBool, "Error codes")
_PSkipChecks = ("skip_checks", ht.EmptyList,
                ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)),
                "Which checks to skip")
140

141
142
143
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")

144
145
146
#: Utility function for L{OpClusterSetParams}
_TestClusterOsList = ht.TOr(ht.TNone,
  ht.TListOf(ht.TAnd(ht.TList, ht.TIsLength(2),
Iustin Pop's avatar
Iustin Pop committed
147
    ht.TMap(ht.WithDesc("GetFirstItem")(compat.fst),
148
149
            ht.TElemOf(constants.DDMS_VALUES)))))

150

151
152
153
154
155
# TODO: Generate check from constants.INIC_PARAMS_TYPES
#: Utility function for testing NIC definitions
_TestNicDef = ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
                         ht.TOr(ht.TNone, ht.TNonEmptyString))

156
157
158
159
160
161
162
163
164
_TSetParamsResultItemItems = [
  ht.Comment("name of changed parameter")(ht.TNonEmptyString),
  ht.TAny,
  ]

_TSetParamsResult = \
  ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)),
                     ht.TItems(_TSetParamsResultItemItems)))

165
166
167
168
169
170
171
_SUMMARY_PREFIX = {
  "CLUSTER_": "C_",
  "GROUP_": "G_",
  "NODE_": "N_",
  "INSTANCE_": "I_",
  }

Michael Hanselmann's avatar
Michael Hanselmann committed
172
173
174
#: Attribute name for dependencies
DEPEND_ATTR = "depends"

175
176
177
#: Attribute name for comment
COMMENT_ATTR = "comment"

178

179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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)

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

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)


214
215
216
217
218
219
220
221
222
223
224
225
226
227
def RequireSharedFileStorage():
  """Checks that shared 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 shared file storage is disabled

  """
  if not constants.ENABLE_SHARED_FILE_STORAGE:
    raise errors.OpPrereqError("Shared file storage disabled at"
                               " configure time", errors.ECODE_INVAL)


228
229
230
@ht.WithDesc("CheckFileStorage")
def _CheckFileStorage(value):
  """Ensures file storage is enabled if used.
231
232

  """
233
  if value == constants.DT_FILE:
234
    RequireFileStorage()
235
236
  elif value == constants.DT_SHARED_FILE:
    RequireSharedFileStorage()
237
238
239
  return True


240
241
242
243
_CheckDiskTemplate = ht.TAnd(ht.TElemOf(constants.DISK_TEMPLATES),
                             _CheckFileStorage)


244
245
246
247
248
249
250
251
252
253
254
255
256
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
257
258
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
                 "Storage type")
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276


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

279
    attrs["OP_ID"] = _NameToId(name)
280
281
282
283
284

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

    # Use parameter names as slots
285
    slots = [pname for (pname, _, _, _) in params]
286
287
288
289
290
291
292
293

    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)

294

Iustin Pop's avatar
Iustin Pop committed
295
class BaseOpCode(object):
296
297
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
298
299
300
  This object serves as a parent class for OpCode without any custom
  field handling.

301
  """
302
303
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
304
305
  __metaclass__ = _AutoOpParamSlots

Iustin Pop's avatar
Iustin Pop committed
306
  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
307
308
309
310
311
312
313
314
    """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.

    """
315
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
316
    for key in kwargs:
317
      if key not in slots:
318
        raise TypeError("Object %s doesn't support the parameter '%s'" %
319
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
320
321
      setattr(self, key, kwargs[key])

322
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
323
324
325
326
327
328
329
330
331
    """Generic serializer.

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

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

    """
332
    state = {}
333
    for name in self._all_slots():
334
335
336
337
338
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
339
340
341
342
343
344
345
346
347
    """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}

    """
348
349
350
351
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

352
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
353
      if name not in state and hasattr(self, name):
354
355
356
357
358
        delattr(self, name)

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

359
360
361
362
363
364
365
366
367
368
  @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

369
370
371
372
373
374
375
376
377
378
  @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

379
380
381
382
383
384
385
386
387
  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

    """
388
    for (attr_name, default, test, _) in self.GetAllParams():
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
      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)

416

417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
def _BuildJobDepCheck(relative):
  """Builds check for job dependencies (L{DEPEND_ATTR}).

  @type relative: bool
  @param relative: Whether to accept relative job IDs (negative)
  @rtype: callable

  """
  if relative:
    job_id = ht.TOr(ht.TJobId, ht.TRelativeJobId)
  else:
    job_id = ht.TJobId

  job_dep = \
    ht.TAnd(ht.TIsLength(2),
            ht.TItems([job_id,
                       ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))]))

  return ht.TOr(ht.TNone, ht.TListOf(job_dep))


TNoRelativeJobDependencies = _BuildJobDepCheck(False)

440
#: List of submission status and job ID as returned by C{SubmitManyJobs}
441
442
443
444
445
446
447
_TJobIdListItem = \
  ht.TAnd(ht.TIsLength(2),
          ht.TItems([ht.Comment("success")(ht.TBool),
                     ht.Comment("Job ID if successful, error message"
                                " otherwise")(ht.TOr(ht.TString,
                                                     ht.TJobId))]))
TJobIdList = ht.TListOf(_TJobIdListItem)
448

449
450
#: Result containing only list of submitted jobs
TJobIdListOnly = ht.TStrictDict(True, True, {
451
  constants.JOB_IDS_KEY: ht.Comment("List of submitted jobs")(TJobIdList),
452
453
  })

454

Iustin Pop's avatar
Iustin Pop committed
455
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
456
457
458
459
460
461
  """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
462
               children of this class.
463
464
465
  @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).
466
467
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
468
  @cvar OP_RESULT: Callable to verify opcode result
469
470
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
471
472
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
473
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
474
475

  """
476
477
  # pylint: disable-msg=E1101
  # as OP_ID is dynamically defined
478
  WITH_LU = True
479
  OP_PARAMS = [
480
481
    ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
    ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt), "Debug level"),
482
    ("priority", constants.OP_PRIO_DEFAULT,
483
     ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
484
485
486
    (DEPEND_ATTR, None, _BuildJobDepCheck(True),
     "Job dependencies; if used through ``SubmitManyJobs`` relative (negative)"
     " job IDs can be used"),
487
488
    (COMMENT_ATTR, None, ht.TMaybeString,
     "Comment describing the purpose of the opcode"),
489
    ]
490
  OP_RESULT = None
491
492
493
494

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

Iustin Pop's avatar
Iustin Pop committed
495
496
497
498
499
500
501
    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

502
    """
Iustin Pop's avatar
Iustin Pop committed
503
    data = BaseOpCode.__getstate__(self)
504
505
506
507
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
508
  def LoadOpCode(cls, data):
509
510
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
511
512
513
514
515
516
517
    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

518
519
520
521
522
523
524
    """
    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
525
526
527
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
528
529
530
531
532
533
534
535
      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

536
537
538
  def Summary(self):
    """Generates a summary description of this opcode.

539
540
541
542
543
    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).
544

545
    """
546
    assert self.OP_ID is not None and len(self.OP_ID) > 3
547
548
549
550
551
    # 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)
552
553
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
554
555
556
      txt = "%s(%s)" % (txt, field_value)
    return txt

557
558
559
560
561
562
563
564
565
566
567
568
569
570
  def TinySummary(self):
    """Generates a compact summary description of the opcode.

    """
    assert self.OP_ID.startswith("OP_")

    text = self.OP_ID[3:]

    for (prefix, supplement) in _SUMMARY_PREFIX.items():
      if text.startswith(prefix):
        return supplement + text[len(prefix):]

    return text

Iustin Pop's avatar
Iustin Pop committed
571

572
573
# cluster opcodes

574
class OpClusterPostInit(OpCode):
575
576
577
578
579
580
581
582
  """Post cluster initialization.

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

  """


583
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
584
585
586
587
588
589
  """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
590
591


592
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
593
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
594
595


596
597
598
599
600
601
602
603
604
605
606
class OpClusterVerify(OpCode):
  """Submits all jobs necessary to verify the cluster.

  """
  OP_PARAMS = [
    _PDebugSimulateErrors,
    _PErrorCodes,
    _PSkipChecks,
    _PVerbose,
    ("group_name", None, ht.TMaybeString, "Group to verify")
    ]
607
  OP_RESULT = TJobIdListOnly
608
609


610
611
612
613
614
class OpClusterVerifyConfig(OpCode):
  """Verify the cluster config.

  """
  OP_PARAMS = [
615
616
617
    _PDebugSimulateErrors,
    _PErrorCodes,
    _PVerbose,
618
    ]
619
  OP_RESULT = ht.TBool
620
621
622
623


class OpClusterVerifyGroup(OpCode):
  """Run verify on a node group from the cluster.
Iustin Pop's avatar
Iustin Pop committed
624
625
626
627
628
629
630
631

  @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

  """
632
  OP_DSC_FIELD = "group_name"
633
  OP_PARAMS = [
634
635
636
637
638
    _PGroupName,
    _PDebugSimulateErrors,
    _PErrorCodes,
    _PSkipChecks,
    _PVerbose,
639
    ]
640
  OP_RESULT = ht.TBool
Iustin Pop's avatar
Iustin Pop committed
641
642


643
class OpClusterVerifyDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
644
645
  """Verify the cluster disks.

646
  """
647
  OP_RESULT = TJobIdListOnly
648
649
650
651


class OpGroupVerifyDisks(OpCode):
  """Verifies the status of all disks in a node group.
Iustin Pop's avatar
Iustin Pop committed
652

653
654
  Result: a tuple of three elements:
    - dict of node names with issues (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
655
    - list of instances with degraded disks (that should be activated)
656
657
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
658

659
660
661
662
  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
663
664
665
666
667

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

  """
668
669
670
671
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    ]
672
673
674
675
676
  OP_RESULT = \
    ht.TAnd(ht.TIsLength(3),
            ht.TItems([ht.TDictOf(ht.TString, ht.TString),
                       ht.TListOf(ht.TString),
                       ht.TDictOf(ht.TString, ht.TListOf(ht.TString))]))
Iustin Pop's avatar
Iustin Pop committed
677
678


679
class OpClusterRepairDiskSizes(OpCode):
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
  """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

  """
695
  OP_PARAMS = [
696
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
697
    ]
698
699


700
class OpClusterConfigQuery(OpCode):
701
  """Query cluster configuration values."""
702
703
704
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
705
706


707
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
708
709
710
711
712
713
714
715
  """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.

  """
716
  OP_DSC_FIELD = "name"
717
  OP_PARAMS = [
718
    ("name", ht.NoDefault, ht.TNonEmptyString, None),
719
    ]
720
721


722
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
723
724
725
726
727
728
  """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.

  """
729
  OP_PARAMS = [
730
    ("vg_name", None, ht.TMaybeString, "Volume group name"),
731
732
    ("enabled_hypervisors", None,
     ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
733
734
            ht.TNone),
     "List of enabled hypervisors"),
735
    ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
736
737
738
739
                              ht.TNone),
     "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
    ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
     "Cluster-wide backend parameter defaults"),
740
    ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
741
742
                            ht.TNone),
     "Cluster-wide per-OS hypervisor parameter defaults"),
743
    ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
744
745
                              ht.TNone),
     "Cluster-wide OS parameter defaults"),
746
    ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone),
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
     "Master candidate pool size"),
    ("uid_pool", None, ht.NoType,
     "Set UID pool, must be list of lists describing UID ranges (two items,"
     " start and end inclusive)"),
    ("add_uids", None, ht.NoType,
     "Extend UID pool, must be list of lists describing UID ranges (two"
     " items, start and end inclusive) to be added"),
    ("remove_uids", None, ht.NoType,
     "Shrink UID pool, must be list of lists describing UID ranges (two"
     " items, start and end inclusive) to be removed"),
    ("maintain_node_health", None, ht.TMaybeBool,
     "Whether to automatically maintain node health"),
    ("prealloc_wipe_disks", None, ht.TMaybeBool,
     "Whether to wipe disks before allocating them to instances"),
    ("nicparams", None, ht.TMaybeDict, "Cluster-wide NIC parameter defaults"),
    ("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"),
    ("drbd_helper", None, ht.TOr(ht.TString, ht.TNone), "DRBD helper program"),
    ("default_iallocator", None, ht.TOr(ht.TString, ht.TNone),
     "Default iallocator for cluster"),
    ("master_netdev", None, ht.TOr(ht.TString, ht.TNone),
     "Master network device"),
    ("reserved_lvs", None, ht.TOr(ht.TListOf(ht.TNonEmptyString), ht.TNone),
     "List of reserved LVs"),
    ("hidden_os", None, _TestClusterOsList,
     "Modify list of hidden operating systems. Each modification must have"
     " two items, the operation and the OS name. The operation can be"
     " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
    ("blacklisted_os", None, _TestClusterOsList,
     "Modify list of blacklisted operating systems. Each modification must have"
     " two items, the operation and the OS name. The operation can be"
     " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
778
    ]
779
780


781
class OpClusterRedistConf(OpCode):
782
783
784
785
  """Force a full push of the cluster configuration.

  """

Michael Hanselmann's avatar
Michael Hanselmann committed
786
787
788
789

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

790
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
791
792
793
794
  @ivar fields: List of fields to retrieve
  @ivar filter: Query filter

  """
795
  OP_DSC_FIELD = "what"
796
  OP_PARAMS = [
797
    _PQueryWhat,
798
    _PUseLocking,
799
800
    ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
     "Requested fields"),
801
    ("filter", None, ht.TOr(ht.TNone, ht.TListOf),
802
     "Query filter"),
Michael Hanselmann's avatar
Michael Hanselmann committed
803
804
805
806
807
808
    ]


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

809
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
810
811
812
  @ivar fields: List of fields to retrieve

  """
813
  OP_DSC_FIELD = "what"
814
  OP_PARAMS = [
815
816
817
    _PQueryWhat,
    ("fields", None, ht.TOr(ht.TNone, ht.TListOf(ht.TNonEmptyString)),
     "Requested fields; if not given, all are returned"),
Michael Hanselmann's avatar
Michael Hanselmann committed
818
819
820
    ]


821
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
822
  """Interact with OOB."""
823
  OP_PARAMS = [
824
825
826
827
828
829
830
831
    ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "List of nodes to run the OOB command against"),
    ("command", None, ht.TElemOf(constants.OOB_COMMANDS),
     "OOB command to be run"),
    ("timeout", constants.OOB_TIMEOUT, ht.TInt,
     "Timeout before the OOB helper will be terminated"),
    ("ignore_status", False, ht.TBool,
     "Ignores the node offline status for power off"),
832
833
    ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat,
     "Time in seconds to wait between powering on nodes"),
René Nussbaumer's avatar
René Nussbaumer committed
834
835
836
    ]


837
838
# node opcodes

839
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
840
841
842
843
844
845
846
  """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.

  """
847
  OP_DSC_FIELD = "node_name"
848
849
850
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
851
852


Iustin Pop's avatar
Iustin Pop committed
853
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
  """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.
873
874
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
875
876
877
878
  @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
879
880

  """
881
  OP_DSC_FIELD = "node_name"
882
883
  OP_PARAMS = [
    _PNodeName,
884
885
886
887
888
889
890
891
892
    ("primary_ip", None, ht.NoType, "Primary IP address"),
    ("secondary_ip", None, ht.TMaybeString, "Secondary IP address"),
    ("readd", False, ht.TBool, "Whether node is re-added to cluster"),
    ("group", None, ht.TMaybeString, "Initial node group"),
    ("master_capable", None, ht.TMaybeBool,
     "Whether node can become master or master candidate"),
    ("vm_capable", None, ht.TMaybeBool,
     "Whether node can host instances"),
    ("ndparams", None, ht.TMaybeDict, "Node parameters"),
893
    ]
Iustin Pop's avatar
Iustin Pop committed
894
895


896
class OpNodeQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
897
  """Compute the list of nodes."""
898
899
  OP_PARAMS = [
    _POutputFields,
900
901
902
    _PUseLocking,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
903
    ]
Iustin Pop's avatar
Iustin Pop committed
904
905


906
class OpNodeQueryvols(OpCode):
907
  """Get list of volumes on node."""
908
909
  OP_PARAMS = [
    _POutputFields,
910
911
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
912
    ]
913
914


915
class OpNodeQueryStorage(OpCode):
916
  """Get information on storage for node(s)."""
917
918
919
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
920
921
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
    ("name", None, ht.TMaybeString, "Storage name"),
922
923
924
    ]


925
class OpNodeModifyStorage(OpCode):
926
  """Modifies the properies of a storage unit"""
927
928
929
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
930
931
    _PStorageName,
    ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
932
933
934
    ]


935
936
937
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_DSC_FIELD = "node_name"
938
939
940
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
941
942
    _PStorageName,
    _PIgnoreConsistency,
943
944
945
    ]


946
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
947
948
  """Change the parameters of a node."""
  OP_DSC_FIELD = "node_name"
949
950
951
  OP_PARAMS = [
    _PNodeName,
    _PForce,
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
    ("master_candidate", None, ht.TMaybeBool,
     "Whether the node should become a master candidate"),
    ("offline", None, ht.TMaybeBool,
     "Whether the node should be marked as offline"),
    ("drained", None, ht.TMaybeBool,
     "Whether the node should be marked as drained"),
    ("auto_promote", False, ht.TBool,
     "Whether node(s) should be promoted to master candidate if necessary"),
    ("master_capable", None, ht.TMaybeBool,
     "Denote whether node can become master or master candidate"),
    ("vm_capable", None, ht.TMaybeBool,
     "Denote whether node can host instances"),
    ("secondary_ip", None, ht.TMaybeString,
     "Change node's secondary IP address"),
    ("ndparams", None, ht.TMaybeDict, "Set node parameters"),
    ("powered", None, ht.TMaybeBool,
     "Whether the node should be marked as powered"),
Iustin Pop's avatar
Iustin Pop committed
969
    ]
970
  OP_RESULT = _TSetParamsResult
Iustin Pop's avatar
Iustin Pop committed
971

Iustin Pop's avatar
Iustin Pop committed
972

973
class OpNodePowercycle(OpCode):
Iustin Pop's avatar
Iustin Pop committed
974
975
  """Tries to powercycle a node."""
  OP_DSC_FIELD = "node_name"
976
977
978
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
979
980
    ]

981

982
class OpNodeMigrate(OpCode):
983
984
  """Migrate all instances from a node."""
  OP_DSC_FIELD = "node_name"
985
986
987
988
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
Michael Hanselmann's avatar
Michael Hanselmann committed
989
    _PMigrationTargetNode,
990
991
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
992
993
994
    ]


995
996
997
998
999
1000
1001
1002
1003
1004
1005
class OpNodeEvacuate(OpCode):
  """Evacuate instances off a number of nodes."""
  OP_DSC_FIELD = "node_name"
  OP_PARAMS = [
    _PEarlyRelease,
    _PNodeName,
    ("remote_node", None, ht.TMaybeString, "New secondary node"),
    ("iallocator", None, ht.TMaybeString, "Iallocator for computing solution"),
    ("mode", ht.NoDefault, ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES),
     "Node evacuation mode"),
    ]
1006
  OP_RESULT = TJobIdListOnly
1007
1008


Iustin Pop's avatar
Iustin Pop committed
1009
1010
# instance opcodes

1011
class OpInstanceCreate(OpCode):
1012
1013
1014
1015
1016
1017
1018
  """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)
1019
1020
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
1021
1022

  """
1023
  OP_DSC_FIELD = "instance_name"
1024
1025
  OP_PARAMS = [
    _PInstanceName,
1026
1027
1028
1029
    _PForceVariant,
    _PWaitForSync,
    _PNameCheck,
    ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
    ("disks", ht.NoDefault,
     # TODO: Generate check from constants.IDISK_PARAMS_TYPES
     ht.TListOf(ht.TDictOf(ht.TElemOf(constants.IDISK_PARAMS),
                           ht.TOr(ht.TNonEmptyString, ht.TInt))),
     "Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;"
     " each disk definition must contain a ``%s`` value and"
     " can contain an optional ``%s`` value denoting the disk access mode"
     " (%s)" %
     (constants.IDISK_SIZE, constants.IDISK_SIZE, constants.IDISK_SIZE,
      constants.IDISK_MODE,
      " or ".join("``%s``" % i for i in sorted(constants.DISK_ACCESS_SET)))),
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
    ("disk_template", ht.NoDefault, _CheckDiskTemplate, "Disk template"),
    ("file_driver", None, ht.TOr(ht.TNone, ht.TElemOf(constants.FILE_DRIVER)),
     "Driver for file-backed disks"),
    ("file_storage_dir", None, ht.TMaybeString,
     "Directory for storing file-backed disks"),
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Hypervisor parameters for instance, hypervisor-dependent"),
    ("hypervisor", None, ht.TMaybeString, "Hypervisor"),
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding which node(s) to use"),
    ("identify_defaults", False, ht.TBool,
     "Reset instance parameters to default if equal"),
    ("ip_check", True, ht.TBool, _PIpCheckDoc),
    ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES),
     "Instance creation mode"),
1056
1057
1058
1059
1060
1061
    ("nics", ht.NoDefault, ht.TListOf(_TestNicDef),
     "List of NIC (network interface) definitions, for example"
     " ``[{}, {}, {\"%s\": \"198.51.100.4\"}]``; each NIC definition can"
     " contain the optional values %s" %
     (constants.INIC_IP,
      ", ".join("``%s``" % i for i in sorted(constants.INIC_PARAMS)))),
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
    ("no_install", None, ht.TMaybeBool,
     "Do not install the OS (will disable automatic start)"),
    ("osparams", ht.EmptyDict, ht.TDict, "OS parameters for instance"),
    ("os_type", None, ht.TMaybeString, "Operating system"),
    ("pnode", None, ht.TMaybeString, "Primary node"),
    ("snode", None, ht.TMaybeString, "Secondary node"),
    ("source_handshake", None, ht.TOr(ht.TList, ht.TNone),
     "Signed handshake from source (remote import only)"),
    ("source_instance_name", None, ht.TMaybeString,
     "Source instance name (remote import only)"),
1072
    ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
1073
1074
     ht.TPositiveInt,
     "How long source instance was given to shut down (remote import only)"),
1075
1076
1077
1078
1079
    ("source_x509_ca", None, ht.TMaybeString,
     "Source X509 CA in PEM format (remote import only)"),
    ("src_node", None, ht.TMaybeString, "Source node for import"),
    ("src_path", None, ht.TMaybeString, "Source directory for import"),
    ("start", True, ht.TBool, "Whether to start instance after creation"),
1080
    ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
1081
    ]
1082
  OP_RESULT = ht.Comment("instance nodes")(ht.TListOf(ht.TNonEmptyString))
Iustin Pop's avatar
Iustin Pop committed
1083
1084


1085
class OpInstanceReinstall(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1086
  """Reinstall an instance's OS."""
1087
  OP_DSC_FIELD = "instance_name"
1088
1089
  OP_PARAMS = [
    _PInstanceName,
1090
1091
1092
    _PForceVariant,
    ("os_type", None, ht.TMaybeString, "Instance operating system"),
    ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
1093
    ]
1094
1095


1096
class OpInstanceRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1097
  """Remove an instance."""
1098
  OP_DSC_FIELD = "instance_name"
1099
1100
1101
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1102
1103
    ("ignore_failures", False, ht.TBool,
     "Whether to ignore failures during removal"),
1104
    ]
Iustin Pop's avatar
Iustin Pop committed
1105
1106


1107
class OpInstanceRename(OpCode):
1108
  """Rename an instance."""
1109
1110
  OP_PARAMS = [
    _PInstanceName,
1111
1112
1113
    _PNameCheck,
    ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
    ("ip_check", False, ht.TBool, _PIpCheckDoc),
1114
    ]
1115
  OP_RESULT = ht.Comment("New instance name")(ht.TNonEmptyString)
1116
1117


1118
class OpInstanceStartup(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1119
  """Startup an instance."""
1120
  OP_DSC_FIELD = "instance_name"
1121
1122
1123
1124
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
1125
1126
1127
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Temporary hypervisor parameters, hypervisor-dependent"),
    ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
1128
    _PNoRemember,
1129
    _PStartupPaused,
1130
    ]
Iustin Pop's avatar
Iustin Pop committed
1131
1132


1133
class OpInstanceShutdown(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1134
  """Shutdown an instance."""
1135
  OP_DSC_FIELD = "instance_name"
1136
1137
1138
  OP_PARAMS = [
    _PInstanceName,
    _PIgnoreOfflineNodes,
1139
1140
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TPositiveInt,
     "How long to wait for instance to shut down"),
1141
    _PNoRemember,
1142
    ]
Iustin Pop's avatar
Iustin Pop committed
1143
1144


1145
class OpInstanceReboot(OpCode):
1146
  """Reboot an instance."""
1147
  OP_DSC_FIELD = "instance_name"
1148
1149
1150
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1151
1152
1153
1154
    ("ignore_secondaries", False, ht.TBool,
     "Whether to start the instance even if secondary disks are failing"),
    ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES),
     "How to reboot instance"),
1155
    ]
1156
1157


1158
class OpInstanceReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1159
  """Replace the disks of an instance."""
1160
  OP_DSC_FIELD = "instance_name"
1161
1162
  OP_PARAMS = [
    _PInstanceName,
1163
    _PEarlyRelease,
1164
1165
1166
1167
1168
1169
1170
    ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
     "Replacement mode"),
    ("disks", ht.EmptyList, ht.TListOf(ht.TPositiveInt),
     "Disk indexes"),
    ("remote_node", None, ht.TMaybeString, "New secondary node"),
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding new secondary node"),
1171
    ]
Iustin Pop's avatar
Iustin Pop committed
1172
1173


1174
class OpInstanceFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1175
  """Failover an instance."""
1176
  OP_DSC_FIELD = "instance_name"
1177
1178
1179
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1180
    _PIgnoreConsistency,
Michael Hanselmann's avatar
Michael Hanselmann committed
1181
    _PMigrationTargetNode,
1182
1183
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
1184
    ]
Iustin Pop's avatar
Iustin Pop committed
1185
1186


1187
class OpInstanceMigrate(OpCode):
1188
1189
1190
1191
1192
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
1193
  @ivar instance_name: the name of the instance