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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
from base64 import b64encode
import logging
import pprint
import os
import yaml
from .charm import Charm
from .feedback import Feedback
from .service import Service, ServiceUnitPlacementV3, ServiceUnitPlacementV4
from .relation import Endpoint
from .utils import path_join, yaml_dump, ErrorExit, resolve_include, x_in_y
class Deployment(object):
log = logging.getLogger("deployer.deploy")
def __init__(self, name, data, include_dirs, repo_path="", version=3):
self.name = name
self.data = data
self.include_dirs = include_dirs
self.repo_path = repo_path
self.version = version
self.machines = {}
@property
def series(self):
# Series could use a little help, charm series should be inferred
# directly from a store url
return self.data.get('series', 'precise')
@property
def series_path(self):
return path_join(self.repo_path, self.series)
def pretty_print(self):
pprint.pprint(self.data)
def get_service(self, name):
if not name in self.data['services']:
return
return Service(name, self.data['services'][name])
def get_services(self):
services = []
for name, svc_data in self.data.get('services', {}).items():
services.append(Service(name, svc_data))
if self.version == 3:
# Sort unplaced units first, then sort by name for placed units.
services.sort(key=lambda svc: (bool(svc.unit_placement), svc.name))
else:
services.sort(self._machines_placement_sort)
return services
def set_machines(self, machines):
"""Set a dict of machines, mapping from the names in the machine spec
to the machine names in the environment status.
"""
self.machines = machines
def get_machines(self):
"""Return a dict mapping machine names to machine options.
An empty dict is returned if no machines are defined in the
bundle YAML.
"""
machines = {}
for key, machine in self.data.get('machines', {}).items():
machines[str(key)] = machine
return machines
def get_service_names(self):
"""Return a sequence of service names for this deployment."""
return self.data.get('services', {}).keys()
@staticmethod
def _machines_placement_sort(svc_a, svc_b):
"""Sort machines with machine placement in mind.
If svc_a is colocated alongside svc_b, svc_b needs to be deployed
first, so that it exists by the time svc_a is deployed, and vice
versa; this sorts first based on this fact, then secondly based on
whether or not the service has a unit placement, and then finally
based on the name of the service.
"""
if svc_a.unit_placement:
if svc_b.unit_placement:
# Check for colocation. This naively assumes that there is no
# circularity in placements.
if x_in_y(svc_b, svc_a):
return -1
if x_in_y(svc_a, svc_b):
return 1
# If no colocation exists, simply compare names.
return cmp(svc_a.name, svc_b.name)
return 1
if svc_b.unit_placement:
return -1
return cmp(svc_a.name, svc_b.name)
def get_unit_placement(self, svc, status):
if isinstance(svc, (str, unicode)):
svc = self.get_service(svc)
if self.version == 3:
return ServiceUnitPlacementV3(svc, self, status)
else:
return ServiceUnitPlacementV4(svc, self, status,
machines_map=self.machines)
def get_relations(self):
if 'relations' not in self.data:
return
# Strip duplicate rels
seen = set()
def check(a, b):
k = tuple(sorted([a, b]))
if k in seen:
#self.log.warning(" Skipping duplicate relation %r" % (k,))
return
seen.add(k)
return True
# Support an ordered list of [endpoints]
if isinstance(self.data['relations'], list):
for end_a, end_b in self.data['relations']:
# Allow shorthand of [end_a, [end_b, end_c]]
if isinstance(end_b, list):
for eb in end_b:
if check(end_a, eb):
yield (end_a, eb)
else:
if check(end_a, end_b):
yield (end_a, end_b)
return
# Legacy format (dictionary of dictionaries with weights)
rels = {}
for k, v in self.data['relations'].items():
expanded = []
for c in v['consumes']:
expanded.append((k, c))
by_weight = rels.setdefault(v.get('weight', 0), [])
by_weight.extend(expanded)
for k in sorted(rels, reverse=True):
for r in rels[k]:
if check(*r):
yield r
#self.log.debug(
# "Found relations %s\n %s" % (" ".join(map(str, seen))))
def get_charms(self):
for k, v in self.data.get('services', {}).items():
yield Charm.from_service(k, self.repo_path, self.series, v)
def get_charm_for(self, svc_name):
svc_data = self.data['services'][svc_name]
return Charm.from_service(
svc_name, self.repo_path, self.series, svc_data)
def fetch_charms(self, update=False, no_local_mods=False):
for charm in self.get_charms():
if charm.is_local():
if charm.exists():
if no_local_mods and charm.is_modified():
self.log.warning(
"Charm %r has local modifications",
charm.path)
raise ErrorExit()
if charm.rev or update:
if charm.rev and charm.is_modified():
self.log.warning((
"Charm %r with pinned revision has"
" local modifications"), charm.path)
raise ErrorExit()
charm.update(build=True)
continue
elif not os.path.exists(charm.series_path):
os.mkdir(charm.series_path)
charm.fetch()
def resolve(self, cli_overides=()):
# Once we have charms definitions available, we can do verification
# of config options.
self.load_overrides(cli_overides)
self.resolve_config()
self.validate_relations()
self.validate_placement()
def load_overrides(self, cli_overrides=()):
"""Load overrides."""
overrides = {}
overrides.update(self.data.get('overrides', {}))
for o in cli_overrides:
key, value = o.split('=', 1)
overrides[key] = value
for k, v in overrides.iteritems():
found = False
for svc_name, svc_data in self.data['services'].items():
charm = self.get_charm_for(svc_name)
if k in charm.config:
if 'options' not in svc_data:
svc_data['options'] = {}
svc_data['options'][k] = v
found = True
if not found:
self.log.warning(
"Override %s does not match any charms", k)
def resolve_config(self):
"""Load any lazy config values (includes), and verify config options.
"""
self.log.debug("Resolving configuration")
# XXX TODO, rename resolve, validate relations
# against defined services
feedback = Feedback()
for svc_name, svc_data in self.data.get('services', {}).items():
if not 'options' in svc_data:
continue
charm = self.get_charm_for(svc_name)
config = charm.config
options = {}
svc_options = svc_data.get('options', {})
if svc_options is None:
svc_options = {}
for k, v in svc_options.items():
if not k in config:
feedback.error(
"Invalid config charm %s %s=%s" % (charm.name, k, v))
continue
iv = self._resolve_include(svc_name, k, v)
if isinstance(iv, Feedback):
feedback.extend(iv)
continue
if iv is not None:
v = iv
options[k] = v
svc_data['options'] = options
self._handle_feedback(feedback)
def _resolve_include(self, svc_name, k, v):
feedback = Feedback()
for include_type in ["file", "base64"]:
if (not isinstance(v, basestring)
or not v.startswith(
"include-%s://" % include_type)):
continue
include, fname = v.split("://", 1)
ip = resolve_include(fname, self.include_dirs)
if ip is None:
feedback.error(
"Invalid config %s.%s include not found %s" % (
svc_name, k, v))
continue
with open(ip) as fh:
v = fh.read()
if include_type == "base64":
v = b64encode(v)
return v
if feedback:
return feedback
def validate_relations(self):
# Could extend to do interface matching against charms.
services = dict([(s.name, s) for s in self.get_services()])
feedback = Feedback()
for e_a, e_b in self.get_relations():
for ep in [Endpoint(e_a), Endpoint(e_b)]:
if not ep.service in services:
feedback.error(
("Invalid relation in config,"
" service %s not found, rel %s") % (
ep.service, "%s <-> %s" % (e_a, e_b)))
continue
self._handle_feedback(feedback)
def validate_placement(self):
services = dict([(s.name, s) for s in self.get_services()])
feedback = Feedback()
for name, s in services.items():
placement = self.get_unit_placement(s, {})
feedback.extend(placement.validate())
self._handle_feedback(feedback)
def _handle_feedback(self, feedback):
for e in feedback.get_errors():
self.log.error(e)
for w in feedback.get_warnings():
self.log.warning(w)
if feedback.has_errors:
raise ErrorExit()
def save(self, path):
with open(path, "w") as fh:
fh.write(yaml_dump(self.data))
@staticmethod
def to_yaml(dumper, deployment):
return dumper.represent_dict(deployment.data)
yaml.add_representer(Deployment, Deployment.to_yaml)
|