summaryrefslogtreecommitdiff
path: root/cloudinit/sources/DataSourceGCE.py
blob: e2be15b0d5075050d3ae07da5f49191096e59c8d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# vi: ts=4 expandtab
#
#    Author: Vaidas Jablonskis <jablonskis@gmail.com>
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License version 3, as
#    published by the Free Software Foundation.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.


from cloudinit import log as logging
from cloudinit import util
from cloudinit import sources
from cloudinit import url_helper

LOG = logging.getLogger(__name__)

BUILTIN_DS_CONFIG = {
    'metadata_url': 'http://metadata.google.internal./computeMetadata/v1/'
}
REQUIRED_FIELDS = ('instance-id', 'availability-zone', 'local-hostname')


class DataSourceGCE(sources.DataSource):
    def __init__(self, sys_cfg, distro, paths):
        sources.DataSource.__init__(self, sys_cfg, distro, paths)
        self.metadata = dict()
        self.ds_cfg = util.mergemanydict([
            util.get_cfg_by_path(sys_cfg, ["datasource", "GCE"], {}),
            BUILTIN_DS_CONFIG])
        self.metadata_address = self.ds_cfg['metadata_url']

    # GCE takes sshKeys attribute in the format of '<user>:<public_key>'
    # so we have to trim each key to remove the username part
    def _trim_key(self, public_key):
        try:
            index = public_key.index(':')
            if index > 0:
                return public_key[(index + 1):]
        except:
            return public_key

    def get_data(self):
        # GCE metadata server requires a custom header since v1
        headers = {'X-Google-Metadata-Request': True}

        url_map = {
            'instance-id': self.metadata_address + 'instance/id',
            'availability-zone': self.metadata_address + 'instance/zone',
            'public-keys': self.metadata_address + 'project/attributes/sshKeys',
            'local-hostname': self.metadata_address + 'instance/hostname',
            'user-data': self.metadata_address + 'instance/attributes/user-data',
        }

        # if we cannot resolve the metadata server, then no point in trying
        if not util.is_resolvable(self.metadata_address):
            LOG.debug('{0} is not resolvable'.format(self.metadata_address))
            return False

        # iterate over url_map keys to get metadata items
        for mkey in url_map.iterkeys():
            try:
                resp = url_helper.readurl(
                    url=url_map[mkey], headers=headers)
                if resp.code == 200:
                    if mkey == 'public-keys':
                        pub_keys = [self._trim_key(k) for k in resp.contents.splitlines()]
                        self.metadata[mkey] = pub_keys
                    else:
                        self.metadata[mkey] = resp.contents
                else:
                    self.metadata[mkey] = None
            except url_helper.UrlError as e:
                self.metadata[mkey] = None
                LOG.warn('Failed to get {0} metadata item. Reason {1}.'.format(
                    mkey, e))
        return True

    @property
    def launch_index(self):
        # GCE does not provide lauch_index property
        return None

    def get_instance_id(self):
        return self.metadata['instance-id']

    def get_public_ssh_keys(self):
        return self.metadata['public-keys']

    def get_hostname(self, fqdn=False):
        return self.metadata['local-hostname']

    def get_userdata_raw(self):
        return self.metadata['user-data']

    @property
    def availability_zone(self):
        return self.metadata['availability-zone']

# Used to match classes to dependencies
datasources = [
    (DataSourceGCE, (sources.DEP_FILESYSTEM, sources.DEP_NETWORK)),
]


# Return a list of data sources that match this set of dependencies
def get_datasource_list(depends):
    return sources.list_from_depends(depends, datasources)