4 # Copyright (C) 2006, 2007 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Module implementing the logic behind the cluster operations
24 This module implements the logic for doing operations in the cluster. There
25 are two kinds of classes defined:
26 - logical units, which know how to deal with their specific opcode only
27 - the processor, which dispatches the opcodes to their logical units
32 from ganeti import opcodes
33 from ganeti import constants
34 from ganeti import errors
35 from ganeti import rpc
36 from ganeti import cmdlib
37 from ganeti import config
38 from ganeti import ssconf
39 from ganeti import logger
41 class Processor(object):
42 """Object which runs OpCodes"""
45 opcodes.OpInitCluster: cmdlib.LUInitCluster,
46 opcodes.OpDestroyCluster: cmdlib.LUDestroyCluster,
47 opcodes.OpQueryClusterInfo: cmdlib.LUQueryClusterInfo,
48 opcodes.OpClusterCopyFile: cmdlib.LUClusterCopyFile,
49 opcodes.OpRunClusterCommand: cmdlib.LURunClusterCommand,
50 opcodes.OpVerifyCluster: cmdlib.LUVerifyCluster,
51 opcodes.OpMasterFailover: cmdlib.LUMasterFailover,
52 opcodes.OpDumpClusterConfig: cmdlib.LUDumpClusterConfig,
53 opcodes.OpRenameCluster: cmdlib.LURenameCluster,
54 opcodes.OpVerifyDisks: cmdlib.LUVerifyDisks,
56 opcodes.OpAddNode: cmdlib.LUAddNode,
57 opcodes.OpQueryNodes: cmdlib.LUQueryNodes,
58 opcodes.OpQueryNodeVolumes: cmdlib.LUQueryNodeVolumes,
59 opcodes.OpRemoveNode: cmdlib.LURemoveNode,
61 opcodes.OpCreateInstance: cmdlib.LUCreateInstance,
62 opcodes.OpReinstallInstance: cmdlib.LUReinstallInstance,
63 opcodes.OpRemoveInstance: cmdlib.LURemoveInstance,
64 opcodes.OpRenameInstance: cmdlib.LURenameInstance,
65 opcodes.OpActivateInstanceDisks: cmdlib.LUActivateInstanceDisks,
66 opcodes.OpShutdownInstance: cmdlib.LUShutdownInstance,
67 opcodes.OpStartupInstance: cmdlib.LUStartupInstance,
68 opcodes.OpRebootInstance: cmdlib.LURebootInstance,
69 opcodes.OpDeactivateInstanceDisks: cmdlib.LUDeactivateInstanceDisks,
70 opcodes.OpAddMDDRBDComponent: cmdlib.LUAddMDDRBDComponent,
71 opcodes.OpRemoveMDDRBDComponent: cmdlib.LURemoveMDDRBDComponent,
72 opcodes.OpReplaceDisks: cmdlib.LUReplaceDisks,
73 opcodes.OpFailoverInstance: cmdlib.LUFailoverInstance,
74 opcodes.OpConnectConsole: cmdlib.LUConnectConsole,
75 opcodes.OpQueryInstances: cmdlib.LUQueryInstances,
76 opcodes.OpQueryInstanceData: cmdlib.LUQueryInstanceData,
77 opcodes.OpSetInstanceParms: cmdlib.LUSetInstanceParms,
79 opcodes.OpDiagnoseOS: cmdlib.LUDiagnoseOS,
81 opcodes.OpQueryExports: cmdlib.LUQueryExports,
82 opcodes.OpExportInstance: cmdlib.LUExportInstance,
84 opcodes.OpGetTags: cmdlib.LUGetTags,
85 opcodes.OpSearchTags: cmdlib.LUSearchTags,
86 opcodes.OpAddTags: cmdlib.LUAddTags,
87 opcodes.OpDelTags: cmdlib.LUDelTags,
89 opcodes.OpTestDelay: cmdlib.LUTestDelay,
90 opcodes.OpTestAllocator: cmdlib.LUTestAllocator,
93 def __init__(self, feedback=None):
94 """Constructor for Processor
97 - feedback_fn: the feedback function (taking one string) to be run when
98 interesting events are happening
102 self._feedback_fn = feedback
104 def ExecOpCode(self, op):
105 """Execute an opcode.
108 op: the opcode to be executed
111 if not isinstance(op, opcodes.OpCode):
112 raise errors.ProgrammerError("Non-opcode instance passed"
115 lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
117 raise errors.OpCodeUnknown("Unknown opcode")
119 if lu_class.REQ_CLUSTER and self.cfg is None:
120 self.cfg = config.ConfigWriter()
121 self.sstore = ssconf.SimpleStore()
122 if self.cfg is not None:
123 write_count = self.cfg.write_count
126 lu = lu_class(self, op, self.cfg, self.sstore)
128 hm = HooksMaster(rpc.call_hooks_runner, self, lu)
129 hm.RunPhase(constants.HOOKS_PHASE_PRE)
131 result = lu.Exec(self._feedback_fn)
132 hm.RunPhase(constants.HOOKS_PHASE_POST)
134 if lu.cfg is not None:
135 # we use lu.cfg and not self.cfg as for init cluster, self.cfg
136 # is None but lu.cfg has been recently initialized in the
138 if write_count != lu.cfg.write_count:
143 def ChainOpCode(self, op):
144 """Chain and execute an opcode.
146 This is used by LUs when they need to execute a child LU.
149 - opcode: the opcode to be executed
152 if not isinstance(op, opcodes.OpCode):
153 raise errors.ProgrammerError("Non-opcode instance passed"
156 lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
158 raise errors.OpCodeUnknown("Unknown opcode")
160 if lu_class.REQ_CLUSTER and self.cfg is None:
161 self.cfg = config.ConfigWriter()
162 self.sstore = ssconf.SimpleStore()
163 #do_hooks = lu_class.HPATH is not None
164 lu = lu_class(self, op, self.cfg, self.sstore)
167 # hm = HooksMaster(rpc.call_hooks_runner, self, lu)
168 # hm.RunPhase(constants.HOOKS_PHASE_PRE)
169 result = lu.Exec(self._feedback_fn)
171 # hm.RunPhase(constants.HOOKS_PHASE_POST)
174 def LogStep(self, current, total, message):
175 """Log a change in LU execution progress.
178 logger.Debug("Step %d/%d %s" % (current, total, message))
179 self._feedback_fn("STEP %d/%d %s" % (current, total, message))
181 def LogWarning(self, message, hint=None):
182 """Log a warning to the logs and the user.
185 logger.Error(message)
186 self._feedback_fn(" - WARNING: %s" % message)
188 self._feedback_fn(" Hint: %s" % hint)
190 def LogInfo(self, message):
191 """Log an informational message to the logs and the user.
195 self._feedback_fn(" - INFO: %s" % message)
198 class HooksMaster(object):
201 This class distributes the run commands to the nodes based on the
204 In order to remove the direct dependency on the rpc module, the
205 constructor needs a function which actually does the remote
206 call. This will usually be rpc.call_hooks_runner, but any function
207 which behaves the same works.
210 def __init__(self, callfn, proc, lu):
215 self.env, node_list_pre, node_list_post = self._BuildEnv()
216 self.node_list = {constants.HOOKS_PHASE_PRE: node_list_pre,
217 constants.HOOKS_PHASE_POST: node_list_post}
220 """Compute the environment and the target nodes.
222 Based on the opcode and the current node list, this builds the
223 environment for the hooks and the target node list for the run.
227 "PATH": "/sbin:/bin:/usr/sbin:/usr/bin",
228 "GANETI_HOOKS_VERSION": constants.HOOKS_VERSION,
229 "GANETI_OP_CODE": self.op.OP_ID,
230 "GANETI_OBJECT_TYPE": self.lu.HTYPE,
231 "GANETI_DATA_DIR": constants.DATA_DIR,
234 if self.lu.HPATH is not None:
235 lu_env, lu_nodes_pre, lu_nodes_post = self.lu.BuildHooksEnv()
238 env["GANETI_" + key] = lu_env[key]
240 lu_nodes_pre = lu_nodes_post = []
242 return env, frozenset(lu_nodes_pre), frozenset(lu_nodes_post)
244 def _RunWrapper(self, node_list, hpath, phase):
245 """Simple wrapper over self.callfn.
247 This method fixes the environment before doing the rpc call.
250 env = self.env.copy()
251 env["GANETI_HOOKS_PHASE"] = phase
252 env["GANETI_HOOKS_PATH"] = hpath
253 if self.lu.sstore is not None:
254 env["GANETI_CLUSTER"] = self.lu.sstore.GetClusterName()
255 env["GANETI_MASTER"] = self.lu.sstore.GetMasterNode()
257 env = dict([(str(key), str(val)) for key, val in env.iteritems()])
259 return self.callfn(node_list, hpath, phase, env)
261 def RunPhase(self, phase):
262 """Run all the scripts for a phase.
264 This is the main function of the HookMaster.
267 if not self.node_list[phase]:
268 # empty node list, we should not attempt to run this as either
269 # we're in the cluster init phase and the rpc client part can't
270 # even attempt to run, or this LU doesn't do hooks at all
272 hpath = self.lu.HPATH
273 results = self._RunWrapper(self.node_list[phase], hpath, phase)
274 if phase == constants.HOOKS_PHASE_PRE:
277 raise errors.HooksFailure("Communication failure")
278 for node_name in results:
279 res = results[node_name]
280 if res is False or not isinstance(res, list):
281 self.proc.LogWarning("Communication failure to node %s" % node_name)
283 for script, hkr, output in res:
284 if hkr == constants.HKR_FAIL:
285 output = output.strip().encode("string_escape")
286 errs.append((node_name, script, output))
288 raise errors.HooksAbort(errs)
290 def RunConfigUpdate(self):
291 """Run the special configuration update hook
293 This is a special hook that runs only on the master after each
294 top-level LI if the configuration has been updated.
297 phase = constants.HOOKS_PHASE_POST
298 hpath = constants.HOOKS_NAME_CFGUPDATE
299 if self.lu.sstore is None:
300 raise errors.ProgrammerError("Null sstore on config update hook")
301 nodes = [self.lu.sstore.GetMasterNode()]
302 results = self._RunWrapper(nodes, hpath, phase)