/usr/lib/python2.7/dist-packages/provisioningserver/rpc/clusterservice.py is in python-maas-provisioningserver 1.5.4+bzr2294-0ubuntu1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | # Copyright 2014 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""RPC implementation for clusters."""
from __future__ import (
absolute_import,
print_function,
unicode_literals,
)
str = None
__metaclass__ = type
__all__ = [
"ClusterClientService",
"ClusterService",
]
import json
import random
from urlparse import urlparse
from apiclient.utils import ascii_url
from provisioningserver.boot import tftppath
from provisioningserver.cluster_config import (
get_cluster_uuid,
get_maas_url,
)
from provisioningserver.config import Config
from provisioningserver.driver import (
ArchitectureRegistry,
PowerTypeRegistry,
)
from provisioningserver.rpc import (
cluster,
common,
exceptions,
region,
)
from provisioningserver.rpc.interfaces import IConnection
from twisted.application.internet import (
StreamServerEndpointService,
TimerService,
)
from twisted.internet import ssl
from twisted.internet.defer import inlineCallbacks
from twisted.internet.endpoints import (
connectProtocol,
TCP4ClientEndpoint,
TCP4ServerEndpoint,
)
from twisted.internet.error import ConnectError
from twisted.internet.protocol import Factory
from twisted.protocols import amp
from twisted.python import (
filepath,
log,
)
from twisted.web.client import getPage
from zope.interface import implementer
class Cluster(amp.AMP, object):
"""The RPC protocol supported by a cluster controller.
This can be used on the client or server end of a connection; once a
connection is established, AMP is symmetric.
"""
@cluster.Identify.responder
def identify(self):
"""identify()
Implementation of
:py:class:`~provisioningserver.rpc.cluster.Identify`.
"""
return {b"ident": get_cluster_uuid().decode("ascii")}
@cluster.ListBootImages.responder
def list_boot_images(self):
"""list_boot_images()
Implementation of
:py:class:`~provisioningserver.rpc.cluster.ListBootImages`.
"""
images = tftppath.list_boot_images(
Config.load_from_cache()['tftp']['resource_root'])
return {"images": images}
@cluster.DescribePowerTypes.responder
def describe_power_types(self):
"""describe_power_types()
Implementation of
:py:class:`~provisioningserver.rpc.cluster.DescribePowerTypes`.
"""
return {
'power_types': [item for name, item in PowerTypeRegistry],
}
@cluster.ListSupportedArchitectures.responder
def list_supported_architectures(self):
return {
'architectures': [
{'name': arch.name, 'description': arch.description}
for _, arch in ArchitectureRegistry
],
}
@amp.StartTLS.responder
def get_tls_parameters(self):
"""get_tls_parameters()
Implementation of :py:class:`~twisted.protocols.amp.StartTLS`.
"""
# TODO: Obtain certificates from a config store.
testing = filepath.FilePath(__file__).sibling("testing")
with testing.child("cluster.crt").open() as fin:
tls_localCertificate = ssl.PrivateCertificate.loadPEM(fin.read())
with testing.child("trust.crt").open() as fin:
tls_verifyAuthorities = [
ssl.Certificate.loadPEM(fin.read()),
]
return {
"tls_localCertificate": tls_localCertificate,
"tls_verifyAuthorities": tls_verifyAuthorities,
}
class ClusterService(StreamServerEndpointService):
"""A cluster controller RPC service.
This is a service - in the Twisted sense - that exposes the
``Cluster`` protocol on the given port.
"""
def __init__(self, reactor, port):
super(ClusterService, self).__init__(
TCP4ServerEndpoint(reactor, port),
Factory.forProtocol(Cluster))
@implementer(IConnection)
class ClusterClient(Cluster):
"""The RPC protocol supported by a cluster controller, client version.
This works hand-in-hand with ``ClusterClientService``, maintaining
the latter's `connections` map.
:ivar address: The `(host, port)` of the remote endpoint.
:ivar eventloop: The event-loop this client is related to.
:ivar service: A reference to the :class:`ClusterClientService` that
made self.
"""
address = None
eventloop = None
service = None
def __init__(self, address, eventloop, service):
super(ClusterClient, self).__init__()
self.address = address
self.eventloop = eventloop
self.service = service
@property
def ident(self):
"""The ident of the remote event-loop."""
return self.eventloop
def connectionMade(self):
super(ClusterClient, self).connectionMade()
if not self.service.running:
self.transport.loseConnection()
elif self.eventloop in self.service.connections:
self.transport.loseConnection()
else:
self.service.connections[self.eventloop] = self
def connectionLost(self, reason):
if self.eventloop in self.service.connections:
if self.service.connections[self.eventloop] is self:
del self.service.connections[self.eventloop]
super(ClusterClient, self).connectionLost(reason)
@inlineCallbacks
def secureConnection(self):
yield self.callRemote(amp.StartTLS, **self.get_tls_parameters())
# For some weird reason (it's mentioned in Twisted's source),
# TLS negotiation does not complete until we do something with
# the connection. Here we check that the remote event-loop is
# who we expected it to be.
response = yield self.callRemote(region.Identify)
remote_name = response.get("name")
if remote_name != self.eventloop:
log.msg(
"The remote event-loop identifies itself as %s, but "
"%s was expected." % (remote_name, self.eventloop))
self.transport.loseConnection()
return
# We should now have a full set of parameters for the transport.
log.msg("Host certificate: %r" % self.hostCertificate)
log.msg("Peer certificate: %r" % self.peerCertificate)
class ClusterClientService(TimerService, object):
"""A cluster controller RPC client service.
This is a service - in the Twisted sense - that connects to a set of
remote AMP endpoints. The endpoints are obtained from a view in the
region controller and periodically refreshed; this list is used to
update the connections maintained in this service.
:ivar connections: A mapping of eventloop names to protocol
instances connected to it.
"""
INTERVAL_LOW = 2 # seconds.
INTERVAL_MID = 10 # seconds.
INTERVAL_HIGH = 30 # seconds.
def __init__(self, reactor):
super(ClusterClientService, self).__init__(
self._calculate_interval(None, None), self.update)
self.connections = {}
self.clock = reactor
def getClient(self):
"""Returns a :class:`common.Client` connected to a region.
The client is chosen at random.
:raises: :py:class:`~.exceptions.NoConnectionsAvailable` when
there are no open connections to a region controller.
"""
conns = list(self.connections.viewvalues())
if len(conns) == 0:
raise exceptions.NoConnectionsAvailable()
else:
return common.Client(random.choice(conns))
@inlineCallbacks
def update(self):
"""Refresh outgoing connections.
This obtains a list of endpoints from the region then connects
to new ones and drops connections to those no longer used.
"""
try:
info_url = self._get_rpc_info_url()
info_page = yield getPage(info_url)
info = json.loads(info_page)
eventloops = info["eventloops"]
yield self._update_connections(eventloops)
except ConnectError as error:
self._update_interval(None, len(self.connections))
log.msg("Region not available: %s" % (error,))
except:
self._update_interval(None, len(self.connections))
log.err()
else:
self._update_interval(len(eventloops), len(self.connections))
@staticmethod
def _get_rpc_info_url():
"""Return the URL to the RPC infomation page on the region."""
url = urlparse(get_maas_url())
url = url._replace(path="%s/rpc/" % url.path.rstrip("/"))
url = url.geturl()
return ascii_url(url)
def _calculate_interval(self, num_eventloops, num_connections):
"""Calculate the update interval.
The interval is `INTERVAL_LOW` seconds when there are no
connections, so that this can quickly obtain its first
connection.
The interval changes to `INTERVAL_MID` seconds when there are
some connections, but fewer than there are event-loops.
After that it drops back to `INTERVAL_HIGH` seconds.
"""
if num_eventloops is None:
# The region is not available; keep trying regularly.
return self.INTERVAL_LOW
elif num_eventloops == 0:
# The region is coming up; keep trying regularly.
return self.INTERVAL_LOW
elif num_connections == 0:
# No connections to the region; keep trying regularly.
return self.INTERVAL_LOW
elif num_connections < num_eventloops:
# Some connections to the region, but not to all event
# loops; keep updating reasonably frequently.
return self.INTERVAL_MID
else:
# Fully connected to the region; update every so often.
return self.INTERVAL_HIGH
def _update_interval(self, num_eventloops, num_connections):
"""Change the update interval."""
self._loop.interval = self.step = self._calculate_interval(
num_eventloops, num_connections)
@inlineCallbacks
def _update_connections(self, eventloops):
"""Update the persistent connections to the region.
For each event-loop, ensure that there is (a) a connection
established and that (b) that connection corresponds to one of
the endpoints declared. If not (a), attempt to connect to each
endpoint in turn. If not (b), immediately drop the connection
and proceed as if not (a).
For each established connection to an event-loop, check that
it's still in the list of event-loops to which this cluster
should connect. If not, immediately drop the connection.
"""
# Ensure that the event-loop addresses are tuples so that
# they'll work as dictionary keys.
eventloops = {
name: [tuple(address) for address in addresses]
for name, addresses in eventloops.iteritems()
}
# Drop connections to event-loops that no longer include one of
# this cluster's established connections among its advertised
# endpoints. This is most likely to have happened because of
# network reconfiguration on the machine hosting the event-loop,
# and so the connection may have dropped already, but there's
# nothing wrong with a bit of belt-and-braces engineering
# between consenting adults.
for eventloop, addresses in eventloops.iteritems():
if eventloop in self.connections:
connection = self.connections[eventloop]
if connection.address not in addresses:
yield self._drop_connection(connection)
# Create new connections to event-loops that the cluster does
# not yet have a connection to. Try each advertised endpoint
# (address) in turn until one of them bites.
for eventloop, addresses in eventloops.iteritems():
if eventloop not in self.connections:
for address in addresses:
try:
yield self._make_connection(eventloop, address)
except ConnectError as error:
host, port = address
log.msg("Event-loop %s (%s:%d): %s" % (
eventloop, host, port, error))
except:
log.err()
else:
break
# Remove connections to event-loops that are no longer
# advertised by the RPC info view. Most likely this means that
# the process in which the event-loop is no longer running, but
# it could be an indicator of a heavily loaded machine, or a
# fault. In any case, it seems to make sense to disconnect.
for eventloop in self.connections:
if eventloop not in eventloops:
connection = self.connections[eventloop]
yield self._drop_connection(connection)
def _make_connection(self, eventloop, address):
"""Connect to `eventloop` at `address`."""
endpoint = TCP4ClientEndpoint(self.clock, *address)
protocol = ClusterClient(address, eventloop, self)
return connectProtocol(endpoint, protocol)
def _drop_connection(self, connection):
"""Drop the given `connection`."""
return connection.transport.loseConnection()
|