opcodes.py 17.4 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#

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


"""OpCodes module

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

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

"""

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

36

Iustin Pop's avatar
Iustin Pop committed
37
class BaseOpCode(object):
38
39
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
40
41
42
  This object serves as a parent class for OpCode without any custom
  field handling.

43
  """
Iustin Pop's avatar
Iustin Pop committed
44
45
46
  __slots__ = []

  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
47
48
49
50
51
52
53
54
    """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.

    """
Iustin Pop's avatar
Iustin Pop committed
55
56
    for key in kwargs:
      if key not in self.__slots__:
57
        raise TypeError("Object %s doesn't support the parameter '%s'" %
58
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
59
60
      setattr(self, key, kwargs[key])

61
  def __getstate__(self):
Iustin Pop's avatar
Iustin Pop committed
62
63
64
65
66
67
68
69
70
    """Generic serializer.

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

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

    """
71
72
73
74
75
76
77
    state = {}
    for name in self.__slots__:
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
78
79
80
81
82
83
84
85
86
    """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}

    """
87
88
89
90
91
92
93
94
95
96
97
98
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

    for name in self.__slots__:
      if name not in state:
        delattr(self, name)

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


Iustin Pop's avatar
Iustin Pop committed
99
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
100
101
102
103
104
105
  """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
106
107
108
               children of this class.
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
Iustin Pop's avatar
Iustin Pop committed
109
110

  """
111
  OP_ID = "OP_ABSTRACT"
112
  __slots__ = BaseOpCode.__slots__ + ["dry_run"]
113
114
115
116

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

Iustin Pop's avatar
Iustin Pop committed
117
118
119
120
121
122
123
    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

124
    """
Iustin Pop's avatar
Iustin Pop committed
125
    data = BaseOpCode.__getstate__(self)
126
127
128
129
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
130
  def LoadOpCode(cls, data):
131
132
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
133
134
135
136
137
138
139
    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

140
141
142
143
144
145
146
    """
    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
147
148
149
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
150
151
152
153
154
155
156
157
      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

158
159
160
161
162
163
164
165
166
167
168
169
  def Summary(self):
    """Generates a summary description of this opcode.

    """
    # 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)
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
170

171
172
# cluster opcodes

Iustin Pop's avatar
Iustin Pop committed
173
class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
174
175
176
177
178
179
  """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
180
  OP_ID = "OP_CLUSTER_DESTROY"
181
  __slots__ = OpCode.__slots__ + []
Iustin Pop's avatar
Iustin Pop committed
182
183
184


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
185
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
186
  OP_ID = "OP_CLUSTER_QUERY"
187
  __slots__ = OpCode.__slots__ + []
Iustin Pop's avatar
Iustin Pop committed
188
189
190


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
191
192
193
194
195
196
197
198
199
  """Verify the cluster state.

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

  """
Iustin Pop's avatar
Iustin Pop committed
200
  OP_ID = "OP_CLUSTER_VERIFY"
201
  __slots__ = OpCode.__slots__ + ["skip_checks"]
Iustin Pop's avatar
Iustin Pop committed
202
203


Iustin Pop's avatar
Iustin Pop committed
204
205
206
207
208
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

209
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
210
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
211
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
212
    - list of instances with degraded disks (that should be activated)
213
214
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
215

216
217
218
219
  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
220
221
222
223
224
225

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

  """
  OP_ID = "OP_CLUSTER_VERIFY_DISKS"
226
  __slots__ = OpCode.__slots__ + []
Iustin Pop's avatar
Iustin Pop committed
227
228


229
230
231
class OpQueryConfigValues(OpCode):
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
232
  __slots__ = OpCode.__slots__ + ["output_fields"]
Iustin Pop's avatar
Iustin Pop committed
233
234


235
class OpRenameCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
236
237
238
239
240
241
242
243
  """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.

  """
244
  OP_ID = "OP_CLUSTER_RENAME"
245
  OP_DSC_FIELD = "name"
246
  __slots__ = OpCode.__slots__ + ["name"]
247
248


249
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
250
251
252
253
254
255
  """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.

  """
256
  OP_ID = "OP_CLUSTER_SET_PARAMS"
257
  __slots__ = OpCode.__slots__ + [
258
259
260
261
    "vg_name",
    "enabled_hypervisors",
    "hvparams",
    "beparams",
262
    "nicparams",
263
264
    "candidate_pool_size",
    ]
265
266


267
268
269
270
271
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"
272
  __slots__ = OpCode.__slots__ + [
273
274
    ]

275
276
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
277
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
278
279
280
281
282
283
284
  """Remove a node.

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

  """
Iustin Pop's avatar
Iustin Pop committed
285
  OP_ID = "OP_NODE_REMOVE"
286
  OP_DSC_FIELD = "node_name"
287
  __slots__ = OpCode.__slots__ + ["node_name"]
Iustin Pop's avatar
Iustin Pop committed
288
289
290


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
  """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.

  """
Iustin Pop's avatar
Iustin Pop committed
312
  OP_ID = "OP_NODE_ADD"
313
  OP_DSC_FIELD = "node_name"
314
315
316
  __slots__ = OpCode.__slots__ + [
    "node_name", "primary_ip", "secondary_ip", "readd",
    ]
Iustin Pop's avatar
Iustin Pop committed
317
318
319
320
321


class OpQueryNodes(OpCode):
  """Compute the list of nodes."""
  OP_ID = "OP_NODE_QUERY"
322
  __slots__ = OpCode.__slots__ + ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
323
324


325
326
327
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
328
  __slots__ = OpCode.__slots__ + ["nodes", "output_fields"]
329
330


331
332
333
334
335
336
337
338
339
340
341
class OpQueryNodeStorage(OpCode):
  """Get information on storage for node(s)."""
  OP_ID = "OP_NODE_QUERY_STORAGE"
  __slots__ = OpCode.__slots__ + [
    "nodes",
    "storage_type",
    "name",
    "output_fields",
    ]


342
343
344
345
346
347
348
349
350
351
352
class OpModifyNodeStorage(OpCode):
  """"""
  OP_ID = "OP_NODE_MODIFY_STORAGE"
  __slots__ = OpCode.__slots__ + [
    "node_name",
    "storage_type",
    "name",
    "changes",
    ]


Iustin Pop's avatar
Iustin Pop committed
353
354
355
356
class OpSetNodeParams(OpCode):
  """Change the parameters of a node."""
  OP_ID = "OP_NODE_SET_PARAMS"
  OP_DSC_FIELD = "node_name"
357
  __slots__ = OpCode.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
358
359
360
    "node_name",
    "force",
    "master_candidate",
361
    "offline",
362
    "drained",
Iustin Pop's avatar
Iustin Pop committed
363
364
    ]

Iustin Pop's avatar
Iustin Pop committed
365
366
367
368
369

class OpPowercycleNode(OpCode):
  """Tries to powercycle a node."""
  OP_ID = "OP_NODE_POWERCYCLE"
  OP_DSC_FIELD = "node_name"
370
  __slots__ = OpCode.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
371
372
373
374
    "node_name",
    "force",
    ]

375
376
377
378
379
380
381
382
383
384

class OpEvacuateNode(OpCode):
  """Relocate secondary instances from a node."""
  OP_ID = "OP_NODE_EVACUATE"
  OP_DSC_FIELD = "node_name"
  __slots__ = OpCode.__slots__ + [
    "node_name", "remote_node", "iallocator",
    ]


385
386
387
388
389
390
391
392
393
394
class OpMigrateNode(OpCode):
  """Migrate all instances from a node."""
  OP_ID = "OP_NODE_MIGRATE"
  OP_DSC_FIELD = "node_name"
  __slots__ = OpCode.__slots__ + [
    "node_name",
    "live",
    ]


Iustin Pop's avatar
Iustin Pop committed
395
396
397
# instance opcodes

class OpCreateInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
398
  """Create an instance."""
Iustin Pop's avatar
Iustin Pop committed
399
  OP_ID = "OP_INSTANCE_CREATE"
400
  OP_DSC_FIELD = "instance_name"
401
  __slots__ = OpCode.__slots__ + [
402
403
404
405
406
    "instance_name", "os_type", "pnode",
    "disk_template", "snode", "mode",
    "disks", "nics",
    "src_node", "src_path", "start",
    "wait_for_sync", "ip_check",
407
    "file_storage_dir", "file_driver",
408
409
    "iallocator",
    "hypervisor", "hvparams", "beparams",
410
    "dry_run",
411
    ]
Iustin Pop's avatar
Iustin Pop committed
412
413


414
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
415
  """Reinstall an instance's OS."""
416
  OP_ID = "OP_INSTANCE_REINSTALL"
417
  OP_DSC_FIELD = "instance_name"
418
  __slots__ = OpCode.__slots__ + ["instance_name", "os_type"]
419
420


Iustin Pop's avatar
Iustin Pop committed
421
422
423
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
424
  OP_DSC_FIELD = "instance_name"
425
  __slots__ = OpCode.__slots__ + ["instance_name", "ignore_failures"]
Iustin Pop's avatar
Iustin Pop committed
426
427


428
429
430
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
431
432
433
  __slots__ = OpCode.__slots__ + [
    "instance_name", "ignore_ip", "new_name",
    ]
434
435


Iustin Pop's avatar
Iustin Pop committed
436
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
437
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
438
  OP_ID = "OP_INSTANCE_STARTUP"
439
  OP_DSC_FIELD = "instance_name"
440
441
442
  __slots__ = OpCode.__slots__ + [
    "instance_name", "force", "hvparams", "beparams",
    ]
Iustin Pop's avatar
Iustin Pop committed
443
444
445


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
446
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
447
  OP_ID = "OP_INSTANCE_SHUTDOWN"
448
  OP_DSC_FIELD = "instance_name"
449
  __slots__ = OpCode.__slots__ + ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
450
451


452
453
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
454
  OP_ID = "OP_INSTANCE_REBOOT"
455
  OP_DSC_FIELD = "instance_name"
456
457
458
  __slots__ = OpCode.__slots__ + [
    "instance_name", "reboot_type", "ignore_secondaries",
    ]
459
460


Iustin Pop's avatar
Iustin Pop committed
461
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
462
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
463
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
464
  OP_DSC_FIELD = "instance_name"
465
466
467
  __slots__ = OpCode.__slots__ + [
    "instance_name", "remote_node", "mode", "disks", "iallocator",
    ]
Iustin Pop's avatar
Iustin Pop committed
468
469
470
471
472


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
473
  OP_DSC_FIELD = "instance_name"
474
  __slots__ = OpCode.__slots__ + ["instance_name", "ignore_consistency"]
Iustin Pop's avatar
Iustin Pop committed
475
476


477
478
479
480
481
482
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
483
  @ivar instance_name: the name of the instance
484
485
486

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
487
  OP_DSC_FIELD = "instance_name"
488
  __slots__ = OpCode.__slots__ + ["instance_name", "live", "cleanup"]
489
490


Iustin Pop's avatar
Iustin Pop committed
491
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
492
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
493
  OP_ID = "OP_INSTANCE_CONSOLE"
494
  OP_DSC_FIELD = "instance_name"
495
  __slots__ = OpCode.__slots__ + ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
496
497
498


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
499
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
500
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
501
  OP_DSC_FIELD = "instance_name"
502
  __slots__ = OpCode.__slots__ + ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
503
504
505


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
506
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
507
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
508
  OP_DSC_FIELD = "instance_name"
509
  __slots__ = OpCode.__slots__ + ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
510
511
512
513
514


class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
515
  __slots__ = OpCode.__slots__ + ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
516
517
518
519
520


class OpQueryInstanceData(OpCode):
  """Compute the run-time status of instances."""
  OP_ID = "OP_INSTANCE_QUERY_DATA"
521
  __slots__ = OpCode.__slots__ + ["instances", "static"]
Iustin Pop's avatar
Iustin Pop committed
522
523


524
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
525
  """Change the parameters of an instance."""
526
  OP_ID = "OP_INSTANCE_SET_PARAMS"
527
  OP_DSC_FIELD = "instance_name"
528
  __slots__ = OpCode.__slots__ + [
529
    "instance_name",
Iustin Pop's avatar
Iustin Pop committed
530
    "hvparams", "beparams", "force",
531
    "nics", "disks",
532
    ]
Iustin Pop's avatar
Iustin Pop committed
533
534


Iustin Pop's avatar
Iustin Pop committed
535
536
537
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
538
  OP_DSC_FIELD = "instance_name"
539
540
541
  __slots__ = OpCode.__slots__ + [
    "instance_name", "disk", "amount", "wait_for_sync",
    ]
Iustin Pop's avatar
Iustin Pop committed
542
543


Iustin Pop's avatar
Iustin Pop committed
544
545
546
547
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
548
  __slots__ = OpCode.__slots__ + ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
549

550

Iustin Pop's avatar
Iustin Pop committed
551
552
553
554
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
555
  __slots__ = OpCode.__slots__ + ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
556

557

Iustin Pop's avatar
Iustin Pop committed
558
559
560
class OpExportInstance(OpCode):
  """Export an instance."""
  OP_ID = "OP_BACKUP_EXPORT"
561
  OP_DSC_FIELD = "instance_name"
562
  __slots__ = OpCode.__slots__ + ["instance_name", "target_node", "shutdown"]
563

Michael Hanselmann's avatar
Michael Hanselmann committed
564

565
566
567
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
568
  OP_DSC_FIELD = "instance_name"
569
  __slots__ = OpCode.__slots__ + ["instance_name"]
570

Michael Hanselmann's avatar
Michael Hanselmann committed
571

572
573
574
575
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
576
  OP_DSC_FIELD = "name"
577
  __slots__ = OpCode.__slots__ + ["kind", "name"]
578
579


Iustin Pop's avatar
Iustin Pop committed
580
581
582
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
583
  OP_DSC_FIELD = "pattern"
584
  __slots__ = OpCode.__slots__ + ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
585
586


587
588
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
589
  OP_ID = "OP_TAGS_SET"
590
  __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
591
592


593
594
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
595
  OP_ID = "OP_TAGS_DEL"
596
  __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621


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

  This is used just for debugging and testing.

  Parameters:
    - duration: the time to sleep
    - on_master: if true, sleep on the master
    - on_nodes: list of nodes in which to sleep

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

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

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

  """
  OP_ID = "OP_TEST_DELAY"
622
  OP_DSC_FIELD = "duration"
623
  __slots__ = OpCode.__slots__ + ["duration", "on_master", "on_nodes"]
624
625
626
627
628
629
630
631
632
633
634
635
636
637


class OpTestAllocator(OpCode):
  """Allocator framework testing.

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

  """
  OP_ID = "OP_TEST_ALLOCATOR"
638
  OP_DSC_FIELD = "allocator"
639
  __slots__ = OpCode.__slots__ + [
640
641
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
642
    "os", "tags", "nics", "vcpus", "hypervisor",
643
    ]
Iustin Pop's avatar
Iustin Pop committed
644
645
646
647

OP_MAPPING = dict([(v.OP_ID, v) for v in globals().values()
                   if (isinstance(v, type) and issubclass(v, OpCode) and
                       hasattr(v, "OP_ID"))])