opcodes.py 8.79 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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
#

# 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.


This module implements the logic for doing operations in the cluster. There
are two kinds of classes defined:
  - opcodes, which are small classes only holding data for the task at hand
  - logical units, which know how to deal with their specific opcode only

"""

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

class OpCode(object):
  """Abstract OpCode"""
  OP_ID = "OP_ABSTRACT"
  __slots__ = []

  def __init__(self, **kwargs):
    for key in kwargs:
      if key not in self.__slots__:
47
48
        raise TypeError("OpCode %s doesn't support the parameter '%s'" %
                        (self.__class__.__name__, key))
Iustin Pop's avatar
Iustin Pop committed
49
50
51
52
53
54
55
      setattr(self, key, kwargs[key])


class OpInitCluster(OpCode):
  """Initialise the cluster."""
  OP_ID = "OP_CLUSTER_INIT"
  __slots__ = ["cluster_name", "secondary_ip", "hypervisor_type",
56
               "vg_name", "mac_prefix", "def_bridge", "master_netdev"]
Iustin Pop's avatar
Iustin Pop committed
57
58
59
60
61
62
63
64
65


class OpDestroyCluster(OpCode):
  """Destroy the cluster."""
  OP_ID = "OP_CLUSTER_DESTROY"
  __slots__ = []


class OpQueryClusterInfo(OpCode):
Iustin Pop's avatar
Iustin Pop committed
66
  """Query cluster information."""
Iustin Pop's avatar
Iustin Pop committed
67
68
69
70
71
  OP_ID = "OP_CLUSTER_QUERY"
  __slots__ = []


class OpClusterCopyFile(OpCode):
Iustin Pop's avatar
Iustin Pop committed
72
  """Copy a file to multiple nodes."""
Iustin Pop's avatar
Iustin Pop committed
73
74
75
76
77
  OP_ID = "OP_CLUSTER_COPYFILE"
  __slots__ = ["nodes", "filename"]


class OpRunClusterCommand(OpCode):
Iustin Pop's avatar
Iustin Pop committed
78
  """Run a command on multiple nodes."""
Iustin Pop's avatar
Iustin Pop committed
79
80
81
82
83
  OP_ID = "OP_CLUSTER_RUNCOMMAND"
  __slots__ = ["nodes", "command"]


class OpVerifyCluster(OpCode):
Iustin Pop's avatar
Iustin Pop committed
84
  """Verify the cluster state."""
Iustin Pop's avatar
Iustin Pop committed
85
86
87
88
  OP_ID = "OP_CLUSTER_VERIFY"
  __slots__ = []


Iustin Pop's avatar
Iustin Pop committed
89
90
91
92
93
94
95
class OpVerifyDisks(OpCode):
  """Verify the cluster disks.

  Parameters: none

  Result: two lists:
    - list of node names with bad data returned (unreachable, etc.)
96
    - dist of node names with broken volume groups (values: error msg)
Iustin Pop's avatar
Iustin Pop committed
97
    - list of instances with degraded disks (that should be activated)
98
99
    - dict of instances with missing logical volumes (values: (node, vol)
      pairs with details about the missing volumes)
Iustin Pop's avatar
Iustin Pop committed
100

101
102
103
104
  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
105
106
107
108
109
110
111
112
113

  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"
  __slots__ = []


Iustin Pop's avatar
Iustin Pop committed
114
class OpMasterFailover(OpCode):
Iustin Pop's avatar
Iustin Pop committed
115
  """Do a master failover."""
Iustin Pop's avatar
Iustin Pop committed
116
117
118
119
120
  OP_ID = "OP_CLUSTER_MASTERFAILOVER"
  __slots__ = []


class OpDumpClusterConfig(OpCode):
Iustin Pop's avatar
Iustin Pop committed
121
  """Dump the cluster configuration."""
Iustin Pop's avatar
Iustin Pop committed
122
123
124
125
  OP_ID = "OP_CLUSTER_DUMPCONFIG"
  __slots__ = []


126
127
128
129
130
131
132
133
class OpRenameCluster(OpCode):
  """Rename the cluster."""
  OP_ID = "OP_CLUSTER_RENAME"
  __slots__ = ["name"]


# node opcodes

Iustin Pop's avatar
Iustin Pop committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class OpRemoveNode(OpCode):
  """Remove a node."""
  OP_ID = "OP_NODE_REMOVE"
  __slots__ = ["node_name"]


class OpAddNode(OpCode):
  """Add a node."""
  OP_ID = "OP_NODE_ADD"
  __slots__ = ["node_name", "primary_ip", "secondary_ip"]


class OpQueryNodes(OpCode):
  """Compute the list of nodes."""
  OP_ID = "OP_NODE_QUERY"
149
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
150
151


152
153
154
155
156
157
class OpQueryNodeVolumes(OpCode):
  """Get list of volumes on node."""
  OP_ID = "OP_NODE_QUERYVOLS"
  __slots__ = ["nodes", "output_fields"]


Iustin Pop's avatar
Iustin Pop committed
158
159
160
# instance opcodes

class OpCreateInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
161
  """Create an instance."""
Iustin Pop's avatar
Iustin Pop committed
162
  OP_ID = "OP_INSTANCE_CREATE"
163
164
165
166
167
  __slots__ = [
    "instance_name", "mem_size", "disk_size", "os_type", "pnode",
    "disk_template", "snode", "swap_size", "mode",
    "vcpus", "ip", "bridge", "src_node", "src_path", "start",
    "wait_for_sync", "ip_check", "mac",
168
    "kernel_path", "initrd_path", "hvm_boot_order",
169
    ]
Iustin Pop's avatar
Iustin Pop committed
170
171


172
class OpReinstallInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
173
  """Reinstall an instance's OS."""
174
  OP_ID = "OP_INSTANCE_REINSTALL"
175
  __slots__ = ["instance_name", "os_type"]
176
177


Iustin Pop's avatar
Iustin Pop committed
178
179
180
class OpRemoveInstance(OpCode):
  """Remove an instance."""
  OP_ID = "OP_INSTANCE_REMOVE"
Iustin Pop's avatar
Iustin Pop committed
181
  __slots__ = ["instance_name", "ignore_failures"]
Iustin Pop's avatar
Iustin Pop committed
182
183


184
185
186
187
188
189
class OpRenameInstance(OpCode):
  """Rename an instance."""
  OP_ID = "OP_INSTANCE_RENAME"
  __slots__ = ["instance_name", "ignore_ip", "new_name"]


Iustin Pop's avatar
Iustin Pop committed
190
class OpStartupInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
191
  """Startup an instance."""
Iustin Pop's avatar
Iustin Pop committed
192
193
194
195
196
  OP_ID = "OP_INSTANCE_STARTUP"
  __slots__ = ["instance_name", "force", "extra_args"]


class OpShutdownInstance(OpCode):
Iustin Pop's avatar
Iustin Pop committed
197
  """Shutdown an instance."""
Iustin Pop's avatar
Iustin Pop committed
198
199
200
201
  OP_ID = "OP_INSTANCE_SHUTDOWN"
  __slots__ = ["instance_name"]


202
203
class OpRebootInstance(OpCode):
  """Reboot an instance."""
Iustin Pop's avatar
Iustin Pop committed
204
  OP_ID = "OP_INSTANCE_REBOOT"
205
206
207
208
  __slots__ = ["instance_name", "reboot_type", "extra_args",
               "ignore_secondaries" ]


Iustin Pop's avatar
Iustin Pop committed
209
210
211
212
213
214
215
216
217
218
219
220
221
class OpAddMDDRBDComponent(OpCode):
  """Add a MD-DRBD component."""
  OP_ID = "OP_INSTANCE_ADD_MDDRBD"
  __slots__ = ["instance_name", "remote_node", "disk_name"]


class OpRemoveMDDRBDComponent(OpCode):
  """Remove a MD-DRBD component."""
  OP_ID = "OP_INSTANCE_REMOVE_MDDRBD"
  __slots__ = ["instance_name", "disk_name", "disk_id"]


class OpReplaceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
222
  """Replace the disks of an instance."""
Iustin Pop's avatar
Iustin Pop committed
223
  OP_ID = "OP_INSTANCE_REPLACE_DISKS"
224
  __slots__ = ["instance_name", "remote_node", "mode", "disks"]
Iustin Pop's avatar
Iustin Pop committed
225
226
227
228
229
230
231
232
233


class OpFailoverInstance(OpCode):
  """Failover an instance."""
  OP_ID = "OP_INSTANCE_FAILOVER"
  __slots__ = ["instance_name", "ignore_consistency"]


class OpConnectConsole(OpCode):
Iustin Pop's avatar
Iustin Pop committed
234
  """Connect to an instance's console."""
Iustin Pop's avatar
Iustin Pop committed
235
236
237
238
239
  OP_ID = "OP_INSTANCE_CONSOLE"
  __slots__ = ["instance_name"]


class OpActivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
240
  """Activate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
241
242
243
244
245
  OP_ID = "OP_INSTANCE_ACTIVATE_DISKS"
  __slots__ = ["instance_name"]


class OpDeactivateInstanceDisks(OpCode):
Iustin Pop's avatar
Iustin Pop committed
246
  """Deactivate an instance's disks."""
Iustin Pop's avatar
Iustin Pop committed
247
248
249
250
251
252
253
  OP_ID = "OP_INSTANCE_DEACTIVATE_DISKS"
  __slots__ = ["instance_name"]


class OpQueryInstances(OpCode):
  """Compute the list of instances."""
  OP_ID = "OP_INSTANCE_QUERY"
254
  __slots__ = ["output_fields", "names"]
Iustin Pop's avatar
Iustin Pop committed
255
256
257
258
259
260
261
262
263
264
265


class OpQueryInstanceData(OpCode):
  """Compute the run-time status of instances."""
  OP_ID = "OP_INSTANCE_QUERY_DATA"
  __slots__ = ["instances"]


class OpSetInstanceParms(OpCode):
  """Change the parameters of an instance."""
  OP_ID = "OP_INSTANCE_SET_PARMS"
266
267
  __slots__ = [
    "instance_name", "mem", "vcpus", "ip", "bridge", "mac",
268
    "kernel_path", "initrd_path", "hvm_boot_order",
269
    ]
Iustin Pop's avatar
Iustin Pop committed
270
271
272
273
274
275
276
277


# OS opcodes
class OpDiagnoseOS(OpCode):
  """Compute the list of guest operating systems."""
  OP_ID = "OP_OS_DIAGNOSE"
  __slots__ = []

278

Iustin Pop's avatar
Iustin Pop committed
279
280
281
282
283
284
# Exports opcodes
class OpQueryExports(OpCode):
  """Compute the list of exported images."""
  OP_ID = "OP_BACKUP_QUERY"
  __slots__ = ["nodes"]

285

Iustin Pop's avatar
Iustin Pop committed
286
287
288
289
class OpExportInstance(OpCode):
  """Export an instance."""
  OP_ID = "OP_BACKUP_EXPORT"
  __slots__ = ["instance_name", "target_node", "shutdown"]
290
291
292
293
294
295
296
297
298


# Tags opcodes
class OpGetTags(OpCode):
  """Returns the tags of the given object."""
  OP_ID = "OP_TAGS_GET"
  __slots__ = ["kind", "name"]


Iustin Pop's avatar
Iustin Pop committed
299
300
301
302
303
304
class OpSearchTags(OpCode):
  """Searches the tags in the cluster for a given pattern."""
  OP_ID = "OP_TAGS_SEARCH"
  __slots__ = ["pattern"]


305
306
class OpAddTags(OpCode):
  """Add a list of tags on a given object."""
307
  OP_ID = "OP_TAGS_SET"
308
  __slots__ = ["kind", "name", "tags"]
309
310


311
312
class OpDelTags(OpCode):
  """Remove a list of tags from a given object."""
313
  OP_ID = "OP_TAGS_DEL"
314
  __slots__ = ["kind", "name", "tags"]
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340


# 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"
  __slots__ = ["duration", "on_master", "on_nodes"]