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

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

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

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

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

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

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

    """
88
89
90
91
    if not isinstance(state, dict):
      raise ValueError("Invalid data to __setstate__: expected dict, got %s" %
                       type(state))

92
    for name in self._all_slots():
Iustin Pop's avatar
Iustin Pop committed
93
      if name not in state and hasattr(self, name):
94
95
96
97
98
        delattr(self, name)

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

99
100
101
102
103
104
105
106
107
108
  @classmethod
  def _all_slots(cls):
    """Compute the list of all declared slots for a class.

    """
    slots = []
    for parent in cls.__mro__:
      slots.extend(getattr(parent, "__slots__", []))
    return slots

109

Iustin Pop's avatar
Iustin Pop committed
110
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
111
112
113
114
115
116
  """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
117
118
119
               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
120
121

  """
122
  OP_ID = "OP_ABSTRACT"
123
  __slots__ = ["dry_run", "debug_level"]
124
125
126
127

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

Iustin Pop's avatar
Iustin Pop committed
128
129
130
131
132
133
134
    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

135
    """
Iustin Pop's avatar
Iustin Pop committed
136
    data = BaseOpCode.__getstate__(self)
137
138
139
140
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
141
  def LoadOpCode(cls, data):
142
143
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
144
145
146
147
148
149
150
    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

151
152
153
154
155
156
157
    """
    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
158
159
160
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
161
162
163
164
165
166
167
168
      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

169
170
171
172
173
174
175
176
177
178
179
180
  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
181

182
183
# cluster opcodes

184
185
186
187
188
189
190
191
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"
Balazs Lecz's avatar
Balazs Lecz committed
192
  __slots__ = []
193
194


Iustin Pop's avatar
Iustin Pop committed
195
class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
196
197
198
199
200
201
  """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
202
  OP_ID = "OP_CLUSTER_DESTROY"
Balazs Lecz's avatar
Balazs Lecz committed
203
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
204
205
206


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
207
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
208
  OP_ID = "OP_CLUSTER_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
209
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
210
211
212


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
213
214
215
216
217
218
219
220
221
  """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
222
  OP_ID = "OP_CLUSTER_VERIFY"
Balazs Lecz's avatar
Balazs Lecz committed
223
224
  __slots__ = ["skip_checks", "verbose", "error_codes",
               "debug_simulate_errors"]
Iustin Pop's avatar
Iustin Pop committed
225
226


Iustin Pop's avatar
Iustin Pop committed
227
228
229
230
231
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

232
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
233
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
234
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
235
    - list of instances with degraded disks (that should be activated)
236
237
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
238

239
240
241
242
  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
243
244
245
246
247
248

  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"
Balazs Lecz's avatar
Balazs Lecz committed
249
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
250
251


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
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"]


272
273
274
class OpQueryConfigValues(OpCode):
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
275
  __slots__ = ["output_fields"]
Iustin Pop's avatar
Iustin Pop committed
276
277


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

  """
287
  OP_ID = "OP_CLUSTER_RENAME"
288
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
289
  __slots__ = ["name"]
290
291


292
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
293
294
295
296
297
298
  """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.

  """
299
  OP_ID = "OP_CLUSTER_SET_PARAMS"
Balazs Lecz's avatar
Balazs Lecz committed
300
  __slots__ = [
301
302
303
    "vg_name",
    "enabled_hypervisors",
    "hvparams",
304
    "os_hvp",
305
    "beparams",
306
    "nicparams",
307
    "candidate_pool_size",
308
    "maintain_node_health",
309
    "uid_pool",
310
311
    "add_uids",
    "remove_uids",
312
    ]
313
314


315
316
317
318
319
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"
Balazs Lecz's avatar
Balazs Lecz committed
320
  __slots__ = []
321

322
323
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
324
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
325
326
327
328
329
330
331
  """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
332
  OP_ID = "OP_NODE_REMOVE"
333
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
334
  __slots__ = ["node_name"]
Iustin Pop's avatar
Iustin Pop committed
335
336
337


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
  """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
359
  OP_ID = "OP_NODE_ADD"
360
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
361
  __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd"]
Iustin Pop's avatar
Iustin Pop committed
362
363
364
365
366


class OpQueryNodes(OpCode):
  """Compute the list of nodes."""
  OP_ID = "OP_NODE_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
367
  __slots__ = ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
368
369


370
371
372
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
Balazs Lecz's avatar
Balazs Lecz committed
373
  __slots__ = ["nodes", "output_fields"]
374
375


376
377
378
class OpQueryNodeStorage(OpCode):
  """Get information on storage for node(s)."""
  OP_ID = "OP_NODE_QUERY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
379
  __slots__ = [
380
381
382
383
384
385
386
    "nodes",
    "storage_type",
    "name",
    "output_fields",
    ]


387
class OpModifyNodeStorage(OpCode):
388
  """Modifies the properies of a storage unit"""
389
  OP_ID = "OP_NODE_MODIFY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
390
  __slots__ = [
391
392
393
394
395
396
397
    "node_name",
    "storage_type",
    "name",
    "changes",
    ]


398
399
400
401
class OpRepairNodeStorage(OpCode):
  """Repairs the volume group on a node."""
  OP_ID = "OP_REPAIR_NODE_STORAGE"
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
402
  __slots__ = [
403
404
405
    "node_name",
    "storage_type",
    "name",
406
    "ignore_consistency",
407
408
409
    ]


Iustin Pop's avatar
Iustin Pop committed
410
411
412
413
class OpSetNodeParams(OpCode):
  """Change the parameters of a node."""
  OP_ID = "OP_NODE_SET_PARAMS"
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
414
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
415
416
417
    "node_name",
    "force",
    "master_candidate",
418
    "offline",
419
    "drained",
420
    "auto_promote",
Iustin Pop's avatar
Iustin Pop committed
421
422
    ]

Iustin Pop's avatar
Iustin Pop committed
423
424
425
426
427

class OpPowercycleNode(OpCode):
  """Tries to powercycle a node."""
  OP_ID = "OP_NODE_POWERCYCLE"
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
428
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
429
430
431
432
    "node_name",
    "force",
    ]

433
434
435
436
437

class OpEvacuateNode(OpCode):
  """Relocate secondary instances from a node."""
  OP_ID = "OP_NODE_EVACUATE"
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
438
  __slots__ = [
439
    "node_name", "remote_node", "iallocator", "early_release",
440
441
442
    ]


443
444
445
446
class OpMigrateNode(OpCode):
  """Migrate all instances from a node."""
  OP_ID = "OP_NODE_MIGRATE"
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
447
  __slots__ = [
448
449
450
451
452
    "node_name",
    "live",
    ]


453
454
455
456
457
458
459
class OpNodeEvacuationStrategy(OpCode):
  """Compute the evacuation strategy for a list of nodes."""
  OP_ID = "OP_NODE_EVAC_STRATEGY"
  OP_DSC_FIELD = "nodes"
  __slots__ = ["nodes", "iallocator", "remote_node"]


Iustin Pop's avatar
Iustin Pop committed
460
461
462
# instance opcodes

class OpCreateInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
463
  """Create an instance."""
Iustin Pop's avatar
Iustin Pop committed
464
  OP_ID = "OP_INSTANCE_CREATE"
465
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
466
  __slots__ = [
467
468
    "instance_name",
    "os_type", "force_variant", "no_install",
469
    "pnode", "disk_template", "snode", "mode",
470
    "disks", "nics",
471
    "src_node", "src_path", "start", "identify_defaults",
472
    "wait_for_sync", "ip_check", "name_check",
473
    "file_storage_dir", "file_driver",
474
475
    "iallocator",
    "hypervisor", "hvparams", "beparams",
476
    "dry_run",
477
    ]
Iustin Pop's avatar
Iustin Pop committed
478
479


480
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
481
  """Reinstall an instance's OS."""
482
  OP_ID = "OP_INSTANCE_REINSTALL"
483
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
484
  __slots__ = ["instance_name", "os_type", "force_variant"]
485
486


Iustin Pop's avatar
Iustin Pop committed
487
488
489
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
490
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
491
  __slots__ = [
492
493
494
495
    "instance_name",
    "ignore_failures",
    "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
496
497


498
499
500
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
Balazs Lecz's avatar
Balazs Lecz committed
501
  __slots__ = [
502
503
    "instance_name", "ignore_ip", "new_name",
    ]
504
505


Iustin Pop's avatar
Iustin Pop committed
506
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
507
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
508
  OP_ID = "OP_INSTANCE_STARTUP"
509
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
510
  __slots__ = [
511
512
    "instance_name", "force", "hvparams", "beparams",
    ]
Iustin Pop's avatar
Iustin Pop committed
513
514
515


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
516
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
517
  OP_ID = "OP_INSTANCE_SHUTDOWN"
518
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
519
  __slots__ = ["instance_name", "timeout"]
Iustin Pop's avatar
Iustin Pop committed
520
521


522
523
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
524
  OP_ID = "OP_INSTANCE_REBOOT"
525
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
526
  __slots__ = [
527
    "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
528
    ]
529
530


Iustin Pop's avatar
Iustin Pop committed
531
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
532
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
533
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
534
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
535
  __slots__ = [
536
    "instance_name", "remote_node", "mode", "disks", "iallocator",
537
    "early_release",
538
    ]
Iustin Pop's avatar
Iustin Pop committed
539
540
541
542
543


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
544
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
545
  __slots__ = [
546
547
    "instance_name", "ignore_consistency", "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
548
549


550
551
552
553
554
555
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
556
  @ivar instance_name: the name of the instance
557
558
559

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
560
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
561
  __slots__ = ["instance_name", "live", "cleanup"]
562
563


564
565
566
567
568
569
570
571
572
573
574
575
class OpMoveInstance(OpCode):
  """Move an instance.

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

  @ivar instance_name: the name of the instance
  @ivar target_node: the destination node

  """
  OP_ID = "OP_INSTANCE_MOVE"
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
576
  __slots__ = [
577
    "instance_name", "target_node", "shutdown_timeout",
Balazs Lecz's avatar
Balazs Lecz committed
578
    ]
579
580


Iustin Pop's avatar
Iustin Pop committed
581
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
582
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
583
  OP_ID = "OP_INSTANCE_CONSOLE"
584
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
585
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
586
587
588


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
589
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
590
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
591
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
592
  __slots__ = ["instance_name", "ignore_size"]
Iustin Pop's avatar
Iustin Pop committed
593
594
595


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
596
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
597
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
598
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
599
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
600
601


Iustin Pop's avatar
Iustin Pop committed
602
603
604
605
class OpRecreateInstanceDisks(OpCode):
  """Deactivate an instance's disks."""
  OP_ID = "OP_INSTANCE_RECREATE_DISKS"
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
606
  __slots__ = ["instance_name", "disks"]
Iustin Pop's avatar
Iustin Pop committed
607
608


Iustin Pop's avatar
Iustin Pop committed
609
610
611
class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
612
  __slots__ = ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
613
614
615
616
617


class OpQueryInstanceData(OpCode):
  """Compute the run-time status of instances."""
  OP_ID = "OP_INSTANCE_QUERY_DATA"
Balazs Lecz's avatar
Balazs Lecz committed
618
  __slots__ = ["instances", "static"]
Iustin Pop's avatar
Iustin Pop committed
619
620


621
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
622
  """Change the parameters of an instance."""
623
  OP_ID = "OP_INSTANCE_SET_PARAMS"
624
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
625
  __slots__ = [
626
    "instance_name",
Iustin Pop's avatar
Iustin Pop committed
627
    "hvparams", "beparams", "force",
628
    "nics", "disks", "disk_template",
629
    "remote_node", "os_name", "force_variant",
630
    ]
Iustin Pop's avatar
Iustin Pop committed
631
632


Iustin Pop's avatar
Iustin Pop committed
633
634
635
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
636
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
637
  __slots__ = [
638
639
    "instance_name", "disk", "amount", "wait_for_sync",
    ]
Iustin Pop's avatar
Iustin Pop committed
640
641


Iustin Pop's avatar
Iustin Pop committed
642
643
644
645
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
Balazs Lecz's avatar
Balazs Lecz committed
646
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
647

648

Iustin Pop's avatar
Iustin Pop committed
649
650
651
652
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
653
  __slots__ = ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
654

655

656
657
658
659
660
661
662
663
664
665
666
667
668
669
class OpPrepareExport(OpCode):
  """Prepares an instance export.

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

  """
  OP_ID = "OP_BACKUP_PREPARE"
  OP_DSC_FIELD = "instance_name"
  __slots__ = [
    "instance_name", "mode",
    ]


Iustin Pop's avatar
Iustin Pop committed
670
class OpExportInstance(OpCode):
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
  """Export an instance.

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

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

  """
Iustin Pop's avatar
Iustin Pop committed
686
  OP_ID = "OP_BACKUP_EXPORT"
687
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
688
  __slots__ = [
689
690
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
691
    "instance_name", "target_node", "shutdown", "shutdown_timeout",
692
693
    "remove_instance",
    "ignore_remove_failures",
694
695
696
    "mode",
    "x509_key_name",
    "destination_x509_ca",
697
    ]
698

Michael Hanselmann's avatar
Michael Hanselmann committed
699

700
701
702
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
703
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
704
  __slots__ = ["instance_name"]
705

Michael Hanselmann's avatar
Michael Hanselmann committed
706

707
708
709
710
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
711
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
712
  __slots__ = ["kind", "name"]
713
714


Iustin Pop's avatar
Iustin Pop committed
715
716
717
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
718
  OP_DSC_FIELD = "pattern"
Balazs Lecz's avatar
Balazs Lecz committed
719
  __slots__ = ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
720
721


722
723
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
724
  OP_ID = "OP_TAGS_SET"
Balazs Lecz's avatar
Balazs Lecz committed
725
  __slots__ = ["kind", "name", "tags"]
726
727


728
729
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
730
  OP_ID = "OP_TAGS_DEL"
Balazs Lecz's avatar
Balazs Lecz committed
731
  __slots__ = ["kind", "name", "tags"]
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756


# 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"
757
  OP_DSC_FIELD = "duration"
Balazs Lecz's avatar
Balazs Lecz committed
758
  __slots__ = ["duration", "on_master", "on_nodes"]
759
760
761
762
763
764
765
766
767
768
769
770
771
772


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"
773
  OP_DSC_FIELD = "allocator"
Balazs Lecz's avatar
Balazs Lecz committed
774
  __slots__ = [
775
776
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
777
    "os", "tags", "nics", "vcpus", "hypervisor",
778
    "evac_nodes",
779
    ]
Iustin Pop's avatar
Iustin Pop committed
780

781

Iustin Pop's avatar
Iustin Pop committed
782
783
784
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"))])