Statistics
| Branch: | Tag: | Revision:

root / lib / ssconf.py @ 93384844

History | View | Annotate | Download (7.4 kB)

1 2f31098c Iustin Pop
#
2 a8083063 Iustin Pop
#
3 a8083063 Iustin Pop
4 856c67e1 Michael Hanselmann
# Copyright (C) 2006, 2007, 2008 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
"""Global Configuration data for Ganeti.
23 a8083063 Iustin Pop

24 a8083063 Iustin Pop
This module provides the interface to a special case of cluster
25 a8083063 Iustin Pop
configuration data, which is mostly static and available to all nodes.
26 a8083063 Iustin Pop

27 a8083063 Iustin Pop
"""
28 a8083063 Iustin Pop
29 5675cd1f Iustin Pop
import sys
30 03d1dba2 Michael Hanselmann
import re
31 a8083063 Iustin Pop
32 a8083063 Iustin Pop
from ganeti import errors
33 a8083063 Iustin Pop
from ganeti import constants
34 41a57aab Michael Hanselmann
from ganeti import utils
35 856c67e1 Michael Hanselmann
from ganeti import serializer
36 a8083063 Iustin Pop
37 a8083063 Iustin Pop
38 0c223ea9 Michael Hanselmann
SSCONF_LOCK_TIMEOUT = 10
39 0c223ea9 Michael Hanselmann
40 03d1dba2 Michael Hanselmann
RE_VALID_SSCONF_NAME = re.compile(r'^[-_a-z0-9]+$')
41 03d1dba2 Michael Hanselmann
42 0c223ea9 Michael Hanselmann
43 02f99608 Oleksiy Mishchenko
class SimpleConfigReader(object):
44 856c67e1 Michael Hanselmann
  """Simple class to read configuration file.
45 856c67e1 Michael Hanselmann

46 856c67e1 Michael Hanselmann
  """
47 856c67e1 Michael Hanselmann
  def __init__(self, file_name=constants.CLUSTER_CONF_FILE):
48 856c67e1 Michael Hanselmann
    """Initializes this class.
49 856c67e1 Michael Hanselmann

50 856c67e1 Michael Hanselmann
    @type file_name: string
51 856c67e1 Michael Hanselmann
    @param file_name: Configuration file path
52 856c67e1 Michael Hanselmann

53 856c67e1 Michael Hanselmann
    """
54 856c67e1 Michael Hanselmann
    self._file_name = file_name
55 856c67e1 Michael Hanselmann
    self._config_data = serializer.Load(utils.ReadFile(file_name))
56 856c67e1 Michael Hanselmann
    # TODO: Error handling
57 856c67e1 Michael Hanselmann
58 856c67e1 Michael Hanselmann
  def GetClusterName(self):
59 856c67e1 Michael Hanselmann
    return self._config_data["cluster"]["cluster_name"]
60 856c67e1 Michael Hanselmann
61 856c67e1 Michael Hanselmann
  def GetHostKey(self):
62 856c67e1 Michael Hanselmann
    return self._config_data["cluster"]["rsahostkeypub"]
63 856c67e1 Michael Hanselmann
64 856c67e1 Michael Hanselmann
  def GetMasterNode(self):
65 856c67e1 Michael Hanselmann
    return self._config_data["cluster"]["master_node"]
66 856c67e1 Michael Hanselmann
67 856c67e1 Michael Hanselmann
  def GetMasterIP(self):
68 856c67e1 Michael Hanselmann
    return self._config_data["cluster"]["master_ip"]
69 856c67e1 Michael Hanselmann
70 856c67e1 Michael Hanselmann
  def GetMasterNetdev(self):
71 856c67e1 Michael Hanselmann
    return self._config_data["cluster"]["master_netdev"]
72 856c67e1 Michael Hanselmann
73 856c67e1 Michael Hanselmann
  def GetFileStorageDir(self):
74 856c67e1 Michael Hanselmann
    return self._config_data["cluster"]["file_storage_dir"]
75 856c67e1 Michael Hanselmann
76 856c67e1 Michael Hanselmann
  def GetHypervisorType(self):
77 856c67e1 Michael Hanselmann
    return self._config_data["cluster"]["hypervisor"]
78 856c67e1 Michael Hanselmann
79 856c67e1 Michael Hanselmann
  def GetNodeList(self):
80 856c67e1 Michael Hanselmann
    return self._config_data["nodes"].keys()
81 856c67e1 Michael Hanselmann
82 02f99608 Oleksiy Mishchenko
  @classmethod
83 02f99608 Oleksiy Mishchenko
  def FromDict(cls, val, cfg_file=constants.CLUSTER_CONF_FILE):
84 02f99608 Oleksiy Mishchenko
    """Alternative construction from a dictionary.
85 02f99608 Oleksiy Mishchenko

86 02f99608 Oleksiy Mishchenko
    """
87 02f99608 Oleksiy Mishchenko
    obj = SimpleConfigReader.__new__(cls)
88 02f99608 Oleksiy Mishchenko
    obj._config_data = val
89 02f99608 Oleksiy Mishchenko
    obj._file_name = cfg_file
90 02f99608 Oleksiy Mishchenko
    return obj
91 02f99608 Oleksiy Mishchenko
92 856c67e1 Michael Hanselmann
93 856c67e1 Michael Hanselmann
class SimpleConfigWriter(SimpleConfigReader):
94 856c67e1 Michael Hanselmann
  """Simple class to write configuration file.
95 856c67e1 Michael Hanselmann

96 856c67e1 Michael Hanselmann
  """
97 856c67e1 Michael Hanselmann
  def SetMasterNode(self, node):
98 856c67e1 Michael Hanselmann
    """Change master node.
99 856c67e1 Michael Hanselmann

100 856c67e1 Michael Hanselmann
    """
101 856c67e1 Michael Hanselmann
    self._config_data["cluster"]["master_node"] = node
102 856c67e1 Michael Hanselmann
103 856c67e1 Michael Hanselmann
  def Save(self):
104 856c67e1 Michael Hanselmann
    """Writes configuration file.
105 856c67e1 Michael Hanselmann

106 856c67e1 Michael Hanselmann
    Warning: Doesn't take care of locking or synchronizing with other
107 856c67e1 Michael Hanselmann
    processes.
108 856c67e1 Michael Hanselmann

109 856c67e1 Michael Hanselmann
    """
110 856c67e1 Michael Hanselmann
    utils.WriteFile(self._file_name,
111 856c67e1 Michael Hanselmann
                    data=serializer.Dump(self._config_data),
112 856c67e1 Michael Hanselmann
                    mode=0600)
113 856c67e1 Michael Hanselmann
114 856c67e1 Michael Hanselmann
115 93384844 Iustin Pop
class SimpleStore(object):
116 93384844 Iustin Pop
  """Interface to static cluster data.
117 93384844 Iustin Pop

118 93384844 Iustin Pop
  This is different that the config.ConfigWriter and
119 93384844 Iustin Pop
  SimpleConfigReader classes in that it holds data that will always be
120 93384844 Iustin Pop
  present, even on nodes which don't have all the cluster data.
121 93384844 Iustin Pop

122 93384844 Iustin Pop
  Other particularities of the datastore:
123 93384844 Iustin Pop
    - keys are restricted to predefined values
124 93384844 Iustin Pop

125 93384844 Iustin Pop
  """
126 93384844 Iustin Pop
  _SS_FILEPREFIX = "ssconf_"
127 93384844 Iustin Pop
  _VALID_KEYS = (
128 93384844 Iustin Pop
    constants.SS_CLUSTER_NAME,
129 93384844 Iustin Pop
    constants.SS_FILE_STORAGE_DIR,
130 93384844 Iustin Pop
    constants.SS_MASTER_IP,
131 93384844 Iustin Pop
    constants.SS_MASTER_NETDEV,
132 93384844 Iustin Pop
    constants.SS_MASTER_NODE,
133 93384844 Iustin Pop
    constants.SS_NODE_LIST,
134 93384844 Iustin Pop
    )
135 93384844 Iustin Pop
  _MAX_SIZE = 131072
136 93384844 Iustin Pop
137 93384844 Iustin Pop
  def __init__(self, cfg_location=None):
138 93384844 Iustin Pop
    if cfg_location is None:
139 93384844 Iustin Pop
      self._cfg_dir = constants.DATA_DIR
140 93384844 Iustin Pop
    else:
141 93384844 Iustin Pop
      self._cfg_dir = cfg_location
142 93384844 Iustin Pop
143 93384844 Iustin Pop
  def KeyToFilename(self, key):
144 93384844 Iustin Pop
    """Convert a given key into filename.
145 93384844 Iustin Pop

146 93384844 Iustin Pop
    """
147 93384844 Iustin Pop
    if key not in self._VALID_KEYS:
148 93384844 Iustin Pop
      raise errors.ProgrammerError("Invalid key requested from SSConf: '%s'"
149 93384844 Iustin Pop
                                   % str(key))
150 93384844 Iustin Pop
151 93384844 Iustin Pop
    filename = self._cfg_dir + '/' + self._SS_FILEPREFIX + key
152 93384844 Iustin Pop
    return filename
153 93384844 Iustin Pop
154 93384844 Iustin Pop
  def _ReadFile(self, key):
155 93384844 Iustin Pop
    """Generic routine to read keys.
156 93384844 Iustin Pop

157 93384844 Iustin Pop
    This will read the file which holds the value requested. Errors
158 93384844 Iustin Pop
    will be changed into ConfigurationErrors.
159 93384844 Iustin Pop

160 93384844 Iustin Pop
    """
161 93384844 Iustin Pop
    filename = self.KeyToFilename(key)
162 93384844 Iustin Pop
    try:
163 93384844 Iustin Pop
      fh = file(filename, 'r')
164 93384844 Iustin Pop
      try:
165 93384844 Iustin Pop
        data = fh.read(self._MAX_SIZE)
166 93384844 Iustin Pop
        data = data.rstrip('\n')
167 93384844 Iustin Pop
      finally:
168 93384844 Iustin Pop
        fh.close()
169 93384844 Iustin Pop
    except EnvironmentError, err:
170 93384844 Iustin Pop
      raise errors.ConfigurationError("Can't read from the ssconf file:"
171 93384844 Iustin Pop
                                      " '%s'" % str(err))
172 93384844 Iustin Pop
    return data
173 93384844 Iustin Pop
174 93384844 Iustin Pop
  def GetFileList(self):
175 93384844 Iustin Pop
    """Return the list of all config files.
176 93384844 Iustin Pop

177 93384844 Iustin Pop
    This is used for computing node replication data.
178 93384844 Iustin Pop

179 93384844 Iustin Pop
    """
180 93384844 Iustin Pop
    return [self.KeyToFilename(key) for key in self._VALID_KEYS]
181 93384844 Iustin Pop
182 93384844 Iustin Pop
  def GetClusterName(self):
183 93384844 Iustin Pop
    """Get the cluster name.
184 93384844 Iustin Pop

185 93384844 Iustin Pop
    """
186 93384844 Iustin Pop
    return self._ReadFile(constants.SS_CLUSTER_NAME)
187 93384844 Iustin Pop
188 93384844 Iustin Pop
  def GetFileStorageDir(self):
189 93384844 Iustin Pop
    """Get the file storage dir.
190 93384844 Iustin Pop

191 93384844 Iustin Pop
    """
192 93384844 Iustin Pop
    return self._ReadFile(constants.SS_FILE_STORAGE_DIR)
193 93384844 Iustin Pop
194 93384844 Iustin Pop
  def GetMasterIP(self):
195 93384844 Iustin Pop
    """Get the IP of the master node for this cluster.
196 93384844 Iustin Pop

197 93384844 Iustin Pop
    """
198 93384844 Iustin Pop
    return self._ReadFile(constants.SS_MASTER_IP)
199 93384844 Iustin Pop
200 93384844 Iustin Pop
  def GetMasterNetdev(self):
201 93384844 Iustin Pop
    """Get the netdev to which we'll add the master ip.
202 93384844 Iustin Pop

203 93384844 Iustin Pop
    """
204 93384844 Iustin Pop
    return self._ReadFile(constants.SS_MASTER_NETDEV)
205 93384844 Iustin Pop
206 93384844 Iustin Pop
  def GetMasterNode(self):
207 93384844 Iustin Pop
    """Get the hostname of the master node for this cluster.
208 93384844 Iustin Pop

209 93384844 Iustin Pop
    """
210 93384844 Iustin Pop
    return self._ReadFile(constants.SS_MASTER_NODE)
211 93384844 Iustin Pop
212 93384844 Iustin Pop
  def GetNodeList(self):
213 93384844 Iustin Pop
    """Return the list of cluster nodes.
214 93384844 Iustin Pop

215 93384844 Iustin Pop
    """
216 93384844 Iustin Pop
    data = self._ReadFile(constants.SS_NODE_LIST)
217 93384844 Iustin Pop
    nl = data.splitlines(False)
218 93384844 Iustin Pop
    return nl
219 93384844 Iustin Pop
220 93384844 Iustin Pop
221 0c223ea9 Michael Hanselmann
def _SsconfPath(name):
222 03d1dba2 Michael Hanselmann
  if not RE_VALID_SSCONF_NAME.match(name):
223 03d1dba2 Michael Hanselmann
    raise errors.ParameterError("Invalid ssconf name: %s" % name)
224 0c223ea9 Michael Hanselmann
  return "%s/ssconf_%s" % (constants.DATA_DIR, name)
225 0c223ea9 Michael Hanselmann
226 0c223ea9 Michael Hanselmann
227 03d1dba2 Michael Hanselmann
def WriteSsconfFiles(values):
228 0c223ea9 Michael Hanselmann
  """Writes legacy ssconf files to be used by external scripts.
229 0c223ea9 Michael Hanselmann

230 03d1dba2 Michael Hanselmann
  @type values: dict
231 03d1dba2 Michael Hanselmann
  @param values: Dictionary of (name, value)
232 0c223ea9 Michael Hanselmann

233 0c223ea9 Michael Hanselmann
  """
234 0c223ea9 Michael Hanselmann
  ssconf_lock = utils.FileLock(constants.SSCONF_LOCK_FILE)
235 0c223ea9 Michael Hanselmann
236 0c223ea9 Michael Hanselmann
  # Get lock while writing files
237 0c223ea9 Michael Hanselmann
  ssconf_lock.Exclusive(blocking=True, timeout=SSCONF_LOCK_TIMEOUT)
238 0c223ea9 Michael Hanselmann
  try:
239 03d1dba2 Michael Hanselmann
    for name, value in values.iteritems():
240 03d1dba2 Michael Hanselmann
      if not value.endswith("\n"):
241 03d1dba2 Michael Hanselmann
        value += "\n"
242 03d1dba2 Michael Hanselmann
      utils.WriteFile(_SsconfPath(name),
243 03d1dba2 Michael Hanselmann
                      data=value)
244 0c223ea9 Michael Hanselmann
  finally:
245 0c223ea9 Michael Hanselmann
    ssconf_lock.Unlock()
246 0c223ea9 Michael Hanselmann
247 0c223ea9 Michael Hanselmann
248 b33e986b Iustin Pop
def GetMasterAndMyself(ss=None):
249 b33e986b Iustin Pop
  """Get the master node and my own hostname.
250 b33e986b Iustin Pop

251 b33e986b Iustin Pop
  This can be either used for a 'soft' check (compared to CheckMaster,
252 b33e986b Iustin Pop
  which exits) or just for computing both at the same time.
253 b33e986b Iustin Pop

254 b33e986b Iustin Pop
  The function does not handle any errors, these should be handled in
255 b33e986b Iustin Pop
  the caller (errors.ConfigurationError, errors.ResolverError).
256 b33e986b Iustin Pop

257 b33e986b Iustin Pop
  """
258 b33e986b Iustin Pop
  if ss is None:
259 93384844 Iustin Pop
    ss = SimpleStore()
260 b33e986b Iustin Pop
  return ss.GetMasterNode(), utils.HostInfo().name
261 b33e986b Iustin Pop
262 06dc5b44 Iustin Pop
263 b33e986b Iustin Pop
def CheckMaster(debug, ss=None):
264 5675cd1f Iustin Pop
  """Checks the node setup.
265 5675cd1f Iustin Pop

266 5675cd1f Iustin Pop
  If this is the master, the function will return. Otherwise it will
267 5675cd1f Iustin Pop
  exit with an exit code based on the node status.
268 5675cd1f Iustin Pop

269 5675cd1f Iustin Pop
  """
270 5675cd1f Iustin Pop
  try:
271 b33e986b Iustin Pop
    master_name, myself = GetMasterAndMyself(ss)
272 5675cd1f Iustin Pop
  except errors.ConfigurationError, err:
273 5675cd1f Iustin Pop
    print "Cluster configuration incomplete: '%s'" % str(err)
274 5675cd1f Iustin Pop
    sys.exit(constants.EXIT_NODESETUP_ERROR)
275 5675cd1f Iustin Pop
  except errors.ResolverError, err:
276 5675cd1f Iustin Pop
    sys.stderr.write("Cannot resolve my own name (%s)\n" % err.args[0])
277 5675cd1f Iustin Pop
    sys.exit(constants.EXIT_NODESETUP_ERROR)
278 5675cd1f Iustin Pop
279 b33e986b Iustin Pop
  if myself != master_name:
280 5675cd1f Iustin Pop
    if debug:
281 5675cd1f Iustin Pop
      sys.stderr.write("Not master, exiting.\n")
282 5675cd1f Iustin Pop
    sys.exit(constants.EXIT_NOTMASTER)