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

"""

# this are practically structures, so disable the message about too
# few public methods:
34
# pylint: disable=R0903
Iustin Pop's avatar
Iustin Pop committed
35

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
_PIgnoreErrors = ("ignore_errors", ht.EmptyList,
                  ht.TListOf(ht.TElemOf(constants.CV_ALL_ECODES_STRINGS)),
                  "List of error codes that should be treated as warnings")
143

144
145
146
147
148
149
150
# Disk parameters
_PDiskParams = ("diskparams", None,
                ht.TOr(
                  ht.TDictOf(ht.TElemOf(constants.DISK_TEMPLATES), ht.TDict),
                  ht.TNone),
                "Disk templates' parameter defaults")

151
152
153
154
# Parameters for node resource model
_PHvState = ("hv_state", None, ht.TMaybeDict, "Set hypervisor states")
_PDiskState = ("disk_state", None, ht.TMaybeDict, "Set disk states")

155
156
157
#: OP_ID conversion regular expression
_OPID_RE = re.compile("([a-z])([A-Z])")

158
159
160
#: 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
161
    ht.TMap(ht.WithDesc("GetFirstItem")(compat.fst),
162
163
            ht.TElemOf(constants.DDMS_VALUES)))))

164

165
166
167
168
169
# 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))

170
171
_TSetParamsResultItemItems = [
  ht.Comment("name of changed parameter")(ht.TNonEmptyString),
172
  ht.Comment("new value")(ht.TAny),
173
174
175
176
177
178
  ]

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

179
180
181
182
183
184
185
_SUMMARY_PREFIX = {
  "CLUSTER_": "C_",
  "GROUP_": "G_",
  "NODE_": "N_",
  "INSTANCE_": "I_",
  }

Michael Hanselmann's avatar
Michael Hanselmann committed
186
187
188
#: Attribute name for dependencies
DEPEND_ATTR = "depends"

189
190
191
#: Attribute name for comment
COMMENT_ATTR = "comment"

192

193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
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)

213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

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)


228
229
230
231
232
233
234
235
236
237
238
239
240
241
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)


242
243
244
@ht.WithDesc("CheckFileStorage")
def _CheckFileStorage(value):
  """Ensures file storage is enabled if used.
245
246

  """
247
  if value == constants.DT_FILE:
248
    RequireFileStorage()
249
250
  elif value == constants.DT_SHARED_FILE:
    RequireSharedFileStorage()
251
252
253
  return True


254
255
256
257
258
259
260
261
262
263
264
265
266
267
def _BuildDiskTemplateCheck(accept_none):
  """Builds check for disk template.

  @type accept_none: bool
  @param accept_none: whether to accept None as a correct value
  @rtype: callable

  """
  template_check = ht.TElemOf(constants.DISK_TEMPLATES)

  if accept_none:
    template_check = ht.TOr(template_check, ht.TNone)

  return ht.TAnd(template_check, _CheckFileStorage)
268
269


270
271
272
273
274
275
276
277
278
279
280
281
282
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
283
284
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
                 "Storage type")
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302


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

305
    attrs["OP_ID"] = _NameToId(name)
306
307
308
309
310

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

    # Use parameter names as slots
311
    slots = [pname for (pname, _, _, _) in params]
312
313
314
315
316
317
318
319

    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)

320

Iustin Pop's avatar
Iustin Pop committed
321
class BaseOpCode(object):
322
323
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
324
325
326
  This object serves as a parent class for OpCode without any custom
  field handling.

327
  """
328
  # pylint: disable=E1101
329
  # as OP_ID is dynamically defined
330
331
  __metaclass__ = _AutoOpParamSlots

Iustin Pop's avatar
Iustin Pop committed
332
  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
333
334
335
336
337
338
339
340
    """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.

    """
341
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
342
    for key in kwargs:
343
      if key not in slots:
344
        raise TypeError("Object %s doesn't support the parameter '%s'" %
345
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
346
347
      setattr(self, key, kwargs[key])

348
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
349
350
351
352
353
354
355
356
357
    """Generic serializer.

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

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

    """
358
    state = {}
359
    for name in self._all_slots():
360
361
362
363
364
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
365
366
367
368
369
370
371
372
373
    """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}

    """
374
375
376
377
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

378
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
379
      if name not in state and hasattr(self, name):
380
381
382
383
384
        delattr(self, name)

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

385
386
387
388
389
390
391
392
393
394
  @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

395
396
397
398
399
400
401
402
403
404
  @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

405
406
407
408
409
410
411
412
413
  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

    """
414
    for (attr_name, default, test, _) in self.GetAllParams():
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
      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)

442

443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
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)

466
#: List of submission status and job ID as returned by C{SubmitManyJobs}
467
468
469
470
471
472
473
_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)
474

475
476
#: Result containing only list of submitted jobs
TJobIdListOnly = ht.TStrictDict(True, True, {
477
  constants.JOB_IDS_KEY: ht.Comment("List of submitted jobs")(TJobIdList),
478
479
  })

480

Iustin Pop's avatar
Iustin Pop committed
481
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
482
483
484
485
486
487
  """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
488
               children of this class.
489
490
491
  @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).
492
493
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
                   get if not already defined, and types they must match.
494
  @cvar OP_RESULT: Callable to verify opcode result
495
496
  @cvar WITH_LU: Boolean that specifies whether this should be included in
      mcpu's dispatch table
497
498
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
499
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
500
501

  """
502
  # pylint: disable=E1101
503
  # as OP_ID is dynamically defined
504
  WITH_LU = True
505
  OP_PARAMS = [
506
507
    ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
    ("debug_level", None, ht.TOr(ht.TNone, ht.TPositiveInt), "Debug level"),
508
    ("priority", constants.OP_PRIO_DEFAULT,
509
     ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
510
511
512
    (DEPEND_ATTR, None, _BuildJobDepCheck(True),
     "Job dependencies; if used through ``SubmitManyJobs`` relative (negative)"
     " job IDs can be used"),
513
514
    (COMMENT_ATTR, None, ht.TMaybeString,
     "Comment describing the purpose of the opcode"),
515
    ]
516
  OP_RESULT = None
517
518
519
520

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

Iustin Pop's avatar
Iustin Pop committed
521
522
523
524
525
526
527
    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

528
    """
Iustin Pop's avatar
Iustin Pop committed
529
    data = BaseOpCode.__getstate__(self)
530
531
532
533
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
534
  def LoadOpCode(cls, data):
535
536
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
537
538
539
540
541
542
543
    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

544
545
546
547
548
549
550
    """
    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
551
552
553
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
554
555
556
557
558
559
560
561
      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

562
563
564
  def Summary(self):
    """Generates a summary description of this opcode.

565
566
567
568
569
    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).
570

571
    """
572
    assert self.OP_ID is not None and len(self.OP_ID) > 3
573
574
575
576
577
    # 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)
578
579
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
580
581
582
      txt = "%s(%s)" % (txt, field_value)
    return txt

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

598
599
# cluster opcodes

600
class OpClusterPostInit(OpCode):
601
602
603
604
605
606
607
608
  """Post cluster initialization.

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

  """


609
class OpClusterDestroy(OpCode):
Iustin Pop's avatar
Iustin Pop committed
610
611
612
613
614
615
  """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
616
617


618
class OpClusterQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
619
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
620
621


622
623
624
625
626
627
628
629
class OpClusterVerify(OpCode):
  """Submits all jobs necessary to verify the cluster.

  """
  OP_PARAMS = [
    _PDebugSimulateErrors,
    _PErrorCodes,
    _PSkipChecks,
630
    _PIgnoreErrors,
631
632
633
    _PVerbose,
    ("group_name", None, ht.TMaybeString, "Group to verify")
    ]
634
  OP_RESULT = TJobIdListOnly
635
636


637
638
639
640
641
class OpClusterVerifyConfig(OpCode):
  """Verify the cluster config.

  """
  OP_PARAMS = [
642
643
    _PDebugSimulateErrors,
    _PErrorCodes,
644
    _PIgnoreErrors,
645
    _PVerbose,
646
    ]
647
  OP_RESULT = ht.TBool
648
649
650
651


class OpClusterVerifyGroup(OpCode):
  """Run verify on a node group from the cluster.
Iustin Pop's avatar
Iustin Pop committed
652
653
654
655
656
657
658
659

  @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

  """
660
  OP_DSC_FIELD = "group_name"
661
  OP_PARAMS = [
662
663
664
665
    _PGroupName,
    _PDebugSimulateErrors,
    _PErrorCodes,
    _PSkipChecks,
666
    _PIgnoreErrors,
667
    _PVerbose,
668
    ]
669
  OP_RESULT = ht.TBool
Iustin Pop's avatar
Iustin Pop committed
670
671


672
class OpClusterVerifyDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
673
674
  """Verify the cluster disks.

675
  """
676
  OP_RESULT = TJobIdListOnly
677
678
679
680


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

682
683
  Result: a tuple of three elements:
    - dict of node names with issues (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
684
    - list of instances with degraded disks (that should be activated)
685
686
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
687

688
689
690
691
  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
692
693
694
695
696

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

  """
697
698
699
700
  OP_DSC_FIELD = "group_name"
  OP_PARAMS = [
    _PGroupName,
    ]
701
702
703
704
  OP_RESULT = \
    ht.TAnd(ht.TIsLength(3),
            ht.TItems([ht.TDictOf(ht.TString, ht.TString),
                       ht.TListOf(ht.TString),
705
706
                       ht.TDictOf(ht.TString,
                                  ht.TListOf(ht.TListOf(ht.TString)))]))
Iustin Pop's avatar
Iustin Pop committed
707
708


709
class OpClusterRepairDiskSizes(OpCode):
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
  """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

  """
725
  OP_PARAMS = [
726
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
727
    ]
728
729


730
class OpClusterConfigQuery(OpCode):
731
  """Query cluster configuration values."""
732
733
734
  OP_PARAMS = [
    _POutputFields
    ]
Iustin Pop's avatar
Iustin Pop committed
735
736


737
class OpClusterRename(OpCode):
Iustin Pop's avatar
Iustin Pop committed
738
739
740
741
742
743
744
745
  """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.

  """
746
  OP_DSC_FIELD = "name"
747
  OP_PARAMS = [
748
    ("name", ht.NoDefault, ht.TNonEmptyString, None),
749
    ]
750
751


752
class OpClusterSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
753
754
755
756
757
758
  """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.

  """
759
  OP_PARAMS = [
760
761
    _PHvState,
    _PDiskState,
762
    ("vg_name", None, ht.TMaybeString, "Volume group name"),
763
764
    ("enabled_hypervisors", None,
     ht.TOr(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)), ht.TTrue),
765
766
            ht.TNone),
     "List of enabled hypervisors"),
767
    ("hvparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
768
769
770
771
                              ht.TNone),
     "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
    ("beparams", None, ht.TOr(ht.TDict, ht.TNone),
     "Cluster-wide backend parameter defaults"),
772
    ("os_hvp", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
773
774
                            ht.TNone),
     "Cluster-wide per-OS hypervisor parameter defaults"),
775
    ("osparams", None, ht.TOr(ht.TDictOf(ht.TNonEmptyString, ht.TDict),
776
777
                              ht.TNone),
     "Cluster-wide OS parameter defaults"),
778
    _PDiskParams,
779
    ("candidate_pool_size", None, ht.TOr(ht.TStrictPositiveInt, ht.TNone),
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
     "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"),
796
    ("ipolicy", None, ht.TMaybeDict, "Cluster-wide instance policy specs"),
797
798
799
800
801
    ("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"),
802
803
    ("master_netmask", None, ht.TOr(ht.TInt, ht.TNone),
     "Netmask of the master IP"),
804
805
806
807
808
809
810
811
812
813
    ("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)),
814
815
    ("use_external_mip_script", None, ht.TMaybeBool,
     "Whether to use an external master IP address setup script"),
816
    ]
817
818


819
class OpClusterRedistConf(OpCode):
820
821
822
823
  """Force a full push of the cluster configuration.

  """

Michael Hanselmann's avatar
Michael Hanselmann committed
824

825
826
827
828
829
830
831
832
833
834
835
836
class OpClusterActivateMasterIp(OpCode):
  """Activate the master IP on the master node.

  """


class OpClusterDeactivateMasterIp(OpCode):
  """Deactivate the master IP on the master node.

  """


Michael Hanselmann's avatar
Michael Hanselmann committed
837
838
839
class OpQuery(OpCode):
  """Query for resources/items.

840
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
841
  @ivar fields: List of fields to retrieve
842
  @ivar qfilter: Query filter
Michael Hanselmann's avatar
Michael Hanselmann committed
843
844

  """
845
  OP_DSC_FIELD = "what"
846
  OP_PARAMS = [
847
    _PQueryWhat,
848
    _PUseLocking,
849
850
    ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
     "Requested fields"),
851
    ("qfilter", None, ht.TOr(ht.TNone, ht.TListOf),
852
     "Query filter"),
Michael Hanselmann's avatar
Michael Hanselmann committed
853
854
855
856
857
858
    ]


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

859
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
Michael Hanselmann's avatar
Michael Hanselmann committed
860
861
862
  @ivar fields: List of fields to retrieve

  """
863
  OP_DSC_FIELD = "what"
864
  OP_PARAMS = [
865
866
867
    _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
868
869
870
    ]


871
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
872
  """Interact with OOB."""
873
  OP_PARAMS = [
874
875
876
877
878
879
880
881
    ("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"),
882
883
    ("power_delay", constants.OOB_POWER_DELAY, ht.TPositiveFloat,
     "Time in seconds to wait between powering on nodes"),
René Nussbaumer's avatar
René Nussbaumer committed
884
885
886
    ]


887
888
# node opcodes

889
class OpNodeRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
890
891
892
893
894
895
896
  """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.

  """
897
  OP_DSC_FIELD = "node_name"
898
899
900
  OP_PARAMS = [
    _PNodeName,
    ]
Iustin Pop's avatar
Iustin Pop committed
901
902


Iustin Pop's avatar
Iustin Pop committed
903
class OpNodeAdd(OpCode):
Iustin Pop's avatar
Iustin Pop committed
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
  """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.
923
924
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
925
926
927
928
  @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
929
930

  """
931
  OP_DSC_FIELD = "node_name"
932
933
  OP_PARAMS = [
    _PNodeName,
934
935
936
937
938
939
940
941
942
    ("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"),
943
    ]
Iustin Pop's avatar
Iustin Pop committed
944
945


946
class OpNodeQuery(OpCode):
Iustin Pop's avatar
Iustin Pop committed
947
  """Compute the list of nodes."""
948
949
  OP_PARAMS = [
    _POutputFields,
950
951
952
    _PUseLocking,
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
953
    ]
Iustin Pop's avatar
Iustin Pop committed
954
955


956
class OpNodeQueryvols(OpCode):
957
  """Get list of volumes on node."""
958
959
  OP_PARAMS = [
    _POutputFields,
960
961
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
     "Empty list to query all nodes, node names otherwise"),
962
    ]
963
964


965
class OpNodeQueryStorage(OpCode):
966
  """Get information on storage for node(s)."""
967
968
969
  OP_PARAMS = [
    _POutputFields,
    _PStorageType,
970
971
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
    ("name", None, ht.TMaybeString, "Storage name"),
972
973
974
    ]


975
class OpNodeModifyStorage(OpCode):
976
  """Modifies the properies of a storage unit"""
977
978
979
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
980
981
    _PStorageName,
    ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
982
983
984
    ]


985
986
987
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_DSC_FIELD = "node_name"
988
989
990
  OP_PARAMS = [
    _PNodeName,
    _PStorageType,
991
992
    _PStorageName,
    _PIgnoreConsistency,
993
994
995
    ]


996
class OpNodeSetParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
997
998
  """Change the parameters of a node."""
  OP_DSC_FIELD = "node_name"
999
1000
1001
  OP_PARAMS = [
    _PNodeName,
    _PForce,
1002
1003
    _PHvState,
    _PDiskState,
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
    ("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
1021
    ]
1022
  OP_RESULT = _TSetParamsResult
Iustin Pop's avatar
Iustin Pop committed
1023

Iustin Pop's avatar
Iustin Pop committed
1024

1025
class OpNodePowercycle(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1026
1027
  """Tries to powercycle a node."""
  OP_DSC_FIELD = "node_name"
1028
1029
1030
  OP_PARAMS = [
    _PNodeName,
    _PForce,
Iustin Pop's avatar
Iustin Pop committed
1031
1032
    ]

1033

1034
class OpNodeMigrate(OpCode):
1035
1036
  """Migrate all instances from a node."""
  OP_DSC_FIELD = "node_name"
1037
1038
1039
1040
  OP_PARAMS = [
    _PNodeName,
    _PMigrationMode,
    _PMigrationLive,
Michael Hanselmann's avatar
Michael Hanselmann committed
1041
    _PMigrationTargetNode,
1042
1043
    ("iallocator", None, ht.TMaybeString,
     "Iallocator for deciding the target node for shared-storage instances"),
1044
    ]
1045
  OP_RESULT = TJobIdListOnly
1046
1047


1048
1049
1050
1051
1052
1053
1054
1055
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"),
1056
    ("mode", ht.NoDefault, ht.TElemOf(constants.NODE_EVAC_MODES),
1057
1058
     "Node evacuation mode"),
    ]
1059
  OP_RESULT = TJobIdListOnly
1060
1061


Iustin Pop's avatar
Iustin Pop committed
1062
1063
# instance opcodes

1064
class OpInstanceCreate(OpCode):
1065
1066
1067
1068
1069
1070
1071
  """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)
1072
1073
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
1074
1075

  """
1076
  OP_DSC_FIELD = "instance_name"
1077
1078
  OP_PARAMS = [
    _PInstanceName,
1079
1080
1081
1082
    _PForceVariant,
    _PWaitForSync,
    _PNameCheck,
    ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
    ("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)))),
1094
1095
    ("disk_template", ht.NoDefault, _BuildDiskTemplateCheck(True),
     "Disk template"),
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
    ("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"),
1110
1111
1112
1113
1114
1115
    ("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)))),
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
    ("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)"),
1126
    ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
1127
1128
     ht.TPositiveInt,
     "How long source instance was given to shut down (remote import only)"),
1129
1130
1131
1132
1133
    ("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"),
1134
    ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
1135
    ]
1136
  OP_RESULT = ht.Comment("instance nodes")(ht.TListOf(ht.TNonEmptyString))
Iustin Pop's avatar
Iustin Pop committed
1137
1138


1139
class OpInstanceReinstall(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1140
  """Reinstall an instance's OS."""
1141
  OP_DSC_FIELD = "instance_name"
1142
1143
  OP_PARAMS = [
    _PInstanceName,
1144
1145
1146
    _PForceVariant,
    ("os_type", None, ht.TMaybeString, "Instance operating system"),
    ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
1147
    ]
1148
1149


1150
class OpInstanceRemove(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1151
  """Remove an instance."""
1152
  OP_DSC_FIELD = "instance_name"
1153
1154
1155
  OP_PARAMS = [
    _PInstanceName,
    _PShutdownTimeout,
1156
1157
    ("ignore_failures", False, ht.TBool,
     "Whether to ignore failures during removal"),
1158
    ]
Iustin Pop's avatar
Iustin Pop committed
1159
1160


1161
class OpInstanceRename(OpCode):
1162
  """Rename an instance."""
1163
1164
  OP_PARAMS = [
    _PInstanceName,
1165
1166
1167
    _PNameCheck,
    ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
    ("ip_check", False, ht.TBool, _PIpCheckDoc),
1168
    ]
1169
  OP_RESULT = ht.Comment("New instance name")(ht.TNonEmptyString)
1170
1171


1172
class OpInstanceStartup(OpCode):
Iustin Pop's avatar
Iustin Pop committed
1173
  """Startup an instance."""
1174
  OP_DSC_FIELD = "instance_name"
1175
1176
1177
1178
  OP_PARAMS = [
    _PInstanceName,
    _PForce,
    _PIgnoreOfflineNodes,
1179
1180
1181
    ("hvparams", ht.EmptyDict, ht.TDict,
     "Temporary hypervisor parameters, hypervisor-dependent"),
    ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
1182
    _PNoRemember,
1183
    _PStartupPaused,
1184
    ]
Iustin Pop's avatar
Iustin Pop committed
1185
1186


1187
class OpInstanceShutdown(OpCode):
Iustin Pop's avatar