opcodes.py 24 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
               children of this class.
118
119
120
  @cvar OP_DSC_FIELD: The name of a field whose value will be included in the
                      string returned by Summary(); see the docstring of that
                      method for details).
121
122
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
123
  @ivar priority: Opcode priority for queue
Iustin Pop's avatar
Iustin Pop committed
124
125

  """
126
  OP_ID = "OP_ABSTRACT"
127
  __slots__ = ["dry_run", "debug_level", "priority"]
128
129
130
131

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

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

139
    """
Iustin Pop's avatar
Iustin Pop committed
140
    data = BaseOpCode.__getstate__(self)
141
142
143
144
    data["OP_ID"] = self.OP_ID
    return data

  @classmethod
145
  def LoadOpCode(cls, data):
146
147
    """Generic load opcode method.

Iustin Pop's avatar
Iustin Pop committed
148
149
150
151
152
153
154
    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

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

173
174
175
  def Summary(self):
    """Generates a summary description of this opcode.

176
177
178
179
180
    The summary is the value of the OP_ID attribute (without the "OP_" prefix),
    plus the value of the OP_DSC_FIELD attribute, if one was defined; this field
    should allow to easily identify the operation (for an instance creation job,
    e.g., it would be the instance name).

181
182
183
184
185
186
    """
    # 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)
187
188
      if isinstance(field_value, (list, tuple)):
        field_value = ",".join(str(i) for i in field_value)
189
190
191
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
192

193
194
# cluster opcodes

195
196
197
198
199
200
201
202
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
203
  __slots__ = []
204
205


Iustin Pop's avatar
Iustin Pop committed
206
class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
207
208
209
210
211
212
  """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
213
  OP_ID = "OP_CLUSTER_DESTROY"
Balazs Lecz's avatar
Balazs Lecz committed
214
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
215
216
217


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
218
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
219
  OP_ID = "OP_CLUSTER_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
220
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
221
222
223


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
224
225
226
227
228
229
230
231
232
  """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
233
  OP_ID = "OP_CLUSTER_VERIFY"
Balazs Lecz's avatar
Balazs Lecz committed
234
235
  __slots__ = ["skip_checks", "verbose", "error_codes",
               "debug_simulate_errors"]
Iustin Pop's avatar
Iustin Pop committed
236
237


Iustin Pop's avatar
Iustin Pop committed
238
239
240
241
242
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

243
  Result: a tuple of four elements:
Iustin Pop's avatar
Iustin Pop committed
244
    - list of node names with bad data returned (unreachable, etc.)
Iustin Pop's avatar
Iustin Pop committed
245
    - dict of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
246
    - list of instances with degraded disks (that should be activated)
247
248
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
249

250
251
252
253
  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
254
255
256
257
258
259

  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
260
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
261
262


263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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"]


283
284
285
class OpQueryConfigValues(OpCode):
  """Query cluster configuration values."""
  OP_ID = "OP_CLUSTER_CONFIG_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
286
  __slots__ = ["output_fields"]
Iustin Pop's avatar
Iustin Pop committed
287
288


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

  """
298
  OP_ID = "OP_CLUSTER_RENAME"
299
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
300
  __slots__ = ["name"]
301
302


303
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
304
305
306
307
308
309
  """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.

  """
310
  OP_ID = "OP_CLUSTER_SET_PARAMS"
Balazs Lecz's avatar
Balazs Lecz committed
311
  __slots__ = [
312
    "vg_name",
313
    "drbd_helper",
314
315
    "enabled_hypervisors",
    "hvparams",
316
    "os_hvp",
317
    "beparams",
318
    "osparams",
319
    "nicparams",
320
    "ndparams",
321
    "candidate_pool_size",
322
    "maintain_node_health",
323
    "uid_pool",
324
325
    "add_uids",
    "remove_uids",
326
    "default_iallocator",
327
    "reserved_lvs",
328
329
    "hidden_os",
    "blacklisted_os",
330
    "prealloc_wipe_disks",
331
    "master_netdev",
332
    ]
333
334


335
336
337
338
339
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"
Balazs Lecz's avatar
Balazs Lecz committed
340
  __slots__ = []
341

Michael Hanselmann's avatar
Michael Hanselmann committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372

class OpQuery(OpCode):
  """Query for resources/items.

  @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
  @ivar fields: List of fields to retrieve
  @ivar filter: Query filter

  """
  OP_ID = "OP_QUERY"
  __slots__ = [
    "what",
    "fields",
    "filter",
    ]


class OpQueryFields(OpCode):
  """Query for available resource/item fields.

  @ivar what: Resources to query for, must be one of L{constants.QR_OP_QUERY}
  @ivar fields: List of fields to retrieve

  """
  OP_ID = "OP_QUERY_FIELDS"
  __slots__ = [
    "what",
    "fields",
    ]


373
class OpOobCommand(OpCode):
René Nussbaumer's avatar
René Nussbaumer committed
374
  """Interact with OOB."""
375
  OP_ID = "OP_OOB_COMMAND"
René Nussbaumer's avatar
René Nussbaumer committed
376
377
378
379
380
381
382
  __slots__ = [
    "node_name",
    "command",
    "timeout",
    ]


383
384
# node opcodes

Iustin Pop's avatar
Iustin Pop committed
385
class OpRemoveNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
386
387
388
389
390
391
392
  """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
393
  OP_ID = "OP_NODE_REMOVE"
394
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
395
  __slots__ = ["node_name"]
Iustin Pop's avatar
Iustin Pop committed
396
397
398


class OpAddNode(OpCode):
Iustin Pop's avatar
Iustin Pop committed
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
  """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.
418
419
  @type group: C{str}
  @ivar group: The node group to which this node will belong.
420
421
422
423
  @type vm_capable: C{bool}
  @ivar vm_capable: The vm_capable node attribute
  @type master_capable: C{bool}
  @ivar master_capable: The master_capable node attribute
Iustin Pop's avatar
Iustin Pop committed
424
425

  """
Iustin Pop's avatar
Iustin Pop committed
426
  OP_ID = "OP_NODE_ADD"
427
  OP_DSC_FIELD = "node_name"
428
  __slots__ = ["node_name", "primary_ip", "secondary_ip", "readd", "group",
429
               "vm_capable", "master_capable", "ndparams"]
Iustin Pop's avatar
Iustin Pop committed
430
431
432
433
434


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


438
439
440
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
Balazs Lecz's avatar
Balazs Lecz committed
441
  __slots__ = ["nodes", "output_fields"]
442
443


444
445
446
class OpQueryNodeStorage(OpCode):
  """Get information on storage for node(s)."""
  OP_ID = "OP_NODE_QUERY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
447
  __slots__ = [
448
449
450
451
452
453
454
    "nodes",
    "storage_type",
    "name",
    "output_fields",
    ]


455
class OpModifyNodeStorage(OpCode):
456
  """Modifies the properies of a storage unit"""
457
  OP_ID = "OP_NODE_MODIFY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
458
  __slots__ = [
459
460
461
462
463
464
465
    "node_name",
    "storage_type",
    "name",
    "changes",
    ]


466
467
468
469
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
470
  __slots__ = [
471
472
473
    "node_name",
    "storage_type",
    "name",
474
    "ignore_consistency",
475
476
477
    ]


Iustin Pop's avatar
Iustin Pop committed
478
479
480
481
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
482
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
483
484
485
    "node_name",
    "force",
    "master_candidate",
486
    "offline",
487
    "drained",
488
    "auto_promote",
489
    "master_capable",
Iustin Pop's avatar
Iustin Pop committed
490
    "vm_capable",
491
    "secondary_ip",
492
    "ndparams",
493
    "powered",
Iustin Pop's avatar
Iustin Pop committed
494
495
    ]

Iustin Pop's avatar
Iustin Pop committed
496
497
498
499
500

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
501
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
502
503
504
505
    "node_name",
    "force",
    ]

506

507
508
509
510
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
511
  __slots__ = [
512
    "node_name",
513
    "mode",
514
    "live",
515
516
517
    ]


518
519
520
521
522
523
524
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
525
526
527
# instance opcodes

class OpCreateInstance(OpCode):
528
529
530
531
532
533
534
  """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)
535
536
  @ivar source_shutdown_timeout: Shutdown timeout used for source instance
    (remote import only)
537
538

  """
Iustin Pop's avatar
Iustin Pop committed
539
  OP_ID = "OP_INSTANCE_CREATE"
540
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
541
  __slots__ = [
542
543
    "instance_name",
    "os_type", "force_variant", "no_install",
544
    "pnode", "disk_template", "snode", "mode",
545
    "disks", "nics",
546
    "src_node", "src_path", "start", "identify_defaults",
547
    "wait_for_sync", "ip_check", "name_check",
548
    "file_storage_dir", "file_driver",
549
    "iallocator",
550
    "hypervisor", "hvparams", "beparams", "osparams",
551
552
553
    "source_handshake",
    "source_x509_ca",
    "source_instance_name",
554
    "source_shutdown_timeout",
555
    ]
Iustin Pop's avatar
Iustin Pop committed
556
557


558
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
559
  """Reinstall an instance's OS."""
560
  OP_ID = "OP_INSTANCE_REINSTALL"
561
  OP_DSC_FIELD = "instance_name"
562
  __slots__ = ["instance_name", "os_type", "force_variant", "osparams"]
563
564


Iustin Pop's avatar
Iustin Pop committed
565
566
567
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
568
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
569
  __slots__ = [
570
571
572
573
    "instance_name",
    "ignore_failures",
    "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
574
575


576
577
578
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
Balazs Lecz's avatar
Balazs Lecz committed
579
  __slots__ = [
580
    "instance_name", "ip_check", "new_name", "name_check",
581
    ]
582
583


Iustin Pop's avatar
Iustin Pop committed
584
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
585
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
586
  OP_ID = "OP_INSTANCE_STARTUP"
587
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
588
  __slots__ = [
589
    "instance_name", "force", "hvparams", "beparams", "ignore_offline_nodes",
590
    ]
Iustin Pop's avatar
Iustin Pop committed
591
592
593


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
594
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
595
  OP_ID = "OP_INSTANCE_SHUTDOWN"
596
  OP_DSC_FIELD = "instance_name"
597
598
599
  __slots__ = [
    "instance_name", "timeout", "ignore_offline_nodes",
    ]
Iustin Pop's avatar
Iustin Pop committed
600
601


602
603
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
604
  OP_ID = "OP_INSTANCE_REBOOT"
605
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
606
  __slots__ = [
607
    "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
608
    ]
609
610


Iustin Pop's avatar
Iustin Pop committed
611
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
612
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
613
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
614
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
615
  __slots__ = [
616
    "instance_name", "remote_node", "mode", "disks", "iallocator",
617
    "early_release",
618
    ]
Iustin Pop's avatar
Iustin Pop committed
619
620
621
622
623


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
624
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
625
  __slots__ = [
626
627
    "instance_name", "ignore_consistency", "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
628
629


630
631
632
633
634
635
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
636
  @ivar instance_name: the name of the instance
637
  @ivar mode: the migration mode (live, non-live or None for auto)
638
639
640

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
641
  OP_DSC_FIELD = "instance_name"
642
  __slots__ = ["instance_name", "mode", "cleanup", "live"]
643
644


645
646
647
648
649
650
651
652
653
654
655
656
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
657
  __slots__ = [
658
    "instance_name", "target_node", "shutdown_timeout",
Balazs Lecz's avatar
Balazs Lecz committed
659
    ]
660
661


Iustin Pop's avatar
Iustin Pop committed
662
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
663
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
664
  OP_ID = "OP_INSTANCE_CONSOLE"
665
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
666
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
667
668
669


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
670
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
671
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
672
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
673
  __slots__ = ["instance_name", "ignore_size"]
Iustin Pop's avatar
Iustin Pop committed
674
675
676


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
677
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
678
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
679
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
680
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
681
682


Iustin Pop's avatar
Iustin Pop committed
683
684
685
686
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
687
  __slots__ = ["instance_name", "disks"]
Iustin Pop's avatar
Iustin Pop committed
688
689


Iustin Pop's avatar
Iustin Pop committed
690
691
692
class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
693
  __slots__ = ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
694
695
696
697
698


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


702
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
703
  """Change the parameters of an instance."""
704
  OP_ID = "OP_INSTANCE_SET_PARAMS"
705
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
706
  __slots__ = [
707
    "instance_name",
708
    "hvparams", "beparams", "osparams", "force",
709
    "nics", "disks", "disk_template",
710
    "remote_node", "os_name", "force_variant",
711
    ]
Iustin Pop's avatar
Iustin Pop committed
712
713


Iustin Pop's avatar
Iustin Pop committed
714
715
716
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
717
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
718
  __slots__ = [
719
720
    "instance_name", "disk", "amount", "wait_for_sync",
    ]
Iustin Pop's avatar
Iustin Pop committed
721
722


723
724
# Node group opcodes

725
726
727
728
class OpAddGroup(OpCode):
  """Add a node group to the cluster."""
  OP_ID = "OP_GROUP_ADD"
  OP_DSC_FIELD = "group_name"
729
730
731
  __slots__ = [
    "group_name",
    "ndparams",
732
    "alloc_policy",
733
    ]
734
735


736
737
738
739
740
741
class OpQueryGroups(OpCode):
  """Compute the list of node groups."""
  OP_ID = "OP_GROUP_QUERY"
  __slots__ = ["output_fields", "names"]


742
743
744
745
746
747
748
class OpSetGroupParams(OpCode):
  """Change the parameters of a node group."""
  OP_ID = "OP_GROUP_SET_PARAMS"
  OP_DSC_FIELD = "group_name"
  __slots__ = [
    "group_name",
    "ndparams",
749
    "alloc_policy",
750
751
752
    ]


753
754
755
756
757
758
759
class OpRemoveGroup(OpCode):
  """Remove a node group from the cluster."""
  OP_ID = "OP_GROUP_REMOVE"
  OP_DSC_FIELD = "group_name"
  __slots__ = ["group_name"]


760
761
762
763
764
765
766
class OpRenameGroup(OpCode):
  """Rename a node group in the cluster."""
  OP_ID = "OP_GROUP_RENAME"
  OP_DSC_FIELD = "old_name"
  __slots__ = ["old_name", "new_name"]


Iustin Pop's avatar
Iustin Pop committed
767
768
769
770
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
Balazs Lecz's avatar
Balazs Lecz committed
771
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
772

773

Iustin Pop's avatar
Iustin Pop committed
774
775
776
777
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
778
  __slots__ = ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
779

780

781
782
783
784
785
786
787
788
789
790
791
792
793
794
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
795
class OpExportInstance(OpCode):
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
  """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
811
  OP_ID = "OP_BACKUP_EXPORT"
812
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
813
  __slots__ = [
814
815
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
816
    "instance_name", "target_node", "shutdown", "shutdown_timeout",
817
818
    "remove_instance",
    "ignore_remove_failures",
819
820
821
    "mode",
    "x509_key_name",
    "destination_x509_ca",
822
    ]
823

Michael Hanselmann's avatar
Michael Hanselmann committed
824

825
826
827
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
828
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
829
  __slots__ = ["instance_name"]
830

Michael Hanselmann's avatar
Michael Hanselmann committed
831

832
833
834
835
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
836
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
837
  __slots__ = ["kind", "name"]
838
839


Iustin Pop's avatar
Iustin Pop committed
840
841
842
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
843
  OP_DSC_FIELD = "pattern"
Balazs Lecz's avatar
Balazs Lecz committed
844
  __slots__ = ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
845
846


847
848
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
849
  OP_ID = "OP_TAGS_SET"
Balazs Lecz's avatar
Balazs Lecz committed
850
  __slots__ = ["kind", "name", "tags"]
851
852


853
854
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
855
  OP_ID = "OP_TAGS_DEL"
Balazs Lecz's avatar
Balazs Lecz committed
856
  __slots__ = ["kind", "name", "tags"]
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881


# 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"
882
  OP_DSC_FIELD = "duration"
883
  __slots__ = ["duration", "on_master", "on_nodes", "repeat"]
884
885
886
887
888
889
890
891
892
893
894
895
896
897


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"
898
  OP_DSC_FIELD = "allocator"
Balazs Lecz's avatar
Balazs Lecz committed
899
  __slots__ = [
900
901
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
902
    "os", "tags", "nics", "vcpus", "hypervisor",
903
    "evac_nodes",
904
    ]
Iustin Pop's avatar
Iustin Pop committed
905

906

907
908
909
910
911
912
913
914
915
916
917
918
919
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",
    ]


920
921
922
923
924
925
926
927
928
929
930
931
class OpTestDummy(OpCode):
  """Utility opcode used by unittests.

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


Iustin Pop's avatar
Iustin Pop committed
932
933
934
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"))])