Statistics
| Branch: | Tag: | Revision:

root / lib / mcpu.py @ b74159ee

History | View | Annotate | Download (10.1 kB)

1 2f31098c Iustin Pop
#
2 a8083063 Iustin Pop
#
3 a8083063 Iustin Pop
4 a8083063 Iustin Pop
# Copyright (C) 2006, 2007 Google Inc.
5 a8083063 Iustin Pop
#
6 a8083063 Iustin Pop
# This program is free software; you can redistribute it and/or modify
7 a8083063 Iustin Pop
# it under the terms of the GNU General Public License as published by
8 a8083063 Iustin Pop
# the Free Software Foundation; either version 2 of the License, or
9 a8083063 Iustin Pop
# (at your option) any later version.
10 a8083063 Iustin Pop
#
11 a8083063 Iustin Pop
# This program is distributed in the hope that it will be useful, but
12 a8083063 Iustin Pop
# WITHOUT ANY WARRANTY; without even the implied warranty of
13 a8083063 Iustin Pop
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 a8083063 Iustin Pop
# General Public License for more details.
15 a8083063 Iustin Pop
#
16 a8083063 Iustin Pop
# You should have received a copy of the GNU General Public License
17 a8083063 Iustin Pop
# along with this program; if not, write to the Free Software
18 a8083063 Iustin Pop
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 a8083063 Iustin Pop
# 02110-1301, USA.
20 a8083063 Iustin Pop
21 a8083063 Iustin Pop
22 a8083063 Iustin Pop
"""Module implementing the logic behind the cluster operations
23 a8083063 Iustin Pop

24 a8083063 Iustin Pop
This module implements the logic for doing operations in the cluster. There
25 a8083063 Iustin Pop
are two kinds of classes defined:
26 a8083063 Iustin Pop
  - logical units, which know how to deal with their specific opcode only
27 a8083063 Iustin Pop
  - the processor, which dispatches the opcodes to their logical units
28 a8083063 Iustin Pop

29 a8083063 Iustin Pop
"""
30 a8083063 Iustin Pop
31 a8083063 Iustin Pop
32 a8083063 Iustin Pop
from ganeti import opcodes
33 a8083063 Iustin Pop
from ganeti import constants
34 a8083063 Iustin Pop
from ganeti import errors
35 a8083063 Iustin Pop
from ganeti import rpc
36 a8083063 Iustin Pop
from ganeti import cmdlib
37 a8083063 Iustin Pop
from ganeti import config
38 a8083063 Iustin Pop
from ganeti import ssconf
39 0fbbf897 Iustin Pop
from ganeti import logger
40 a8083063 Iustin Pop
41 7c0d6283 Michael Hanselmann
42 a8083063 Iustin Pop
class Processor(object):
43 a8083063 Iustin Pop
  """Object which runs OpCodes"""
44 a8083063 Iustin Pop
  DISPATCH_TABLE = {
45 a8083063 Iustin Pop
    # Cluster
46 a8083063 Iustin Pop
    opcodes.OpInitCluster: cmdlib.LUInitCluster,
47 a8083063 Iustin Pop
    opcodes.OpDestroyCluster: cmdlib.LUDestroyCluster,
48 a8083063 Iustin Pop
    opcodes.OpQueryClusterInfo: cmdlib.LUQueryClusterInfo,
49 a8083063 Iustin Pop
    opcodes.OpClusterCopyFile: cmdlib.LUClusterCopyFile,
50 a8083063 Iustin Pop
    opcodes.OpRunClusterCommand: cmdlib.LURunClusterCommand,
51 a8083063 Iustin Pop
    opcodes.OpVerifyCluster: cmdlib.LUVerifyCluster,
52 a8083063 Iustin Pop
    opcodes.OpMasterFailover: cmdlib.LUMasterFailover,
53 a8083063 Iustin Pop
    opcodes.OpDumpClusterConfig: cmdlib.LUDumpClusterConfig,
54 07bd8a51 Iustin Pop
    opcodes.OpRenameCluster: cmdlib.LURenameCluster,
55 f4d4e184 Iustin Pop
    opcodes.OpVerifyDisks: cmdlib.LUVerifyDisks,
56 0cc05d44 Manuel Franceschini
    opcodes.OpSetClusterParams: cmdlib.LUSetClusterParams,
57 a8083063 Iustin Pop
    # node lu
58 a8083063 Iustin Pop
    opcodes.OpAddNode: cmdlib.LUAddNode,
59 a8083063 Iustin Pop
    opcodes.OpQueryNodes: cmdlib.LUQueryNodes,
60 dcb93971 Michael Hanselmann
    opcodes.OpQueryNodeVolumes: cmdlib.LUQueryNodeVolumes,
61 a8083063 Iustin Pop
    opcodes.OpRemoveNode: cmdlib.LURemoveNode,
62 a8083063 Iustin Pop
    # instance lu
63 a8083063 Iustin Pop
    opcodes.OpCreateInstance: cmdlib.LUCreateInstance,
64 fe7b0351 Michael Hanselmann
    opcodes.OpReinstallInstance: cmdlib.LUReinstallInstance,
65 a8083063 Iustin Pop
    opcodes.OpRemoveInstance: cmdlib.LURemoveInstance,
66 decd5f45 Iustin Pop
    opcodes.OpRenameInstance: cmdlib.LURenameInstance,
67 a8083063 Iustin Pop
    opcodes.OpActivateInstanceDisks: cmdlib.LUActivateInstanceDisks,
68 a8083063 Iustin Pop
    opcodes.OpShutdownInstance: cmdlib.LUShutdownInstance,
69 a8083063 Iustin Pop
    opcodes.OpStartupInstance: cmdlib.LUStartupInstance,
70 bf6929a2 Alexander Schreiber
    opcodes.OpRebootInstance: cmdlib.LURebootInstance,
71 a8083063 Iustin Pop
    opcodes.OpDeactivateInstanceDisks: cmdlib.LUDeactivateInstanceDisks,
72 a8083063 Iustin Pop
    opcodes.OpReplaceDisks: cmdlib.LUReplaceDisks,
73 a8083063 Iustin Pop
    opcodes.OpFailoverInstance: cmdlib.LUFailoverInstance,
74 a8083063 Iustin Pop
    opcodes.OpConnectConsole: cmdlib.LUConnectConsole,
75 a8083063 Iustin Pop
    opcodes.OpQueryInstances: cmdlib.LUQueryInstances,
76 a8083063 Iustin Pop
    opcodes.OpQueryInstanceData: cmdlib.LUQueryInstanceData,
77 7767bbf5 Manuel Franceschini
    opcodes.OpSetInstanceParams: cmdlib.LUSetInstanceParams,
78 a8083063 Iustin Pop
    # os lu
79 a8083063 Iustin Pop
    opcodes.OpDiagnoseOS: cmdlib.LUDiagnoseOS,
80 a8083063 Iustin Pop
    # exports lu
81 a8083063 Iustin Pop
    opcodes.OpQueryExports: cmdlib.LUQueryExports,
82 a8083063 Iustin Pop
    opcodes.OpExportInstance: cmdlib.LUExportInstance,
83 9ac99fda Guido Trotter
    opcodes.OpRemoveExport: cmdlib.LURemoveExport,
84 5c947f38 Iustin Pop
    # tags lu
85 5c947f38 Iustin Pop
    opcodes.OpGetTags: cmdlib.LUGetTags,
86 73415719 Iustin Pop
    opcodes.OpSearchTags: cmdlib.LUSearchTags,
87 f27302fa Iustin Pop
    opcodes.OpAddTags: cmdlib.LUAddTags,
88 f27302fa Iustin Pop
    opcodes.OpDelTags: cmdlib.LUDelTags,
89 06009e27 Iustin Pop
    # test lu
90 06009e27 Iustin Pop
    opcodes.OpTestDelay: cmdlib.LUTestDelay,
91 d61df03e Iustin Pop
    opcodes.OpTestAllocator: cmdlib.LUTestAllocator,
92 a8083063 Iustin Pop
    }
93 a8083063 Iustin Pop
94 1a8c0ce1 Iustin Pop
  def __init__(self, feedback=None):
95 a8083063 Iustin Pop
    """Constructor for Processor
96 a8083063 Iustin Pop

97 1a8c0ce1 Iustin Pop
    Args:
98 1a8c0ce1 Iustin Pop
     - feedback_fn: the feedback function (taking one string) to be run when
99 1a8c0ce1 Iustin Pop
                    interesting events are happening
100 a8083063 Iustin Pop
    """
101 a8083063 Iustin Pop
    self.cfg = None
102 a8083063 Iustin Pop
    self.sstore = None
103 1a8c0ce1 Iustin Pop
    self._feedback_fn = feedback
104 a8083063 Iustin Pop
105 1a8c0ce1 Iustin Pop
  def ExecOpCode(self, op):
106 a8083063 Iustin Pop
    """Execute an opcode.
107 a8083063 Iustin Pop

108 a8083063 Iustin Pop
    Args:
109 c99a3cc0 Manuel Franceschini
      op: the opcode to be executed
110 a8083063 Iustin Pop

111 a8083063 Iustin Pop
    """
112 a8083063 Iustin Pop
    if not isinstance(op, opcodes.OpCode):
113 3ecf6786 Iustin Pop
      raise errors.ProgrammerError("Non-opcode instance passed"
114 3ecf6786 Iustin Pop
                                   " to ExecOpcode")
115 a8083063 Iustin Pop
116 a8083063 Iustin Pop
    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
117 a8083063 Iustin Pop
    if lu_class is None:
118 3ecf6786 Iustin Pop
      raise errors.OpCodeUnknown("Unknown opcode")
119 a8083063 Iustin Pop
120 a8083063 Iustin Pop
    if lu_class.REQ_CLUSTER and self.cfg is None:
121 a8083063 Iustin Pop
      self.cfg = config.ConfigWriter()
122 a8083063 Iustin Pop
      self.sstore = ssconf.SimpleStore()
123 6a4aa7c1 Iustin Pop
    if self.cfg is not None:
124 6a4aa7c1 Iustin Pop
      write_count = self.cfg.write_count
125 6a4aa7c1 Iustin Pop
    else:
126 6a4aa7c1 Iustin Pop
      write_count = 0
127 a8083063 Iustin Pop
    lu = lu_class(self, op, self.cfg, self.sstore)
128 a8083063 Iustin Pop
    lu.CheckPrereq()
129 2395c322 Iustin Pop
    hm = HooksMaster(rpc.call_hooks_runner, self, lu)
130 9a395a76 Iustin Pop
    hm.RunPhase(constants.HOOKS_PHASE_PRE)
131 fe482621 Iustin Pop
    try:
132 fe482621 Iustin Pop
      result = lu.Exec(self._feedback_fn)
133 fe482621 Iustin Pop
      hm.RunPhase(constants.HOOKS_PHASE_POST)
134 fe482621 Iustin Pop
    finally:
135 fe482621 Iustin Pop
      if lu.cfg is not None:
136 fe482621 Iustin Pop
        # we use lu.cfg and not self.cfg as for init cluster, self.cfg
137 fe482621 Iustin Pop
        # is None but lu.cfg has been recently initialized in the
138 fe482621 Iustin Pop
        # lu.Exec method
139 fe482621 Iustin Pop
        if write_count != lu.cfg.write_count:
140 fe482621 Iustin Pop
          hm.RunConfigUpdate()
141 6a4aa7c1 Iustin Pop
142 a8083063 Iustin Pop
    return result
143 a8083063 Iustin Pop
144 1a8c0ce1 Iustin Pop
  def ChainOpCode(self, op):
145 a8083063 Iustin Pop
    """Chain and execute an opcode.
146 a8083063 Iustin Pop

147 a8083063 Iustin Pop
    This is used by LUs when they need to execute a child LU.
148 a8083063 Iustin Pop

149 a8083063 Iustin Pop
    Args:
150 a8083063 Iustin Pop
     - opcode: the opcode to be executed
151 a8083063 Iustin Pop

152 a8083063 Iustin Pop
    """
153 a8083063 Iustin Pop
    if not isinstance(op, opcodes.OpCode):
154 3ecf6786 Iustin Pop
      raise errors.ProgrammerError("Non-opcode instance passed"
155 3ecf6786 Iustin Pop
                                   " to ExecOpcode")
156 a8083063 Iustin Pop
157 a8083063 Iustin Pop
    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
158 a8083063 Iustin Pop
    if lu_class is None:
159 3ecf6786 Iustin Pop
      raise errors.OpCodeUnknown("Unknown opcode")
160 a8083063 Iustin Pop
161 a8083063 Iustin Pop
    if lu_class.REQ_CLUSTER and self.cfg is None:
162 a8083063 Iustin Pop
      self.cfg = config.ConfigWriter()
163 a8083063 Iustin Pop
      self.sstore = ssconf.SimpleStore()
164 f97a6b10 Iustin Pop
    #do_hooks = lu_class.HPATH is not None
165 a8083063 Iustin Pop
    lu = lu_class(self, op, self.cfg, self.sstore)
166 a8083063 Iustin Pop
    lu.CheckPrereq()
167 a8083063 Iustin Pop
    #if do_hooks:
168 2395c322 Iustin Pop
    #  hm = HooksMaster(rpc.call_hooks_runner, self, lu)
169 a8083063 Iustin Pop
    #  hm.RunPhase(constants.HOOKS_PHASE_PRE)
170 1a8c0ce1 Iustin Pop
    result = lu.Exec(self._feedback_fn)
171 a8083063 Iustin Pop
    #if do_hooks:
172 a8083063 Iustin Pop
    #  hm.RunPhase(constants.HOOKS_PHASE_POST)
173 a8083063 Iustin Pop
    return result
174 a8083063 Iustin Pop
175 0fbbf897 Iustin Pop
  def LogStep(self, current, total, message):
176 0fbbf897 Iustin Pop
    """Log a change in LU execution progress.
177 0fbbf897 Iustin Pop

178 0fbbf897 Iustin Pop
    """
179 0fbbf897 Iustin Pop
    logger.Debug("Step %d/%d %s" % (current, total, message))
180 0fbbf897 Iustin Pop
    self._feedback_fn("STEP %d/%d %s" % (current, total, message))
181 0fbbf897 Iustin Pop
182 5bfac263 Iustin Pop
  def LogWarning(self, message, hint=None):
183 0fbbf897 Iustin Pop
    """Log a warning to the logs and the user.
184 0fbbf897 Iustin Pop

185 0fbbf897 Iustin Pop
    """
186 0fbbf897 Iustin Pop
    logger.Error(message)
187 0fbbf897 Iustin Pop
    self._feedback_fn(" - WARNING: %s" % message)
188 5bfac263 Iustin Pop
    if hint:
189 5bfac263 Iustin Pop
      self._feedback_fn("      Hint: %s" % hint)
190 0fbbf897 Iustin Pop
191 0fbbf897 Iustin Pop
  def LogInfo(self, message):
192 0fbbf897 Iustin Pop
    """Log an informational message to the logs and the user.
193 0fbbf897 Iustin Pop

194 0fbbf897 Iustin Pop
    """
195 0fbbf897 Iustin Pop
    logger.Info(message)
196 0fbbf897 Iustin Pop
    self._feedback_fn(" - INFO: %s" % message)
197 0fbbf897 Iustin Pop
198 a8083063 Iustin Pop
199 a8083063 Iustin Pop
class HooksMaster(object):
200 a8083063 Iustin Pop
  """Hooks master.
201 a8083063 Iustin Pop

202 a8083063 Iustin Pop
  This class distributes the run commands to the nodes based on the
203 a8083063 Iustin Pop
  specific LU class.
204 a8083063 Iustin Pop

205 a8083063 Iustin Pop
  In order to remove the direct dependency on the rpc module, the
206 a8083063 Iustin Pop
  constructor needs a function which actually does the remote
207 a8083063 Iustin Pop
  call. This will usually be rpc.call_hooks_runner, but any function
208 a8083063 Iustin Pop
  which behaves the same works.
209 a8083063 Iustin Pop

210 a8083063 Iustin Pop
  """
211 2395c322 Iustin Pop
  def __init__(self, callfn, proc, lu):
212 a8083063 Iustin Pop
    self.callfn = callfn
213 2395c322 Iustin Pop
    self.proc = proc
214 a8083063 Iustin Pop
    self.lu = lu
215 a8083063 Iustin Pop
    self.op = lu.op
216 a8083063 Iustin Pop
    self.env, node_list_pre, node_list_post = self._BuildEnv()
217 a8083063 Iustin Pop
    self.node_list = {constants.HOOKS_PHASE_PRE: node_list_pre,
218 a8083063 Iustin Pop
                      constants.HOOKS_PHASE_POST: node_list_post}
219 a8083063 Iustin Pop
220 a8083063 Iustin Pop
  def _BuildEnv(self):
221 a8083063 Iustin Pop
    """Compute the environment and the target nodes.
222 a8083063 Iustin Pop

223 a8083063 Iustin Pop
    Based on the opcode and the current node list, this builds the
224 a8083063 Iustin Pop
    environment for the hooks and the target node list for the run.
225 a8083063 Iustin Pop

226 a8083063 Iustin Pop
    """
227 a8083063 Iustin Pop
    env = {
228 a8083063 Iustin Pop
      "PATH": "/sbin:/bin:/usr/sbin:/usr/bin",
229 a8083063 Iustin Pop
      "GANETI_HOOKS_VERSION": constants.HOOKS_VERSION,
230 a8083063 Iustin Pop
      "GANETI_OP_CODE": self.op.OP_ID,
231 a8083063 Iustin Pop
      "GANETI_OBJECT_TYPE": self.lu.HTYPE,
232 6a4aa7c1 Iustin Pop
      "GANETI_DATA_DIR": constants.DATA_DIR,
233 a8083063 Iustin Pop
      }
234 a8083063 Iustin Pop
235 9a395a76 Iustin Pop
    if self.lu.HPATH is not None:
236 9a395a76 Iustin Pop
      lu_env, lu_nodes_pre, lu_nodes_post = self.lu.BuildHooksEnv()
237 9a395a76 Iustin Pop
      if lu_env:
238 9a395a76 Iustin Pop
        for key in lu_env:
239 9a395a76 Iustin Pop
          env["GANETI_" + key] = lu_env[key]
240 9a395a76 Iustin Pop
    else:
241 9a395a76 Iustin Pop
      lu_nodes_pre = lu_nodes_post = []
242 a8083063 Iustin Pop
243 4167825b Iustin Pop
    return env, frozenset(lu_nodes_pre), frozenset(lu_nodes_post)
244 4167825b Iustin Pop
245 4167825b Iustin Pop
  def _RunWrapper(self, node_list, hpath, phase):
246 4167825b Iustin Pop
    """Simple wrapper over self.callfn.
247 4167825b Iustin Pop

248 4167825b Iustin Pop
    This method fixes the environment before doing the rpc call.
249 4167825b Iustin Pop

250 4167825b Iustin Pop
    """
251 4167825b Iustin Pop
    env = self.env.copy()
252 4167825b Iustin Pop
    env["GANETI_HOOKS_PHASE"] = phase
253 4167825b Iustin Pop
    env["GANETI_HOOKS_PATH"] = hpath
254 f97a6b10 Iustin Pop
    if self.lu.sstore is not None:
255 f97a6b10 Iustin Pop
      env["GANETI_CLUSTER"] = self.lu.sstore.GetClusterName()
256 f97a6b10 Iustin Pop
      env["GANETI_MASTER"] = self.lu.sstore.GetMasterNode()
257 a8083063 Iustin Pop
258 4167825b Iustin Pop
    env = dict([(str(key), str(val)) for key, val in env.iteritems()])
259 a8083063 Iustin Pop
260 4167825b Iustin Pop
    return self.callfn(node_list, hpath, phase, env)
261 a8083063 Iustin Pop
262 a8083063 Iustin Pop
  def RunPhase(self, phase):
263 a8083063 Iustin Pop
    """Run all the scripts for a phase.
264 a8083063 Iustin Pop

265 a8083063 Iustin Pop
    This is the main function of the HookMaster.
266 a8083063 Iustin Pop

267 a8083063 Iustin Pop
    """
268 a8083063 Iustin Pop
    if not self.node_list[phase]:
269 9a395a76 Iustin Pop
      # empty node list, we should not attempt to run this as either
270 9a395a76 Iustin Pop
      # we're in the cluster init phase and the rpc client part can't
271 9a395a76 Iustin Pop
      # even attempt to run, or this LU doesn't do hooks at all
272 a8083063 Iustin Pop
      return
273 4167825b Iustin Pop
    hpath = self.lu.HPATH
274 4167825b Iustin Pop
    results = self._RunWrapper(self.node_list[phase], hpath, phase)
275 a8083063 Iustin Pop
    if phase == constants.HOOKS_PHASE_PRE:
276 a8083063 Iustin Pop
      errs = []
277 a8083063 Iustin Pop
      if not results:
278 3ecf6786 Iustin Pop
        raise errors.HooksFailure("Communication failure")
279 a8083063 Iustin Pop
      for node_name in results:
280 a8083063 Iustin Pop
        res = results[node_name]
281 a8083063 Iustin Pop
        if res is False or not isinstance(res, list):
282 2395c322 Iustin Pop
          self.proc.LogWarning("Communication failure to node %s" % node_name)
283 2395c322 Iustin Pop
          continue
284 a8083063 Iustin Pop
        for script, hkr, output in res:
285 a8083063 Iustin Pop
          if hkr == constants.HKR_FAIL:
286 a8083063 Iustin Pop
            output = output.strip().encode("string_escape")
287 a8083063 Iustin Pop
            errs.append((node_name, script, output))
288 a8083063 Iustin Pop
      if errs:
289 3ecf6786 Iustin Pop
        raise errors.HooksAbort(errs)
290 6a4aa7c1 Iustin Pop
291 6a4aa7c1 Iustin Pop
  def RunConfigUpdate(self):
292 6a4aa7c1 Iustin Pop
    """Run the special configuration update hook
293 6a4aa7c1 Iustin Pop

294 6a4aa7c1 Iustin Pop
    This is a special hook that runs only on the master after each
295 6a4aa7c1 Iustin Pop
    top-level LI if the configuration has been updated.
296 6a4aa7c1 Iustin Pop

297 6a4aa7c1 Iustin Pop
    """
298 6a4aa7c1 Iustin Pop
    phase = constants.HOOKS_PHASE_POST
299 6a4aa7c1 Iustin Pop
    hpath = constants.HOOKS_NAME_CFGUPDATE
300 6a4aa7c1 Iustin Pop
    if self.lu.sstore is None:
301 6a4aa7c1 Iustin Pop
      raise errors.ProgrammerError("Null sstore on config update hook")
302 6a4aa7c1 Iustin Pop
    nodes = [self.lu.sstore.GetMasterNode()]
303 6a4aa7c1 Iustin Pop
    results = self._RunWrapper(nodes, hpath, phase)