summaryrefslogtreecommitdiffstats
path: root/deploy/deploy.py
blob: 192b4ee4571da9fae9ceebf49005f03b1af8c2a3 (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
##############################################################################
# Copyright (c) 2017 ZTE Corporation and others.
#
# 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
##############################################################################

##############################################################################
# TODO:
# [ ] 1. specify VM templates (Server, Controller & Compute) in deploy.yml
# [ ] 2. specify network templates in deploy.yml
# [x] 3. specify adapter(ipmi, libvirt) in deploy.yml
# [x] 4. get ipmi user/password from PDF (Pod Descriptor File)
# [x] 5. get pxe bridge from jjb
# [x] 6. enlarge the vm size of Controller & Compute in deploy.yml
# [x] 7. support scenarios options and configuration
##############################################################################

import argparse
from jinja2 import Template
import os
import tempfile
import time
import yaml


from config.schemas import (
    MIN_DAISY_DISK_SIZE,
    deploy_schema_validate
)
from utils import (
    WORKSPACE,
    save_log_to_file,
    LI,
    LW,
    LE,
    err_exit,
    log_bar,
    path_join,
    check_sudo_privilege,
    check_file_exists,
    make_file_executable,
    confirm_dir_exists,
    merge_dicts,
    check_scenario_valid
)
from environment import (
    DaisyEnvironment,
)


class DaisyDeployment(object):
    def __init__(self, **kwargs):
        for key in kwargs:
            self.__setattr__(key, kwargs[key])

        self.deploy_struct = self._construct_final_deploy_conf(self.scenario)
        self.deploy_file, self.deploy_file_name = self._construct_final_deploy_file(self.deploy_struct, self.work_dir)

        if not self.cleanup_only:
            self.net_file_name = os.path.basename(self.net_file)
            with open(self.net_file) as yaml_file:
                self.net_struct = yaml.safe_load(yaml_file)
        else:
            self.net_struct = None

        result = deploy_schema_validate(self.deploy_struct)
        if result:
            LE(result)
            err_exit('Configuration deploy.yml check failed!')

        self.adapter = self._get_adapter_info()
        LI('The adapter is %s' % self.adapter)

        # Virtual deployment always uses 'daisy1' as default bridge.
        if self.adapter == 'libvirt':
            self.pxe_bridge = 'daisy1'

        LI('Use %s as the bridge name in daisy deployment.' % self.pxe_bridge)

        self.daisy_server_info = self._get_daisy_server_info()

        self.daisy_env = DaisyEnvironment(self.deploy_struct,
                                          self.net_struct,
                                          self.adapter,
                                          self.pxe_bridge,
                                          self.daisy_server_info,
                                          self.work_dir,
                                          self.storage_dir,
                                          self.scenario)
        return

    def _get_adapter_info(self):
        default_adapter = 'libvirt' if 'virtual' in self.pod_name else 'ipmi'
        return self.deploy_struct.get('adapter', default_adapter)

    def _get_daisy_server_info(self):
        address = self.deploy_struct.get('daisy_ip', '10.20.11.2')
        gateway = self.deploy_struct.get('daisy_gateway', '10.20.11.1')
        password = self.deploy_struct.get('daisy_passwd', 'r00tme')
        disk_size = self.deploy_struct.get('disks', {}).get('daisy', MIN_DAISY_DISK_SIZE)
        # TODO: get VM name of daisy server from deploy.yml or vm template
        name = 'daisy'
        image = path_join(self.storage_dir, name + '.qcow2')

        return {'name': name,
                'image': image,
                'address': address,
                'gateway': gateway,
                'password': password,
                'disk_size': disk_size}

    def _use_pod_descriptor_file(self):
        # INSTALLER_IP is provided by Jenkins on an OPNFV CI POD (bare metal)
        installer_ip = os.environ.get('INSTALLER_IP', '')
        if not installer_ip:
            LW('INSTALLER_IP is not provided. Use deploy.yml in POD configuration directory !')
            return None

        pdf_yaml = path_join(self.labs_dir, 'labs', self.lab_name, self.pod_name + '.yaml')
        template_file = path_join(self.labs_dir, 'installers/daisy/pod_config.yaml.j2')
        if not os.access(pdf_yaml, os.R_OK) or not os.access(template_file, os.R_OK):
            LI('There is not a POD Descriptor File or an installer template file for this deployment.')
            LI('Use deploy.yml in POD configuration directory !')
            return None

        try:
            template = Template(open(template_file).read())
            output = template.render(conf=yaml.safe_load(open(pdf_yaml)))
            deploy_struct = yaml.safe_load(output)
        except Exception as e:
            LE('Fail to use POD Descriptor File: %s' % e)
            return None

        if not deploy_struct.get('daisy_ip', ''):
            deploy_struct['daisy_ip'] = installer_ip

        dummy, deploy_file = tempfile.mkstemp(prefix='daisy_', suffix='.yml')
        fh = open(deploy_file, 'w')
        fh.write(yaml.safe_dump(deploy_struct))
        fh.close()
        LI('Use %s generated by PDO Descriptor File as deployment configuration.' % deploy_file)
        return deploy_file

    def _construct_final_deploy_conf(self, scenario):
        deploy_file = self._use_pod_descriptor_file()
        if not deploy_file:
            deploy_file = self.src_deploy_file
        check_file_exists(deploy_file)
        with open(deploy_file) as yaml_file:
            deploy_struct = yaml.safe_load(yaml_file)
        scenario_file = path_join(WORKSPACE, 'deploy/scenario/scenario.yaml')
        with open(scenario_file) as yaml_file:
            scenario_trans_conf = yaml.safe_load(yaml_file)
        if scenario in scenario_trans_conf:
            fin_scenario_file = path_join(WORKSPACE, 'deploy/scenario',
                                          scenario_trans_conf[scenario]['configfile'])
        else:
            fin_scenario_file = path_join(WORKSPACE, 'deploy/scenario', scenario)
        with open(fin_scenario_file) as yaml_file:
            deploy_scenario_conf = yaml.safe_load(yaml_file)
        deploy_scenario_override_conf = deploy_scenario_conf['deploy-override-config']
        # Only virtual deploy scenarios can override deploy.yml
        if deploy_scenario_conf and (deploy_struct['adapter'] == 'libvirt'):
            deploy_struct = dict(merge_dicts(deploy_struct, deploy_scenario_override_conf))
        modules = deploy_scenario_conf['stack-extensions']
        deploy_struct['modules'] = modules
        return deploy_struct

    def _construct_final_deploy_file(self, deploy_infor, work_dir):
        final_deploy_file_name = 'final_deploy.yml'
        final_deploy_file = path_join(work_dir, 'final_deploy.yml')
        with open(final_deploy_file, 'w') as f:
            f.write("\n".join([("title: This file automatically generated"),
                               "created: " + str(time.strftime("%d/%m/%Y")) +
                               " " + str(time.strftime("%H:%M:%S")),
                               "comment: none\n"]))
            yaml.dump(deploy_infor, f, default_flow_style=False)
        return final_deploy_file, final_deploy_file_name

    def run(self):
        self.daisy_env.delete_old_environment(skip_daisy=self.skip_daisy)
        if self.cleanup_only:
            return

        if self.skip_daisy:
            self.daisy_env.connect_daisy_server(self.remote_dir, self.bin_file,
                                                self.deploy_file_name, self.net_file_name)
        else:
            self.daisy_env.create_daisy_server()
            self.daisy_env.connect_daisy_server(self.remote_dir, self.bin_file,
                                                self.deploy_file_name, self.net_file_name)
            self.daisy_env.install_daisy()

        if self.daisy_only:
            log_bar('Create Daisy Server successfully !')
            return

        self.daisy_env.deploy(self.deploy_file, self.net_file, skip_preparation=self.skip_daisy)
        log_bar('Daisy deploy successfully !')


def config_arg_parser():
    parser = argparse.ArgumentParser(prog='python %s' % __file__,
                                     formatter_class=argparse.RawTextHelpFormatter,
                                     description='NOTE: You need ROOT privilege to run this script.')

    parser.add_argument('-L', dest='labs_dir', action='store',
                        default=None, required=True,
                        help='Base directory to store the labs configuration')

    parser.add_argument('-lab', dest='lab_name', action='store',
                        default=None, required=True,
                        help='Lab Name')
    parser.add_argument('-pod', dest='pod_name', action='store',
                        default=None, required=True,
                        help='Pod Name')

    parser.add_argument('-bin', dest='bin_file', action='store',
                        default=path_join(WORKSPACE, 'opnfv.bin'),
                        help='OPNFV Daisy BIN File')

    parser.add_argument('-S', dest='skip_daisy', action='store_true',
                        default=False,
                        help='DO NOT install Daisy Server again')

    parser.add_argument('-do', dest='daisy_only', action='store_true',
                        default=False,
                        help='Install Daisy Server only')
    parser.add_argument('-co', dest='cleanup_only', action='store_true',
                        default=False,
                        help='Cleanup VMs and Virtual Networks')

    parser.add_argument('-rdir', dest='remote_dir', action='store',
                        default='/home/daisy',
                        help='Code directory on Daisy Server')

    parser.add_argument('-wdir', dest='work_dir', action='store',
                        default='/tmp/workdir',
                        help='Temporary working directory')
    parser.add_argument('-sdir', dest='storage_dir', action='store',
                        default='/home/qemu/vms',
                        help='Storage directory for VM images')
    parser.add_argument('-B', dest='pxe_bridge', action='store',
                        default='pxebr',
                        help='Linux Bridge for booting up the Daisy Server VM\n'
                             '[default: pxebr]')
    parser.add_argument('-log', dest='deploy_log', action='store',
                        default=path_join(WORKSPACE, 'deploy.log'),
                        help='Deployment log file')
    parser.add_argument('-s', dest='scenario', action='store',
                        default='os-nosdn-nofeature-noha',
                        help='Deployment scenario')
    return parser


def parse_arguments():
    parser = config_arg_parser()
    args = parser.parse_args()

    check_sudo_privilege()

    save_log_to_file(args.deploy_log)
    LI(args)

    check_scenario_valid(args.scenario)

    conf_base_dir = path_join(args.labs_dir, 'labs', args.lab_name, args.pod_name)
    deploy_file = path_join(conf_base_dir, 'daisy/config/deploy.yml')
    net_file = path_join(conf_base_dir, 'daisy/config/network.yml')

    if not args.cleanup_only:
        check_file_exists(net_file)
    make_file_executable(args.bin_file)

    confirm_dir_exists(args.work_dir)
    confirm_dir_exists(args.storage_dir)

    kwargs = {
        'labs_dir': args.labs_dir,
        'lab_name': args.lab_name,
        'pod_name': args.pod_name,
        'src_deploy_file': deploy_file,
        'net_file': net_file,
        'bin_file': args.bin_file,
        'skip_daisy': args.skip_daisy,
        'daisy_only': args.daisy_only,
        'cleanup_only': args.cleanup_only,
        'remote_dir': args.remote_dir,
        'work_dir': args.work_dir,
        'storage_dir': args.storage_dir,
        'pxe_bridge': args.pxe_bridge,
        'deploy_log': args.deploy_log,
        'scenario': args.scenario
    }
    return kwargs


def main():
    kwargs = parse_arguments()
    deploy = DaisyDeployment(**kwargs)
    deploy.run()


if __name__ == '__main__':
    main()