1 ##############################################################################
2 # Copyright (c) 2017 Tim Rozet (trozet@redhat.com) and others.
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
20 from apex.common import constants as con
21 from apex.common.exceptions import ApexDeployException
22 from apex.common import parsers
23 from apex.virtual import virtual_utils as virt_utils
24 from cryptography.hazmat.primitives import serialization as \
26 from cryptography.hazmat.primitives.asymmetric import rsa
27 from cryptography.hazmat.backends import default_backend as \
28 crypto_default_backend
33 'sfc': 'opendaylight_sfc.yaml',
34 'vpn': 'neutron-bgpvpn-opendaylight.yaml',
35 'gluon': 'gluon.yaml',
37 'odl_vpp_netvirt': 'neutron-opendaylight-netvirt-vpp.yaml',
38 'default': 'neutron-opendaylight-honeycomb.yaml'
40 'default': 'neutron-opendaylight.yaml',
43 'sfc': 'neutron-onos-sfc.yaml',
44 'default': 'neutron-onos.yaml'
46 'ovn': 'neutron-ml2-ovn.yaml',
48 'vpp': 'neutron-ml2-vpp.yaml',
49 'dataplane': ('ovs_dpdk', 'neutron-ovs-dpdk.yaml')
54 'tacker': 'enable_tacker.yaml',
55 'congress': 'enable_congress.yaml',
56 'barometer': 'enable_barometer.yaml',
57 'rt_kvm': 'enable_rt_kvm.yaml'
61 'HostCpusList': 'dpdk_cores',
62 'NeutronDpdkCoreList': 'pmd_cores',
63 'NeutronDpdkSocketMemory': 'socket_memory',
64 'NeutronDpdkMemoryChannels': 'memory_channels'
67 OVS_NSH_KMOD_RPM = "openvswitch-kmod-2.6.1-1.el7.centos.x86_64.rpm"
68 OVS_NSH_RPM = "openvswitch-2.6.1-1.el7.centos.x86_64.rpm"
69 ODL_NETVIRT_VPP_RPM = "/root/opendaylight-7.0.0-0.1.20170531snap665.el7" \
73 def build_sdn_env_list(ds, sdn_map, env_list=None):
76 for k, v in sdn_map.items():
77 if ds['sdn_controller'] == k or (k in ds and ds[k] is True):
78 if isinstance(v, dict):
79 env_list.extend(build_sdn_env_list(ds, v))
81 env_list.append(os.path.join(con.THT_ENV_DIR, v))
82 elif isinstance(v, tuple):
84 env_list.append(os.path.join(con.THT_ENV_DIR, v[1]))
85 if len(env_list) == 0:
87 env_list.append(os.path.join(
88 con.THT_ENV_DIR, sdn_map[ds['sdn_controller']]['default']))
90 logging.warning("Unable to find default file for SDN")
95 def create_deploy_cmd(ds, ns, inv, tmp_dir,
96 virtual, env_file='opnfv-environment.yaml'):
98 logging.info("Creating deployment command")
99 deploy_options = [env_file, 'network-environment.yaml']
100 ds_opts = ds['deploy_options']
101 deploy_options += build_sdn_env_list(ds_opts, SDN_FILE_MAP)
103 # TODO(trozet): make sure rt kvm file is in tht dir
104 for k, v in OTHER_FILE_MAP.items():
105 if k in ds_opts and ds_opts[k]:
106 deploy_options.append(os.path.join(con.THT_ENV_DIR, v))
109 prep_storage_env(ds, tmp_dir)
110 deploy_options.append(os.path.join(con.THT_ENV_DIR,
111 'storage-environment.yaml'))
112 if ds['global_params']['ha_enabled']:
113 deploy_options.append(os.path.join(con.THT_ENV_DIR,
114 'puppet-pacemaker.yaml'))
117 deploy_options.append('virtual-environment.yaml')
119 deploy_options.append('baremetal-environment.yaml')
125 if node['capabilities'] == 'profile:control':
127 elif node['capabilities'] == 'profile:compute':
130 # TODO(trozet) do we want to allow capabilities to not exist?
131 logging.error("Every node must include a 'capabilities' key "
132 "tagged with either 'profile:control' or "
134 raise ApexDeployException("Node missing capabilities "
135 "key: {}".format(node))
136 if num_control == 0 or num_compute == 0:
137 logging.error("Detected 0 control or compute nodes. Control nodes: "
138 "{}, compute nodes{}".format(num_control, num_compute))
139 raise ApexDeployException("Invalid number of control or computes")
140 elif num_control > 1 and not ds['global_params']['ha_enabled']:
142 cmd = "openstack overcloud deploy --templates --timeout {} " \
143 "--libvirt-type kvm".format(con.DEPLOY_TIMEOUT)
145 for option in deploy_options:
146 cmd += " -e {}".format(option)
147 cmd += " --ntp-server {}".format(ns['ntp'][0])
148 cmd += " --control-scale {}".format(num_control)
149 cmd += " --compute-scale {}".format(num_compute)
150 cmd += ' --control-flavor control --compute-flavor compute'
151 logging.info("Deploy command set: {}".format(cmd))
153 with open(os.path.join(tmp_dir, 'deploy_command'), 'w') as fh:
158 def prep_image(ds, img, tmp_dir, root_pw=None):
160 Locates sdn image and preps for deployment.
161 :param ds: deploy settings
162 :param img: sdn image
163 :param tmp_dir: dir to store modified sdn image
164 :param root_pw: password to configure for overcloud image
167 # TODO(trozet): Come up with a better way to organize this logic in this
169 logging.info("Preparing image: {} for deployment".format(img))
170 if not os.path.isfile(img):
171 logging.error("Missing SDN image {}".format(img))
172 raise ApexDeployException("Missing SDN image file: {}".format(img))
174 ds_opts = ds['deploy_options']
176 sdn = ds_opts['sdn_controller']
177 # we need this due to rhbz #1436021
178 # fixed in systemd-219-37.el7
180 logging.info("Neutron openvswitch-agent disabled")
183 "rm -f /etc/systemd/system/multi-user.target.wants/"
184 "neutron-openvswitch-agent.service"},
187 "rm -f /usr/lib/systemd/system/neutron-openvswitch-agent"
192 virt_cmds.append({con.VIRT_RUN_CMD: "systemctl enable zrpcd"})
193 logging.info("ZRPC and Quagga enabled")
195 dataplane = ds_opts['dataplane']
196 if dataplane == 'ovs_dpdk' or dataplane == 'fdio':
197 logging.info("Enabling kernel modules for dpdk")
198 # file to module mapping
200 os.path.join(tmp_dir, 'vfio_pci.modules'): 'vfio_pci',
201 os.path.join(tmp_dir, 'uio_pci_generic.modules'): 'uio_pci_generic'
203 for mod_file, mod in uio_types.items():
204 with open(mod_file, 'w') as fh:
205 fh.write('#!/bin/bash\n')
206 fh.write('exec /sbin/modprobe {}'.format(mod))
210 {con.VIRT_UPLOAD: "{}:/etc/sysconfig/modules/".format(
212 {con.VIRT_RUN_CMD: "chmod 0755 /etc/sysconfig/modules/"
213 "{}".format(os.path.basename(mod_file))}
216 pw_op = "password:{}".format(root_pw)
217 virt_cmds.append({con.VIRT_PW: pw_op})
218 if ds_opts['sfc'] and dataplane == 'ovs':
220 {con.VIRT_RUN_CMD: "yum -y install "
221 "/root/ovs/rpm/rpmbuild/RPMS/x86_64/"
222 "{}".format(OVS_NSH_KMOD_RPM)},
223 {con.VIRT_RUN_CMD: "yum upgrade -y "
224 "/root/ovs/rpm/rpmbuild/RPMS/x86_64/"
225 "{}".format(OVS_NSH_RPM)}
227 if dataplane == 'fdio':
228 # Patch neutron with using OVS external interface for router
229 # and add generic linux NS interface driver
231 {con.VIRT_RUN_CMD: "cd /usr/lib/python2.7/site-packages && patch "
232 "-p1 < neutron-patch-NSDriver.patch"})
234 if sdn == 'opendaylight':
235 if ds_opts['odl_version'] != con.DEFAULT_ODL_VERSION:
237 {con.VIRT_RUN_CMD: "yum -y remove opendaylight"},
238 {con.VIRT_RUN_CMD: "yum -y install /root/{}/*".format(
239 con.DEFAULT_ODL_VERSION)},
240 {con.VIRT_RUN_CMD: "rm -rf /etc/puppet/modules/opendaylight"},
241 {con.VIRT_RUN_CMD: "cd /etc/puppet/modules && tar xzf "
242 "/root/puppet-opendaylight-"
243 "{}.tar.gz".format(ds_opts['odl_version'])}
245 elif sdn == 'opendaylight' and 'odl_vpp_netvirt' in ds_opts \
246 and ds_opts['odl_vpp_netvirt']:
248 {con.VIRT_RUN_CMD: "yum -y remove opendaylight"},
249 {con.VIRT_RUN_CMD: "yum -y install /root/{}/*".format(
250 ODL_NETVIRT_VPP_RPM)}
255 {con.VIRT_RUN_CMD: "cd /root/ovs28 && yum update -y "
257 {con.VIRT_RUN_CMD: "cd /root/ovs28 && yum downgrade -y "
261 tmp_oc_image = os.path.join(tmp_dir, 'overcloud-full.qcow2')
262 shutil.copyfile(img, tmp_oc_image)
263 logging.debug("Temporary overcloud image stored as: {}".format(
265 virt_utils.virt_customize(virt_cmds, tmp_oc_image)
266 logging.info("Overcloud image customization complete")
271 Creates public and private ssh keys with 1024 bit RSA encryption
272 :return: private, public key
274 key = rsa.generate_private_key(
275 backend=crypto_default_backend(),
276 public_exponent=65537,
280 private_key = key.private_bytes(
281 crypto_serialization.Encoding.PEM,
282 crypto_serialization.PrivateFormat.PKCS8,
283 crypto_serialization.NoEncryption())
284 public_key = key.public_key().public_bytes(
285 crypto_serialization.Encoding.OpenSSH,
286 crypto_serialization.PublicFormat.OpenSSH
288 pub_key = re.sub('ssh-rsa\s*', '', public_key.decode('utf-8'))
289 return private_key.decode('utf-8'), pub_key
292 def prep_env(ds, ns, opnfv_env, net_env, tmp_dir):
294 Creates modified opnfv/network environments for deployment
295 :param ds: deploy settings
296 :param ns: network settings
297 :param opnfv_env: file path for opnfv-environment file
298 :param net_env: file path for network-environment file
299 :param tmp_dir: Apex tmp dir
303 logging.info("Preparing opnfv-environment and network-environment files")
304 ds_opts = ds['deploy_options']
305 tmp_opnfv_env = os.path.join(tmp_dir, os.path.basename(opnfv_env))
306 shutil.copyfile(opnfv_env, tmp_opnfv_env)
307 tenant_nic_map = ns['networks']['tenant']['nic_mapping']
308 tenant_ctrl_nic = tenant_nic_map['controller']['members'][0]
309 tenant_comp_nic = tenant_nic_map['compute']['members'][0]
312 private_key, public_key = make_ssh_key()
314 # Make easier/faster variables to index in the file editor
315 if 'performance' in ds_opts:
318 if 'vpp' in ds_opts['performance']['Compute']:
319 perf_vpp_comp = ds_opts['performance']['Compute']['vpp']
322 if 'vpp' in ds_opts['performance']['Controller']:
323 perf_vpp_ctrl = ds_opts['performance']['Controller']['vpp']
328 if 'ovs' in ds_opts['performance']['Compute']:
329 perf_ovs_comp = ds_opts['performance']['Compute']['ovs']
334 if 'kernel' in ds_opts['performance']['Compute']:
335 perf_kern_comp = ds_opts['performance']['Compute']['kernel']
337 perf_kern_comp = None
341 # Modify OPNFV environment
342 # TODO: Change to build a dict and outputing yaml rather than parsing
343 for line in fileinput.input(tmp_opnfv_env, inplace=True):
344 line = line.strip('\n')
346 if 'CloudDomain' in line:
347 output_line = " CloudDomain: {}".format(ns['domain_name'])
348 elif 'replace_private_key' in line:
349 output_line = " key: '{}'".format(private_key)
350 elif 'replace_public_key' in line:
351 output_line = " key: '{}'".format(public_key)
353 if ds_opts['sdn_controller'] == 'opendaylight' and \
354 'odl_vpp_routing_node' in ds_opts and ds_opts[
355 'odl_vpp_routing_node'] != 'dvr':
356 if 'opendaylight::vpp_routing_node' in line:
357 output_line = (" opendaylight::vpp_routing_node: ${}.${}"
358 .format(ds_opts['odl_vpp_routing_node'],
360 elif 'ControllerExtraConfig' in line:
361 output_line = (" ControllerExtraConfig:\n "
362 "tripleo::profile::base::neutron::agents::"
363 "honeycomb::interface_role_mapping:"
364 " ['{}:tenant-interface]'"
365 .format(tenant_ctrl_nic))
366 elif 'NovaComputeExtraConfig' in line:
367 output_line = (" NovaComputeExtraConfig:\n "
368 "tripleo::profile::base::neutron::agents::"
369 "honeycomb::interface_role_mapping:"
370 " ['{}:tenant-interface]'"
371 .format(tenant_comp_nic))
372 elif not ds_opts['sdn_controller'] and ds_opts['dataplane'] == 'fdio':
373 if 'NeutronVPPAgentPhysnets' in line:
374 output_line = (" NeutronVPPAgentPhysnets: 'datacentre:{}'".
375 format(tenant_ctrl_nic))
378 for role in 'NovaCompute', 'Controller':
379 if role == 'NovaCompute':
380 perf_opts = perf_vpp_comp
382 perf_opts = perf_vpp_ctrl
383 cfg = "{}ExtraConfig".format(role)
384 if cfg in line and perf_opts:
386 if 'main-core' in perf_opts:
387 perf_line += ("\n fdio::vpp_cpu_main_core: '{}'"
388 .format(perf_opts['main-core']))
389 if 'corelist-workers' in perf_opts:
391 "fdio::vpp_cpu_corelist_workers: '{}'"
392 .format(perf_opts['corelist-workers']))
394 output_line = (" {}:{}".format(cfg, perf_line))
397 # (FIXME) use compute's kernel settings for all nodes for now.
398 if 'ComputeKernelArgs' in line and perf_kern_comp:
400 for k, v in perf_kern_comp.items():
401 kernel_args += "{}={} ".format(k, v)
403 output_line = " ComputeKernelArgs: '{}'".\
405 elif ds_opts['dataplane'] == 'ovs_dpdk' and perf_ovs_comp:
406 for k, v in OVS_PERF_MAP.items():
407 if k in line and v in perf_ovs_comp:
408 output_line = " {}: {}".format(k, perf_ovs_comp[v])
412 logging.info("opnfv-environment file written to {}".format(tmp_opnfv_env))
414 # Modify Network environment
415 for line in fileinput.input(net_env, inplace=True):
416 line = line.strip('\n')
417 if ds_opts['dataplane'] == 'ovs_dpdk':
418 if 'ComputeExtraConfigPre' in line:
419 print(' OS::TripleO::ComputeExtraConfigPre: '
420 './ovs-dpdk-preconfig.yaml')
423 elif perf and perf_kern_comp:
424 if 'resource_registry' in line:
425 print("resource_registry:\n"
426 " OS::TripleO::NodeUserData: first-boot.yaml")
427 elif 'NovaSchedulerDefaultFilters' in line:
428 print(" NovaSchedulerDefaultFilters: 'RamFilter,"
429 "ComputeFilter,AvailabilityZoneFilter,"
430 "ComputeCapabilitiesFilter,ImagePropertiesFilter,"
431 "NUMATopologyFilter'")
437 logging.info("network-environment file written to {}".format(net_env))
440 def generate_ceph_key():
442 header = struct.pack('<hiih', 1, int(time.time()), 0, len(key))
443 return base64.b64encode(header + key)
446 def prep_storage_env(ds, tmp_dir):
448 Creates storage environment file for deployment. Source file is copied by
449 undercloud playbook to host.
454 ds_opts = ds['deploy_options']
455 storage_file = os.path.join(tmp_dir, 'storage-environment.yaml')
456 if not os.path.isfile(storage_file):
457 logging.error("storage-environment file is not in tmp directory: {}. "
458 "Check if file was copied from "
459 "undercloud".format(tmp_dir))
460 raise ApexDeployException("storage-environment file not copied from "
462 for line in fileinput.input(storage_file, inplace=True):
463 line = line.strip('\n')
464 if 'CephClusterFSID' in line:
465 print(" CephClusterFSID: {}".format(str(uuid.uuid4())))
466 elif 'CephMonKey' in line:
467 print(" CephMonKey: {}".format(generate_ceph_key().decode(
469 elif 'CephAdminKey' in line:
470 print(" CephAdminKey: {}".format(generate_ceph_key().decode(
474 if 'ceph_device' in ds_opts and ds_opts['ceph_device']:
475 with open(storage_file, 'a') as fh:
476 fh.write(' ExtraConfig:\n')
477 fh.write(" ceph::profile::params::osds:{{{}:{{}}}}\n".format(
478 ds_opts['ceph_device']
482 def external_network_cmds(ns):
484 Generates external network openstack commands
485 :param ns: network settings
486 :return: list of commands to configure external network
488 if 'external' in ns.enabled_network_list:
489 net_config = ns['networks']['external'][0]
491 pool_start, pool_end = net_config['floating_ip_range']
493 net_config = ns['networks']['admin']
495 pool_start, pool_end = ns['apex']['networks']['admin'][
496 'introspection_range']
497 nic_config = net_config['nic_mapping']
498 gateway = net_config['gateway']
500 # create network command
501 if nic_config['compute']['vlan'] == 'native':
504 ext_type = "vlan --provider-segment {}".format(nic_config[
506 cmds.append("openstack network create external --project service "
507 "--external --provider-network-type {} "
508 "--provider-physical-network datacentre".format(ext_type))
509 # create subnet command
510 cidr = net_config['cidr']
511 subnet_cmd = "openstack subnet create external-subnet --project " \
512 "service --network external --no-dhcp --gateway {} " \
513 "--allocation-pool start={},end={} --subnet-range " \
514 "{}".format(gateway, pool_start, pool_end, str(cidr))
515 if external and cidr.version == 6:
516 subnet_cmd += ' --ip-version 6 --ipv6-ra-mode slaac ' \
517 '--ipv6-address-mode slaac'
518 cmds.append(subnet_cmd)
519 logging.debug("Neutron external network commands determined "
520 "as: {}".format(cmds))
524 def create_congress_cmds(overcloud_file):
525 drivers = ['nova', 'neutronv2', 'cinder', 'glancev2', 'keystone', 'doctor']
526 overcloudrc = parsers.parse_overcloudrc(overcloud_file)
527 logging.info("Creating congress commands")
530 "username={}".format(overcloudrc['OS_USERNAME']),
531 "tenant_name={}".format(overcloudrc['OS_PROJECT_NAME']),
532 "password={}".format(overcloudrc['OS_PASSWORD']),
533 "auth_url={}".format(overcloudrc['OS_AUTH_URL'])
536 logging.error("Unable to find all keys required for congress in "
537 "overcloudrc: OS_USERNAME, OS_PROJECT_NAME, "
538 "OS_PASSWORD, OS_AUTH_URL. Please check overcloudrc "
539 "file: {}".format(overcloud_file))
542 ds_cfg = '--config ' + ' --config '.join(ds_cfg)
544 for driver in drivers:
545 if driver == 'doctor':
546 cmd = "{} \"{}\"".format(driver, driver)
548 cmd = "{} \"{}\" {}".format(driver, driver, ds_cfg)
550 cmd += ' --config api_version="2.34"'
551 logging.debug("Congress command created: {}".format(cmd))