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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
# vi: ts=4 expandtab
#
# Copyright (C) 2013 Canonical Ltd.
#
# Author: Ben Howard <ben.howard@canonical.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/>.
#
#
# Datasource for provisioning on SmartOS. This works on Joyent
# and public/private Clouds using SmartOS.
#
# SmartOS hosts use a serial console (/dev/ttyS1) on Linux Guests.
# The meta-data is transmitted via key/value pairs made by
# requests on the console. For example, to get the hostname, you
# would send "GET hostname" on /dev/ttyS1.
#
from cloudinit import log as logging
from cloudinit import sources
from cloudinit import util
import os
import os.path
import serial
DEF_TTY_LOC = '/dev/ttyS1'
DEF_TTY_TIMEOUT = 60
LOG = logging.getLogger(__name__)
SMARTOS_ATTRIB_MAP = {
#Cloud-init Key : (SmartOS Key, Strip line endings)
'local-hostname': ('hostname', True),
'public-keys': ('root_authorized_keys', True),
'user-script': ('user-script', False),
'user-data': ('user-data', False),
'iptables_disable': ('iptables_disable', True),
'motd_sys_info': ('motd_sys_info', True),
}
class DataSourceSmartOS(sources.DataSource):
def __init__(self, sys_cfg, distro, paths):
sources.DataSource.__init__(self, sys_cfg, distro, paths)
self.seed_dir = os.path.join(paths.seed_dir, 'sdc')
self.is_smartdc = None
self.seed = self.sys_cfg.get("serial_device", DEF_TTY_LOC)
self.seed_timeout = self.sys_cfg.get("serial_timeout",
DEF_TTY_TIMEOUT)
def __str__(self):
root = sources.DataSource.__str__(self)
return "%s [seed=%s]" % (root, self.seed)
def get_data(self):
md = {}
ud = ""
if not os.path.exists(self.seed):
LOG.debug("Host does not appear to be on SmartOS")
return False
self.seed = self.seed
dmi_info = dmi_data()
if dmi_info is False:
LOG.debug("No dmidata utility found")
return False
system_uuid, system_type = dmi_info
if 'smartdc' not in system_type.lower():
LOG.debug("Host is not on SmartOS")
return False
self.is_smartdc = True
md['instance-id'] = system_uuid
for ci_noun, attribute in SMARTOS_ATTRIB_MAP.iteritems():
smartos_noun, strip = attribute
md[ci_noun] = query_data(smartos_noun, self.seed,
self.seed_timeout, strip=strip)
if not md['local-hostname']:
md['local-hostname'] = system_uuid
if md['user-data']:
ud = md['user-data']
else:
ud = md['user-script']
self.metadata = md
self.userdata_raw = ud
return True
def get_instance_id(self):
return self.metadata['instance-id']
def get_serial(seed_device, seed_timeout):
"""This is replaced in unit testing, allowing us to replace
serial.Serial with a mocked class
The timeout value of 60 seconds should never be hit. The value
is taken from SmartOS own provisioning tools. Since we are reading
each line individually up until the single ".", the transfer is
usually very fast (i.e. microseconds) to get the response.
"""
if not seed_device:
raise AttributeError("seed_device value is not set")
ser = serial.Serial(seed_device, timeout=seed_timeout)
if not ser.isOpen():
raise SystemError("Unable to open %s" % seed_device)
return ser
def query_data(noun, seed_device, seed_timeout, strip=False):
"""Makes a request to via the serial console via "GET <NOUN>"
In the response, the first line is the status, while subsequent lines
are is the value. A blank line with a "." is used to indicate end of
response.
"""
if not noun:
return False
ser = get_serial(seed_device, seed_timeout)
ser.write("GET %s\n" % noun.rstrip())
status = str(ser.readline()).rstrip()
response = []
eom_found = False
if 'SUCCESS' not in status:
ser.close()
return None
while not eom_found:
m = ser.readline()
if m.rstrip() == ".":
eom_found = True
else:
response.append(m)
ser.close()
if not strip:
return "".join(response)
else:
return "".join(response).rstrip()
return None
def dmi_data():
sys_uuid, sys_type = None, None
dmidecode_path = util.which('dmidecode')
if not dmidecode_path:
return False
sys_uuid_cmd = [dmidecode_path, "-s", "system-uuid"]
try:
LOG.debug("Getting hostname from dmidecode")
(sys_uuid, _err) = util.subp(sys_uuid_cmd)
except Exception as e:
util.logexc(LOG, "Failed to get system UUID", e)
sys_type_cmd = [dmidecode_path, "-s", "system-product-name"]
try:
LOG.debug("Determining hypervisor product name via dmidecode")
(sys_type, _err) = util.subp(sys_type_cmd)
except Exception as e:
util.logexc(LOG, "Failed to get system UUID", e)
return sys_uuid.lower(), sys_type
# Used to match classes to dependencies
datasources = [
(DataSourceSmartOS, (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)
|
