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._disktype_links = {dt.name: self._object_link(dt)
  38                                 for dt in self.real.ex_list_disktypes()}
  39
  40     @staticmethod
  41     def _name_key(cloud_object):
  42         return cloud_object.name
  43
  44     @staticmethod
  45     def _object_link(cloud_object):
  46         return cloud_object.extra.get('selfLink')
  47
  48     def _init_image(self, image_name):
  49         return 'image', self.search_for(
  50             image_name, 'list_images', self._name_key)
  51
  52     def _init_network(self, network_name):
  53         return 'ex_network', self.search_for(
  54             network_name, 'ex_list_networks', self._name_key)
  55
  56     def _init_service_accounts(self, service_accounts_str):
  57         return 'ex_service_accounts', json.loads(service_accounts_str)
  58
  59     def _init_ssh_key(self, filename):
  60         # SSH keys are delivered to GCE nodes via ex_metadata: see
  61         # http://stackoverflow.com/questions/26752617/creating-sshkeys-for-gce-instance-using-libcloud
  62         with open(filename) as ssh_file:
  63             self.create_kwargs['ex_metadata']['sshKeys'] = (
  64                 'root:' + ssh_file.read().strip())
  65
  66     def arvados_create_kwargs(self, arvados_node):
  67         cluster_id, _, node_id = arvados_node['uuid'].split('-')
  68         name = 'compute-{}-{}'.format(node_id, cluster_id)
  69         disks = [
  70             {'autoDelete': True,
  71              'boot': True,
  72              'deviceName': name,
  73              'initializeParams':
  74                  {'diskName': name,
  75                   'diskType': self._disktype_links['pd-standard'],
  76                   'sourceImage': self._object_link(self.create_kwargs['image']),
  77                   },
  78              'type': 'PERSISTENT',
  79              },
  80             {'autoDelete': True,
  81              'boot': False,
  82              # Boot images rely on this device name to find the SSD.
  83              # Any change must be coordinated in the image.
  84              'deviceName': 'tmp',
  85              'initializeParams':
  86                  {'diskType': self._disktype_links['local-ssd'],
  87                   },
  88              'type': 'SCRATCH',
  89              },
  90             ]
  91         result = {'name': name,
  92                   'ex_metadata': self.create_kwargs['ex_metadata'].copy(),
  93                   'ex_tags': list(self.node_tags),
  94                   'ex_disks_gce_struct': disks,
  95                   }
  96         result['ex_metadata'].update({
  97                 'arv-ping-url': self._make_ping_url(arvados_node),
  98                 'booted_at': time.strftime(ARVADOS_TIMEFMT, time.gmtime()),
  99                 'hostname': arvados_node_fqdn(arvados_node),
 100                 })
 101         return result
 102
 103     def list_nodes(self):
 104         # The GCE libcloud driver only supports filtering node lists by zone.
 105         # Do our own filtering based on tag list.
 106         return [node for node in
 107                 super(ComputeNodeDriver, self).list_nodes()
 108                 if self.node_tags.issubset(node.extra.get('tags', []))]
 109
 110     @classmethod
 111     def _find_metadata(cls, metadata_items, key):
 112         # Given a list of two-item metadata dictonaries, return the one with
 113         # the named key.  Raise KeyError if not found.
 114         try:
 115             return next(data_dict for data_dict in metadata_items
 116                         if data_dict.get('key') == key)
 117         except StopIteration:
 118             raise KeyError(key)
 119
 120     @classmethod
 121     def _get_metadata(cls, metadata_items, key, *default):
 122         try:
 123             return cls._find_metadata(metadata_items, key)['value']
 124         except KeyError:
 125             if default:
 126                 return default[0]
 127             raise
 128
 129     def sync_node(self, cloud_node, arvados_node):
 130         # We can't store the FQDN on the name attribute or anything like it,
 131         # because (a) names are static throughout the node's life (so FQDN
 132         # isn't available because we don't know it at node creation time) and
 133         # (b) it can't contain dots.  Instead stash it in metadata.
 134         hostname = arvados_node_fqdn(arvados_node)
 135         metadata_req = cloud_node.extra['metadata'].copy()
 136         metadata_items = metadata_req.setdefault('items', [])
 137         try:
 138             self._find_metadata(metadata_items, 'hostname')['value'] = hostname
 139         except KeyError:
 140             metadata_items.append({'key': 'hostname', 'value': hostname})
 141         response = self.real.connection.async_request(
 142             '/zones/{}/instances/{}/setMetadata'.format(
 143                 cloud_node.extra['zone'].name, cloud_node.name),
 144             method='POST', data=metadata_req)
 145         if not response.success():
 146             raise Exception("setMetadata error: {}".format(response.error))
 147
 148     @classmethod
 149     def node_fqdn(cls, node):
 150         # See sync_node comment.
 151         return cls._get_metadata(node.extra['metadata'].get('items', []),
 152                                  'hostname', '')
 153
 154     @classmethod
 155     def node_start_time(cls, node):
 156         try:
 157             return arvados_timestamp(cls._get_metadata(
 158                     node.extra['metadata']['items'], 'booted_at'))
 159         except KeyError:
 160             return 0