opcodes.py 21.5 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

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


"""OpCodes module

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

Iustin Pop's avatar
Iustin Pop committed
27
28
Every operation which modifies the cluster state is expressed via
opcodes.
Iustin Pop's avatar
Iustin Pop committed
29
30
31
32
33
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
120
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
121
122

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

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

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

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

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

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

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

170
171
172
173
174
175
176
177
178
  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)
179
180
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
181
182
183
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
184

185
186
# cluster opcodes

187
188
189
190
191
192
193
194
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
195
  __slots__ = []
196
197


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


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


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


Iustin Pop's avatar
Iustin Pop committed
230
231
232
233
234
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

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

242
243
244
245
  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
246
247
248
249
250
251

  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
252
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
253
254


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


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


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

  """
290
  OP_ID = "OP_CLUSTER_RENAME"
291
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
292
  __slots__ = ["name"]
293
294


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

  """
302
  OP_ID = "OP_CLUSTER_SET_PARAMS"
Balazs Lecz's avatar
Balazs Lecz committed
303
  __slots__ = [
304
    "vg_name",
305
    "drbd_helper",
306
307
    "enabled_hypervisors",
    "hvparams",
308
    "os_hvp",
309
    "beparams",
310
    "osparams",
311
    "nicparams",
312
    "candidate_pool_size",
313
    "maintain_node_health",
314
    "uid_pool",
315
316
    "add_uids",
    "remove_uids",
317
    "default_iallocator",
318
    "reserved_lvs",
319
320
    "hidden_os",
    "blacklisted_os",
321
    "prealloc_wipe_disks",
322
    ]
323
324


325
326
327
328
329
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"
Balazs Lecz's avatar
Balazs Lecz committed
330
  __slots__ = []
331

332
333
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
334
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
335
336
337
338
339
340
341
  """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
342
  OP_ID = "OP_NODE_REMOVE"
343
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
344
  __slots__ = ["node_name"]
Iustin Pop's avatar
Iustin Pop committed
345
346
347


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
  """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.
367
368
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
Iustin Pop's avatar
Iustin Pop committed
369
370

  """
Iustin Pop's avatar
Iustin Pop committed
371
  OP_ID = "OP_NODE_ADD"
372
  OP_DSC_FIELD = "node_name"
373
  __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd", "group"]
Iustin Pop's avatar
Iustin Pop committed
374
375
376
377
378


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


382
383
384
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
Balazs Lecz's avatar
Balazs Lecz committed
385
  __slots__ = ["nodes", "output_fields"]
386
387


388
389
390
class OpQueryNodeStorage(OpCode):
  """Get information on storage for node(s)."""
  OP_ID = "OP_NODE_QUERY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
391
  __slots__ = [
392
393
394
395
396
397
398
    "nodes",
    "storage_type",
    "name",
    "output_fields",
    ]


399
class OpModifyNodeStorage(OpCode):
400
  """Modifies the properies of a storage unit"""
401
  OP_ID = "OP_NODE_MODIFY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
402
  __slots__ = [
403
404
405
406
407
408
409
    "node_name",
    "storage_type",
    "name",
    "changes",
    ]


410
411
412
413
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
414
  __slots__ = [
415
416
417
    "node_name",
    "storage_type",
    "name",
418
    "ignore_consistency",
419
420
421
    ]


Iustin Pop's avatar
Iustin Pop committed
422
423
424
425
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
426
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
427
428
429
    "node_name",
    "force",
    "master_candidate",
430
    "offline",
431
    "drained",
432
    "auto_promote",
433
    "master_capable",
Iustin Pop's avatar
Iustin Pop committed
434
    "vm_capable",
Iustin Pop's avatar
Iustin Pop committed
435
436
    ]

Iustin Pop's avatar
Iustin Pop committed
437
438
439
440
441

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
442
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
443
444
445
446
    "node_name",
    "force",
    ]

447

448
449
450
451
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
452
  __slots__ = [
453
    "node_name",
454
    "mode",
455
    "live",
456
457
458
    ]


459
460
461
462
463
464
465
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
466
467
468
# instance opcodes

class OpCreateInstance(OpCode):
469
470
471
472
473
474
475
476
477
  """Create an instance.

  @ivar instance_name: Instance name
  @ivar mode: Instance creation mode (one of L{constants.INSTANCE_CREATE_MODES})
  @ivar source_handshake: Signed handshake from source (remote import only)
  @ivar source_x509_ca: Source X509 CA in PEM format (remote import only)
  @ivar source_instance_name: Previous name of instance (remote import only)

  """
Iustin Pop's avatar
Iustin Pop committed
478
  OP_ID = "OP_INSTANCE_CREATE"
479
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
480
  __slots__ = [
481
482
    "instance_name",
    "os_type", "force_variant", "no_install",
483
    "pnode", "disk_template", "snode", "mode",
484
    "disks", "nics",
485
    "src_node", "src_path", "start", "identify_defaults",
486
    "wait_for_sync", "ip_check", "name_check",
487
    "file_storage_dir", "file_driver",
488
    "iallocator",
489
    "hypervisor", "hvparams", "beparams", "osparams",
490
491
492
    "source_handshake",
    "source_x509_ca",
    "source_instance_name",
493
    ]
Iustin Pop's avatar
Iustin Pop committed
494
495


496
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
497
  """Reinstall an instance's OS."""
498
  OP_ID = "OP_INSTANCE_REINSTALL"
499
  OP_DSC_FIELD = "instance_name"
500
  __slots__ = ["instance_name", "os_type", "force_variant", "osparams"]
501
502


Iustin Pop's avatar
Iustin Pop committed
503
504
505
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
506
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
507
  __slots__ = [
508
509
510
511
    "instance_name",
    "ignore_failures",
    "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
512
513


514
515
516
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
Balazs Lecz's avatar
Balazs Lecz committed
517
  __slots__ = [
518
    "instance_name", "ip_check", "new_name", "name_check",
519
    ]
520
521


Iustin Pop's avatar
Iustin Pop committed
522
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
523
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
524
  OP_ID = "OP_INSTANCE_STARTUP"
525
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
526
  __slots__ = [
527
    "instance_name", "force", "hvparams", "beparams", "ignore_offline_nodes",
528
    ]
Iustin Pop's avatar
Iustin Pop committed
529
530
531


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
532
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
533
  OP_ID = "OP_INSTANCE_SHUTDOWN"
534
  OP_DSC_FIELD = "instance_name"
535
536
537
  __slots__ = [
    "instance_name", "timeout", "ignore_offline_nodes",
    ]
Iustin Pop's avatar
Iustin Pop committed
538
539


540
541
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
542
  OP_ID = "OP_INSTANCE_REBOOT"
543
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
544
  __slots__ = [
545
    "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
546
    ]
547
548


Iustin Pop's avatar
Iustin Pop committed
549
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
550
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
551
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
552
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
553
  __slots__ = [
554
    "instance_name", "remote_node", "mode", "disks", "iallocator",
555
    "early_release",
556
    ]
Iustin Pop's avatar
Iustin Pop committed
557
558
559
560
561


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
562
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
563
  __slots__ = [
564
565
    "instance_name", "ignore_consistency", "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
566
567


568
569
570
571
572
573
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
574
  @ivar instance_name: the name of the instance
575
  @ivar mode: the migration mode (live, non-live or None for auto)
576
577
578

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
579
  OP_DSC_FIELD = "instance_name"
580
  __slots__ = ["instance_name", "mode", "cleanup", "live"]
581
582


583
584
585
586
587
588
589
590
591
592
593
594
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
595
  __slots__ = [
596
    "instance_name", "target_node", "shutdown_timeout",
Balazs Lecz's avatar
Balazs Lecz committed
597
    ]
598
599


Iustin Pop's avatar
Iustin Pop committed
600
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
601
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
602
  OP_ID = "OP_INSTANCE_CONSOLE"
603
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
604
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
605
606
607


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
608
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
609
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
610
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
611
  __slots__ = ["instance_name", "ignore_size"]
Iustin Pop's avatar
Iustin Pop committed
612
613
614


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
615
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
616
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
617
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
618
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
619
620


Iustin Pop's avatar
Iustin Pop committed
621
622
623
624
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
625
  __slots__ = ["instance_name", "disks"]
Iustin Pop's avatar
Iustin Pop committed
626
627


Iustin Pop's avatar
Iustin Pop committed
628
629
630
class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
631
  __slots__ = ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
632
633
634
635
636


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


640
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
641
  """Change the parameters of an instance."""
642
  OP_ID = "OP_INSTANCE_SET_PARAMS"
643
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
644
  __slots__ = [
645
    "instance_name",
646
    "hvparams", "beparams", "osparams", "force",
647
    "nics", "disks", "disk_template",
648
    "remote_node", "os_name", "force_variant",
649
    ]
Iustin Pop's avatar
Iustin Pop committed
650
651


Iustin Pop's avatar
Iustin Pop committed
652
653
654
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
655
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
656
  __slots__ = [
657
658
    "instance_name", "disk", "amount", "wait_for_sync",
    ]
Iustin Pop's avatar
Iustin Pop committed
659
660


Iustin Pop's avatar
Iustin Pop committed
661
662
663
664
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
Balazs Lecz's avatar
Balazs Lecz committed
665
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
666

667

Iustin Pop's avatar
Iustin Pop committed
668
669
670
671
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
672
  __slots__ = ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
673

674

675
676
677
678
679
680
681
682
683
684
685
686
687
688
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
689
class OpExportInstance(OpCode):
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
  """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
705
  OP_ID = "OP_BACKUP_EXPORT"
706
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
707
  __slots__ = [
708
709
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
710
    "instance_name", "target_node", "shutdown", "shutdown_timeout",
711
712
    "remove_instance",
    "ignore_remove_failures",
713
714
715
    "mode",
    "x509_key_name",
    "destination_x509_ca",
716
    ]
717

Michael Hanselmann's avatar
Michael Hanselmann committed
718

719
720
721
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
722
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
723
  __slots__ = ["instance_name"]
724

Michael Hanselmann's avatar
Michael Hanselmann committed
725

726
727
728
729
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
730
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
731
  __slots__ = ["kind", "name"]
732
733


Iustin Pop's avatar
Iustin Pop committed
734
735
736
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
737
  OP_DSC_FIELD = "pattern"
Balazs Lecz's avatar
Balazs Lecz committed
738
  __slots__ = ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
739
740


741
742
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
743
  OP_ID = "OP_TAGS_SET"
Balazs Lecz's avatar
Balazs Lecz committed
744
  __slots__ = ["kind", "name", "tags"]
745
746


747
748
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
749
  OP_ID = "OP_TAGS_DEL"
Balazs Lecz's avatar
Balazs Lecz committed
750
  __slots__ = ["kind", "name", "tags"]
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775


# 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"
776
  OP_DSC_FIELD = "duration"
777
  __slots__ = ["duration", "on_master", "on_nodes", "repeat"]
778
779
780
781
782
783
784
785
786
787
788
789
790
791


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"
792
  OP_DSC_FIELD = "allocator"
Balazs Lecz's avatar
Balazs Lecz committed
793
  __slots__ = [
794
795
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
796
    "os", "tags", "nics", "vcpus", "hypervisor",
797
    "evac_nodes",
798
    ]
Iustin Pop's avatar
Iustin Pop committed
799

800

801
802
803
804
805
806
807
808
809
810
811
812
813
class OpTestJobqueue(OpCode):
  """Utility opcode to test some aspects of the job queue.

  """
  OP_ID = "OP_TEST_JQUEUE"
  __slots__ = [
    "notify_waitlock",
    "notify_exec",
    "log_messages",
    "fail",
    ]


814
815
816
817
818
819
820
821
822
823
824
825
class OpTestDummy(OpCode):
  """Utility opcode used by unittests.

  """
  OP_ID = "OP_TEST_DUMMY"
  __slots__ = [
    "result",
    "messages",
    "fail",
    ]


Iustin Pop's avatar
Iustin Pop committed
826
827
828
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"))])