opcodes.py 23.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
               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
    ]
332
333


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

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

Michael Hanselmann's avatar
Michael Hanselmann committed
341
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

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


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


382
383
# node opcodes

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


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

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


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


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


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


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


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


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

Iustin Pop's avatar
Iustin Pop committed
494
495
496
497
498

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

504

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


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

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

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


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


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


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


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


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


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


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


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


628
629
630
631
632
633
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

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

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


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


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


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


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


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


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


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


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


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


721
722
# Node group opcodes

723
724
725
726
727
728
729
class OpAddGroup(OpCode):
  """Add a node group to the cluster."""
  OP_ID = "OP_GROUP_ADD"
  OP_DSC_FIELD = "group_name"
  __slots__ = ["group_name"]


730
731
732
733
734
735
class OpQueryGroups(OpCode):
  """Compute the list of node groups."""
  OP_ID = "OP_GROUP_QUERY"
  __slots__ = ["output_fields", "names"]


736
737
738
739
740
741
742
class OpRemoveGroup(OpCode):
  """Remove a node group from the cluster."""
  OP_ID = "OP_GROUP_REMOVE"
  OP_DSC_FIELD = "group_name"
  __slots__ = ["group_name"]


Iustin Pop's avatar
Iustin Pop committed
743
744
745
746
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
Balazs Lecz's avatar
Balazs Lecz committed
747
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
748

749

Iustin Pop's avatar
Iustin Pop committed
750
751
752
753
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
754
  __slots__ = ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
755

756

757
758
759
760
761
762
763
764
765
766
767
768
769
770
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
771
class OpExportInstance(OpCode):
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
  """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
787
  OP_ID = "OP_BACKUP_EXPORT"
788
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
789
  __slots__ = [
790
791
    # TODO: Rename target_node as it changes meaning for different export modes
    # (e.g. "destination")
792
    "instance_name", "target_node", "shutdown", "shutdown_timeout",
793
794
    "remove_instance",
    "ignore_remove_failures",
795
796
797
    "mode",
    "x509_key_name",
    "destination_x509_ca",
798
    ]
799

Michael Hanselmann's avatar
Michael Hanselmann committed
800

801
802
803
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
804
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
805
  __slots__ = ["instance_name"]
806

Michael Hanselmann's avatar
Michael Hanselmann committed
807

808
809
810
811
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
812
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
813
  __slots__ = ["kind", "name"]
814
815


Iustin Pop's avatar
Iustin Pop committed
816
817
818
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
819
  OP_DSC_FIELD = "pattern"
Balazs Lecz's avatar
Balazs Lecz committed
820
  __slots__ = ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
821
822


823
824
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
825
  OP_ID = "OP_TAGS_SET"
Balazs Lecz's avatar
Balazs Lecz committed
826
  __slots__ = ["kind", "name", "tags"]
827
828


829
830
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
831
  OP_ID = "OP_TAGS_DEL"
Balazs Lecz's avatar
Balazs Lecz committed
832
  __slots__ = ["kind", "name", "tags"]
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857


# 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"
858
  OP_DSC_FIELD = "duration"
859
  __slots__ = ["duration", "on_master", "on_nodes", "repeat"]
860
861
862
863
864
865
866
867
868
869
870
871
872
873


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"
874
  OP_DSC_FIELD = "allocator"
Balazs Lecz's avatar
Balazs Lecz committed
875
  __slots__ = [
876
877
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
878
    "os", "tags", "nics", "vcpus", "hypervisor",
879
    "evac_nodes",
880
    ]
Iustin Pop's avatar
Iustin Pop committed
881

882

883
884
885
886
887
888
889
890
891
892
893
894
895
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",
    ]


896
897
898
899
900
901
902
903
904
905
906
907
class OpTestDummy(OpCode):
  """Utility opcode used by unittests.

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


Iustin Pop's avatar
Iustin Pop committed
908
909
910
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"))])