3 from __future__ import absolute_import, print_function
6 from operator import attrgetter
8 import libcloud.common.types as cloud_types
9 from libcloud.compute.base import NodeDriver, NodeAuthSSHKey
11 from ...config import NETWORK_ERRORS
12 from .. import RetryMixin
14 class BaseComputeNodeDriver(RetryMixin):
15 """Abstract base class for compute node drivers.
17 libcloud drivers abstract away many of the differences between
18 cloud providers, but managing compute nodes requires some
19 cloud-specific features (e.g., keeping track of node FQDNs and
20 boot times). Compute node drivers are responsible for translating
21 the node manager's cloud requests to a specific cloud's
24 Subclasses must implement arvados_create_kwargs, sync_node,
25 node_fqdn, and node_start_time.
27 CLOUD_ERRORS = NETWORK_ERRORS + (cloud_types.LibcloudError,)
30 def _create_driver(self, driver_class, **auth_kwargs):
31 return driver_class(**auth_kwargs)
35 self.sizes = {sz.id: sz for sz in self.real.list_sizes()}
37 def __init__(self, auth_kwargs, list_kwargs, create_kwargs,
38 driver_class, retry_wait=1, max_retry_wait=180):
39 """Base initializer for compute node drivers.
42 * auth_kwargs: A dictionary of arguments that are passed into the
43 driver_class constructor to instantiate a libcloud driver.
44 * list_kwargs: A dictionary of arguments that are passed to the
45 libcloud driver's list_nodes method to return the list of compute
47 * create_kwargs: A dictionary of arguments that are passed to the
48 libcloud driver's create_node method to create a new compute node.
49 * driver_class: The class of a libcloud driver to use.
52 super(BaseComputeNodeDriver, self).__init__(retry_wait, max_retry_wait,
53 logging.getLogger(self.__class__.__name__),
56 self.real = self._create_driver(driver_class, **auth_kwargs)
57 self.list_kwargs = list_kwargs
58 self.create_kwargs = create_kwargs
59 # Transform entries in create_kwargs. For each key K, if this class
60 # has an _init_K method, remove the entry and call _init_K with the
61 # corresponding value. If _init_K returns None, the entry stays out
62 # of the dictionary (we expect we're holding the value somewhere
63 # else, like an instance variable). Otherwise, _init_K returns a
64 # key-value tuple pair, and we add that entry to create_kwargs.
65 for key in self.create_kwargs.keys():
66 init_method = getattr(self, '_init_' + key, None)
67 if init_method is not None:
68 new_pair = init_method(self.create_kwargs.pop(key))
69 if new_pair is not None:
70 self.create_kwargs[new_pair[0]] = new_pair[1]
74 def _init_ping_host(self, ping_host):
75 self.ping_host = ping_host
77 def _init_ssh_key(self, filename):
78 with open(filename) as ssh_file:
79 key = NodeAuthSSHKey(ssh_file.read())
82 def search_for_now(self, term, list_method, key=attrgetter('id'), **kwargs):
83 """Return one matching item from a list of cloud objects.
85 Raises ValueError if the number of matching objects is not exactly 1.
88 * term: The value that identifies a matching item.
89 * list_method: A string that names the method to call for a
91 * key: A function that accepts a cloud object and returns a
92 value search for a `term` match on each item. Returns the
93 object's 'id' attribute by default.
95 items = getattr(self, list_method)(**kwargs)
96 results = [item for item in items if key(item) == term]
99 raise ValueError("{} returned {} results for {!r}".format(
100 list_method, count, term))
103 def search_for(self, term, list_method, key=attrgetter('id'), **kwargs):
104 """Return one cached matching item from a list of cloud objects.
106 See search_for_now() for details of arguments and exceptions.
107 This method caches results, so it's good to find static cloud objects
108 like node sizes, regions, etc.
110 cache_key = (list_method, term)
111 if cache_key not in self.SEARCH_CACHE:
112 self.SEARCH_CACHE[cache_key] = self.search_for_now(
113 term, list_method, key, **kwargs)
114 return self.SEARCH_CACHE[cache_key]
116 def list_nodes(self, **kwargs):
117 l = self.list_kwargs.copy()
119 return self.real.list_nodes(**l)
121 def create_cloud_name(self, arvados_node):
122 """Return a cloud node name for the given Arvados node record.
124 Subclasses must override this method. It should return a string
125 that can be used as the name for a newly-created cloud node,
126 based on identifying information in the Arvados node record.
129 * arvados_node: This Arvados node record to seed the new cloud node.
131 raise NotImplementedError("BaseComputeNodeDriver.create_cloud_name")
133 def arvados_create_kwargs(self, size, arvados_node):
134 """Return dynamic keyword arguments for create_node.
136 Subclasses must override this method. It should return a dictionary
137 of keyword arguments to pass to the libcloud driver's create_node
138 method. These arguments will extend the static arguments in
142 * size: The node size that will be created (libcloud NodeSize object)
143 * arvados_node: The Arvados node record that will be associated
144 with this cloud node, as returned from the API server.
146 raise NotImplementedError("BaseComputeNodeDriver.arvados_create_kwargs")
148 def broken(self, cloud_node):
149 """Return true if libcloud has indicated the node is in a "broken" state."""
152 def _make_ping_url(self, arvados_node):
153 return 'https://{}/arvados/v1/nodes/{}/ping?ping_secret={}'.format(
154 self.ping_host, arvados_node['uuid'],
155 arvados_node['info']['ping_secret'])
158 def _name_key(cloud_object):
159 return cloud_object.name
161 def create_node(self, size, arvados_node):
163 kwargs = self.create_kwargs.copy()
164 kwargs.update(self.arvados_create_kwargs(size, arvados_node))
165 kwargs['size'] = size
166 return self.real.create_node(**kwargs)
167 except self.CLOUD_ERRORS as create_error:
168 # Workaround for bug #6702: sometimes the create node request
169 # succeeds but times out and raises an exception instead of
170 # returning a result. If this happens, we get stuck in a retry
171 # loop forever because subsequent create_node attempts will fail
172 # due to node name collision. So check if the node we intended to
173 # create shows up in the cloud node list and return it if found.
175 return self.search_for_now(kwargs['name'], 'list_nodes', self._name_key)
179 def post_create_node(self, cloud_node):
180 # ComputeNodeSetupActor calls this method after the cloud node is
181 # created. Any setup tasks that need to happen afterward (e.g.,
182 # tagging) should be done in this method.
185 def sync_node(self, cloud_node, arvados_node):
186 # When a compute node first pings the API server, the API server
187 # will automatically assign some attributes on the corresponding
188 # node record, like hostname. This method should propagate that
189 # information back to the cloud node appropriately.
190 raise NotImplementedError("BaseComputeNodeDriver.sync_node")
193 def node_fqdn(cls, node):
194 # This method should return the FQDN of the node object argument.
195 # Different clouds store this in different places.
196 raise NotImplementedError("BaseComputeNodeDriver.node_fqdn")
199 def node_start_time(cls, node):
200 # This method should return the time the node was started, in
201 # seconds since the epoch UTC.
202 raise NotImplementedError("BaseComputeNodeDriver.node_start_time")
205 def is_cloud_exception(cls, exception):
206 # libcloud compute drivers typically raise bare Exceptions to
207 # represent API errors. Return True for any exception that is
208 # exactly an Exception, or a better-known higher-level exception.
209 return (isinstance(exception, cls.CLOUD_ERRORS) or
210 type(exception) is Exception)
212 # Now that we've defined all our own methods, delegate generic, public
213 # attributes of libcloud drivers that we haven't defined ourselves.
214 def _delegate_to_real(attr_name):
216 lambda self: getattr(self.real, attr_name),
217 lambda self, value: setattr(self.real, attr_name, value),
218 doc=getattr(getattr(NodeDriver, attr_name), '__doc__', None))
223 raise NotImplementedError("BaseComputeNodeDriver.node_id")
226 for _attr_name in dir(NodeDriver):
227 if (not _attr_name.startswith('_')) and (_attr_name not in _locals):
228 _locals[_attr_name] = _delegate_to_real(_attr_name)