opcodes.py 18.9 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""OpCodes module

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

Iustin Pop's avatar
Iustin Pop committed
27
28
Every operation which modifies the cluster state is expressed via
opcodes.
Iustin Pop's avatar
Iustin Pop committed
29
30
31
32
33
34
35

"""

# this are practically structures, so disable the message about too
# few public methods:
# pylint: disable-msg=R0903

36

Iustin Pop's avatar
Iustin Pop committed
37
class BaseOpCode(object):
38
39
  """A simple serializable object.

Iustin Pop's avatar
Iustin Pop committed
40
41
42
  This object serves as a parent class for OpCode without any custom
  field handling.

43
  """
Iustin Pop's avatar
Iustin Pop committed
44
45
46
  __slots__ = []

  def __init__(self, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
47
48
49
50
51
52
53
54
    """Constructor for BaseOpCode.

    The constructor takes only keyword arguments and will set
    attributes on this object based on the passed arguments. As such,
    it means that you should not pass arguments which are not in the
    __slots__ attribute for this class.

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

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

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

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

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

  def __setstate__(self, state):
Iustin Pop's avatar
Iustin Pop committed
79
80
81
82
83
84
85
86
87
    """Generic unserializer.

    This method just restores from the serialized state the attributes
    of the current instance.

    @param state: the serialized opcode data
    @type state:  C{dict}

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

92
    for name in self._all_slots():
93
94
95
96
97
98
      if name not in state:
        delattr(self, name)

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

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

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

109

Iustin Pop's avatar
Iustin Pop committed
110
class OpCode(BaseOpCode):
Iustin Pop's avatar
Iustin Pop committed
111
112
113
114
115
116
  """Abstract OpCode.

  This is the root of the actual OpCode hierarchy. All clases derived
  from this class should override OP_ID.

  @cvar OP_ID: The ID of this opcode. This should be unique amongst all
117
118
119
               children of this class.
  @ivar dry_run: Whether the LU should be run in dry-run mode, i.e. just
                 the check steps
Iustin Pop's avatar
Iustin Pop committed
120
121

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

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

Iustin Pop's avatar
Iustin Pop committed
128
129
130
131
132
133
134
    This method adds to the state dictionary the OP_ID of the class,
    so that on unload we can identify the correct class for
    instantiating the opcode.

    @rtype:   C{dict}
    @return:  the state as a dictionary

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

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

Iustin Pop's avatar
Iustin Pop committed
144
145
146
147
148
149
150
    The method identifies the correct opcode class from the dict-form
    by looking for a OP_ID key, if this is not found, or its value is
    not available in this module as a child of this class, we fail.

    @type data:  C{dict}
    @param data: the serialized opcode

151
152
153
154
155
156
157
    """
    if not isinstance(data, dict):
      raise ValueError("Invalid data to LoadOpCode (%s)" % type(data))
    if "OP_ID" not in data:
      raise ValueError("Invalid data to LoadOpcode, missing OP_ID")
    op_id = data["OP_ID"]
    op_class = None
Iustin Pop's avatar
Iustin Pop committed
158
159
160
    if op_id in OP_MAPPING:
      op_class = OP_MAPPING[op_id]
    else:
161
162
163
164
165
166
167
168
      raise ValueError("Invalid data to LoadOpCode: OP_ID %s unsupported" %
                       op_id)
    op = op_class()
    new_data = data.copy()
    del new_data["OP_ID"]
    op.__setstate__(new_data)
    return op

169
170
171
172
173
174
175
176
177
178
179
180
  def Summary(self):
    """Generates a summary description of this opcode.

    """
    # all OP_ID start with OP_, we remove that
    txt = self.OP_ID[3:]
    field_name = getattr(self, "OP_DSC_FIELD", None)
    if field_name:
      field_value = getattr(self, field_name, None)
      txt = "%s(%s)" % (txt, field_value)
    return txt

Iustin Pop's avatar
Iustin Pop committed
181

182
183
# cluster opcodes

184
185
186
187
188
189
190
191
class OpPostInitCluster(OpCode):
  """Post cluster initialization.

  This opcode does not touch the cluster at all. Its purpose is to run hooks
  after the cluster has been initialized.

  """
  OP_ID = "OP_CLUSTER_POST_INIT"
Balazs Lecz's avatar
Balazs Lecz committed
192
  __slots__ = []
193
194


Iustin Pop's avatar
Iustin Pop committed
195
class OpDestroyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
196
197
198
199
200
201
  """Destroy the cluster.

  This opcode has no other parameters. All the state is irreversibly
  lost after the execution of this opcode.

  """
Iustin Pop's avatar
Iustin Pop committed
202
  OP_ID = "OP_CLUSTER_DESTROY"
Balazs Lecz's avatar
Balazs Lecz committed
203
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
204
205
206


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


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
213
214
215
216
217
218
219
220
221
  """Verify the cluster state.

  @type skip_checks: C{list}
  @ivar skip_checks: steps to be skipped from the verify process; this
                     needs to be a subset of
                     L{constants.VERIFY_OPTIONAL_CHECKS}; currently
                     only L{constants.VERIFY_NPLUSONE_MEM} can be passed

  """
Iustin Pop's avatar
Iustin Pop committed
222
  OP_ID = "OP_CLUSTER_VERIFY"
Balazs Lecz's avatar
Balazs Lecz committed
223
224
  __slots__ = ["skip_checks", "verbose", "error_codes",
               "debug_simulate_errors"]
Iustin Pop's avatar
Iustin Pop committed
225
226


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

  Parameters: none

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

239
240
241
242
  In normal operation, all lists should be empty. A non-empty instance
  list (3rd element of the result) is still ok (errors were fixed) but
  non-empty node list means some node is down, and probably there are
  unfixable drbd errors.
Iustin Pop's avatar
Iustin Pop committed
243
244
245
246
247
248

  Note that only instances that are drbd-based are taken into
  consideration. This might need to be revisited in the future.

  """
  OP_ID = "OP_CLUSTER_VERIFY_DISKS"
Balazs Lecz's avatar
Balazs Lecz committed
249
  __slots__ = []
Iustin Pop's avatar
Iustin Pop committed
250
251


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
class OpRepairDiskSizes(OpCode):
  """Verify the disk sizes of the instances and fixes configuration
  mimatches.

  Parameters: optional instances list, in case we want to restrict the
  checks to only a subset of the instances.

  Result: a list of tuples, (instance, disk, new-size) for changed
  configurations.

  In normal operation, the list should be empty.

  @type instances: list
  @ivar instances: the list of instances to check, or empty for all instances

  """
  OP_ID = "OP_CLUSTER_REPAIR_DISK_SIZES"
  __slots__ = ["instances"]


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


278
class OpRenameCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
279
280
281
282
283
284
285
286
  """Rename the cluster.

  @type name: C{str}
  @ivar name: The new name of the cluster. The name and/or the master IP
              address will be changed to match the new name and its IP
              address.

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


292
class OpSetClusterParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
293
294
295
296
297
298
  """Change the parameters of the cluster.

  @type vg_name: C{str} or C{None}
  @ivar vg_name: The new volume group name or None to disable LVM usage.

  """
299
  OP_ID = "OP_CLUSTER_SET_PARAMS"
Balazs Lecz's avatar
Balazs Lecz committed
300
  __slots__ = [
301
302
303
304
    "vg_name",
    "enabled_hypervisors",
    "hvparams",
    "beparams",
305
    "nicparams",
306
307
    "candidate_pool_size",
    ]
308
309


310
311
312
313
314
class OpRedistributeConfig(OpCode):
  """Force a full push of the cluster configuration.

  """
  OP_ID = "OP_CLUSTER_REDIST_CONF"
Balazs Lecz's avatar
Balazs Lecz committed
315
  __slots__ = []
316

317
318
# node opcodes

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


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


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


365
366
367
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
Balazs Lecz's avatar
Balazs Lecz committed
368
  __slots__ = ["nodes", "output_fields"]
369
370


371
372
373
class OpQueryNodeStorage(OpCode):
  """Get information on storage for node(s)."""
  OP_ID = "OP_NODE_QUERY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
374
  __slots__ = [
375
376
377
378
379
380
381
    "nodes",
    "storage_type",
    "name",
    "output_fields",
    ]


382
class OpModifyNodeStorage(OpCode):
383
  """Modifies the properies of a storage unit"""
384
  OP_ID = "OP_NODE_MODIFY_STORAGE"
Balazs Lecz's avatar
Balazs Lecz committed
385
  __slots__ = [
386
387
388
389
390
391
392
    "node_name",
    "storage_type",
    "name",
    "changes",
    ]


393
394
395
396
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
397
  __slots__ = [
398
399
400
    "node_name",
    "storage_type",
    "name",
401
    "ignore_consistency",
402
403
404
    ]


Iustin Pop's avatar
Iustin Pop committed
405
406
407
408
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
409
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
410
411
412
    "node_name",
    "force",
    "master_candidate",
413
    "offline",
414
    "drained",
Iustin Pop's avatar
Iustin Pop committed
415
416
    ]

Iustin Pop's avatar
Iustin Pop committed
417
418
419
420
421

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
422
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
423
424
425
426
    "node_name",
    "force",
    ]

427
428
429
430
431

class OpEvacuateNode(OpCode):
  """Relocate secondary instances from a node."""
  OP_ID = "OP_NODE_EVACUATE"
  OP_DSC_FIELD = "node_name"
Balazs Lecz's avatar
Balazs Lecz committed
432
  __slots__ = [
433
    "node_name", "remote_node", "iallocator", "early_release",
434
435
436
    ]


437
438
439
440
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
441
  __slots__ = [
442
443
444
445
446
    "node_name",
    "live",
    ]


447
448
449
450
451
452
453
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
454
455
456
# instance opcodes

class OpCreateInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
457
  """Create an instance."""
Iustin Pop's avatar
Iustin Pop committed
458
  OP_ID = "OP_INSTANCE_CREATE"
459
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
460
  __slots__ = [
461
462
    "instance_name", "os_type", "force_variant",
    "pnode", "disk_template", "snode", "mode",
463
464
    "disks", "nics",
    "src_node", "src_path", "start",
465
    "wait_for_sync", "ip_check", "name_check",
466
    "file_storage_dir", "file_driver",
467
468
    "iallocator",
    "hypervisor", "hvparams", "beparams",
469
    "dry_run",
470
    ]
Iustin Pop's avatar
Iustin Pop committed
471
472


473
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
474
  """Reinstall an instance's OS."""
475
  OP_ID = "OP_INSTANCE_REINSTALL"
476
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
477
  __slots__ = ["instance_name", "os_type", "force_variant"]
478
479


Iustin Pop's avatar
Iustin Pop committed
480
481
482
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
483
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
484
  __slots__ = [
485
486
487
488
    "instance_name",
    "ignore_failures",
    "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
489
490


491
492
493
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
Balazs Lecz's avatar
Balazs Lecz committed
494
  __slots__ = [
495
496
    "instance_name", "ignore_ip", "new_name",
    ]
497
498


Iustin Pop's avatar
Iustin Pop committed
499
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
500
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
501
  OP_ID = "OP_INSTANCE_STARTUP"
502
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
503
  __slots__ = [
504
505
    "instance_name", "force", "hvparams", "beparams",
    ]
Iustin Pop's avatar
Iustin Pop committed
506
507
508


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
509
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
510
  OP_ID = "OP_INSTANCE_SHUTDOWN"
511
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
512
  __slots__ = ["instance_name", "timeout"]
Iustin Pop's avatar
Iustin Pop committed
513
514


515
516
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
517
  OP_ID = "OP_INSTANCE_REBOOT"
518
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
519
  __slots__ = [
520
    "instance_name", "reboot_type", "ignore_secondaries", "shutdown_timeout",
521
    ]
522
523


Iustin Pop's avatar
Iustin Pop committed
524
class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
525
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
526
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
527
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
528
  __slots__ = [
529
    "instance_name", "remote_node", "mode", "disks", "iallocator",
530
    "early_release",
531
    ]
Iustin Pop's avatar
Iustin Pop committed
532
533
534
535
536


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
537
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
538
  __slots__ = [
539
540
    "instance_name", "ignore_consistency", "shutdown_timeout",
    ]
Iustin Pop's avatar
Iustin Pop committed
541
542


543
544
545
546
547
548
class OpMigrateInstance(OpCode):
  """Migrate an instance.

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

Iustin Pop's avatar
Iustin Pop committed
549
  @ivar instance_name: the name of the instance
550
551
552

  """
  OP_ID = "OP_INSTANCE_MIGRATE"
Iustin Pop's avatar
Iustin Pop committed
553
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
554
  __slots__ = ["instance_name", "live", "cleanup"]
555
556


557
558
559
560
561
562
563
564
565
566
567
568
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
569
  __slots__ = [
570
    "instance_name", "target_node", "shutdown_timeout",
Balazs Lecz's avatar
Balazs Lecz committed
571
    ]
572
573


Iustin Pop's avatar
Iustin Pop committed
574
class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
575
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
576
  OP_ID = "OP_INSTANCE_CONSOLE"
577
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
578
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
579
580
581


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
582
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
583
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
584
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
585
  __slots__ = ["instance_name", "ignore_size"]
Iustin Pop's avatar
Iustin Pop committed
586
587
588


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
589
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
590
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
591
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
592
  __slots__ = ["instance_name"]
Iustin Pop's avatar
Iustin Pop committed
593
594


Iustin Pop's avatar
Iustin Pop committed
595
596
597
598
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
599
  __slots__ = ["instance_name", "disks"]
Iustin Pop's avatar
Iustin Pop committed
600
601


Iustin Pop's avatar
Iustin Pop committed
602
603
604
class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
605
  __slots__ = ["output_fields", "names", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
606
607
608
609
610


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


614
class OpSetInstanceParams(OpCode):
Iustin Pop's avatar
Iustin Pop committed
615
  """Change the parameters of an instance."""
616
  OP_ID = "OP_INSTANCE_SET_PARAMS"
617
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
618
  __slots__ = [
619
    "instance_name",
Iustin Pop's avatar
Iustin Pop committed
620
    "hvparams", "beparams", "force",
621
    "nics", "disks",
622
    ]
Iustin Pop's avatar
Iustin Pop committed
623
624


Iustin Pop's avatar
Iustin Pop committed
625
626
627
class OpGrowDisk(OpCode):
  """Grow a disk of an instance."""
  OP_ID = "OP_INSTANCE_GROW_DISK"
628
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
629
  __slots__ = [
630
631
    "instance_name", "disk", "amount", "wait_for_sync",
    ]
Iustin Pop's avatar
Iustin Pop committed
632
633


Iustin Pop's avatar
Iustin Pop committed
634
635
636
637
# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
Balazs Lecz's avatar
Balazs Lecz committed
638
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
639

640

Iustin Pop's avatar
Iustin Pop committed
641
642
643
644
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
Balazs Lecz's avatar
Balazs Lecz committed
645
  __slots__ = ["nodes", "use_locking"]
Iustin Pop's avatar
Iustin Pop committed
646

647

Iustin Pop's avatar
Iustin Pop committed
648
649
650
class OpExportInstance(OpCode):
  """Export an instance."""
  OP_ID = "OP_BACKUP_EXPORT"
651
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
652
  __slots__ = [
653
654
    "instance_name", "target_node", "shutdown", "shutdown_timeout",
    ]
655

Michael Hanselmann's avatar
Michael Hanselmann committed
656

657
658
659
class OpRemoveExport(OpCode):
  """Remove an instance's export."""
  OP_ID = "OP_BACKUP_REMOVE"
660
  OP_DSC_FIELD = "instance_name"
Balazs Lecz's avatar
Balazs Lecz committed
661
  __slots__ = ["instance_name"]
662

Michael Hanselmann's avatar
Michael Hanselmann committed
663

664
665
666
667
# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
668
  OP_DSC_FIELD = "name"
Balazs Lecz's avatar
Balazs Lecz committed
669
  __slots__ = ["kind", "name"]
670
671


Iustin Pop's avatar
Iustin Pop committed
672
673
674
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
675
  OP_DSC_FIELD = "pattern"
Balazs Lecz's avatar
Balazs Lecz committed
676
  __slots__ = ["pattern"]
Iustin Pop's avatar
Iustin Pop committed
677
678


679
680
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
681
  OP_ID = "OP_TAGS_SET"
Balazs Lecz's avatar
Balazs Lecz committed
682
  __slots__ = ["kind", "name", "tags"]
683
684


685
686
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
687
  OP_ID = "OP_TAGS_DEL"
Balazs Lecz's avatar
Balazs Lecz committed
688
  __slots__ = ["kind", "name", "tags"]
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713


# 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"
714
  OP_DSC_FIELD = "duration"
Balazs Lecz's avatar
Balazs Lecz committed
715
  __slots__ = ["duration", "on_master", "on_nodes"]
716
717
718
719
720
721
722
723
724
725
726
727
728
729


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"
730
  OP_DSC_FIELD = "allocator"
Balazs Lecz's avatar
Balazs Lecz committed
731
  __slots__ = [
732
733
    "direction", "mode", "allocator", "name",
    "mem_size", "disks", "disk_template",
734
    "os", "tags", "nics", "vcpus", "hypervisor",
735
    "evac_nodes",
736
    ]
Iustin Pop's avatar
Iustin Pop committed
737

738

Iustin Pop's avatar
Iustin Pop committed
739
740
741
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"))])