opcodes.py 21.3 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
    ]
322
323


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

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

331
332
# node opcodes

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


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
  """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
368
  OP_ID = "OP_NODE_ADD"
369
  OP_DSC_FIELD = "node_name"
370
  __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd", "nodegroup"]
Iustin Pop's avatar
Iustin Pop committed
371
372
373
374
375


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


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


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


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


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


Iustin Pop's avatar
Iustin Pop committed
419
420
421
422
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
423
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
424
425
426
    "node_name",
    "force",
    "master_candidate",
427
    "offline",
428
    "drained",
429
    "auto_promote",
Iustin Pop's avatar
Iustin Pop committed
430
431
    ]

Iustin Pop's avatar
Iustin Pop committed
432
433
434
435
436

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
437
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
438
439
440
441
    "node_name",
    "force",
    ]

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
    "node_name",
449
    "mode",
450
    "live",
451
452
453
    ]


454
455
456
457
458
459
460
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
461
462
463
# instance opcodes

class OpCreateInstance(OpCode):
464
465
466
467
468
469
470
471
472
  """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
473
  OP_ID = "OP_INSTANCE_CREATE"
474
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
475
  __slots__ = [
476
477
    "instance_name",
    "os_type", "force_variant", "no_install",
478
    "pnode", "disk_template", "snode", "mode",
479
    "disks", "nics",
480
    "src_node", "src_path", "start", "identify_defaults",
481
    "wait_for_sync", "ip_check", "name_check",
482
    "file_storage_dir", "file_driver",
483
    "iallocator",
484
    "hypervisor", "hvparams", "beparams", "osparams",
485
486
487
    "source_handshake",
    "source_x509_ca",
    "source_instance_name",
488
    ]
Iustin Pop's avatar
Iustin Pop committed
489
490


491
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
492
  """Reinstall an instance's OS."""
493
  OP_ID = "OP_INSTANCE_REINSTALL"
494
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
495
  __slots__ = ["instance_name", "os_type", "force_variant"]
496
497


Iustin Pop's avatar
Iustin Pop committed
498
499
500
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
501
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
502
  __slots__ = [
503
504
505
506
    "instance_name",
    "ignore_failures",
    "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
507
508


509
510
511
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
Balazs Lecz's avatar
Balazs Lecz committed
512
  __slots__ = [
513
    "instance_name", "ip_check", "new_name", "name_check",
514
    ]
515
516


Iustin Pop's avatar
Iustin Pop committed
517
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
518
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
519
  OP_ID = "OP_INSTANCE_STARTUP"
520
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
521
  __slots__ = [
522
523
    "instance_name", "force", "hvparams", "beparams",
    ]
Iustin Pop's avatar
Iustin Pop committed
524
525
526


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
527
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
528
  OP_ID = "OP_INSTANCE_SHUTDOWN"
529
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
530
  __slots__ = ["instance_name", "timeout"]
Iustin Pop's avatar
Iustin Pop committed
531
532


533
534
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
535
  OP_ID = "OP_INSTANCE_REBOOT"
536
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
537
  __slots__ = [
538
    "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
539
    ]
540
541


Iustin Pop's avatar
Iustin Pop committed
542
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
543
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
544
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
545
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
546
  __slots__ = [
547
    "instance_name", "remote_node", "mode", "disks", "iallocator",
548
    "early_release",
549
    ]
Iustin Pop's avatar
Iustin Pop committed
550
551
552
553
554


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
555
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
556
  __slots__ = [
557
558
    "instance_name", "ignore_consistency", "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
559
560


561
562
563
564
565
566
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
567
  @ivar instance_name: the name of the instance
568
  @ivar mode: the migration mode (live, non-live or None for auto)
569
570
571

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
572
  OP_DSC_FIELD = "instance_name"
573
  __slots__ = ["instance_name", "mode", "cleanup", "live"]
574
575


576
577
578
579
580
581
582
583
584
585
586
587
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
588
  __slots__ = [
589
    "instance_name", "target_node", "shutdown_timeout",
Balazs Lecz's avatar
Balazs Lecz committed
590
    ]
591
592


Iustin Pop's avatar
Iustin Pop committed
593
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
594
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
595
  OP_ID = "OP_INSTANCE_CONSOLE"
596
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
597
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
598
599
600


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
601
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
602
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
603
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
604
  __slots__ = ["instance_name", "ignore_size"]
Iustin Pop's avatar
Iustin Pop committed
605
606
607


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
608
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
609
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
610
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
611
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
612
613


Iustin Pop's avatar
Iustin Pop committed
614
615
616
617
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
618
  __slots__ = ["instance_name", "disks"]
Iustin Pop's avatar
Iustin Pop committed
619
620


Iustin Pop's avatar
Iustin Pop committed
621
622
623
class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
624
  __slots__ = ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
625
626
627
628
629


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


633
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
634
  """Change the parameters of an instance."""
635
  OP_ID = "OP_INSTANCE_SET_PARAMS"
636
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
637
  __slots__ = [
638
    "instance_name",
639
    "hvparams", "beparams", "osparams", "force",
640
    "nics", "disks", "disk_template",
641
    "remote_node", "os_name", "force_variant",
642
    ]
Iustin Pop's avatar
Iustin Pop committed
643
644


Iustin Pop's avatar
Iustin Pop committed
645
646
647
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
648
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
649
  __slots__ = [
650
651
    "instance_name", "disk", "amount", "wait_for_sync",
    ]
Iustin Pop's avatar
Iustin Pop committed
652
653


Iustin Pop's avatar
Iustin Pop committed
654
655
656
657
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
Balazs Lecz's avatar
Balazs Lecz committed
658
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
659

660

Iustin Pop's avatar
Iustin Pop committed
661
662
663
664
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
665
  __slots__ = ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
666

667

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

Michael Hanselmann's avatar
Michael Hanselmann committed
711

712
713
714
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
715
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
716
  __slots__ = ["instance_name"]
717

Michael Hanselmann's avatar
Michael Hanselmann committed
718

719
720
721
722
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
723
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
724
  __slots__ = ["kind", "name"]
725
726


Iustin Pop's avatar
Iustin Pop committed
727
728
729
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
730
  OP_DSC_FIELD = "pattern"
Balazs Lecz's avatar
Balazs Lecz committed
731
  __slots__ = ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
732
733


734
735
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
736
  OP_ID = "OP_TAGS_SET"
Balazs Lecz's avatar
Balazs Lecz committed
737
  __slots__ = ["kind", "name", "tags"]
738
739


740
741
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
742
  OP_ID = "OP_TAGS_DEL"
Balazs Lecz's avatar
Balazs Lecz committed
743
  __slots__ = ["kind", "name", "tags"]
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768


# 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"
769
  OP_DSC_FIELD = "duration"
770
  __slots__ = ["duration", "on_master", "on_nodes", "repeat"]
771
772
773
774
775
776
777
778
779
780
781
782
783
784


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"
785
  OP_DSC_FIELD = "allocator"
Balazs Lecz's avatar
Balazs Lecz committed
786
  __slots__ = [
787
788
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
789
    "os", "tags", "nics", "vcpus", "hypervisor",
790
    "evac_nodes",
791
    ]
Iustin Pop's avatar
Iustin Pop committed
792

793

794
795
796
797
798
799
800
801
802
803
804
805
806
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",
    ]


807
808
809
810
811
812
813
814
815
816
817
818
class OpTestDummy(OpCode):
  """Utility opcode used by unittests.

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


Iustin Pop's avatar
Iustin Pop committed
819
820
821
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"))])