Statistics
| Branch: | Tag: | Revision:

root / lib / ssconf.py @ 75a5f456

History | View | Annotate | Download (5 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
"""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 a8083063 Iustin Pop
import socket
30 a8083063 Iustin Pop
31 a8083063 Iustin Pop
from ganeti import errors
32 a8083063 Iustin Pop
from ganeti import constants
33 41a57aab Michael Hanselmann
from ganeti import utils
34 a8083063 Iustin Pop
35 a8083063 Iustin Pop
36 a8083063 Iustin Pop
class SimpleStore:
37 a8083063 Iustin Pop
  """Interface to static cluster data.
38 a8083063 Iustin Pop

39 a8083063 Iustin Pop
  This is different that the config.ConfigWriter class in that it
40 a8083063 Iustin Pop
  holds data that is (mostly) constant after the cluster
41 a8083063 Iustin Pop
  initialization. Its purpose is to allow limited customization of
42 a8083063 Iustin Pop
  things which would otherwise normally live in constants.py. Note
43 a8083063 Iustin Pop
  that this data cannot live in ConfigWriter as that is available only
44 a8083063 Iustin Pop
  on the master node, and our data must be readable by both the master
45 a8083063 Iustin Pop
  and the nodes.
46 a8083063 Iustin Pop

47 a8083063 Iustin Pop
  Other particularities of the datastore:
48 a8083063 Iustin Pop
    - keys are restricted to predefined values
49 a8083063 Iustin Pop
    - values are small (<4k)
50 a8083063 Iustin Pop
    - since the data is practically static, read keys are cached in memory
51 a8083063 Iustin Pop
    - some keys are handled specially (read from the system, so
52 a8083063 Iustin Pop
      we can't update them)
53 a8083063 Iustin Pop

54 a8083063 Iustin Pop
  """
55 a8083063 Iustin Pop
  _SS_FILEPREFIX = "ssconf_"
56 a8083063 Iustin Pop
  SS_HYPERVISOR = "hypervisor"
57 a8083063 Iustin Pop
  SS_NODED_PASS = "node_pass"
58 880478f8 Iustin Pop
  SS_MASTER_NODE = "master_node"
59 880478f8 Iustin Pop
  SS_MASTER_IP = "master_ip"
60 880478f8 Iustin Pop
  SS_MASTER_NETDEV = "master_netdev"
61 5fcdc80d Iustin Pop
  SS_CLUSTER_NAME = "cluster_name"
62 880478f8 Iustin Pop
  _VALID_KEYS = (SS_HYPERVISOR, SS_NODED_PASS, SS_MASTER_NODE, SS_MASTER_IP,
63 5fcdc80d Iustin Pop
                 SS_MASTER_NETDEV, SS_CLUSTER_NAME)
64 a8083063 Iustin Pop
  _MAX_SIZE = 4096
65 a8083063 Iustin Pop
66 a8083063 Iustin Pop
  def __init__(self, cfg_location=None):
67 a8083063 Iustin Pop
    if cfg_location is None:
68 a8083063 Iustin Pop
      self._cfg_dir = constants.DATA_DIR
69 a8083063 Iustin Pop
    else:
70 a8083063 Iustin Pop
      self._cfg_dir = cfg_location
71 a8083063 Iustin Pop
    self._cache = {}
72 a8083063 Iustin Pop
73 a8083063 Iustin Pop
  def KeyToFilename(self, key):
74 a8083063 Iustin Pop
    """Convert a given key into filename.
75 a8083063 Iustin Pop

76 a8083063 Iustin Pop
    """
77 a8083063 Iustin Pop
    if key not in self._VALID_KEYS:
78 3ecf6786 Iustin Pop
      raise errors.ProgrammerError("Invalid key requested from SSConf: '%s'"
79 3ecf6786 Iustin Pop
                                   % str(key))
80 a8083063 Iustin Pop
81 a8083063 Iustin Pop
    filename = self._cfg_dir + '/' + self._SS_FILEPREFIX + key
82 a8083063 Iustin Pop
    return filename
83 a8083063 Iustin Pop
84 a8083063 Iustin Pop
  def _ReadFile(self, key):
85 a8083063 Iustin Pop
    """Generic routine to read keys.
86 a8083063 Iustin Pop

87 a8083063 Iustin Pop
    This will read the file which holds the value requested. Errors
88 a8083063 Iustin Pop
    will be changed into ConfigurationErrors.
89 a8083063 Iustin Pop

90 a8083063 Iustin Pop
    """
91 a8083063 Iustin Pop
    if key in self._cache:
92 a8083063 Iustin Pop
      return self._cache[key]
93 a8083063 Iustin Pop
    filename = self.KeyToFilename(key)
94 a8083063 Iustin Pop
    try:
95 a8083063 Iustin Pop
      fh = file(filename, 'r')
96 a8083063 Iustin Pop
      try:
97 a8083063 Iustin Pop
        data = fh.readline(self._MAX_SIZE)
98 a8083063 Iustin Pop
        data = data.rstrip('\n')
99 a8083063 Iustin Pop
      finally:
100 a8083063 Iustin Pop
        fh.close()
101 a8083063 Iustin Pop
    except EnvironmentError, err:
102 3ecf6786 Iustin Pop
      raise errors.ConfigurationError("Can't read from the ssconf file:"
103 3ecf6786 Iustin Pop
                                      " '%s'" % str(err))
104 a8083063 Iustin Pop
    self._cache[key] = data
105 a8083063 Iustin Pop
    return data
106 a8083063 Iustin Pop
107 a8083063 Iustin Pop
  def GetNodeDaemonPort(self):
108 a8083063 Iustin Pop
    """Get the node daemon port for this cluster.
109 a8083063 Iustin Pop

110 a8083063 Iustin Pop
    Note that this routine does not read a ganeti-specific file, but
111 a8083063 Iustin Pop
    instead uses socket.getservbyname to allow pre-customization of
112 a8083063 Iustin Pop
    this parameter outside of ganeti.
113 a8083063 Iustin Pop

114 a8083063 Iustin Pop
    """
115 a8083063 Iustin Pop
    try:
116 a8083063 Iustin Pop
      port = socket.getservbyname("ganeti-noded", "tcp")
117 a8083063 Iustin Pop
    except socket.error:
118 a8083063 Iustin Pop
      port = constants.DEFAULT_NODED_PORT
119 a8083063 Iustin Pop
120 a8083063 Iustin Pop
    return port
121 a8083063 Iustin Pop
122 a8083063 Iustin Pop
  def GetHypervisorType(self):
123 a8083063 Iustin Pop
    """Get the hypervisor type for this cluster.
124 a8083063 Iustin Pop

125 a8083063 Iustin Pop
    """
126 a8083063 Iustin Pop
    return self._ReadFile(self.SS_HYPERVISOR)
127 a8083063 Iustin Pop
128 a8083063 Iustin Pop
  def GetNodeDaemonPassword(self):
129 a8083063 Iustin Pop
    """Get the node password for this cluster.
130 a8083063 Iustin Pop

131 a8083063 Iustin Pop
    """
132 a8083063 Iustin Pop
    return self._ReadFile(self.SS_NODED_PASS)
133 a8083063 Iustin Pop
134 880478f8 Iustin Pop
  def GetMasterNode(self):
135 880478f8 Iustin Pop
    """Get the hostname of the master node for this cluster.
136 880478f8 Iustin Pop

137 880478f8 Iustin Pop
    """
138 880478f8 Iustin Pop
    return self._ReadFile(self.SS_MASTER_NODE)
139 880478f8 Iustin Pop
140 880478f8 Iustin Pop
  def GetMasterIP(self):
141 880478f8 Iustin Pop
    """Get the IP of the master node for this cluster.
142 880478f8 Iustin Pop

143 880478f8 Iustin Pop
    """
144 880478f8 Iustin Pop
    return self._ReadFile(self.SS_MASTER_IP)
145 880478f8 Iustin Pop
146 880478f8 Iustin Pop
  def GetMasterNetdev(self):
147 880478f8 Iustin Pop
    """Get the netdev to which we'll add the master ip.
148 880478f8 Iustin Pop

149 880478f8 Iustin Pop
    """
150 880478f8 Iustin Pop
    return self._ReadFile(self.SS_MASTER_NETDEV)
151 880478f8 Iustin Pop
152 5fcdc80d Iustin Pop
  def GetClusterName(self):
153 5fcdc80d Iustin Pop
    """Get the cluster name.
154 5fcdc80d Iustin Pop

155 5fcdc80d Iustin Pop
    """
156 5fcdc80d Iustin Pop
    return self._ReadFile(self.SS_CLUSTER_NAME)
157 5fcdc80d Iustin Pop
158 a8083063 Iustin Pop
  def SetKey(self, key, value):
159 a8083063 Iustin Pop
    """Set the value of a key.
160 a8083063 Iustin Pop

161 a8083063 Iustin Pop
    This should be used only when adding a node to a cluster.
162 a8083063 Iustin Pop

163 a8083063 Iustin Pop
    """
164 a8083063 Iustin Pop
    file_name = self.KeyToFilename(key)
165 41a57aab Michael Hanselmann
    utils.WriteFile(file_name, data="%s\n" % str(value),
166 41a57aab Michael Hanselmann
                    uid=0, gid=0, mode=0400)
167 41a57aab Michael Hanselmann
    self._cache[key] = value
168 a8083063 Iustin Pop
169 a8083063 Iustin Pop
  def GetFileList(self):
170 a8083063 Iustin Pop
    """Return the lis of all config files.
171 a8083063 Iustin Pop

172 a8083063 Iustin Pop
    This is used for computing node replication data.
173 a8083063 Iustin Pop

174 a8083063 Iustin Pop
    """
175 a8083063 Iustin Pop
    return [self.KeyToFilename(key) for key in self._VALID_KEYS]