Statistics
| Branch: | Tag: | Revision:

root / lib / opcodes.py @ 40d93e3b

History | View | Annotate | Download (67.3 kB)

1
#
2
#
3

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

    
21

    
22
"""OpCodes module
23

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

27
Every operation which modifies the cluster state is expressed via
28
opcodes.
29

30
"""
31

    
32
# this are practically structures, so disable the message about too
33
# few public methods:
34
# pylint: disable=R0903
35

    
36
import logging
37
import re
38
import ipaddr
39

    
40
from ganeti import constants
41
from ganeti import errors
42
from ganeti import ht
43
from ganeti import objects
44
from ganeti import outils
45

    
46

    
47
# Common opcode attributes
48

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

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

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

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

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

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

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

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

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

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

    
88
#: List of tag strings
89
_PTags = ("tags", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
90
          "List of tag names")
91

    
92
_PForceVariant = ("force_variant", False, ht.TBool,
93
                  "Whether to force an unknown OS variant")
94

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

    
98
_PWaitForSyncFalse = ("wait_for_sync", False, ht.TBool,
99
                      "Whether to wait for the disk to synchronize"
100
                      " (defaults to false)")
101

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

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

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

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

    
112
_PNodeGroupAllocPolicy = \
113
  ("alloc_policy", None,
114
   ht.TMaybe(ht.TElemOf(constants.VALID_ALLOC_POLICIES)),
115
   "Instance allocation policy")
116

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

    
120
_PQueryWhat = ("what", ht.NoDefault, ht.TElemOf(constants.QR_VIA_OP),
121
               "Resource(s) to query for")
122

    
123
_PEarlyRelease = ("early_release", False, ht.TBool,
124
                  "Whether to release locks as soon as possible")
125

    
126
_PIpCheckDoc = "Whether to ensure instance's IP address is inactive"
127

    
128
#: Do not remember instance state changes
129
_PNoRemember = ("no_remember", False, ht.TBool,
130
                "Do not remember the state change")
131

    
132
#: Target node for instance migration/failover
133
_PMigrationTargetNode = ("target_node", None, ht.TMaybeString,
134
                         "Target node for shared-storage instances")
135

    
136
_PStartupPaused = ("startup_paused", False, ht.TBool,
137
                   "Pause instance at startup")
138

    
139
_PVerbose = ("verbose", False, ht.TBool, "Verbose mode")
140

    
141
# Parameters for cluster verification
142
_PDebugSimulateErrors = ("debug_simulate_errors", False, ht.TBool,
143
                         "Whether to simulate errors (useful for debugging)")
144
_PErrorCodes = ("error_codes", False, ht.TBool, "Error codes")
145
_PSkipChecks = ("skip_checks", ht.EmptyList,
146
                ht.TListOf(ht.TElemOf(constants.VERIFY_OPTIONAL_CHECKS)),
147
                "Which checks to skip")
148
_PIgnoreErrors = ("ignore_errors", ht.EmptyList,
149
                  ht.TListOf(ht.TElemOf(constants.CV_ALL_ECODES_STRINGS)),
150
                  "List of error codes that should be treated as warnings")
151

    
152
# Disk parameters
153
_PDiskParams = \
154
  ("diskparams", None,
155
   ht.TMaybe(ht.TDictOf(ht.TElemOf(constants.DISK_TEMPLATES), ht.TDict)),
156
   "Disk templates' parameter defaults")
157

    
158
# Parameters for node resource model
159
_PHvState = ("hv_state", None, ht.TMaybeDict, "Set hypervisor states")
160
_PDiskState = ("disk_state", None, ht.TMaybeDict, "Set disk states")
161

    
162
#: Opportunistic locking
163
_POpportunisticLocking = \
164
  ("opportunistic_locking", False, ht.TBool,
165
   ("Whether to employ opportunistic locking for nodes, meaning nodes"
166
    " already locked by another opcode won't be considered for instance"
167
    " allocation (only when an iallocator is used)"))
168

    
169
_PIgnoreIpolicy = ("ignore_ipolicy", False, ht.TBool,
170
                   "Whether to ignore ipolicy violations")
171

    
172
# Allow runtime changes while migrating
173
_PAllowRuntimeChgs = ("allow_runtime_changes", True, ht.TBool,
174
                      "Allow runtime changes (eg. memory ballooning)")
175

    
176
#: IAllocator field builder
177
_PIAllocFromDesc = lambda desc: ("iallocator", None, ht.TMaybeString, desc)
178

    
179
#: a required network name
180
_PNetworkName = ("network_name", ht.NoDefault, ht.TNonEmptyString,
181
                 "Set network name")
182

    
183
_PTargetGroups = \
184
  ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString),
185
   "Destination group names or UUIDs (defaults to \"all but current group\")")
186

    
187
#: OP_ID conversion regular expression
188
_OPID_RE = re.compile("([a-z])([A-Z])")
189

    
190
#: Utility function for L{OpClusterSetParams}
191
_TestClusterOsListItem = \
192
  ht.TAnd(ht.TIsLength(2), ht.TItems([
193
    ht.TElemOf(constants.DDMS_VALUES),
194
    ht.TNonEmptyString,
195
    ]))
196

    
197
_TestClusterOsList = ht.TMaybeListOf(_TestClusterOsListItem)
198

    
199
# TODO: Generate check from constants.INIC_PARAMS_TYPES
200
#: Utility function for testing NIC definitions
201
_TestNicDef = \
202
  ht.Comment("NIC parameters")(ht.TDictOf(ht.TElemOf(constants.INIC_PARAMS),
203
                                          ht.TMaybeString))
204

    
205
_TSetParamsResultItemItems = [
206
  ht.Comment("name of changed parameter")(ht.TNonEmptyString),
207
  ht.Comment("new value")(ht.TAny),
208
  ]
209

    
210
_TSetParamsResult = \
211
  ht.TListOf(ht.TAnd(ht.TIsLength(len(_TSetParamsResultItemItems)),
212
                     ht.TItems(_TSetParamsResultItemItems)))
213

    
214
# In the disks option we can provide arbitrary parameters too, which
215
# we may not be able to validate at this level, so we just check the
216
# format of the dict here and the checks concerning IDISK_PARAMS will
217
# happen at the LU level
218
_TDiskParams = \
219
  ht.Comment("Disk parameters")(ht.TDictOf(ht.TNonEmptyString,
220
                                           ht.TOr(ht.TNonEmptyString, ht.TInt)))
221

    
222
_TQueryRow = \
223
  ht.TListOf(ht.TAnd(ht.TIsLength(2),
224
                     ht.TItems([ht.TElemOf(constants.RS_ALL),
225
                                ht.TAny])))
226

    
227
_TQueryResult = ht.TListOf(_TQueryRow)
228

    
229
_TOldQueryRow = ht.TListOf(ht.TAny)
230

    
231
_TOldQueryResult = ht.TListOf(_TOldQueryRow)
232

    
233

    
234
_SUMMARY_PREFIX = {
235
  "CLUSTER_": "C_",
236
  "GROUP_": "G_",
237
  "NODE_": "N_",
238
  "INSTANCE_": "I_",
239
  }
240

    
241
#: Attribute name for dependencies
242
DEPEND_ATTR = "depends"
243

    
244
#: Attribute name for comment
245
COMMENT_ATTR = "comment"
246

    
247

    
248
def _NameComponents(name):
249
  """Split an opcode class name into its components
250

251
  @type name: string
252
  @param name: the class name, as OpXxxYyy
253
  @rtype: array of strings
254
  @return: the components of the name
255

256
  """
257
  assert name.startswith("Op")
258
  # Note: (?<=[a-z])(?=[A-Z]) would be ideal, since it wouldn't
259
  # consume any input, and hence we would just have all the elements
260
  # in the list, one by one; but it seems that split doesn't work on
261
  # non-consuming input, hence we have to process the input string a
262
  # bit
263
  name = _OPID_RE.sub(r"\1,\2", name)
264
  elems = name.split(",")
265
  return elems
266

    
267

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

271
  @type name: string
272
  @param name: the class name, as OpXxxYyy
273
  @rtype: string
274
  @return: the name in the OP_XXXX_YYYY format
275

276
  """
277
  if not name.startswith("Op"):
278
    return None
279
  return "_".join(n.upper() for n in _NameComponents(name))
280

    
281

    
282
def NameToReasonSrc(name):
283
  """Convert an opcode class name to a source string for the reason trail
284

285
  @type name: string
286
  @param name: the class name, as OpXxxYyy
287
  @rtype: string
288
  @return: the name in the OP_XXXX_YYYY format
289

290
  """
291
  if not name.startswith("Op"):
292
    return None
293
  return "%s:%s" % (constants.OPCODE_REASON_SRC_OPCODE,
294
                    "_".join(n.lower() for n in _NameComponents(name)))
295

    
296

    
297
def _GenerateObjectTypeCheck(obj, fields_types):
298
  """Helper to generate type checks for objects.
299

300
  @param obj: The object to generate type checks
301
  @param fields_types: The fields and their types as a dict
302
  @return: A ht type check function
303

304
  """
305
  assert set(obj.GetAllSlots()) == set(fields_types.keys()), \
306
    "%s != %s" % (set(obj.GetAllSlots()), set(fields_types.keys()))
307
  return ht.TStrictDict(True, True, fields_types)
308

    
309

    
310
_TQueryFieldDef = \
311
  _GenerateObjectTypeCheck(objects.QueryFieldDefinition, {
312
    "name": ht.TNonEmptyString,
313
    "title": ht.TNonEmptyString,
314
    "kind": ht.TElemOf(constants.QFT_ALL),
315
    "doc": ht.TNonEmptyString,
316
    })
317

    
318

    
319
def RequireFileStorage():
320
  """Checks that file storage is enabled.
321

322
  While it doesn't really fit into this module, L{utils} was deemed too large
323
  of a dependency to be imported for just one or two functions.
324

325
  @raise errors.OpPrereqError: when file storage is disabled
326

327
  """
328
  if not constants.ENABLE_FILE_STORAGE:
329
    raise errors.OpPrereqError("File storage disabled at configure time",
330
                               errors.ECODE_INVAL)
331

    
332

    
333
def RequireSharedFileStorage():
334
  """Checks that shared file storage is enabled.
335

336
  While it doesn't really fit into this module, L{utils} was deemed too large
337
  of a dependency to be imported for just one or two functions.
338

339
  @raise errors.OpPrereqError: when shared file storage is disabled
340

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

    
346

    
347
@ht.WithDesc("CheckFileStorage")
348
def _CheckFileStorage(value):
349
  """Ensures file storage is enabled if used.
350

351
  """
352
  if value == constants.DT_FILE:
353
    RequireFileStorage()
354
  elif value == constants.DT_SHARED_FILE:
355
    RequireSharedFileStorage()
356
  return True
357

    
358

    
359
def _BuildDiskTemplateCheck(accept_none):
360
  """Builds check for disk template.
361

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

366
  """
367
  template_check = ht.TElemOf(constants.DISK_TEMPLATES)
368

    
369
  if accept_none:
370
    template_check = ht.TMaybe(template_check)
371

    
372
  return ht.TAnd(template_check, _CheckFileStorage)
373

    
374

    
375
def _CheckStorageType(storage_type):
376
  """Ensure a given storage type is valid.
377

378
  """
379
  if storage_type not in constants.VALID_STORAGE_TYPES:
380
    raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
381
                               errors.ECODE_INVAL)
382
  if storage_type == constants.ST_FILE:
383
    # TODO: What about shared file storage?
384
    RequireFileStorage()
385
  return True
386

    
387

    
388
#: Storage type parameter
389
_PStorageType = ("storage_type", ht.NoDefault, _CheckStorageType,
390
                 "Storage type")
391

    
392

    
393
@ht.WithDesc("IPv4 network")
394
def _CheckCIDRNetNotation(value):
395
  """Ensure a given CIDR notation type is valid.
396

397
  """
398
  try:
399
    ipaddr.IPv4Network(value)
400
  except ipaddr.AddressValueError:
401
    return False
402
  return True
403

    
404

    
405
@ht.WithDesc("IPv4 address")
406
def _CheckCIDRAddrNotation(value):
407
  """Ensure a given CIDR notation type is valid.
408

409
  """
410
  try:
411
    ipaddr.IPv4Address(value)
412
  except ipaddr.AddressValueError:
413
    return False
414
  return True
415

    
416

    
417
@ht.WithDesc("IPv6 address")
418
def _CheckCIDR6AddrNotation(value):
419
  """Ensure a given CIDR notation type is valid.
420

421
  """
422
  try:
423
    ipaddr.IPv6Address(value)
424
  except ipaddr.AddressValueError:
425
    return False
426
  return True
427

    
428

    
429
@ht.WithDesc("IPv6 network")
430
def _CheckCIDR6NetNotation(value):
431
  """Ensure a given CIDR notation type is valid.
432

433
  """
434
  try:
435
    ipaddr.IPv6Network(value)
436
  except ipaddr.AddressValueError:
437
    return False
438
  return True
439

    
440

    
441
_TIpAddress4 = ht.TAnd(ht.TString, _CheckCIDRAddrNotation)
442
_TIpAddress6 = ht.TAnd(ht.TString, _CheckCIDR6AddrNotation)
443
_TIpNetwork4 = ht.TAnd(ht.TString, _CheckCIDRNetNotation)
444
_TIpNetwork6 = ht.TAnd(ht.TString, _CheckCIDR6NetNotation)
445
_TMaybeAddr4List = ht.TMaybe(ht.TListOf(_TIpAddress4))
446

    
447

    
448
class _AutoOpParamSlots(outils.AutoSlots):
449
  """Meta class for opcode definitions.
450

451
  """
452
  def __new__(mcs, name, bases, attrs):
453
    """Called when a class should be created.
454

455
    @param mcs: The meta class
456
    @param name: Name of created class
457
    @param bases: Base classes
458
    @type attrs: dict
459
    @param attrs: Class attributes
460

461
    """
462
    assert "OP_ID" not in attrs, "Class '%s' defining OP_ID" % name
463

    
464
    slots = mcs._GetSlots(attrs)
465
    assert "OP_DSC_FIELD" not in attrs or attrs["OP_DSC_FIELD"] in slots, \
466
      "Class '%s' uses unknown field in OP_DSC_FIELD" % name
467
    assert ("OP_DSC_FORMATTER" not in attrs or
468
            callable(attrs["OP_DSC_FORMATTER"])), \
469
      ("Class '%s' uses non-callable in OP_DSC_FORMATTER (%s)" %
470
       (name, type(attrs["OP_DSC_FORMATTER"])))
471

    
472
    attrs["OP_ID"] = _NameToId(name)
473

    
474
    return outils.AutoSlots.__new__(mcs, name, bases, attrs)
475

    
476
  @classmethod
477
  def _GetSlots(mcs, attrs):
478
    """Build the slots out of OP_PARAMS.
479

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

    
484
    # Use parameter names as slots
485
    return [pname for (pname, _, _, _) in params]
486

    
487

    
488
class BaseOpCode(outils.ValidatedSlots):
489
  """A simple serializable object.
490

491
  This object serves as a parent class for OpCode without any custom
492
  field handling.
493

494
  """
495
  # pylint: disable=E1101
496
  # as OP_ID is dynamically defined
497
  __metaclass__ = _AutoOpParamSlots
498

    
499
  def __getstate__(self):
500
    """Generic serializer.
501

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

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

508
    """
509
    state = {}
510
    for name in self.GetAllSlots():
511
      if hasattr(self, name):
512
        state[name] = getattr(self, name)
513
    return state
514

    
515
  def __setstate__(self, state):
516
    """Generic unserializer.
517

518
    This method just restores from the serialized state the attributes
519
    of the current instance.
520

521
    @param state: the serialized opcode data
522
    @type state:  C{dict}
523

524
    """
525
    if not isinstance(state, dict):
526
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
527
                       type(state))
528

    
529
    for name in self.GetAllSlots():
530
      if name not in state and hasattr(self, name):
531
        delattr(self, name)
532

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

    
536
  @classmethod
537
  def GetAllParams(cls):
538
    """Compute list of all parameters for an opcode.
539

540
    """
541
    slots = []
542
    for parent in cls.__mro__:
543
      slots.extend(getattr(parent, "OP_PARAMS", []))
544
    return slots
545

    
546
  def Validate(self, set_defaults): # pylint: disable=W0221
547
    """Validate opcode parameters, optionally setting default values.
548

549
    @type set_defaults: bool
550
    @param set_defaults: Whether to set default values
551
    @raise errors.OpPrereqError: When a parameter value doesn't match
552
                                 requirements
553

554
    """
555
    for (attr_name, default, test, _) in self.GetAllParams():
556
      assert test == ht.NoType or callable(test)
557

    
558
      if not hasattr(self, attr_name):
559
        if default == ht.NoDefault:
560
          raise errors.OpPrereqError("Required parameter '%s.%s' missing" %
561
                                     (self.OP_ID, attr_name),
562
                                     errors.ECODE_INVAL)
563
        elif set_defaults:
564
          if callable(default):
565
            dval = default()
566
          else:
567
            dval = default
568
          setattr(self, attr_name, dval)
569

    
570
      if test == ht.NoType:
571
        # no tests here
572
        continue
573

    
574
      if set_defaults or hasattr(self, attr_name):
575
        attr_val = getattr(self, attr_name)
576
        if not test(attr_val):
577
          logging.error("OpCode %s, parameter %s, has invalid type %s/value"
578
                        " '%s' expecting type %s",
579
                        self.OP_ID, attr_name, type(attr_val), attr_val, test)
580
          raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
581
                                     (self.OP_ID, attr_name),
582
                                     errors.ECODE_INVAL)
583

    
584

    
585
def _BuildJobDepCheck(relative):
586
  """Builds check for job dependencies (L{DEPEND_ATTR}).
587

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

592
  """
593
  if relative:
594
    job_id = ht.TOr(ht.TJobId, ht.TRelativeJobId)
595
  else:
596
    job_id = ht.TJobId
597

    
598
  job_dep = \
599
    ht.TAnd(ht.TOr(ht.TList, ht.TTuple),
600
            ht.TIsLength(2),
601
            ht.TItems([job_id,
602
                       ht.TListOf(ht.TElemOf(constants.JOBS_FINALIZED))]))
603

    
604
  return ht.TMaybeListOf(job_dep)
605

    
606

    
607
TNoRelativeJobDependencies = _BuildJobDepCheck(False)
608

    
609
#: List of submission status and job ID as returned by C{SubmitManyJobs}
610
_TJobIdListItem = \
611
  ht.TAnd(ht.TIsLength(2),
612
          ht.TItems([ht.Comment("success")(ht.TBool),
613
                     ht.Comment("Job ID if successful, error message"
614
                                " otherwise")(ht.TOr(ht.TString,
615
                                                     ht.TJobId))]))
616
TJobIdList = ht.TListOf(_TJobIdListItem)
617

    
618
#: Result containing only list of submitted jobs
619
TJobIdListOnly = ht.TStrictDict(True, True, {
620
  constants.JOB_IDS_KEY: ht.Comment("List of submitted jobs")(TJobIdList),
621
  })
622

    
623

    
624
class OpCode(BaseOpCode):
625
  """Abstract OpCode.
626

627
  This is the root of the actual OpCode hierarchy. All clases derived
628
  from this class should override OP_ID.
629

630
  @cvar OP_ID: The ID of this opcode. This should be unique amongst all
631
               children of this class.
632
  @cvar OP_DSC_FIELD: The name of a field whose value will be included in the
633
                      string returned by Summary(); see the docstring of that
634
                      method for details).
635
  @cvar OP_DSC_FORMATTER: A callable that should format the OP_DSC_FIELD; if
636
                          not present, then the field will be simply converted
637
                          to string
638
  @cvar OP_PARAMS: List of opcode attributes, the default values they should
639
                   get if not already defined, and types they must match.
640
  @cvar OP_RESULT: Callable to verify opcode result
641
  @cvar WITH_LU: Boolean that specifies whether this should be included in
642
      mcpu's dispatch table
643
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
644
                 the check steps
645
  @ivar priority: Opcode priority for queue
646

647
  """
648
  # pylint: disable=E1101
649
  # as OP_ID is dynamically defined
650
  WITH_LU = True
651
  OP_PARAMS = [
652
    ("dry_run", None, ht.TMaybeBool, "Run checks only, don't execute"),
653
    ("debug_level", None, ht.TMaybe(ht.TNonNegativeInt), "Debug level"),
654
    ("priority", constants.OP_PRIO_DEFAULT,
655
     ht.TElemOf(constants.OP_PRIO_SUBMIT_VALID), "Opcode priority"),
656
    (DEPEND_ATTR, None, _BuildJobDepCheck(True),
657
     "Job dependencies; if used through ``SubmitManyJobs`` relative (negative)"
658
     " job IDs can be used; see :doc:`design document <design-chained-jobs>`"
659
     " for details"),
660
    (COMMENT_ATTR, None, ht.TMaybeString,
661
     "Comment describing the purpose of the opcode"),
662
    (constants.OPCODE_REASON, None, ht.TMaybeList,
663
     "The reason trail, describing why the OpCode is executed"),
664
    ]
665
  OP_RESULT = None
666

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

670
    This method adds to the state dictionary the OP_ID of the class,
671
    so that on unload we can identify the correct class for
672
    instantiating the opcode.
673

674
    @rtype:   C{dict}
675
    @return:  the state as a dictionary
676

677
    """
678
    data = BaseOpCode.__getstate__(self)
679
    data["OP_ID"] = self.OP_ID
680
    return data
681

    
682
  @classmethod
683
  def LoadOpCode(cls, data):
684
    """Generic load opcode method.
685

686
    The method identifies the correct opcode class from the dict-form
687
    by looking for a OP_ID key, if this is not found, or its value is
688
    not available in this module as a child of this class, we fail.
689

690
    @type data:  C{dict}
691
    @param data: the serialized opcode
692

693
    """
694
    if not isinstance(data, dict):
695
      raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
696
    if "OP_ID" not in data:
697
      raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
698
    op_id = data["OP_ID"]
699
    op_class = None
700
    if op_id in OP_MAPPING:
701
      op_class = OP_MAPPING[op_id]
702
    else:
703
      raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
704
                       op_id)
705
    op = op_class()
706
    new_data = data.copy()
707
    del new_data["OP_ID"]
708
    op.__setstate__(new_data)
709
    return op
710

    
711
  def Summary(self):
712
    """Generates a summary description of this opcode.
713

714
    The summary is the value of the OP_ID attribute (without the "OP_"
715
    prefix), plus the value of the OP_DSC_FIELD attribute, if one was
716
    defined; this field should allow to easily identify the operation
717
    (for an instance creation job, e.g., it would be the instance
718
    name).
719

720
    """
721
    assert self.OP_ID is not None and len(self.OP_ID) > 3
722
    # all OP_ID start with OP_, we remove that
723
    txt = self.OP_ID[3:]
724
    field_name = getattr(self, "OP_DSC_FIELD", None)
725
    if field_name:
726
      field_value = getattr(self, field_name, None)
727
      field_formatter = getattr(self, "OP_DSC_FORMATTER", None)
728
      if callable(field_formatter):
729
        field_value = field_formatter(field_value)
730
      elif isinstance(field_value, (list, tuple)):
731
        field_value = ",".join(str(i) for i in field_value)
732
      txt = "%s(%s)" % (txt, field_value)
733
    return txt
734

    
735
  def TinySummary(self):
736
    """Generates a compact summary description of the opcode.
737

738
    """
739
    assert self.OP_ID.startswith("OP_")
740

    
741
    text = self.OP_ID[3:]
742

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

    
747
    return text
748

    
749

    
750
# cluster opcodes
751

    
752
class OpClusterPostInit(OpCode):
753
  """Post cluster initialization.
754

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

758
  """
759
  OP_RESULT = ht.TBool
760

    
761

    
762
class OpClusterDestroy(OpCode):
763
  """Destroy the cluster.
764

765
  This opcode has no other parameters. All the state is irreversibly
766
  lost after the execution of this opcode.
767

768
  """
769
  OP_RESULT = ht.TNonEmptyString
770

    
771

    
772
class OpClusterQuery(OpCode):
773
  """Query cluster information."""
774
  OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TAny)
775

    
776

    
777
class OpClusterVerify(OpCode):
778
  """Submits all jobs necessary to verify the cluster.
779

780
  """
781
  OP_PARAMS = [
782
    _PDebugSimulateErrors,
783
    _PErrorCodes,
784
    _PSkipChecks,
785
    _PIgnoreErrors,
786
    _PVerbose,
787
    ("group_name", None, ht.TMaybeString, "Group to verify"),
788
    ]
789
  OP_RESULT = TJobIdListOnly
790

    
791

    
792
class OpClusterVerifyConfig(OpCode):
793
  """Verify the cluster config.
794

795
  """
796
  OP_PARAMS = [
797
    _PDebugSimulateErrors,
798
    _PErrorCodes,
799
    _PIgnoreErrors,
800
    _PVerbose,
801
    ]
802
  OP_RESULT = ht.TBool
803

    
804

    
805
class OpClusterVerifyGroup(OpCode):
806
  """Run verify on a node group from the cluster.
807

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

814
  """
815
  OP_DSC_FIELD = "group_name"
816
  OP_PARAMS = [
817
    _PGroupName,
818
    _PDebugSimulateErrors,
819
    _PErrorCodes,
820
    _PSkipChecks,
821
    _PIgnoreErrors,
822
    _PVerbose,
823
    ]
824
  OP_RESULT = ht.TBool
825

    
826

    
827
class OpClusterVerifyDisks(OpCode):
828
  """Verify the cluster disks.
829

830
  """
831
  OP_RESULT = TJobIdListOnly
832

    
833

    
834
class OpGroupVerifyDisks(OpCode):
835
  """Verifies the status of all disks in a node group.
836

837
  Result: a tuple of three elements:
838
    - dict of node names with issues (values: error msg)
839
    - list of instances with degraded disks (that should be activated)
840
    - dict of instances with missing logical volumes (values: (node, vol)
841
      pairs with details about the missing volumes)
842

843
  In normal operation, all lists should be empty. A non-empty instance
844
  list (3rd element of the result) is still ok (errors were fixed) but
845
  non-empty node list means some node is down, and probably there are
846
  unfixable drbd errors.
847

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

851
  """
852
  OP_DSC_FIELD = "group_name"
853
  OP_PARAMS = [
854
    _PGroupName,
855
    ]
856
  OP_RESULT = \
857
    ht.TAnd(ht.TIsLength(3),
858
            ht.TItems([ht.TDictOf(ht.TString, ht.TString),
859
                       ht.TListOf(ht.TString),
860
                       ht.TDictOf(ht.TString,
861
                                  ht.TListOf(ht.TListOf(ht.TString)))]))
862

    
863

    
864
class OpClusterRepairDiskSizes(OpCode):
865
  """Verify the disk sizes of the instances and fixes configuration
866
  mimatches.
867

868
  Parameters: optional instances list, in case we want to restrict the
869
  checks to only a subset of the instances.
870

871
  Result: a list of tuples, (instance, disk, parameter, new-size) for changed
872
  configurations.
873

874
  In normal operation, the list should be empty.
875

876
  @type instances: list
877
  @ivar instances: the list of instances to check, or empty for all instances
878

879
  """
880
  OP_PARAMS = [
881
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
882
    ]
883
  OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(4),
884
                                 ht.TItems([ht.TNonEmptyString,
885
                                            ht.TNonNegativeInt,
886
                                            ht.TNonEmptyString,
887
                                            ht.TNonNegativeInt])))
888

    
889

    
890
class OpClusterConfigQuery(OpCode):
891
  """Query cluster configuration values."""
892
  OP_PARAMS = [
893
    _POutputFields,
894
    ]
895
  OP_RESULT = ht.TListOf(ht.TAny)
896

    
897

    
898
class OpClusterRename(OpCode):
899
  """Rename the cluster.
900

901
  @type name: C{str}
902
  @ivar name: The new name of the cluster. The name and/or the master IP
903
              address will be changed to match the new name and its IP
904
              address.
905

906
  """
907
  OP_DSC_FIELD = "name"
908
  OP_PARAMS = [
909
    ("name", ht.NoDefault, ht.TNonEmptyString, None),
910
    ]
911
  OP_RESULT = ht.TNonEmptyString
912

    
913

    
914
class OpClusterSetParams(OpCode):
915
  """Change the parameters of the cluster.
916

917
  @type vg_name: C{str} or C{None}
918
  @ivar vg_name: The new volume group name or None to disable LVM usage.
919

920
  """
921
  OP_PARAMS = [
922
    _PHvState,
923
    _PDiskState,
924
    ("vg_name", None, ht.TMaybe(ht.TString), "Volume group name"),
925
    ("enabled_hypervisors", None,
926
     ht.TMaybe(ht.TAnd(ht.TListOf(ht.TElemOf(constants.HYPER_TYPES)),
927
                       ht.TTrue)),
928
     "List of enabled hypervisors"),
929
    ("hvparams", None,
930
     ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
931
     "Cluster-wide hypervisor parameter defaults, hypervisor-dependent"),
932
    ("beparams", None, ht.TMaybeDict,
933
     "Cluster-wide backend parameter defaults"),
934
    ("os_hvp", None, ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
935
     "Cluster-wide per-OS hypervisor parameter defaults"),
936
    ("osparams", None,
937
     ht.TMaybe(ht.TDictOf(ht.TNonEmptyString, ht.TDict)),
938
     "Cluster-wide OS parameter defaults"),
939
    _PDiskParams,
940
    ("candidate_pool_size", None, ht.TMaybe(ht.TPositiveInt),
941
     "Master candidate pool size"),
942
    ("uid_pool", None, ht.NoType,
943
     "Set UID pool, must be list of lists describing UID ranges (two items,"
944
     " start and end inclusive)"),
945
    ("add_uids", None, ht.NoType,
946
     "Extend UID pool, must be list of lists describing UID ranges (two"
947
     " items, start and end inclusive) to be added"),
948
    ("remove_uids", None, ht.NoType,
949
     "Shrink UID pool, must be list of lists describing UID ranges (two"
950
     " items, start and end inclusive) to be removed"),
951
    ("maintain_node_health", None, ht.TMaybeBool,
952
     "Whether to automatically maintain node health"),
953
    ("prealloc_wipe_disks", None, ht.TMaybeBool,
954
     "Whether to wipe disks before allocating them to instances"),
955
    ("nicparams", None, ht.TMaybeDict, "Cluster-wide NIC parameter defaults"),
956
    ("ndparams", None, ht.TMaybeDict, "Cluster-wide node parameter defaults"),
957
    ("ipolicy", None, ht.TMaybeDict,
958
     "Cluster-wide :ref:`instance policy <rapi-ipolicy>` specs"),
959
    ("drbd_helper", None, ht.TMaybe(ht.TString), "DRBD helper program"),
960
    ("default_iallocator", None, ht.TMaybe(ht.TString),
961
     "Default iallocator for cluster"),
962
    ("master_netdev", None, ht.TMaybe(ht.TString),
963
     "Master network device"),
964
    ("master_netmask", None, ht.TMaybe(ht.TNonNegativeInt),
965
     "Netmask of the master IP"),
966
    ("reserved_lvs", None, ht.TMaybeListOf(ht.TNonEmptyString),
967
     "List of reserved LVs"),
968
    ("hidden_os", None, _TestClusterOsList,
969
     "Modify list of hidden operating systems: each modification must have"
970
     " two items, the operation and the OS name; the operation can be"
971
     " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
972
    ("blacklisted_os", None, _TestClusterOsList,
973
     "Modify list of blacklisted operating systems: each modification must"
974
     " have two items, the operation and the OS name; the operation can be"
975
     " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
976
    ("use_external_mip_script", None, ht.TMaybeBool,
977
     "Whether to use an external master IP address setup script"),
978
    ("enabled_disk_templates", None,
979
     ht.TMaybe(ht.TAnd(ht.TListOf(ht.TElemOf(constants.DISK_TEMPLATES)),
980
                       ht.TTrue)),
981
     "List of enabled disk templates"),
982
    ]
983
  OP_RESULT = ht.TNone
984

    
985

    
986
class OpClusterRedistConf(OpCode):
987
  """Force a full push of the cluster configuration.
988

989
  """
990
  OP_RESULT = ht.TNone
991

    
992

    
993
class OpClusterActivateMasterIp(OpCode):
994
  """Activate the master IP on the master node.
995

996
  """
997
  OP_RESULT = ht.TNone
998

    
999

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

1003
  """
1004
  OP_RESULT = ht.TNone
1005

    
1006

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

1010
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
1011
  @ivar fields: List of fields to retrieve
1012
  @ivar qfilter: Query filter
1013

1014
  """
1015
  OP_DSC_FIELD = "what"
1016
  OP_PARAMS = [
1017
    _PQueryWhat,
1018
    _PUseLocking,
1019
    ("fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
1020
     "Requested fields"),
1021
    ("qfilter", None, ht.TMaybe(ht.TList),
1022
     "Query filter"),
1023
    ]
1024
  OP_RESULT = \
1025
    _GenerateObjectTypeCheck(objects.QueryResponse, {
1026
      "fields": ht.TListOf(_TQueryFieldDef),
1027
      "data": _TQueryResult,
1028
      })
1029

    
1030

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

1034
  @ivar what: Resources to query for, must be one of L{constants.QR_VIA_OP}
1035
  @ivar fields: List of fields to retrieve
1036

1037
  """
1038
  OP_DSC_FIELD = "what"
1039
  OP_PARAMS = [
1040
    _PQueryWhat,
1041
    ("fields", None, ht.TMaybeListOf(ht.TNonEmptyString),
1042
     "Requested fields; if not given, all are returned"),
1043
    ]
1044
  OP_RESULT = \
1045
    _GenerateObjectTypeCheck(objects.QueryFieldsResponse, {
1046
      "fields": ht.TListOf(_TQueryFieldDef),
1047
      })
1048

    
1049

    
1050
class OpOobCommand(OpCode):
1051
  """Interact with OOB."""
1052
  OP_PARAMS = [
1053
    ("node_names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1054
     "List of nodes to run the OOB command against"),
1055
    ("command", ht.NoDefault, ht.TElemOf(constants.OOB_COMMANDS),
1056
     "OOB command to be run"),
1057
    ("timeout", constants.OOB_TIMEOUT, ht.TInt,
1058
     "Timeout before the OOB helper will be terminated"),
1059
    ("ignore_status", False, ht.TBool,
1060
     "Ignores the node offline status for power off"),
1061
    ("power_delay", constants.OOB_POWER_DELAY, ht.TNonNegativeFloat,
1062
     "Time in seconds to wait between powering on nodes"),
1063
    ]
1064
  # Fixme: Make it more specific with all the special cases in LUOobCommand
1065
  OP_RESULT = _TQueryResult
1066

    
1067

    
1068
class OpRestrictedCommand(OpCode):
1069
  """Runs a restricted command on node(s).
1070

1071
  """
1072
  OP_PARAMS = [
1073
    _PUseLocking,
1074
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
1075
     "Nodes on which the command should be run (at least one)"),
1076
    ("command", ht.NoDefault, ht.TNonEmptyString,
1077
     "Command name (no parameters)"),
1078
    ]
1079

    
1080
  _RESULT_ITEMS = [
1081
    ht.Comment("success")(ht.TBool),
1082
    ht.Comment("output or error message")(ht.TString),
1083
    ]
1084

    
1085
  OP_RESULT = \
1086
    ht.TListOf(ht.TAnd(ht.TIsLength(len(_RESULT_ITEMS)),
1087
                       ht.TItems(_RESULT_ITEMS)))
1088

    
1089

    
1090
# node opcodes
1091

    
1092
class OpNodeRemove(OpCode):
1093
  """Remove a node.
1094

1095
  @type node_name: C{str}
1096
  @ivar node_name: The name of the node to remove. If the node still has
1097
                   instances on it, the operation will fail.
1098

1099
  """
1100
  OP_DSC_FIELD = "node_name"
1101
  OP_PARAMS = [
1102
    _PNodeName,
1103
    ]
1104
  OP_RESULT = ht.TNone
1105

    
1106

    
1107
class OpNodeAdd(OpCode):
1108
  """Add a node to the cluster.
1109

1110
  @type node_name: C{str}
1111
  @ivar node_name: The name of the node to add. This can be a short name,
1112
                   but it will be expanded to the FQDN.
1113
  @type primary_ip: IP address
1114
  @ivar primary_ip: The primary IP of the node. This will be ignored when the
1115
                    opcode is submitted, but will be filled during the node
1116
                    add (so it will be visible in the job query).
1117
  @type secondary_ip: IP address
1118
  @ivar secondary_ip: The secondary IP of the node. This needs to be passed
1119
                      if the cluster has been initialized in 'dual-network'
1120
                      mode, otherwise it must not be given.
1121
  @type readd: C{bool}
1122
  @ivar readd: Whether to re-add an existing node to the cluster. If
1123
               this is not passed, then the operation will abort if the node
1124
               name is already in the cluster; use this parameter to 'repair'
1125
               a node that had its configuration broken, or was reinstalled
1126
               without removal from the cluster.
1127
  @type group: C{str}
1128
  @ivar group: The node group to which this node will belong.
1129
  @type vm_capable: C{bool}
1130
  @ivar vm_capable: The vm_capable node attribute
1131
  @type master_capable: C{bool}
1132
  @ivar master_capable: The master_capable node attribute
1133

1134
  """
1135
  OP_DSC_FIELD = "node_name"
1136
  OP_PARAMS = [
1137
    _PNodeName,
1138
    _PHvState,
1139
    _PDiskState,
1140
    ("primary_ip", None, ht.NoType, "Primary IP address"),
1141
    ("secondary_ip", None, ht.TMaybeString, "Secondary IP address"),
1142
    ("readd", False, ht.TBool, "Whether node is re-added to cluster"),
1143
    ("group", None, ht.TMaybeString, "Initial node group"),
1144
    ("master_capable", None, ht.TMaybeBool,
1145
     "Whether node can become master or master candidate"),
1146
    ("vm_capable", None, ht.TMaybeBool,
1147
     "Whether node can host instances"),
1148
    ("ndparams", None, ht.TMaybeDict, "Node parameters"),
1149
    ]
1150
  OP_RESULT = ht.TNone
1151

    
1152

    
1153
class OpNodeQuery(OpCode):
1154
  """Compute the list of nodes."""
1155
  OP_PARAMS = [
1156
    _POutputFields,
1157
    _PUseLocking,
1158
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1159
     "Empty list to query all nodes, node names otherwise"),
1160
    ]
1161
  OP_RESULT = _TOldQueryResult
1162

    
1163

    
1164
class OpNodeQueryvols(OpCode):
1165
  """Get list of volumes on node."""
1166
  OP_PARAMS = [
1167
    _POutputFields,
1168
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1169
     "Empty list to query all nodes, node names otherwise"),
1170
    ]
1171
  OP_RESULT = ht.TListOf(ht.TAny)
1172

    
1173

    
1174
class OpNodeQueryStorage(OpCode):
1175
  """Get information on storage for node(s)."""
1176
  OP_PARAMS = [
1177
    _POutputFields,
1178
    _PStorageType,
1179
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "List of nodes"),
1180
    ("name", None, ht.TMaybeString, "Storage name"),
1181
    ]
1182
  OP_RESULT = _TOldQueryResult
1183

    
1184

    
1185
class OpNodeModifyStorage(OpCode):
1186
  """Modifies the properies of a storage unit"""
1187
  OP_DSC_FIELD = "node_name"
1188
  OP_PARAMS = [
1189
    _PNodeName,
1190
    _PStorageType,
1191
    _PStorageName,
1192
    ("changes", ht.NoDefault, ht.TDict, "Requested changes"),
1193
    ]
1194
  OP_RESULT = ht.TNone
1195

    
1196

    
1197
class OpRepairNodeStorage(OpCode):
1198
  """Repairs the volume group on a node."""
1199
  OP_DSC_FIELD = "node_name"
1200
  OP_PARAMS = [
1201
    _PNodeName,
1202
    _PStorageType,
1203
    _PStorageName,
1204
    _PIgnoreConsistency,
1205
    ]
1206
  OP_RESULT = ht.TNone
1207

    
1208

    
1209
class OpNodeSetParams(OpCode):
1210
  """Change the parameters of a node."""
1211
  OP_DSC_FIELD = "node_name"
1212
  OP_PARAMS = [
1213
    _PNodeName,
1214
    _PForce,
1215
    _PHvState,
1216
    _PDiskState,
1217
    ("master_candidate", None, ht.TMaybeBool,
1218
     "Whether the node should become a master candidate"),
1219
    ("offline", None, ht.TMaybeBool,
1220
     "Whether the node should be marked as offline"),
1221
    ("drained", None, ht.TMaybeBool,
1222
     "Whether the node should be marked as drained"),
1223
    ("auto_promote", False, ht.TBool,
1224
     "Whether node(s) should be promoted to master candidate if necessary"),
1225
    ("master_capable", None, ht.TMaybeBool,
1226
     "Denote whether node can become master or master candidate"),
1227
    ("vm_capable", None, ht.TMaybeBool,
1228
     "Denote whether node can host instances"),
1229
    ("secondary_ip", None, ht.TMaybeString,
1230
     "Change node's secondary IP address"),
1231
    ("ndparams", None, ht.TMaybeDict, "Set node parameters"),
1232
    ("powered", None, ht.TMaybeBool,
1233
     "Whether the node should be marked as powered"),
1234
    ]
1235
  OP_RESULT = _TSetParamsResult
1236

    
1237

    
1238
class OpNodePowercycle(OpCode):
1239
  """Tries to powercycle a node."""
1240
  OP_DSC_FIELD = "node_name"
1241
  OP_PARAMS = [
1242
    _PNodeName,
1243
    _PForce,
1244
    ]
1245
  OP_RESULT = ht.TMaybeString
1246

    
1247

    
1248
class OpNodeMigrate(OpCode):
1249
  """Migrate all instances from a node."""
1250
  OP_DSC_FIELD = "node_name"
1251
  OP_PARAMS = [
1252
    _PNodeName,
1253
    _PMigrationMode,
1254
    _PMigrationLive,
1255
    _PMigrationTargetNode,
1256
    _PAllowRuntimeChgs,
1257
    _PIgnoreIpolicy,
1258
    _PIAllocFromDesc("Iallocator for deciding the target node"
1259
                     " for shared-storage instances"),
1260
    ]
1261
  OP_RESULT = TJobIdListOnly
1262

    
1263

    
1264
class OpNodeEvacuate(OpCode):
1265
  """Evacuate instances off a number of nodes."""
1266
  OP_DSC_FIELD = "node_name"
1267
  OP_PARAMS = [
1268
    _PEarlyRelease,
1269
    _PNodeName,
1270
    ("remote_node", None, ht.TMaybeString, "New secondary node"),
1271
    _PIAllocFromDesc("Iallocator for computing solution"),
1272
    ("mode", ht.NoDefault, ht.TElemOf(constants.NODE_EVAC_MODES),
1273
     "Node evacuation mode"),
1274
    ]
1275
  OP_RESULT = TJobIdListOnly
1276

    
1277

    
1278
# instance opcodes
1279

    
1280
class OpInstanceCreate(OpCode):
1281
  """Create an instance.
1282

1283
  @ivar instance_name: Instance name
1284
  @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
1285
  @ivar source_handshake: Signed handshake from source (remote import only)
1286
  @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
1287
  @ivar source_instance_name: Previous name of instance (remote import only)
1288
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
1289
    (remote import only)
1290

1291
  """
1292
  OP_DSC_FIELD = "instance_name"
1293
  OP_PARAMS = [
1294
    _PInstanceName,
1295
    _PForceVariant,
1296
    _PWaitForSync,
1297
    _PNameCheck,
1298
    _PIgnoreIpolicy,
1299
    _POpportunisticLocking,
1300
    ("beparams", ht.EmptyDict, ht.TDict, "Backend parameters for instance"),
1301
    ("disks", ht.NoDefault, ht.TListOf(_TDiskParams),
1302
     "Disk descriptions, for example ``[{\"%s\": 100}, {\"%s\": 5}]``;"
1303
     " each disk definition must contain a ``%s`` value and"
1304
     " can contain an optional ``%s`` value denoting the disk access mode"
1305
     " (%s)" %
1306
     (constants.IDISK_SIZE, constants.IDISK_SIZE, constants.IDISK_SIZE,
1307
      constants.IDISK_MODE,
1308
      " or ".join("``%s``" % i for i in sorted(constants.DISK_ACCESS_SET)))),
1309
    ("disk_template", ht.NoDefault, _BuildDiskTemplateCheck(True),
1310
     "Disk template"),
1311
    ("file_driver", None, ht.TMaybe(ht.TElemOf(constants.FILE_DRIVER)),
1312
     "Driver for file-backed disks"),
1313
    ("file_storage_dir", None, ht.TMaybeString,
1314
     "Directory for storing file-backed disks"),
1315
    ("hvparams", ht.EmptyDict, ht.TDict,
1316
     "Hypervisor parameters for instance, hypervisor-dependent"),
1317
    ("hypervisor", None, ht.TMaybeString, "Hypervisor"),
1318
    _PIAllocFromDesc("Iallocator for deciding which node(s) to use"),
1319
    ("identify_defaults", False, ht.TBool,
1320
     "Reset instance parameters to default if equal"),
1321
    ("ip_check", True, ht.TBool, _PIpCheckDoc),
1322
    ("conflicts_check", True, ht.TBool, "Check for conflicting IPs"),
1323
    ("mode", ht.NoDefault, ht.TElemOf(constants.INSTANCE_CREATE_MODES),
1324
     "Instance creation mode"),
1325
    ("nics", ht.NoDefault, ht.TListOf(_TestNicDef),
1326
     "List of NIC (network interface) definitions, for example"
1327
     " ``[{}, {}, {\"%s\": \"198.51.100.4\"}]``; each NIC definition can"
1328
     " contain the optional values %s" %
1329
     (constants.INIC_IP,
1330
      ", ".join("``%s``" % i for i in sorted(constants.INIC_PARAMS)))),
1331
    ("no_install", None, ht.TMaybeBool,
1332
     "Do not install the OS (will disable automatic start)"),
1333
    ("osparams", ht.EmptyDict, ht.TDict, "OS parameters for instance"),
1334
    ("os_type", None, ht.TMaybeString, "Operating system"),
1335
    ("pnode", None, ht.TMaybeString, "Primary node"),
1336
    ("snode", None, ht.TMaybeString, "Secondary node"),
1337
    ("source_handshake", None, ht.TMaybe(ht.TList),
1338
     "Signed handshake from source (remote import only)"),
1339
    ("source_instance_name", None, ht.TMaybeString,
1340
     "Source instance name (remote import only)"),
1341
    ("source_shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
1342
     ht.TNonNegativeInt,
1343
     "How long source instance was given to shut down (remote import only)"),
1344
    ("source_x509_ca", None, ht.TMaybeString,
1345
     "Source X509 CA in PEM format (remote import only)"),
1346
    ("src_node", None, ht.TMaybeString, "Source node for import"),
1347
    ("src_path", None, ht.TMaybeString, "Source directory for import"),
1348
    ("start", True, ht.TBool, "Whether to start instance after creation"),
1349
    ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Instance tags"),
1350
    ]
1351
  OP_RESULT = ht.Comment("instance nodes")(ht.TListOf(ht.TNonEmptyString))
1352

    
1353

    
1354
class OpInstanceMultiAlloc(OpCode):
1355
  """Allocates multiple instances.
1356

1357
  """
1358
  OP_PARAMS = [
1359
    _POpportunisticLocking,
1360
    _PIAllocFromDesc("Iallocator used to allocate all the instances"),
1361
    ("instances", ht.EmptyList, ht.TListOf(ht.TInstanceOf(OpInstanceCreate)),
1362
     "List of instance create opcodes describing the instances to allocate"),
1363
    ]
1364
  _JOB_LIST = ht.Comment("List of submitted jobs")(TJobIdList)
1365
  ALLOCATABLE_KEY = "allocatable"
1366
  FAILED_KEY = "allocatable"
1367
  OP_RESULT = ht.TStrictDict(True, True, {
1368
    constants.JOB_IDS_KEY: _JOB_LIST,
1369
    ALLOCATABLE_KEY: ht.TListOf(ht.TNonEmptyString),
1370
    FAILED_KEY: ht.TListOf(ht.TNonEmptyString),
1371
    })
1372

    
1373
  def __getstate__(self):
1374
    """Generic serializer.
1375

1376
    """
1377
    state = OpCode.__getstate__(self)
1378
    if hasattr(self, "instances"):
1379
      # pylint: disable=E1101
1380
      state["instances"] = [inst.__getstate__() for inst in self.instances]
1381
    return state
1382

    
1383
  def __setstate__(self, state):
1384
    """Generic unserializer.
1385

1386
    This method just restores from the serialized state the attributes
1387
    of the current instance.
1388

1389
    @param state: the serialized opcode data
1390
    @type state: C{dict}
1391

1392
    """
1393
    if not isinstance(state, dict):
1394
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
1395
                       type(state))
1396

    
1397
    if "instances" in state:
1398
      state["instances"] = map(OpCode.LoadOpCode, state["instances"])
1399

    
1400
    return OpCode.__setstate__(self, state)
1401

    
1402
  def Validate(self, set_defaults):
1403
    """Validates this opcode.
1404

1405
    We do this recursively.
1406

1407
    """
1408
    OpCode.Validate(self, set_defaults)
1409

    
1410
    for inst in self.instances: # pylint: disable=E1101
1411
      inst.Validate(set_defaults)
1412

    
1413

    
1414
class OpInstanceReinstall(OpCode):
1415
  """Reinstall an instance's OS."""
1416
  OP_DSC_FIELD = "instance_name"
1417
  OP_PARAMS = [
1418
    _PInstanceName,
1419
    _PForceVariant,
1420
    ("os_type", None, ht.TMaybeString, "Instance operating system"),
1421
    ("osparams", None, ht.TMaybeDict, "Temporary OS parameters"),
1422
    ]
1423
  OP_RESULT = ht.TNone
1424

    
1425

    
1426
class OpInstanceRemove(OpCode):
1427
  """Remove an instance."""
1428
  OP_DSC_FIELD = "instance_name"
1429
  OP_PARAMS = [
1430
    _PInstanceName,
1431
    _PShutdownTimeout,
1432
    ("ignore_failures", False, ht.TBool,
1433
     "Whether to ignore failures during removal"),
1434
    ]
1435
  OP_RESULT = ht.TNone
1436

    
1437

    
1438
class OpInstanceRename(OpCode):
1439
  """Rename an instance."""
1440
  OP_PARAMS = [
1441
    _PInstanceName,
1442
    _PNameCheck,
1443
    ("new_name", ht.NoDefault, ht.TNonEmptyString, "New instance name"),
1444
    ("ip_check", False, ht.TBool, _PIpCheckDoc),
1445
    ]
1446
  OP_RESULT = ht.Comment("New instance name")(ht.TNonEmptyString)
1447

    
1448

    
1449
class OpInstanceStartup(OpCode):
1450
  """Startup an instance."""
1451
  OP_DSC_FIELD = "instance_name"
1452
  OP_PARAMS = [
1453
    _PInstanceName,
1454
    _PForce,
1455
    _PIgnoreOfflineNodes,
1456
    ("hvparams", ht.EmptyDict, ht.TDict,
1457
     "Temporary hypervisor parameters, hypervisor-dependent"),
1458
    ("beparams", ht.EmptyDict, ht.TDict, "Temporary backend parameters"),
1459
    _PNoRemember,
1460
    _PStartupPaused,
1461
    ]
1462
  OP_RESULT = ht.TNone
1463

    
1464

    
1465
class OpInstanceShutdown(OpCode):
1466
  """Shutdown an instance."""
1467
  OP_DSC_FIELD = "instance_name"
1468
  OP_PARAMS = [
1469
    _PInstanceName,
1470
    _PForce,
1471
    _PIgnoreOfflineNodes,
1472
    ("timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT, ht.TNonNegativeInt,
1473
     "How long to wait for instance to shut down"),
1474
    _PNoRemember,
1475
    ]
1476
  OP_RESULT = ht.TNone
1477

    
1478

    
1479
class OpInstanceReboot(OpCode):
1480
  """Reboot an instance."""
1481
  OP_DSC_FIELD = "instance_name"
1482
  OP_PARAMS = [
1483
    _PInstanceName,
1484
    _PShutdownTimeout,
1485
    ("ignore_secondaries", False, ht.TBool,
1486
     "Whether to start the instance even if secondary disks are failing"),
1487
    ("reboot_type", ht.NoDefault, ht.TElemOf(constants.REBOOT_TYPES),
1488
     "How to reboot instance"),
1489
    ]
1490
  OP_RESULT = ht.TNone
1491

    
1492

    
1493
class OpInstanceReplaceDisks(OpCode):
1494
  """Replace the disks of an instance."""
1495
  OP_DSC_FIELD = "instance_name"
1496
  OP_PARAMS = [
1497
    _PInstanceName,
1498
    _PEarlyRelease,
1499
    _PIgnoreIpolicy,
1500
    ("mode", ht.NoDefault, ht.TElemOf(constants.REPLACE_MODES),
1501
     "Replacement mode"),
1502
    ("disks", ht.EmptyList, ht.TListOf(ht.TNonNegativeInt),
1503
     "Disk indexes"),
1504
    ("remote_node", None, ht.TMaybeString, "New secondary node"),
1505
    _PIAllocFromDesc("Iallocator for deciding new secondary node"),
1506
    ]
1507
  OP_RESULT = ht.TNone
1508

    
1509

    
1510
class OpInstanceFailover(OpCode):
1511
  """Failover an instance."""
1512
  OP_DSC_FIELD = "instance_name"
1513
  OP_PARAMS = [
1514
    _PInstanceName,
1515
    _PShutdownTimeout,
1516
    _PIgnoreConsistency,
1517
    _PMigrationTargetNode,
1518
    _PIgnoreIpolicy,
1519
    _PIAllocFromDesc("Iallocator for deciding the target node for"
1520
                     " shared-storage instances"),
1521
    ]
1522
  OP_RESULT = ht.TNone
1523

    
1524

    
1525
class OpInstanceMigrate(OpCode):
1526
  """Migrate an instance.
1527

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

1531
  @ivar instance_name: the name of the instance
1532
  @ivar mode: the migration mode (live, non-live or None for auto)
1533

1534
  """
1535
  OP_DSC_FIELD = "instance_name"
1536
  OP_PARAMS = [
1537
    _PInstanceName,
1538
    _PMigrationMode,
1539
    _PMigrationLive,
1540
    _PMigrationTargetNode,
1541
    _PAllowRuntimeChgs,
1542
    _PIgnoreIpolicy,
1543
    ("cleanup", False, ht.TBool,
1544
     "Whether a previously failed migration should be cleaned up"),
1545
    _PIAllocFromDesc("Iallocator for deciding the target node for"
1546
                     " shared-storage instances"),
1547
    ("allow_failover", False, ht.TBool,
1548
     "Whether we can fallback to failover if migration is not possible"),
1549
    ]
1550
  OP_RESULT = ht.TNone
1551

    
1552

    
1553
class OpInstanceMove(OpCode):
1554
  """Move an instance.
1555

1556
  This move (with shutting down an instance and data copying) to an
1557
  arbitrary node.
1558

1559
  @ivar instance_name: the name of the instance
1560
  @ivar target_node: the destination node
1561

1562
  """
1563
  OP_DSC_FIELD = "instance_name"
1564
  OP_PARAMS = [
1565
    _PInstanceName,
1566
    _PShutdownTimeout,
1567
    _PIgnoreIpolicy,
1568
    ("target_node", ht.NoDefault, ht.TNonEmptyString, "Target node"),
1569
    _PIgnoreConsistency,
1570
    ]
1571
  OP_RESULT = ht.TNone
1572

    
1573

    
1574
class OpInstanceConsole(OpCode):
1575
  """Connect to an instance's console."""
1576
  OP_DSC_FIELD = "instance_name"
1577
  OP_PARAMS = [
1578
    _PInstanceName,
1579
    ]
1580
  OP_RESULT = ht.TDict
1581

    
1582

    
1583
class OpInstanceActivateDisks(OpCode):
1584
  """Activate an instance's disks."""
1585
  OP_DSC_FIELD = "instance_name"
1586
  OP_PARAMS = [
1587
    _PInstanceName,
1588
    ("ignore_size", False, ht.TBool, "Whether to ignore recorded size"),
1589
    _PWaitForSyncFalse,
1590
    ]
1591
  OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(3),
1592
                                 ht.TItems([ht.TNonEmptyString,
1593
                                            ht.TNonEmptyString,
1594
                                            ht.TNonEmptyString])))
1595

    
1596

    
1597
class OpInstanceDeactivateDisks(OpCode):
1598
  """Deactivate an instance's disks."""
1599
  OP_DSC_FIELD = "instance_name"
1600
  OP_PARAMS = [
1601
    _PInstanceName,
1602
    _PForce,
1603
    ]
1604
  OP_RESULT = ht.TNone
1605

    
1606

    
1607
class OpInstanceRecreateDisks(OpCode):
1608
  """Recreate an instance's disks."""
1609
  _TDiskChanges = \
1610
    ht.TAnd(ht.TIsLength(2),
1611
            ht.TItems([ht.Comment("Disk index")(ht.TNonNegativeInt),
1612
                       ht.Comment("Parameters")(_TDiskParams)]))
1613

    
1614
  OP_DSC_FIELD = "instance_name"
1615
  OP_PARAMS = [
1616
    _PInstanceName,
1617
    ("disks", ht.EmptyList,
1618
     ht.TOr(ht.TListOf(ht.TNonNegativeInt), ht.TListOf(_TDiskChanges)),
1619
     "List of disk indexes (deprecated) or a list of tuples containing a disk"
1620
     " index and a possibly empty dictionary with disk parameter changes"),
1621
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1622
     "New instance nodes, if relocation is desired"),
1623
    _PIAllocFromDesc("Iallocator for deciding new nodes"),
1624
    ]
1625
  OP_RESULT = ht.TNone
1626

    
1627

    
1628
class OpInstanceQuery(OpCode):
1629
  """Compute the list of instances."""
1630
  OP_PARAMS = [
1631
    _POutputFields,
1632
    _PUseLocking,
1633
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1634
     "Empty list to query all instances, instance names otherwise"),
1635
    ]
1636
  OP_RESULT = _TOldQueryResult
1637

    
1638

    
1639
class OpInstanceQueryData(OpCode):
1640
  """Compute the run-time status of instances."""
1641
  OP_PARAMS = [
1642
    _PUseLocking,
1643
    ("instances", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1644
     "Instance names"),
1645
    ("static", False, ht.TBool,
1646
     "Whether to only return configuration data without querying"
1647
     " nodes"),
1648
    ]
1649
  OP_RESULT = ht.TDictOf(ht.TNonEmptyString, ht.TDict)
1650

    
1651

    
1652
def _TestInstSetParamsModList(fn):
1653
  """Generates a check for modification lists.
1654

1655
  """
1656
  # Old format
1657
  # TODO: Remove in version 2.8 including support in LUInstanceSetParams
1658
  old_mod_item_fn = \
1659
    ht.TAnd(ht.TIsLength(2), ht.TItems([
1660
      ht.TOr(ht.TElemOf(constants.DDMS_VALUES), ht.TNonNegativeInt),
1661
      fn,
1662
      ]))
1663

    
1664
  # New format, supporting adding/removing disks/NICs at arbitrary indices
1665
  mod_item_fn = \
1666
    ht.TAnd(ht.TIsLength(3), ht.TItems([
1667
      ht.TElemOf(constants.DDMS_VALUES_WITH_MODIFY),
1668
      ht.Comment("Device index, can be negative, e.g. -1 for last disk")
1669
                 (ht.TOr(ht.TInt, ht.TString)),
1670
      fn,
1671
      ]))
1672

    
1673
  return ht.TOr(ht.Comment("Recommended")(ht.TListOf(mod_item_fn)),
1674
                ht.Comment("Deprecated")(ht.TListOf(old_mod_item_fn)))
1675

    
1676

    
1677
class OpInstanceSetParams(OpCode):
1678
  """Change the parameters of an instance.
1679

1680
  """
1681
  TestNicModifications = _TestInstSetParamsModList(_TestNicDef)
1682
  TestDiskModifications = _TestInstSetParamsModList(_TDiskParams)
1683

    
1684
  OP_DSC_FIELD = "instance_name"
1685
  OP_PARAMS = [
1686
    _PInstanceName,
1687
    _PForce,
1688
    _PForceVariant,
1689
    _PIgnoreIpolicy,
1690
    ("nics", ht.EmptyList, TestNicModifications,
1691
     "List of NIC changes: each item is of the form"
1692
     " ``(op, identifier, settings)``, ``op`` is one of ``%s``, ``%s`` or"
1693
     " ``%s``, ``identifier`` can be a zero-based index number (or -1 to refer"
1694
     " to the last position), the NIC's UUID of the NIC's name; a"
1695
     " deprecated version of this parameter used the form ``(op, settings)``,"
1696
     " where ``op`` can be ``%s`` to add a new NIC with the specified"
1697
     " settings, ``%s`` to remove the last NIC or a number to modify the"
1698
     " settings of the NIC with that index" %
1699
     (constants.DDM_ADD, constants.DDM_MODIFY, constants.DDM_REMOVE,
1700
      constants.DDM_ADD, constants.DDM_REMOVE)),
1701
    ("disks", ht.EmptyList, TestDiskModifications,
1702
     "List of disk changes; see ``nics``"),
1703
    ("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"),
1704
    ("runtime_mem", None, ht.TMaybePositiveInt, "New runtime memory"),
1705
    ("hvparams", ht.EmptyDict, ht.TDict,
1706
     "Per-instance hypervisor parameters, hypervisor-dependent"),
1707
    ("disk_template", None, ht.TMaybe(_BuildDiskTemplateCheck(False)),
1708
     "Disk template for instance"),
1709
    ("pnode", None, ht.TMaybeString, "New primary node"),
1710
    ("remote_node", None, ht.TMaybeString,
1711
     "Secondary node (used when changing disk template)"),
1712
    ("os_name", None, ht.TMaybeString,
1713
     "Change the instance's OS without reinstalling the instance"),
1714
    ("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
1715
    ("wait_for_sync", True, ht.TBool,
1716
     "Whether to wait for the disk to synchronize, when changing template"),
1717
    ("offline", None, ht.TMaybeBool, "Whether to mark instance as offline"),
1718
    ("conflicts_check", True, ht.TBool, "Check for conflicting IPs"),
1719
    ]
1720
  OP_RESULT = _TSetParamsResult
1721

    
1722

    
1723
class OpInstanceGrowDisk(OpCode):
1724
  """Grow a disk of an instance."""
1725
  OP_DSC_FIELD = "instance_name"
1726
  OP_PARAMS = [
1727
    _PInstanceName,
1728
    _PWaitForSync,
1729
    ("disk", ht.NoDefault, ht.TInt, "Disk index"),
1730
    ("amount", ht.NoDefault, ht.TNonNegativeInt,
1731
     "Amount of disk space to add (megabytes)"),
1732
    ("absolute", False, ht.TBool,
1733
     "Whether the amount parameter is an absolute target or a relative one"),
1734
    ]
1735
  OP_RESULT = ht.TNone
1736

    
1737

    
1738
class OpInstanceChangeGroup(OpCode):
1739
  """Moves an instance to another node group."""
1740
  OP_DSC_FIELD = "instance_name"
1741
  OP_PARAMS = [
1742
    _PInstanceName,
1743
    _PEarlyRelease,
1744
    _PIAllocFromDesc("Iallocator for computing solution"),
1745
    _PTargetGroups,
1746
    ]
1747
  OP_RESULT = TJobIdListOnly
1748

    
1749

    
1750
# Node group opcodes
1751

    
1752
class OpGroupAdd(OpCode):
1753
  """Add a node group to the cluster."""
1754
  OP_DSC_FIELD = "group_name"
1755
  OP_PARAMS = [
1756
    _PGroupName,
1757
    _PNodeGroupAllocPolicy,
1758
    _PGroupNodeParams,
1759
    _PDiskParams,
1760
    _PHvState,
1761
    _PDiskState,
1762
    ("ipolicy", None, ht.TMaybeDict,
1763
     "Group-wide :ref:`instance policy <rapi-ipolicy>` specs"),
1764
    ]
1765
  OP_RESULT = ht.TNone
1766

    
1767

    
1768
class OpGroupAssignNodes(OpCode):
1769
  """Assign nodes to a node group."""
1770
  OP_DSC_FIELD = "group_name"
1771
  OP_PARAMS = [
1772
    _PGroupName,
1773
    _PForce,
1774
    ("nodes", ht.NoDefault, ht.TListOf(ht.TNonEmptyString),
1775
     "List of nodes to assign"),
1776
    ]
1777
  OP_RESULT = ht.TNone
1778

    
1779

    
1780
class OpGroupQuery(OpCode):
1781
  """Compute the list of node groups."""
1782
  OP_PARAMS = [
1783
    _POutputFields,
1784
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1785
     "Empty list to query all groups, group names otherwise"),
1786
    ]
1787
  OP_RESULT = _TOldQueryResult
1788

    
1789

    
1790
class OpGroupSetParams(OpCode):
1791
  """Change the parameters of a node group."""
1792
  OP_DSC_FIELD = "group_name"
1793
  OP_PARAMS = [
1794
    _PGroupName,
1795
    _PNodeGroupAllocPolicy,
1796
    _PGroupNodeParams,
1797
    _PDiskParams,
1798
    _PHvState,
1799
    _PDiskState,
1800
    ("ipolicy", None, ht.TMaybeDict, "Group-wide instance policy specs"),
1801
    ]
1802
  OP_RESULT = _TSetParamsResult
1803

    
1804

    
1805
class OpGroupRemove(OpCode):
1806
  """Remove a node group from the cluster."""
1807
  OP_DSC_FIELD = "group_name"
1808
  OP_PARAMS = [
1809
    _PGroupName,
1810
    ]
1811
  OP_RESULT = ht.TNone
1812

    
1813

    
1814
class OpGroupRename(OpCode):
1815
  """Rename a node group in the cluster."""
1816
  OP_PARAMS = [
1817
    _PGroupName,
1818
    ("new_name", ht.NoDefault, ht.TNonEmptyString, "New group name"),
1819
    ]
1820
  OP_RESULT = ht.Comment("New group name")(ht.TNonEmptyString)
1821

    
1822

    
1823
class OpGroupEvacuate(OpCode):
1824
  """Evacuate a node group in the cluster."""
1825
  OP_DSC_FIELD = "group_name"
1826
  OP_PARAMS = [
1827
    _PGroupName,
1828
    _PEarlyRelease,
1829
    _PIAllocFromDesc("Iallocator for computing solution"),
1830
    _PTargetGroups,
1831
    ]
1832
  OP_RESULT = TJobIdListOnly
1833

    
1834

    
1835
# OS opcodes
1836
class OpOsDiagnose(OpCode):
1837
  """Compute the list of guest operating systems."""
1838
  OP_PARAMS = [
1839
    _POutputFields,
1840
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1841
     "Which operating systems to diagnose"),
1842
    ]
1843
  OP_RESULT = _TOldQueryResult
1844

    
1845

    
1846
# ExtStorage opcodes
1847
class OpExtStorageDiagnose(OpCode):
1848
  """Compute the list of external storage providers."""
1849
  OP_PARAMS = [
1850
    _POutputFields,
1851
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1852
     "Which ExtStorage Provider to diagnose"),
1853
    ]
1854
  OP_RESULT = _TOldQueryResult
1855

    
1856

    
1857
# Exports opcodes
1858
class OpBackupQuery(OpCode):
1859
  """Compute the list of exported images."""
1860
  OP_PARAMS = [
1861
    _PUseLocking,
1862
    ("nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
1863
     "Empty list to query all nodes, node names otherwise"),
1864
    ]
1865
  OP_RESULT = ht.TDictOf(ht.TNonEmptyString,
1866
                         ht.TOr(ht.Comment("False on error")(ht.TBool),
1867
                                ht.TListOf(ht.TNonEmptyString)))
1868

    
1869

    
1870
class OpBackupPrepare(OpCode):
1871
  """Prepares an instance export.
1872

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

1876
  """
1877
  OP_DSC_FIELD = "instance_name"
1878
  OP_PARAMS = [
1879
    _PInstanceName,
1880
    ("mode", ht.NoDefault, ht.TElemOf(constants.EXPORT_MODES),
1881
     "Export mode"),
1882
    ]
1883
  OP_RESULT = ht.TMaybeDict
1884

    
1885

    
1886
class OpBackupExport(OpCode):
1887
  """Export an instance.
1888

1889
  For local exports, the export destination is the node name. For
1890
  remote exports, the export destination is a list of tuples, each
1891
  consisting of hostname/IP address, port, magic, HMAC and HMAC
1892
  salt. The HMAC is calculated using the cluster domain secret over
1893
  the value "${index}:${hostname}:${port}". The destination X509 CA
1894
  must be a signed certificate.
1895

1896
  @ivar mode: Export mode (one of L{constants.EXPORT_MODES})
1897
  @ivar target_node: Export destination
1898
  @ivar x509_key_name: X509 key to use (remote export only)
1899
  @ivar destination_x509_ca: Destination X509 CA in PEM format (remote export
1900
                             only)
1901

1902
  """
1903
  OP_DSC_FIELD = "instance_name"
1904
  OP_PARAMS = [
1905
    _PInstanceName,
1906
    _PShutdownTimeout,
1907
    # TODO: Rename target_node as it changes meaning for different export modes
1908
    # (e.g. "destination")
1909
    ("target_node", ht.NoDefault, ht.TOr(ht.TNonEmptyString, ht.TList),
1910
     "Destination information, depends on export mode"),
1911
    ("shutdown", True, ht.TBool, "Whether to shutdown instance before export"),
1912
    ("remove_instance", False, ht.TBool,
1913
     "Whether to remove instance after export"),
1914
    ("ignore_remove_failures", False, ht.TBool,
1915
     "Whether to ignore failures while removing instances"),
1916
    ("mode", constants.EXPORT_MODE_LOCAL, ht.TElemOf(constants.EXPORT_MODES),
1917
     "Export mode"),
1918
    ("x509_key_name", None, ht.TMaybe(ht.TList),
1919
     "Name of X509 key (remote export only)"),
1920
    ("destination_x509_ca", None, ht.TMaybeString,
1921
     "Destination X509 CA (remote export only)"),
1922
    ]
1923
  OP_RESULT = \
1924
    ht.TAnd(ht.TIsLength(2), ht.TItems([
1925
      ht.Comment("Finalizing status")(ht.TBool),
1926
      ht.Comment("Status for every exported disk")(ht.TListOf(ht.TBool)),
1927
      ]))
1928

    
1929

    
1930
class OpBackupRemove(OpCode):
1931
  """Remove an instance's export."""
1932
  OP_DSC_FIELD = "instance_name"
1933
  OP_PARAMS = [
1934
    _PInstanceName,
1935
    ]
1936
  OP_RESULT = ht.TNone
1937

    
1938

    
1939
# Tags opcodes
1940
class OpTagsGet(OpCode):
1941
  """Returns the tags of the given object."""
1942
  OP_DSC_FIELD = "name"
1943
  OP_PARAMS = [
1944
    _PTagKind,
1945
    # Not using _PUseLocking as the default is different for historical reasons
1946
    ("use_locking", True, ht.TBool, "Whether to use synchronization"),
1947
    # Name is only meaningful for nodes and instances
1948
    ("name", ht.NoDefault, ht.TMaybeString,
1949
     "Name of object to retrieve tags from"),
1950
    ]
1951
  OP_RESULT = ht.TListOf(ht.TNonEmptyString)
1952

    
1953

    
1954
class OpTagsSearch(OpCode):
1955
  """Searches the tags in the cluster for a given pattern."""
1956
  OP_DSC_FIELD = "pattern"
1957
  OP_PARAMS = [
1958
    ("pattern", ht.NoDefault, ht.TNonEmptyString,
1959
     "Search pattern (regular expression)"),
1960
    ]
1961
  OP_RESULT = ht.TListOf(ht.TAnd(ht.TIsLength(2), ht.TItems([
1962
    ht.TNonEmptyString,
1963
    ht.TNonEmptyString,
1964
    ])))
1965

    
1966

    
1967
class OpTagsSet(OpCode):
1968
  """Add a list of tags on a given object."""
1969
  OP_PARAMS = [
1970
    _PTagKind,
1971
    _PTags,
1972
    # Name is only meaningful for groups, nodes and instances
1973
    ("name", ht.NoDefault, ht.TMaybeString,
1974
     "Name of object where tag(s) should be added"),
1975
    ]
1976
  OP_RESULT = ht.TNone
1977

    
1978

    
1979
class OpTagsDel(OpCode):
1980
  """Remove a list of tags from a given object."""
1981
  OP_PARAMS = [
1982
    _PTagKind,
1983
    _PTags,
1984
    # Name is only meaningful for groups, nodes and instances
1985
    ("name", ht.NoDefault, ht.TMaybeString,
1986
     "Name of object where tag(s) should be deleted"),
1987
    ]
1988
  OP_RESULT = ht.TNone
1989

    
1990

    
1991
# Test opcodes
1992
class OpTestDelay(OpCode):
1993
  """Sleeps for a configured amount of time.
1994

1995
  This is used just for debugging and testing.
1996

1997
  Parameters:
1998
    - duration: the time to sleep, in seconds
1999
    - on_master: if true, sleep on the master
2000
    - on_nodes: list of nodes in which to sleep
2001

2002
  If the on_master parameter is true, it will execute a sleep on the
2003
  master (before any node sleep).
2004

2005
  If the on_nodes list is not empty, it will sleep on those nodes
2006
  (after the sleep on the master, if that is enabled).
2007

2008
  As an additional feature, the case of duration < 0 will be reported
2009
  as an execution error, so this opcode can be used as a failure
2010
  generator. The case of duration == 0 will not be treated specially.
2011

2012
  """
2013
  OP_DSC_FIELD = "duration"
2014
  OP_PARAMS = [
2015
    ("duration", ht.NoDefault, ht.TNumber, None),
2016
    ("on_master", True, ht.TBool, None),
2017
    ("on_nodes", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
2018
    ("repeat", 0, ht.TNonNegativeInt, None),
2019
    ]
2020

    
2021
  def OP_DSC_FORMATTER(self, value): # pylint: disable=C0103,R0201
2022
    """Custom formatter for duration.
2023

2024
    """
2025
    try:
2026
      v = float(value)
2027
    except TypeError:
2028
      v = value
2029
    return str(v)
2030

    
2031

    
2032
class OpTestAllocator(OpCode):
2033
  """Allocator framework testing.
2034

2035
  This opcode has two modes:
2036
    - gather and return allocator input for a given mode (allocate new
2037
      or replace secondary) and a given instance definition (direction
2038
      'in')
2039
    - run a selected allocator for a given operation (as above) and
2040
      return the allocator output (direction 'out')
2041

2042
  """
2043
  OP_DSC_FIELD = "iallocator"
2044
  OP_PARAMS = [
2045
    ("direction", ht.NoDefault,
2046
     ht.TElemOf(constants.VALID_IALLOCATOR_DIRECTIONS), None),
2047
    ("mode", ht.NoDefault, ht.TElemOf(constants.VALID_IALLOCATOR_MODES), None),
2048
    ("name", ht.NoDefault, ht.TNonEmptyString, None),
2049
    ("nics", ht.NoDefault,
2050
     ht.TMaybeListOf(ht.TDictOf(ht.TElemOf([constants.INIC_MAC,
2051
                                            constants.INIC_IP,
2052
                                            "bridge"]),
2053
                                ht.TMaybeString)),
2054
     None),
2055
    ("disks", ht.NoDefault, ht.TMaybe(ht.TList), None),
2056
    ("hypervisor", None, ht.TMaybeString, None),
2057
    _PIAllocFromDesc(None),
2058
    ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), None),
2059
    ("memory", None, ht.TMaybe(ht.TNonNegativeInt), None),
2060
    ("vcpus", None, ht.TMaybe(ht.TNonNegativeInt), None),
2061
    ("os", None, ht.TMaybeString, None),
2062
    ("disk_template", None, ht.TMaybeString, None),
2063
    ("instances", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
2064
    ("evac_mode", None,
2065
     ht.TMaybe(ht.TElemOf(constants.IALLOCATOR_NEVAC_MODES)), None),
2066
    ("target_groups", None, ht.TMaybeListOf(ht.TNonEmptyString), None),
2067
    ("spindle_use", 1, ht.TNonNegativeInt, None),
2068
    ("count", 1, ht.TNonNegativeInt, None),
2069
    ]
2070

    
2071

    
2072
class OpTestJqueue(OpCode):
2073
  """Utility opcode to test some aspects of the job queue.
2074

2075
  """
2076
  OP_PARAMS = [
2077
    ("notify_waitlock", False, ht.TBool, None),
2078
    ("notify_exec", False, ht.TBool, None),
2079
    ("log_messages", ht.EmptyList, ht.TListOf(ht.TString), None),
2080
    ("fail", False, ht.TBool, None),
2081
    ]
2082

    
2083

    
2084
class OpTestDummy(OpCode):
2085
  """Utility opcode used by unittests.
2086

2087
  """
2088
  OP_PARAMS = [
2089
    ("result", ht.NoDefault, ht.NoType, None),
2090
    ("messages", ht.NoDefault, ht.NoType, None),
2091
    ("fail", ht.NoDefault, ht.NoType, None),
2092
    ("submit_jobs", None, ht.NoType, None),
2093
    ]
2094
  WITH_LU = False
2095

    
2096

    
2097
# Network opcodes
2098
# Add a new network in the cluster
2099
class OpNetworkAdd(OpCode):
2100
  """Add an IP network to the cluster."""
2101
  OP_DSC_FIELD = "network_name"
2102
  OP_PARAMS = [
2103
    _PNetworkName,
2104
    ("network", ht.NoDefault, _TIpNetwork4, "IPv4 subnet"),
2105
    ("gateway", None, ht.TMaybe(_TIpAddress4), "IPv4 gateway"),
2106
    ("network6", None, ht.TMaybe(_TIpNetwork6), "IPv6 subnet"),
2107
    ("gateway6", None, ht.TMaybe(_TIpAddress6), "IPv6 gateway"),
2108
    ("mac_prefix", None, ht.TMaybeString,
2109
     "MAC address prefix that overrides cluster one"),
2110
    ("add_reserved_ips", None, _TMaybeAddr4List,
2111
     "Which IP addresses to reserve"),
2112
    ("conflicts_check", True, ht.TBool,
2113
     "Whether to check for conflicting IP addresses"),
2114
    ("tags", ht.EmptyList, ht.TListOf(ht.TNonEmptyString), "Network tags"),
2115
    ]
2116
  OP_RESULT = ht.TNone
2117

    
2118

    
2119
class OpNetworkRemove(OpCode):
2120
  """Remove an existing network from the cluster.
2121
     Must not be connected to any nodegroup.
2122

2123
  """
2124
  OP_DSC_FIELD = "network_name"
2125
  OP_PARAMS = [
2126
    _PNetworkName,
2127
    _PForce,
2128
    ]
2129
  OP_RESULT = ht.TNone
2130

    
2131

    
2132
class OpNetworkSetParams(OpCode):
2133
  """Modify Network's parameters except for IPv4 subnet"""
2134
  OP_DSC_FIELD = "network_name"
2135
  OP_PARAMS = [
2136
    _PNetworkName,
2137
    ("gateway", None, ht.TMaybeValueNone(_TIpAddress4), "IPv4 gateway"),
2138
    ("network6", None, ht.TMaybeValueNone(_TIpNetwork6), "IPv6 subnet"),
2139
    ("gateway6", None, ht.TMaybeValueNone(_TIpAddress6), "IPv6 gateway"),
2140
    ("mac_prefix", None, ht.TMaybeValueNone(ht.TString),
2141
     "MAC address prefix that overrides cluster one"),
2142
    ("add_reserved_ips", None, _TMaybeAddr4List,
2143
     "Which external IP addresses to reserve"),
2144
    ("remove_reserved_ips", None, _TMaybeAddr4List,
2145
     "Which external IP addresses to release"),
2146
    ]
2147
  OP_RESULT = ht.TNone
2148

    
2149

    
2150
class OpNetworkConnect(OpCode):
2151
  """Connect a Network to a specific Nodegroup with the defined netparams
2152
     (mode, link). Nics in this Network will inherit those params.
2153
     Produce errors if a NIC (that its not already assigned to a network)
2154
     has an IP that is contained in the Network this will produce error unless
2155
     --no-conflicts-check is passed.
2156

2157
  """
2158
  OP_DSC_FIELD = "network_name"
2159
  OP_PARAMS = [
2160
    _PGroupName,
2161
    _PNetworkName,
2162
    ("network_mode", ht.NoDefault, ht.TElemOf(constants.NIC_VALID_MODES),
2163
     "Connectivity mode"),
2164
    ("network_link", ht.NoDefault, ht.TString, "Connectivity link"),
2165
    ("conflicts_check", True, ht.TBool, "Whether to check for conflicting IPs"),
2166
    ]
2167
  OP_RESULT = ht.TNone
2168

    
2169

    
2170
class OpNetworkDisconnect(OpCode):
2171
  """Disconnect a Network from a Nodegroup. Produce errors if NICs are
2172
     present in the Network unless --no-conficts-check option is passed.
2173

2174
  """
2175
  OP_DSC_FIELD = "network_name"
2176
  OP_PARAMS = [
2177
    _PGroupName,
2178
    _PNetworkName,
2179
    ]
2180
  OP_RESULT = ht.TNone
2181

    
2182

    
2183
class OpNetworkQuery(OpCode):
2184
  """Compute the list of networks."""
2185
  OP_PARAMS = [
2186
    _POutputFields,
2187
    _PUseLocking,
2188
    ("names", ht.EmptyList, ht.TListOf(ht.TNonEmptyString),
2189
     "Empty list to query all groups, group names otherwise"),
2190
    ]
2191
  OP_RESULT = _TOldQueryResult
2192

    
2193

    
2194
def _GetOpList():
2195
  """Returns list of all defined opcodes.
2196

2197
  Does not eliminate duplicates by C{OP_ID}.
2198

2199
  """
2200
  return [v for v in globals().values()
2201
          if (isinstance(v, type) and issubclass(v, OpCode) and
2202
              hasattr(v, "OP_ID") and v is not OpCode)]
2203

    
2204

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