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         self._project = auth_kwargs.get("project")
  35         super(ComputeNodeDriver, self).__init__(
  36             auth_kwargs, list_kwargs, create_kwargs,
  37             driver_class)
  38         self._sizes_by_name = {sz.name: sz for sz in self.sizes.itervalues()}
  39         self._disktype_links = {dt.name: self._object_link(dt)
  40                                 for dt in self.real.ex_list_disktypes()}
  41
  42     @staticmethod
  43     def _object_link(cloud_object):
  44         return cloud_object.extra.get('selfLink')
  45
  46     def _init_image(self, image_name):
  47         return 'image', self.search_for(
  48             image_name, 'list_images', self._name_key, ex_project=self._project)
  49
  50     def _init_network(self, network_name):
  51         return 'ex_network', self.search_for(
  52             network_name, 'ex_list_networks', self._name_key)
  53
  54     def _init_service_accounts(self, service_accounts_str):
  55         return 'ex_service_accounts', json.loads(service_accounts_str)
  56
  57     def _init_ssh_key(self, filename):
  58         # SSH keys are delivered to GCE nodes via ex_metadata: see
  59         # http://stackoverflow.com/questions/26752617/creating-sshkeys-for-gce-instance-using-libcloud
  60         with open(filename) as ssh_file:
  61             self.create_kwargs['ex_metadata']['sshKeys'] = (
  62                 'root:' + ssh_file.read().strip())
  63
  64     def create_cloud_name(self, arvados_node):
  65         uuid_parts = arvados_node['uuid'].split('-', 2)
  66         return 'compute-{parts[2]}-{parts[0]}'.format(parts=uuid_parts)
  67
  68     def arvados_create_kwargs(self, size, arvados_node):
  69         name = self.create_cloud_name(arvados_node)
  70
  71         if size.scratch > 375000:
  72             self._logger.warning("Requested %d MB scratch space, but GCE driver currently only supports attaching a single 375 GB disk.", size.scratch)
  73
  74         disks = [
  75             {'autoDelete': True,
  76              'boot': True,
  77              'deviceName': name,
  78              'initializeParams':
  79                  {'diskName': name,
  80                   'diskType': self._disktype_links['pd-standard'],
  81                   'sourceImage': self._object_link(self.create_kwargs['image']),
  82                   },
  83              'type': 'PERSISTENT',
  84              },
  85             {'autoDelete': True,
  86              'boot': False,
  87              # Boot images rely on this device name to find the SSD.
  88              # Any change must be coordinated in the image.
  89              'deviceName': 'tmp',
  90              'initializeParams':
  91                  {'diskType': self._disktype_links['local-ssd'],
  92                   },
  93              'type': 'SCRATCH',
  94              },
  95             ]
  96         result = {'name': name,
  97                   'ex_metadata': self.create_kwargs['ex_metadata'].copy(),
  98                   'ex_tags': list(self.node_tags),
  99                   'ex_disks_gce_struct': disks,
 100                   }
 101         result['ex_metadata'].update({
 102                 'arv-ping-url': self._make_ping_url(arvados_node),
 103                 'booted_at': time.strftime(ARVADOS_TIMEFMT, time.gmtime()),
 104                 'hostname': arvados_node_fqdn(arvados_node),
 105                 })
 106         return result
 107
 108
 109     def list_nodes(self):
 110         # The GCE libcloud driver only supports filtering node lists by zone.
 111         # Do our own filtering based on tag list.
 112         nodelist = [node for node in
 113                     super(ComputeNodeDriver, self).list_nodes()
 114                     if self.node_tags.issubset(node.extra.get('tags', []))]
 115         # As of 0.18, the libcloud GCE driver sets node.size to the size's name.
 116         # It's supposed to be the actual size object.  Check that it's not,
 117         # and monkeypatch the results when that's the case.
 118         if nodelist and not hasattr(nodelist[0].size, 'id'):
 119             for node in nodelist:
 120                 node.size = self._sizes_by_name[node.size]
 121         return nodelist
 122
 123     @classmethod
 124     def _find_metadata(cls, metadata_items, key):
 125         # Given a list of two-item metadata dictonaries, return the one with
 126         # the named key.  Raise KeyError if not found.
 127         try:
 128             return next(data_dict for data_dict in metadata_items
 129                         if data_dict.get('key') == key)
 130         except StopIteration:
 131             raise KeyError(key)
 132
 133     @classmethod
 134     def _get_metadata(cls, metadata_items, key, *default):
 135         try:
 136             return cls._find_metadata(metadata_items, key)['value']
 137         except KeyError:
 138             if default:
 139                 return default[0]
 140             raise
 141
 142     def sync_node(self, cloud_node, arvados_node):
 143         # Update the cloud node record to ensure we have the correct metadata
 144         # fingerprint.
 145         cloud_node = self.real.ex_get_node(cloud_node.name, cloud_node.extra['zone'])
 146
 147         # We can't store the FQDN on the name attribute or anything like it,
 148         # because (a) names are static throughout the node's life (so FQDN
 149         # isn't available because we don't know it at node creation time) and
 150         # (b) it can't contain dots.  Instead stash it in metadata.
 151         hostname = arvados_node_fqdn(arvados_node)
 152         metadata_req = cloud_node.extra['metadata'].copy()
 153         metadata_items = metadata_req.setdefault('items', [])
 154         try:
 155             self._find_metadata(metadata_items, 'hostname')['value'] = hostname
 156         except KeyError:
 157             metadata_items.append({'key': 'hostname', 'value': hostname})
 158
 159         self.real.ex_set_node_metadata(cloud_node, metadata_items)
 160
 161     @classmethod
 162     def node_fqdn(cls, node):
 163         # See sync_node comment.
 164         return cls._get_metadata(node.extra['metadata'].get('items', []),
 165                                  'hostname', '')
 166
 167     @classmethod
 168     def node_start_time(cls, node):
 169         try:
 170             return arvados_timestamp(cls._get_metadata(
 171                     node.extra['metadata']['items'], 'booted_at'))
 172         except KeyError:
 173             return 0
 174
 175     @classmethod
 176     def node_id(cls, node):
 177         return node.id