1# Author: Neal Shrader <neal@digitalocean.com>
2# Author: Ben Howard  <bh@digitalocean.com>
3#
4# This file is part of cloud-init. See LICENSE file for license information.
5
6# DigitalOcean Droplet API:
7# https://developers.digitalocean.com/documentation/metadata/
8
9from cloudinit import log as logging
10from cloudinit import sources
11from cloudinit import util
12
13import cloudinit.sources.helpers.digitalocean as do_helper
14
15LOG = logging.getLogger(__name__)
16
17BUILTIN_DS_CONFIG = {
18    'metadata_url': 'http://169.254.169.254/metadata/v1.json',
19}
20
21# Wait for a up to a minute, retrying the meta-data server
22# every 2 seconds.
23MD_RETRIES = 30
24MD_TIMEOUT = 2
25MD_WAIT_RETRY = 2
26MD_USE_IPV4LL = True
27
28
29class DataSourceDigitalOcean(sources.DataSource):
30
31    dsname = 'DigitalOcean'
32
33    def __init__(self, sys_cfg, distro, paths):
34        sources.DataSource.__init__(self, sys_cfg, distro, paths)
35        self.distro = distro
36        self.metadata = dict()
37        self.ds_cfg = util.mergemanydict([
38            util.get_cfg_by_path(sys_cfg, ["datasource", "DigitalOcean"], {}),
39            BUILTIN_DS_CONFIG])
40        self.metadata_address = self.ds_cfg['metadata_url']
41        self.retries = self.ds_cfg.get('retries', MD_RETRIES)
42        self.timeout = self.ds_cfg.get('timeout', MD_TIMEOUT)
43        self.use_ip4LL = self.ds_cfg.get('use_ip4LL', MD_USE_IPV4LL)
44        self.wait_retry = self.ds_cfg.get('wait_retry', MD_WAIT_RETRY)
45        self._network_config = None
46
47    def _get_sysinfo(self):
48        return do_helper.read_sysinfo()
49
50    def _get_data(self):
51        (is_do, droplet_id) = self._get_sysinfo()
52
53        # only proceed if we know we are on DigitalOcean
54        if not is_do:
55            return False
56
57        LOG.info("Running on DigitalOcean. droplet_id=%s", droplet_id)
58
59        ipv4LL_nic = None
60        if self.use_ip4LL:
61            ipv4LL_nic = do_helper.assign_ipv4_link_local(self.distro)
62
63        md = do_helper.read_metadata(
64            self.metadata_address, timeout=self.timeout,
65            sec_between=self.wait_retry, retries=self.retries)
66
67        self.metadata_full = md
68        self.metadata['instance-id'] = md.get('droplet_id', droplet_id)
69        self.metadata['local-hostname'] = md.get('hostname', droplet_id)
70        self.metadata['interfaces'] = md.get('interfaces')
71        self.metadata['public-keys'] = md.get('public_keys')
72        self.metadata['availability_zone'] = md.get('region', 'default')
73        self.vendordata_raw = md.get("vendor_data", None)
74        self.userdata_raw = md.get("user_data", None)
75
76        if ipv4LL_nic:
77            do_helper.del_ipv4_link_local(ipv4LL_nic)
78
79        return True
80
81    def check_instance_id(self, sys_cfg):
82        return sources.instance_id_matches_system_uuid(
83            self.get_instance_id(), 'system-serial-number')
84
85    @property
86    def network_config(self):
87        """Configure the networking. This needs to be done each boot, since
88           the IP information may have changed due to snapshot and/or
89           migration.
90        """
91
92        if self._network_config:
93            return self._network_config
94
95        interfaces = self.metadata.get('interfaces')
96        LOG.debug(interfaces)
97        if not interfaces:
98            raise Exception("Unable to get meta-data from server....")
99
100        nameservers = self.metadata_full['dns']['nameservers']
101        self._network_config = do_helper.convert_network_configuration(
102            interfaces, nameservers)
103        return self._network_config
104
105
106# Used to match classes to dependencies
107datasources = [
108    (DataSourceDigitalOcean, (sources.DEP_FILESYSTEM, )),
109]
110
111
112# Return a list of data sources that match this set of dependencies
113def get_datasource_list(depends):
114    return sources.list_from_depends(depends, datasources)
115
116# vi: ts=4 expandtab
117