services/nodemanager/arvnodeman/computenode/driver/gce.py

   1 #!/usr/bin/env python
   2
   3 from __future__ import absolute_import, print_function
   4
   5 import functools
   6 import json
   7 import time
   8
   9 import libcloud.compute.providers as cloud_provider
  10 import libcloud.compute.types as cloud_types
  11
  12 from . import BaseComputeNodeDriver
  13 from .. import arvados_node_fqdn, arvados_timestamp, ARVADOS_TIMEFMT
  14
  15 class ComputeNodeDriver(BaseComputeNodeDriver):
  16     """Compute node driver wrapper for GCE
  17
  18     This translates cloud driver requests to GCE's specific parameters.
  19     """
  20     DEFAULT_DRIVER = cloud_provider.get_driver(cloud_types.Provider.GCE)
  21     SEARCH_CACHE = {}
  22
  23     def __init__(self, auth_kwargs, list_kwargs, create_kwargs,
  24                  driver_class=DEFAULT_DRIVER):
  25         list_kwargs = list_kwargs.copy()
  26         tags_str = list_kwargs.pop('tags', '')
  27         if not tags_str.strip():
  28             self.node_tags = frozenset()
  29         else:
  30             self.node_tags = frozenset(t.strip() for t in tags_str.split(','))
  31         create_kwargs = create_kwargs.copy()
  32         create_kwargs.setdefault('external_ip', None)
  33         create_kwargs.setdefault('ex_metadata', {})
  34         super(ComputeNodeDriver, self).__init__(
  35             auth_kwargs, list_kwargs, create_kwargs,
  36             driver_class)
  37         self._sizes_by_name = {sz.name: sz for sz in self.sizes.itervalues()}
  38         self._disktype_links = {dt.name: self._object_link(dt)
  39                                 for dt in self.real.ex_list_disktypes()}
  40
  41     @staticmethod
  42     def _object_link(cloud_object):
  43         return cloud_object.extra.get('selfLink')
  44
  45     def _init_image(self, image_name):
  46         return 'image', self.search_for(
  47             image_name, 'list_images', self._name_key)
  48
  49     def _init_network(self, network_name):
  50         return 'ex_network', self.search_for(
  51             network_name, 'ex_list_networks', self._name_key)
  52
  53     def _init_service_accounts(self, service_accounts_str):
  54         return 'ex_service_accounts', json.loads(service_accounts_str)
  55
  56     def _init_ssh_key(self, filename):
  57         # SSH keys are delivered to GCE nodes via ex_metadata: see
  58         # http://stackoverflow.com/questions/26752617/creating-sshkeys-for-gce-instance-using-libcloud
  59         with open(filename) as ssh_file:
  60             self.create_kwargs['ex_metadata']['sshKeys'] = (
  61                 'root:' + ssh_file.read().strip())
  62
  63     def arvados_create_kwargs(self, size, arvados_node):
  64         cluster_id, _, node_id = arvados_node['uuid'].split('-')
  65         name = 'compute-{}-{}'.format(node_id, cluster_id)
  66         disks = [
  67             {'autoDelete': True,
  68              'boot': True,
  69              'deviceName': name,
  70              'initializeParams':
  71                  {'diskName': name,
  72                   'diskType': self._disktype_links['pd-standard'],
  73                   'sourceImage': self._object_link(self.create_kwargs['image']),
  74                   },
  75              'type': 'PERSISTENT',
  76              },
  77             {'autoDelete': True,
  78              'boot': False,
  79              # Boot images rely on this device name to find the SSD.
  80              # Any change must be coordinated in the image.
  81              'deviceName': 'tmp',
  82              'initializeParams':
  83                  {'diskType': self._disktype_links['local-ssd'],
  84                   },
  85              'type': 'SCRATCH',
  86              },
  87             ]
  88         result = {'name': name,
  89                   'ex_metadata': self.create_kwargs['ex_metadata'].copy(),
  90                   'ex_tags': list(self.node_tags),
  91                   'ex_disks_gce_struct': disks,
  92                   }
  93         result['ex_metadata'].update({
  94                 'arv-ping-url': self._make_ping_url(arvados_node),
  95                 'booted_at': time.strftime(ARVADOS_TIMEFMT, time.gmtime()),
  96                 'hostname': arvados_node_fqdn(arvados_node),
  97                 })
  98         return result
  99
 100
 101     def list_nodes(self):
 102         # The GCE libcloud driver only supports filtering node lists by zone.
 103         # Do our own filtering based on tag list.
 104         nodelist = [node for node in
 105                     super(ComputeNodeDriver, self).list_nodes()
 106                     if self.node_tags.issubset(node.extra.get('tags', []))]
 107         # As of 0.18, the libcloud GCE driver sets node.size to the size's name.
 108         # It's supposed to be the actual size object.  Check that it's not,
 109         # and monkeypatch the results when that's the case.
 110         if nodelist and not hasattr(nodelist[0].size, 'id'):
 111             for node in nodelist:
 112                 node.size = self._sizes_by_name[node.size]
 113         return nodelist
 114
 115     @classmethod
 116     def _find_metadata(cls, metadata_items, key):
 117         # Given a list of two-item metadata dictonaries, return the one with
 118         # the named key.  Raise KeyError if not found.
 119         try:
 120             return next(data_dict for data_dict in metadata_items
 121                         if data_dict.get('key') == key)
 122         except StopIteration:
 123             raise KeyError(key)
 124
 125     @classmethod
 126     def _get_metadata(cls, metadata_items, key, *default):
 127         try:
 128             return cls._find_metadata(metadata_items, key)['value']
 129         except KeyError:
 130             if default:
 131                 return default[0]
 132             raise
 133
 134     def sync_node(self, cloud_node, arvados_node):
 135         # We can't store the FQDN on the name attribute or anything like it,
 136         # because (a) names are static throughout the node's life (so FQDN
 137         # isn't available because we don't know it at node creation time) and
 138         # (b) it can't contain dots.  Instead stash it in metadata.
 139         hostname = arvados_node_fqdn(arvados_node)
 140         metadata_req = cloud_node.extra['metadata'].copy()
 141         metadata_items = metadata_req.setdefault('items', [])
 142         try:
 143             self._find_metadata(metadata_items, 'hostname')['value'] = hostname
 144         except KeyError:
 145             metadata_items.append({'key': 'hostname', 'value': hostname})
 146         response = self.real.connection.async_request(
 147             '/zones/{}/instances/{}/setMetadata'.format(
 148                 cloud_node.extra['zone'].name, cloud_node.name),
 149             method='POST', data=metadata_req)
 150         if not response.success():
 151             raise Exception("setMetadata error: {}".format(response.error))
 152
 153     @classmethod
 154     def node_fqdn(cls, node):
 155         # See sync_node comment.
 156         return cls._get_metadata(node.extra['metadata'].get('items', []),
 157                                  'hostname', '')
 158
 159     @classmethod
 160     def node_start_time(cls, node):
 161         try:
 162             return arvados_timestamp(cls._get_metadata(
 163                     node.extra['metadata']['items'], 'booted_at'))
 164         except KeyError:
 165             return 0