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

173
174
175
176
177
178
179
180
181
182
183
class OpPostInitCluster(OpCode):
  """Post cluster initialization.

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

  """
  OP_ID = "OP_CLUSTER_POST_INIT"
  __slots__ = OpCode.__slots__ + []


Iustin Pop's avatar
Iustin Pop committed
184
class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
185
186
187
188
189
190
  """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
191
  OP_ID = "OP_CLUSTER_DESTROY"
192
  __slots__ = OpCode.__slots__ + []
Iustin Pop's avatar
Iustin Pop committed
193
194
195


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
196
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
197
  OP_ID = "OP_CLUSTER_QUERY"
198
  __slots__ = OpCode.__slots__ + []
Iustin Pop's avatar
Iustin Pop committed
199
200
201


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
202
203
204
205
206
207
208
209
210
  """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
211
  OP_ID = "OP_CLUSTER_VERIFY"
212
  __slots__ = OpCode.__slots__ + ["skip_checks"]
Iustin Pop's avatar
Iustin Pop committed
213
214


Iustin Pop's avatar
Iustin Pop committed
215
216
217
218
219
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

220
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
221
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
222
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
223
    - list of instances with degraded disks (that should be activated)
224
225
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
226

227
228
229
230
  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
231
232
233
234
235
236

  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"
237
  __slots__ = OpCode.__slots__ + []
Iustin Pop's avatar
Iustin Pop committed
238
239


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
class OpRepairDiskSizes(OpCode):
  """Verify the disk sizes of the instances and fixes configuration
  mimatches.

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

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

  In normal operation, the list should be empty.

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

  """
  OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES"
  __slots__ = ["instances"]


260
261
262
class OpQueryConfigValues(OpCode):
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
263
  __slots__ = OpCode.__slots__ + ["output_fields"]
Iustin Pop's avatar
Iustin Pop committed
264
265


266
class OpRenameCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
267
268
269
270
271
272
273
274
  """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.

  """
275
  OP_ID = "OP_CLUSTER_RENAME"
276
  OP_DSC_FIELD = "name"
277
  __slots__ = OpCode.__slots__ + ["name"]
278
279


280
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
281
282
283
284
285
286
  """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.

  """
287
  OP_ID = "OP_CLUSTER_SET_PARAMS"
288
  __slots__ = OpCode.__slots__ + [
289
290
291
292
    "vg_name",
    "enabled_hypervisors",
    "hvparams",
    "beparams",
293
    "nicparams",
294
295
    "candidate_pool_size",
    ]
296
297


298
299
300
301
302
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"
303
  __slots__ = OpCode.__slots__ + [
304
305
    ]

306
307
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
308
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
309
310
311
312
313
314
315
  """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
316
  OP_ID = "OP_NODE_REMOVE"
317
  OP_DSC_FIELD = "node_name"
318
  __slots__ = OpCode.__slots__ + ["node_name"]
Iustin Pop's avatar
Iustin Pop committed
319
320
321


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  """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
343
  OP_ID = "OP_NODE_ADD"
344
  OP_DSC_FIELD = "node_name"
345
346
347
  __slots__ = OpCode.__slots__ + [
    "node_name", "primary_ip", "secondary_ip", "readd",
    ]
Iustin Pop's avatar
Iustin Pop committed
348
349
350
351
352


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


356
357
358
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
359
  __slots__ = OpCode.__slots__ + ["nodes", "output_fields"]
360
361


362
363
364
365
366
367
368
369
370
371
372
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",
    ]


373
374
375
376
377
378
379
380
381
382
383
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
384
385
386
387
class OpSetNodeParams(OpCode):
  """Change the parameters of a node."""
  OP_ID = "OP_NODE_SET_PARAMS"
  OP_DSC_FIELD = "node_name"
388
  __slots__ = OpCode.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
389
390
391
    "node_name",
    "force",
    "master_candidate",
392
    "offline",
393
    "drained",
Iustin Pop's avatar
Iustin Pop committed
394
395
    ]

Iustin Pop's avatar
Iustin Pop committed
396
397
398
399
400

class OpPowercycleNode(OpCode):
  """Tries to powercycle a node."""
  OP_ID = "OP_NODE_POWERCYCLE"
  OP_DSC_FIELD = "node_name"
401
  __slots__ = OpCode.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
402
403
404
405
    "node_name",
    "force",
    ]

406
407
408
409
410
411
412
413
414
415

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",
    ]


416
417
418
419
420
421
422
423
424
425
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
426
427
428
# instance opcodes

class OpCreateInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
429
  """Create an instance."""
Iustin Pop's avatar
Iustin Pop committed
430
  OP_ID = "OP_INSTANCE_CREATE"
431
  OP_DSC_FIELD = "instance_name"
432
  __slots__ = OpCode.__slots__ + [
433
434
435
436
437
    "instance_name", "os_type", "pnode",
    "disk_template", "snode", "mode",
    "disks", "nics",
    "src_node", "src_path", "start",
    "wait_for_sync", "ip_check",
438
    "file_storage_dir", "file_driver",
439
440
    "iallocator",
    "hypervisor", "hvparams", "beparams",
441
    "dry_run",
442
    ]
Iustin Pop's avatar
Iustin Pop committed
443
444


445
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
446
  """Reinstall an instance's OS."""
447
  OP_ID = "OP_INSTANCE_REINSTALL"
448
  OP_DSC_FIELD = "instance_name"
449
  __slots__ = OpCode.__slots__ + ["instance_name", "os_type"]
450
451


Iustin Pop's avatar
Iustin Pop committed
452
453
454
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
455
  OP_DSC_FIELD = "instance_name"
456
  __slots__ = OpCode.__slots__ + ["instance_name", "ignore_failures"]
Iustin Pop's avatar
Iustin Pop committed
457
458


459
460
461
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
462
463
464
  __slots__ = OpCode.__slots__ + [
    "instance_name", "ignore_ip", "new_name",
    ]
465
466


Iustin Pop's avatar
Iustin Pop committed
467
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
468
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
469
  OP_ID = "OP_INSTANCE_STARTUP"
470
  OP_DSC_FIELD = "instance_name"
471
472
473
  __slots__ = OpCode.__slots__ + [
    "instance_name", "force", "hvparams", "beparams",
    ]
Iustin Pop's avatar
Iustin Pop committed
474
475
476


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
477
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
478
  OP_ID = "OP_INSTANCE_SHUTDOWN"
479
  OP_DSC_FIELD = "instance_name"
480
  __slots__ = OpCode.__slots__ + ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
481
482


483
484
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
485
  OP_ID = "OP_INSTANCE_REBOOT"
486
  OP_DSC_FIELD = "instance_name"
487
488
489
  __slots__ = OpCode.__slots__ + [
    "instance_name", "reboot_type", "ignore_secondaries",
    ]
490
491


Iustin Pop's avatar
Iustin Pop committed
492
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
493
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
494
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
495
  OP_DSC_FIELD = "instance_name"
496
497
498
  __slots__ = OpCode.__slots__ + [
    "instance_name", "remote_node", "mode", "disks", "iallocator",
    ]
Iustin Pop's avatar
Iustin Pop committed
499
500
501
502
503


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
504
  OP_DSC_FIELD = "instance_name"
505
  __slots__ = OpCode.__slots__ + ["instance_name", "ignore_consistency"]
Iustin Pop's avatar
Iustin Pop committed
506
507


508
509
510
511
512
513
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
514
  @ivar instance_name: the name of the instance
515
516
517

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
518
  OP_DSC_FIELD = "instance_name"
519
  __slots__ = OpCode.__slots__ + ["instance_name", "live", "cleanup"]
520
521


Iustin Pop's avatar
Iustin Pop committed
522
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
523
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
524
  OP_ID = "OP_INSTANCE_CONSOLE"
525
  OP_DSC_FIELD = "instance_name"
526
  __slots__ = OpCode.__slots__ + ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
527
528
529


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
530
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
531
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
532
  OP_DSC_FIELD = "instance_name"
533
  __slots__ = OpCode.__slots__ + ["instance_name", "ignore_size"]
Iustin Pop's avatar
Iustin Pop committed
534
535
536


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
537
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
538
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
539
  OP_DSC_FIELD = "instance_name"
540
  __slots__ = OpCode.__slots__ + ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
541
542
543
544
545


class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
546
  __slots__ = OpCode.__slots__ + ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
547
548
549
550
551


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


555
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
556
  """Change the parameters of an instance."""
557
  OP_ID = "OP_INSTANCE_SET_PARAMS"
558
  OP_DSC_FIELD = "instance_name"
559
  __slots__ = OpCode.__slots__ + [
560
    "instance_name",
Iustin Pop's avatar
Iustin Pop committed
561
    "hvparams", "beparams", "force",
562
    "nics", "disks",
563
    ]
Iustin Pop's avatar
Iustin Pop committed
564
565


Iustin Pop's avatar
Iustin Pop committed
566
567
568
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
569
  OP_DSC_FIELD = "instance_name"
570
571
572
  __slots__ = OpCode.__slots__ + [
    "instance_name", "disk", "amount", "wait_for_sync",
    ]
Iustin Pop's avatar
Iustin Pop committed
573
574


Iustin Pop's avatar
Iustin Pop committed
575
576
577
578
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
579
  __slots__ = OpCode.__slots__ + ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
580

581

Iustin Pop's avatar
Iustin Pop committed
582
583
584
585
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
586
  __slots__ = OpCode.__slots__ + ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
587

588

Iustin Pop's avatar
Iustin Pop committed
589
590
591
class OpExportInstance(OpCode):
  """Export an instance."""
  OP_ID = "OP_BACKUP_EXPORT"
592
  OP_DSC_FIELD = "instance_name"
593
  __slots__ = OpCode.__slots__ + ["instance_name", "target_node", "shutdown"]
594

Michael Hanselmann's avatar
Michael Hanselmann committed
595

596
597
598
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
599
  OP_DSC_FIELD = "instance_name"
600
  __slots__ = OpCode.__slots__ + ["instance_name"]
601

Michael Hanselmann's avatar
Michael Hanselmann committed
602

603
604
605
606
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
607
  OP_DSC_FIELD = "name"
608
  __slots__ = OpCode.__slots__ + ["kind", "name"]
609
610


Iustin Pop's avatar
Iustin Pop committed
611
612
613
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
614
  OP_DSC_FIELD = "pattern"
615
  __slots__ = OpCode.__slots__ + ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
616
617


618
619
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
620
  OP_ID = "OP_TAGS_SET"
621
  __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
622
623


624
625
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
626
  OP_ID = "OP_TAGS_DEL"
627
  __slots__ = OpCode.__slots__ + ["kind", "name", "tags"]
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652


# 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"
653
  OP_DSC_FIELD = "duration"
654
  __slots__ = OpCode.__slots__ + ["duration", "on_master", "on_nodes"]
655
656
657
658
659
660
661
662
663
664
665
666
667
668


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"
669
  OP_DSC_FIELD = "allocator"
670
  __slots__ = OpCode.__slots__ + [
671
672
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
673
    "os", "tags", "nics", "vcpus", "hypervisor",
674
    ]
Iustin Pop's avatar
Iustin Pop committed
675
676
677
678

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"))])