aboutsummaryrefslogtreecommitdiffstats
path: root/deploy/deploy-config.py
blob: 2a09aa351b1e3065d15d20db25c67b0980f4d523 (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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
#!/usr/bin/python
###############################################################################
# Copyright (c) 2015 Ericsson AB and others.
# jonas.bjurel@ericsson.com
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
###############################################################################

###############################################################################
# Description
# This script constructs the final deployment dea.yaml and dha.yaml files
# The dea.yaml get's constructed from (in reverse priority):
# 1) dea-base
# 2) dea-pod-override
# 3) deployment-scenario dea-override-config section
#
# The dha.yaml get's constructed from (in reverse priority):
# 1) pod dha
# 2) deployment-scenario dha-override-config section
###############################################################################


import os
import yaml
import sys
import urllib2
import calendar
import time
import collections
import hashlib

from functools import reduce
from operator import or_
from common import (
    log,
    exec_cmd,
    err,
    warn,
    check_file_exists,
    create_dir_if_not_exists,
    delete,
    check_if_root,
    ArgParser,
)


def parse_arguments():
    parser = ArgParser(prog='python %s' % __file__)
    parser.add_argument('-dha', dest='dha_uri', action='store',
                        default=False,
                        help='dha configuration file FQDN URI',
                        required=True)
    parser.add_argument('-deab', dest='dea_base_uri', action='store',
                        default=False,
                        help='dea base configuration FQDN URI',
                        required=True)
    parser.add_argument('-deao', dest='dea_pod_override_uri',
                        action='store',
                        default=False,
                        help='dea POD override configuration FQDN URI',
                        required=True)
    parser.add_argument('-scenario-base-uri',
                        dest='scenario_base_uri',
                        action='store',
                        default=False,
                        help='Deployment scenario base directory URI',
                        required=True)
    parser.add_argument('-scenario', dest='scenario', action='store',
                        default=False,
                        help=('Deployment scenario short-name (priority), '
                              'or base file name (in the absense of a '
                              'shortname defenition)'),
                        required=True)

    parser.add_argument('-plugins', dest='plugins_uri', action='store',
                        default=False,
                        help='Plugin configurations directory URI',
                        required=True)
    parser.add_argument('-output', dest='output_path', action='store',
                        default=False,
                        help='Local path for resulting output configuration files',
                        required=True)
    args = parser.parse_args()
    kwargs = {'dha_uri': args.dha_uri,
              'dea_base_uri': args.dea_base_uri,
              'dea_pod_override_uri': args.dea_pod_override_uri,
              'scenario_base_uri': args.scenario_base_uri,
              'scenario': args.scenario,
              'plugins_uri': args.plugins_uri,
              'output_path': args.output_path}
    return kwargs


def warning(msg):
    red = '\033[0;31m'
    NC = '\033[0m'
    print('%(red)s WARNING: %(msg)s %(NC)s' % {'red': red,
                                               'msg': msg,
                                               'NC': NC})


def setup_yaml():
    represent_dict_order = lambda self, data: self.represent_mapping('tag:yaml.org,2002:map', data.items())
    yaml.add_representer(collections.OrderedDict, represent_dict_order)


def sha_uri(uri):
    response = urllib2.urlopen(uri)
    data = response.read()
    sha1 = hashlib.sha1()
    sha1.update(data)
    return sha1.hexdigest()


def merge_fuel_plugin_version_list(list1, list2):
    final_list = []
    # When the plugin version in not there in list1 it will
    # not be copied
    for e_l1 in list1:
        plugin_version = e_l1.get('metadata', {}).get('plugin_version')
        plugin_version_found = False
        for e_l2 in list2:
            if plugin_version == e_l2.get('metadata', {}).get('plugin_version'):
                final_list.append(dict(merge_dicts(e_l1, e_l2)))
                plugin_version_found = True
        if not plugin_version_found:
            final_list.append(e_l1)
    return final_list


def merge_networks(list_1, list_2):
    new_nets = {x.get('name'): x for x in list_2}

    return [new_nets.get(net.get('name'), net) for net in list_1]


def merge_dicts(dict1, dict2):
    for k in set(dict1).union(dict2):
        if k in dict1 and k in dict2:
            if isinstance(dict1[k], dict) and isinstance(dict2[k], dict):
                yield (k, dict(merge_dicts(dict1[k], dict2[k])))
                continue
            if isinstance(dict1[k], list) and isinstance(dict2[k], list):
                if k == 'versions':
                    yield (k,
                           merge_fuel_plugin_version_list(dict1[k], dict2[k]))
                    continue
                if k == 'networks':
                    yield (k,
                           merge_networks(dict1[k], dict2[k]))
                    continue

            # If one of the values is not a dict nor a list,
            # you can't continue merging it.
            # Value from second dict overrides one in first if exists.
        if k in dict2:
            yield (k, dict2[k])
        else:
            yield (k, dict1[k])


def get_node_ifaces_and_trans(nodes, nid):
    for node in nodes:
        if node['id'] == nid:
            if 'transformations' in node and 'interfaces' in node:
                return (node['interfaces'], node['transformations'])
            else:
                return None

    return None


class DeployConfig(object):
    def __init__(self):
        self.kwargs = parse_arguments()
        self.dea_conf = dict()
        self.dea_metadata = dict()
        self.dea_pod_ovr_metadata = dict()
        self.dea_pod_ovr_nodes = None
        self.scenario_metadata = dict()
        self.modules = []
        self.module_uris = []
        self.module_titles = []
        self.module_versions = []
        self.module_createds = []
        self.module_shas = []
        self.module_comments = []
        self.dha_pod_conf = dict()
        self.dha_metadata = dict()

    def process_dea_base(self):
        # Generate final dea.yaml by merging following config files/fragments in reverse priority order:
        # "dea-base", "dea-pod-override", "deplyment-scenario/module-config-override"
        # and "deployment-scenario/dea-override"
        print('Generating final dea.yaml configuration....')

        # Fetch dea-base, extract and purge meta-data
        print('Parsing dea-base from: ' + self.kwargs["dea_base_uri"] + "....")
        response = urllib2.urlopen(self.kwargs["dea_base_uri"])
        dea_conf = yaml.load(response.read())

        dea_metadata = dict()
        dea_metadata['title'] = dea_conf['dea-base-config-metadata']['title']
        dea_metadata['version'] = dea_conf['dea-base-config-metadata']['version']
        dea_metadata['created'] = dea_conf['dea-base-config-metadata']['created']
        dea_metadata['sha'] = sha_uri(self.kwargs["dea_base_uri"])
        dea_metadata['comment'] = dea_conf['dea-base-config-metadata']['comment']
        self.dea_metadata = dea_metadata
        dea_conf.pop('dea-base-config-metadata')
        self.dea_conf = dea_conf

    def process_dea_pod_override(self):
        # Fetch dea-pod-override, extract and purge meta-data, merge with previous dea data structure
        print('Parsing the dea-pod-override from: ' + self.kwargs["dea_pod_override_uri"] + "....")
        response = urllib2.urlopen(self.kwargs["dea_pod_override_uri"])
        dea_pod_override_conf = yaml.load(response.read())

        if dea_pod_override_conf:
            metadata = dict()
            metadata['title'] = dea_pod_override_conf['dea-pod-override-config-metadata']['title']
            metadata['version'] = dea_pod_override_conf['dea-pod-override-config-metadata']['version']
            metadata['created'] = dea_pod_override_conf['dea-pod-override-config-metadata']['created']
            metadata['sha'] = sha_uri(self.kwargs["dea_pod_override_uri"])
            metadata['comment'] = dea_pod_override_conf['dea-pod-override-config-metadata']['comment']
            self.dea_pod_ovr_metadata = metadata

            print('Merging dea-base and dea-pod-override configuration ....')
            dea_pod_override_conf.pop('dea-pod-override-config-metadata')

            # Copy the list of original nodes, which holds info on their transformations
            if 'nodes' in dea_pod_override_conf:
                self.dea_pod_ovr_nodes = list(dea_pod_override_conf['nodes'])
            if dea_pod_override_conf:
                self.dea_conf = dict(merge_dicts(self.dea_conf, dea_pod_override_conf))

    def get_scenario_uri(self):
        response = urllib2.urlopen(self.kwargs["scenario_base_uri"] + "/scenario.yaml")
        scenario_short_translation_conf = yaml.load(response.read())
        if self.kwargs["scenario"] in scenario_short_translation_conf:
            scenario_uri = (self.kwargs["scenario_base_uri"]
                            + "/"
                            + scenario_short_translation_conf[self.kwargs["scenario"]]['configfile'])
        else:
            scenario_uri = self.kwargs["scenario_base_uri"] + "/" + self.kwargs["scenario"]

        return scenario_uri

    def get_scenario_config(self):
        self.scenario_metadata['uri'] = self.get_scenario_uri()
        response = urllib2.urlopen(self.scenario_metadata['uri'])
        return yaml.load(response.read())

    def process_modules(self):
        scenario_conf = self.get_scenario_config()
        if scenario_conf["stack-extensions"]:
            for module in scenario_conf["stack-extensions"]:
                print('Loading configuration for module: '
                      + module["module"]
                      + ' and merging it to final dea.yaml configuration....')
                response = urllib2.urlopen(self.kwargs["plugins_uri"]
                                           + '/'
                                           + module["module-config-name"]
                                           + '_'
                                           + module["module-config-version"]
                                           + '.yaml')
                module_conf = yaml.load(response.read())
                self.modules.append(module["module"])
                self.module_uris.append(self.kwargs["plugins_uri"]
                                        + '/'
                                        + module["module-config-name"]
                                        + '_'
                                        + module["module-config-version"]
                                        + '.yaml')
                self.module_titles.append(str(module_conf['plugin-config-metadata']['title']))
                self.module_versions.append(str(module_conf['plugin-config-metadata']['version']))
                self.module_createds.append(str(module_conf['plugin-config-metadata']['created']))
                self.module_shas.append(sha_uri(self.kwargs["plugins_uri"]
                                                + '/'
                                                + module["module-config-name"]
                                                + '_'
                                                + module["module-config-version"]
                                                + '.yaml'))
                self.module_comments.append(str(module_conf['plugin-config-metadata']['comment']))
                module_conf.pop('plugin-config-metadata')
                self.dea_conf['settings']['editable'].update(module_conf)

                scenario_module_override_conf = module.get('module-config-override')
                if scenario_module_override_conf:
                    dea_scenario_module_override_conf = {}
                    dea_scenario_module_override_conf['settings'] = {}
                    dea_scenario_module_override_conf['settings']['editable'] = {}
                    dea_scenario_module_override_conf['settings']['editable'][module["module"]] = scenario_module_override_conf
                    self.dea_conf = dict(merge_dicts(self.dea_conf, dea_scenario_module_override_conf))

    def process_scenario_config(self):
        # Fetch deployment-scenario, extract and purge meta-data, merge deployment-scenario/
        # dea-override-configith previous dea data structure
        print('Parsing deployment-scenario from: ' + self.kwargs["scenario"] + "....")

        scenario_conf = self.get_scenario_config()

        metadata = dict()
        if scenario_conf:
            metadata['title'] = scenario_conf['deployment-scenario-metadata']['title']
            metadata['version'] = scenario_conf['deployment-scenario-metadata']['version']
            metadata['created'] = scenario_conf['deployment-scenario-metadata']['created']
            metadata['sha'] = sha_uri(self.scenario_metadata['uri'])
            metadata['comment'] = scenario_conf['deployment-scenario-metadata']['comment']
            self.scenario_metadata = metadata
            scenario_conf.pop('deployment-scenario-metadata')
        else:
            print("Deployment scenario file not found or is empty")
            print("Cannot continue, exiting ....")
            sys.exit(1)

        dea_scenario_override_conf = scenario_conf["dea-override-config"]
        if dea_scenario_override_conf:
            print('Merging dea-base-, dea-pod-override- and deployment-scenario '
                  'configuration into final dea.yaml configuration....')
            self.dea_conf = dict(merge_dicts(self.dea_conf, dea_scenario_override_conf))

        self.process_modules()

        # Fetch plugin-configuration configuration files, extract and purge meta-data,
        # merge/append with previous dea data structure, override plugin-configuration with
        # deploy-scenario/module-config-override

        if self.dea_pod_ovr_nodes:
            for node in self.dea_conf['nodes']:
                data = get_node_ifaces_and_trans(self.dea_pod_ovr_nodes, node['id'])
                if data:
                    print("Honoring original interfaces and transformations for "
                          "node %d to %s, %s" % (node['id'], data[0], data[1]))
                    node['interfaces'] = data[0]
                    node['transformations'] = data[1]

    def dump_dea_config(self):
        # Dump final dea.yaml including configuration management meta-data to argument provided
        # directory
        path = self.kwargs["output_path"]
        if not os.path.exists(path):
            os.makedirs(path)
        print('Dumping final dea.yaml to ' + path + '/dea.yaml....')
        with open(path + '/dea.yaml', "w") as f:
            f.write("\n".join([("title: DEA.yaml file automatically generated from the "
                                'configuration files stated in the "configuration-files" '
                                "fragment below"),
                               "version: " + str(calendar.timegm(time.gmtime())),
                               "created: " + time.strftime("%d/%m/%Y %H:%M:%S"),
                               "comment: none\n"]))

            f.write("\n".join(["configuration-files:",
                               "  dea-base:",
                               "    uri: " + self.kwargs["dea_base_uri"],
                               "    title: " + self.dea_metadata['title'],
                               "    version: " + self.dea_metadata['version'],
                               "    created: " + self.dea_metadata['created'],
                               "    sha1: " + sha_uri(self.kwargs["dea_base_uri"]),
                               "    comment: " + self.dea_metadata['comment'] + "\n"]))

            f.write("\n".join(["  pod-override:",
                               "    uri: " + self.kwargs["dea_pod_override_uri"],
                               "    title: " + self.dea_pod_ovr_metadata['title'],
                               "    version: " + self.dea_pod_ovr_metadata['version'],
                               "    created: " + self.dea_pod_ovr_metadata['created'],
                               "    sha1: " + self.dea_pod_ovr_metadata['sha'],
                               "    comment: " + self.dea_pod_ovr_metadata['comment'] + "\n"]))

            f.write("\n".join(["  deployment-scenario:",
                               "    uri: " + self.scenario_metadata['uri'],
                               "    title: " + self.scenario_metadata['title'],
                               "    version: " + self.scenario_metadata['version'],
                               "    created: " + self.scenario_metadata['created'],
                               "    sha1: " + self.scenario_metadata['sha'],
                               "    comment: " + self.scenario_metadata['comment'] + "\n"]))

            f.write("  plugin-modules:\n")
            for k, _ in enumerate(self.modules):
                f.write("\n".join(["  - module: " + self.modules[k],
                                   "    uri: " + self.module_uris[k],
                                   "    title: " + self.module_titles[k],
                                   "    version: " + self.module_versions[k],
                                   "    created: " + self.module_createds[k],
                                   "    sha-1: " + self.module_shas[k],
                                   "    comment: " + self.module_comments[k] + "\n"]))

            yaml.dump(self.dea_conf, f, default_flow_style=False)

    def process_dha_pod_config(self):
        # Load POD dha and override it with "deployment-scenario/dha-override-config" section
        print('Generating final dha.yaml configuration....')
        print('Parsing dha-pod yaml configuration....')
        response = urllib2.urlopen(self.kwargs["dha_uri"])
        dha_pod_conf = yaml.load(response.read())

        dha_metadata = dict()
        dha_metadata['title'] = dha_pod_conf['dha-pod-config-metadata']['title']
        dha_metadata['version'] = dha_pod_conf['dha-pod-config-metadata']['version']
        dha_metadata['created'] = dha_pod_conf['dha-pod-config-metadata']['created']
        dha_metadata['sha'] = sha_uri(self.kwargs["dha_uri"])
        dha_metadata['comment'] = dha_pod_conf['dha-pod-config-metadata']['comment']
        self.dha_metadata = dha_metadata
        dha_pod_conf.pop('dha-pod-config-metadata')
        self.dha_pod_conf = dha_pod_conf

        scenario_conf = self.get_scenario_config()
        dha_scenario_override_conf = scenario_conf["dha-override-config"]
        # Only virtual deploy scenarios can override dha.yaml since there
        # is no way to programatically override a physical environment:
        # wireing, IPMI set-up, etc.
        # For Physical environments, dha.yaml overrides will be silently ignored
        if dha_scenario_override_conf and (dha_pod_conf['adapter'] == 'libvirt'
                                           or dha_pod_conf['adapter'] == 'esxi'
                                           or dha_pod_conf['adapter'] == 'vbox'):
            print('Merging dha-pod and deployment-scenario override information to final dha.yaml configuration....')
            self.dha_pod_conf = dict(merge_dicts(self.dha_pod_conf, dha_scenario_override_conf))

    def dump_dha_config(self):
        # Dump final dha.yaml to argument provided directory
        path = self.kwargs["output_path"]
        print('Dumping final dha.yaml to ' + path + '/dha.yaml....')
        with open(path + '/dha.yaml', "w") as f:
            f.write("\n".join([("title: DHA.yaml file automatically generated from "
                                "the configuration files stated in the "
                                '"configuration-files" fragment below'),
                               "version: " + str(calendar.timegm(time.gmtime())),
                               "created: " + time.strftime("%d/%m/%Y %H:%M:%S"),
                               "comment: none\n"]))

            f.write("configuration-files:\n")

            f.write("\n".join(["  dha-pod-configuration:",
                               "    uri: " + self.kwargs["dha_uri"],
                               "    title: " + self.dha_metadata['title'],
                               "    version: " + self.dha_metadata['version'],
                               "    created: " + self.dha_metadata['created'],
                               "    sha-1: " + self.dha_metadata['sha'],
                               "    comment: " + self.dha_metadata['comment'] + "\n"]))

            f.write("\n".join(["  deployment-scenario:",
                               "    uri: " + self.scenario_metadata['uri'],
                               "    title: " + self.scenario_metadata['title'],
                               "    version: " + self.scenario_metadata['version'],
                               "    created: " + self.scenario_metadata['created'],
                               "    sha-1: " + self.scenario_metadata['sha'],
                               "    comment: " + self.scenario_metadata['comment'] + "\n"]))

            yaml.dump(self.dha_pod_conf, f, default_flow_style=False)


def main():
    setup_yaml()

    deploy_config = DeployConfig()
    deploy_config.process_dea_base()
    deploy_config.process_dea_pod_override()
    deploy_config.process_scenario_config()
    deploy_config.dump_dea_config()

    deploy_config.process_dha_pod_config()
    deploy_config.dump_dha_config()


if __name__ == '__main__':
    main()