mcpu.py 10.7 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
#

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


"""Module implementing the logic behind the cluster operations

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

"""


from ganeti import opcodes
from ganeti import constants
from ganeti import errors
from ganeti import rpc
from ganeti import cmdlib
from ganeti import config
from ganeti import ssconf
39
from ganeti import logger
Iustin Pop's avatar
Iustin Pop committed
40

41

Iustin Pop's avatar
Iustin Pop committed
42
43
44
45
46
47
48
49
50
51
52
class Processor(object):
  """Object which runs OpCodes"""
  DISPATCH_TABLE = {
    # Cluster
    opcodes.OpDestroyCluster: cmdlib.LUDestroyCluster,
    opcodes.OpQueryClusterInfo: cmdlib.LUQueryClusterInfo,
    opcodes.OpClusterCopyFile: cmdlib.LUClusterCopyFile,
    opcodes.OpRunClusterCommand: cmdlib.LURunClusterCommand,
    opcodes.OpVerifyCluster: cmdlib.LUVerifyCluster,
    opcodes.OpMasterFailover: cmdlib.LUMasterFailover,
    opcodes.OpDumpClusterConfig: cmdlib.LUDumpClusterConfig,
53
    opcodes.OpRenameCluster: cmdlib.LURenameCluster,
54
    opcodes.OpVerifyDisks: cmdlib.LUVerifyDisks,
55
    opcodes.OpSetClusterParams: cmdlib.LUSetClusterParams,
Iustin Pop's avatar
Iustin Pop committed
56
57
58
    # node lu
    opcodes.OpAddNode: cmdlib.LUAddNode,
    opcodes.OpQueryNodes: cmdlib.LUQueryNodes,
59
    opcodes.OpQueryNodeVolumes: cmdlib.LUQueryNodeVolumes,
Iustin Pop's avatar
Iustin Pop committed
60
61
62
    opcodes.OpRemoveNode: cmdlib.LURemoveNode,
    # instance lu
    opcodes.OpCreateInstance: cmdlib.LUCreateInstance,
63
    opcodes.OpReinstallInstance: cmdlib.LUReinstallInstance,
Iustin Pop's avatar
Iustin Pop committed
64
    opcodes.OpRemoveInstance: cmdlib.LURemoveInstance,
65
    opcodes.OpRenameInstance: cmdlib.LURenameInstance,
Iustin Pop's avatar
Iustin Pop committed
66
67
68
    opcodes.OpActivateInstanceDisks: cmdlib.LUActivateInstanceDisks,
    opcodes.OpShutdownInstance: cmdlib.LUShutdownInstance,
    opcodes.OpStartupInstance: cmdlib.LUStartupInstance,
69
    opcodes.OpRebootInstance: cmdlib.LURebootInstance,
Iustin Pop's avatar
Iustin Pop committed
70
71
72
73
74
75
    opcodes.OpDeactivateInstanceDisks: cmdlib.LUDeactivateInstanceDisks,
    opcodes.OpReplaceDisks: cmdlib.LUReplaceDisks,
    opcodes.OpFailoverInstance: cmdlib.LUFailoverInstance,
    opcodes.OpConnectConsole: cmdlib.LUConnectConsole,
    opcodes.OpQueryInstances: cmdlib.LUQueryInstances,
    opcodes.OpQueryInstanceData: cmdlib.LUQueryInstanceData,
76
    opcodes.OpSetInstanceParams: cmdlib.LUSetInstanceParams,
Iustin Pop's avatar
Iustin Pop committed
77
78
79
80
81
    # os lu
    opcodes.OpDiagnoseOS: cmdlib.LUDiagnoseOS,
    # exports lu
    opcodes.OpQueryExports: cmdlib.LUQueryExports,
    opcodes.OpExportInstance: cmdlib.LUExportInstance,
82
    opcodes.OpRemoveExport: cmdlib.LURemoveExport,
83
84
    # tags lu
    opcodes.OpGetTags: cmdlib.LUGetTags,
Iustin Pop's avatar
Iustin Pop committed
85
    opcodes.OpSearchTags: cmdlib.LUSearchTags,
86
87
    opcodes.OpAddTags: cmdlib.LUAddTags,
    opcodes.OpDelTags: cmdlib.LUDelTags,
88
89
    # test lu
    opcodes.OpTestDelay: cmdlib.LUTestDelay,
90
    opcodes.OpTestAllocator: cmdlib.LUTestAllocator,
Iustin Pop's avatar
Iustin Pop committed
91
92
    }

93
  def __init__(self, feedback=None):
Iustin Pop's avatar
Iustin Pop committed
94
95
    """Constructor for Processor

96
97
98
    Args:
     - feedback_fn: the feedback function (taking one string) to be run when
                    interesting events are happening
Iustin Pop's avatar
Iustin Pop committed
99
100
101
    """
    self.cfg = None
    self.sstore = None
102
    self._feedback_fn = feedback
Iustin Pop's avatar
Iustin Pop committed
103

104
  def ExecOpCode(self, op):
Iustin Pop's avatar
Iustin Pop committed
105
106
107
    """Execute an opcode.

    Args:
108
      op: the opcode to be executed
Iustin Pop's avatar
Iustin Pop committed
109
110
111

    """
    if not isinstance(op, opcodes.OpCode):
112
113
      raise errors.ProgrammerError("Non-opcode instance passed"
                                   " to ExecOpcode")
Iustin Pop's avatar
Iustin Pop committed
114
115
116

    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
    if lu_class is None:
117
      raise errors.OpCodeUnknown("Unknown opcode")
Iustin Pop's avatar
Iustin Pop committed
118

119
    if self.cfg is None:
Iustin Pop's avatar
Iustin Pop committed
120
      self.cfg = config.ConfigWriter()
121
122
123
124
      if lu_class.REQ_WSSTORE:
        self.sstore = ssconf.WritableSimpleStore()
      else:
        self.sstore = ssconf.SimpleStore()
125
126
127
128
    if self.cfg is not None:
      write_count = self.cfg.write_count
    else:
      write_count = 0
Iustin Pop's avatar
Iustin Pop committed
129
130
    lu = lu_class(self, op, self.cfg, self.sstore)
    lu.CheckPrereq()
131
    hm = HooksMaster(rpc.call_hooks_runner, self, lu)
132
133
134
    h_results = hm.RunPhase(constants.HOOKS_PHASE_PRE)
    lu.HooksCallBack(constants.HOOKS_PHASE_PRE,
                     h_results, self._feedback_fn, None)
135
136
    try:
      result = lu.Exec(self._feedback_fn)
137
138
139
      h_results = hm.RunPhase(constants.HOOKS_PHASE_POST)
      result = lu.HooksCallBack(constants.HOOKS_PHASE_POST,
                       h_results, self._feedback_fn, result)
140
141
142
143
144
145
146
    finally:
      if lu.cfg is not None:
        # we use lu.cfg and not self.cfg as for init cluster, self.cfg
        # is None but lu.cfg has been recently initialized in the
        # lu.Exec method
        if write_count != lu.cfg.write_count:
          hm.RunConfigUpdate()
147

Iustin Pop's avatar
Iustin Pop committed
148
149
    return result

150
  def ChainOpCode(self, op):
Iustin Pop's avatar
Iustin Pop committed
151
152
153
154
155
156
157
158
159
    """Chain and execute an opcode.

    This is used by LUs when they need to execute a child LU.

    Args:
     - opcode: the opcode to be executed

    """
    if not isinstance(op, opcodes.OpCode):
160
161
      raise errors.ProgrammerError("Non-opcode instance passed"
                                   " to ExecOpcode")
Iustin Pop's avatar
Iustin Pop committed
162
163
164

    lu_class = self.DISPATCH_TABLE.get(op.__class__, None)
    if lu_class is None:
165
      raise errors.OpCodeUnknown("Unknown opcode")
Iustin Pop's avatar
Iustin Pop committed
166

167
    if self.cfg is None:
Iustin Pop's avatar
Iustin Pop committed
168
169
      self.cfg = config.ConfigWriter()
      self.sstore = ssconf.SimpleStore()
170
    #do_hooks = lu_class.HPATH is not None
Iustin Pop's avatar
Iustin Pop committed
171
172
173
    lu = lu_class(self, op, self.cfg, self.sstore)
    lu.CheckPrereq()
    #if do_hooks:
174
    #  hm = HooksMaster(rpc.call_hooks_runner, self, lu)
175
176
177
    #  h_results = hm.RunPhase(constants.HOOKS_PHASE_PRE)
    #  lu.HooksCallBack(constants.HOOKS_PHASE_PRE,
    #                   h_results, self._feedback_fn, None)
178
    result = lu.Exec(self._feedback_fn)
Iustin Pop's avatar
Iustin Pop committed
179
    #if do_hooks:
180
181
182
    #  h_results = hm.RunPhase(constants.HOOKS_PHASE_POST)
    #  result = lu.HooksCallBack(constants.HOOKS_PHASE_POST,
    #                   h_results, self._feedback_fn, result)
Iustin Pop's avatar
Iustin Pop committed
183
184
    return result

185
186
187
188
189
190
191
  def LogStep(self, current, total, message):
    """Log a change in LU execution progress.

    """
    logger.Debug("Step %d/%d %s" % (current, total, message))
    self._feedback_fn("STEP %d/%d %s" % (current, total, message))

Iustin Pop's avatar
Iustin Pop committed
192
  def LogWarning(self, message, hint=None):
193
194
195
196
197
    """Log a warning to the logs and the user.

    """
    logger.Error(message)
    self._feedback_fn(" - WARNING: %s" % message)
Iustin Pop's avatar
Iustin Pop committed
198
199
    if hint:
      self._feedback_fn("      Hint: %s" % hint)
200
201
202
203
204
205
206
207

  def LogInfo(self, message):
    """Log an informational message to the logs and the user.

    """
    logger.Info(message)
    self._feedback_fn(" - INFO: %s" % message)

Iustin Pop's avatar
Iustin Pop committed
208
209
210
211
212
213
214
215
216
217
218
219
220

class HooksMaster(object):
  """Hooks master.

  This class distributes the run commands to the nodes based on the
  specific LU class.

  In order to remove the direct dependency on the rpc module, the
  constructor needs a function which actually does the remote
  call. This will usually be rpc.call_hooks_runner, but any function
  which behaves the same works.

  """
221
  def __init__(self, callfn, proc, lu):
Iustin Pop's avatar
Iustin Pop committed
222
    self.callfn = callfn
223
    self.proc = proc
Iustin Pop's avatar
Iustin Pop committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
    self.lu = lu
    self.op = lu.op
    self.env, node_list_pre, node_list_post = self._BuildEnv()
    self.node_list = {constants.HOOKS_PHASE_PRE: node_list_pre,
                      constants.HOOKS_PHASE_POST: node_list_post}

  def _BuildEnv(self):
    """Compute the environment and the target nodes.

    Based on the opcode and the current node list, this builds the
    environment for the hooks and the target node list for the run.

    """
    env = {
      "PATH": "/sbin:/bin:/usr/sbin:/usr/bin",
      "GANETI_HOOKS_VERSION": constants.HOOKS_VERSION,
      "GANETI_OP_CODE": self.op.OP_ID,
      "GANETI_OBJECT_TYPE": self.lu.HTYPE,
242
      "GANETI_DATA_DIR": constants.DATA_DIR,
Iustin Pop's avatar
Iustin Pop committed
243
244
      }

245
246
247
248
249
250
251
    if self.lu.HPATH is not None:
      lu_env, lu_nodes_pre, lu_nodes_post = self.lu.BuildHooksEnv()
      if lu_env:
        for key in lu_env:
          env["GANETI_" + key] = lu_env[key]
    else:
      lu_nodes_pre = lu_nodes_post = []
Iustin Pop's avatar
Iustin Pop committed
252

253
254
255
256
257
258
259
260
261
262
263
    return env, frozenset(lu_nodes_pre), frozenset(lu_nodes_post)

  def _RunWrapper(self, node_list, hpath, phase):
    """Simple wrapper over self.callfn.

    This method fixes the environment before doing the rpc call.

    """
    env = self.env.copy()
    env["GANETI_HOOKS_PHASE"] = phase
    env["GANETI_HOOKS_PATH"] = hpath
264
265
266
    if self.lu.sstore is not None:
      env["GANETI_CLUSTER"] = self.lu.sstore.GetClusterName()
      env["GANETI_MASTER"] = self.lu.sstore.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
267

268
    env = dict([(str(key), str(val)) for key, val in env.iteritems()])
Iustin Pop's avatar
Iustin Pop committed
269

270
    return self.callfn(node_list, hpath, phase, env)
Iustin Pop's avatar
Iustin Pop committed
271
272
273
274
275
276

  def RunPhase(self, phase):
    """Run all the scripts for a phase.

    This is the main function of the HookMaster.

277
278
279
280
281
282
    Args:
      phase: the hooks phase to run

    Returns:
      the result of the hooks multi-node rpc call

Iustin Pop's avatar
Iustin Pop committed
283
284
    """
    if not self.node_list[phase]:
285
286
287
      # empty node list, we should not attempt to run this as either
      # we're in the cluster init phase and the rpc client part can't
      # even attempt to run, or this LU doesn't do hooks at all
Iustin Pop's avatar
Iustin Pop committed
288
      return
289
290
    hpath = self.lu.HPATH
    results = self._RunWrapper(self.node_list[phase], hpath, phase)
Iustin Pop's avatar
Iustin Pop committed
291
292
293
    if phase == constants.HOOKS_PHASE_PRE:
      errs = []
      if not results:
294
        raise errors.HooksFailure("Communication failure")
Iustin Pop's avatar
Iustin Pop committed
295
296
297
      for node_name in results:
        res = results[node_name]
        if res is False or not isinstance(res, list):
298
299
          self.proc.LogWarning("Communication failure to node %s" % node_name)
          continue
Iustin Pop's avatar
Iustin Pop committed
300
301
302
303
304
        for script, hkr, output in res:
          if hkr == constants.HKR_FAIL:
            output = output.strip().encode("string_escape")
            errs.append((node_name, script, output))
      if errs:
305
        raise errors.HooksAbort(errs)
306
    return results
307
308
309
310
311
312
313
314
315
316
317
318
319
320

  def RunConfigUpdate(self):
    """Run the special configuration update hook

    This is a special hook that runs only on the master after each
    top-level LI if the configuration has been updated.

    """
    phase = constants.HOOKS_PHASE_POST
    hpath = constants.HOOKS_NAME_CFGUPDATE
    if self.lu.sstore is None:
      raise errors.ProgrammerError("Null sstore on config update hook")
    nodes = [self.lu.sstore.GetMasterNode()]
    results = self._RunWrapper(nodes, hpath, phase)