apex/overcloud/deploy.py

   1 ##############################################################################
   2 # Copyright (c) 2017 Tim Rozet (trozet@redhat.com) and others.
   3 #
   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 ##############################################################################
   9
  10 import base64
  11 import fileinput
  12 import logging
  13 import os
  14 import platform
  15 import pprint
  16 import shutil
  17 import uuid
  18 import struct
  19 import time
  20 import yaml
  21 import apex.builders.overcloud_builder as oc_builder
  22 import apex.builders.common_builder as c_builder
  23
  24 from apex.common import constants as con
  25 from apex.common.exceptions import ApexDeployException
  26 from apex.common import parsers
  27 from apex.common import utils
  28 from apex.virtual import utils as virt_utils
  29 from cryptography.hazmat.primitives import serialization as \
  30     crypto_serialization
  31 from cryptography.hazmat.primitives.asymmetric import rsa
  32 from cryptography.hazmat.backends import default_backend as \
  33     crypto_default_backend
  34
  35
  36 SDN_FILE_MAP = {
  37     'opendaylight': {
  38         'sfc': 'neutron-sfc-opendaylight.yaml',
  39         'vpn': 'neutron-bgpvpn-opendaylight.yaml',
  40         'gluon': 'gluon.yaml',
  41         'vpp': {
  42             'odl_vpp_netvirt': 'neutron-opendaylight-netvirt-vpp.yaml',
  43             'dvr': 'neutron-opendaylight-fdio-dvr.yaml',
  44             'default': 'neutron-opendaylight-honeycomb.yaml'
  45         },
  46         'l2gw': 'neutron-l2gw-opendaylight.yaml',
  47         'sriov': 'neutron-opendaylight-sriov.yaml',
  48         'default': 'neutron-opendaylight.yaml',
  49     },
  50     'onos': {
  51         'sfc': 'neutron-onos-sfc.yaml',
  52         'default': 'neutron-onos.yaml'
  53     },
  54     'ovn': 'neutron-ml2-ovn.yaml',
  55     False: {
  56         'vpp': 'neutron-ml2-vpp.yaml',
  57         'dataplane': ('ovs_dpdk', 'neutron-ovs-dpdk.yaml')
  58     }
  59 }
  60
  61 OTHER_FILE_MAP = {
  62     'tacker': 'enable_tacker.yaml',
  63     'congress': 'enable_congress.yaml',
  64     'barometer': 'enable_barometer.yaml',
  65     'rt_kvm': 'enable_rt_kvm.yaml'
  66 }
  67
  68 OVS_PERF_MAP = {
  69     'HostCpusList': 'dpdk_cores',
  70     'NeutronDpdkCoreList': 'pmd_cores',
  71     'NeutronDpdkSocketMemory': 'socket_memory',
  72     'NeutronDpdkMemoryChannels': 'memory_channels'
  73 }
  74
  75 ODL_NETVIRT_VPP_RPM = "/root/opendaylight-7.0.0-0.1.20170531snap665.el7" \
  76                       ".noarch.rpm"
  77
  78 LOOP_DEVICE_SIZE = "10G"
  79
  80 LOSETUP_SERVICE = """[Unit]
  81 Description=Setup loop devices
  82 Before=network.target
  83
  84 [Service]
  85 Type=oneshot
  86 ExecStart=/sbin/losetup /dev/loop3 /srv/data.img
  87 ExecStop=/sbin/losetup -d /dev/loop3
  88 TimeoutSec=60
  89 RemainAfterExit=yes
  90
  91 [Install]
  92 WantedBy=multi-user.target
  93 """
  94
  95 DUPLICATE_COMPUTE_SERVICES = [
  96     'OS::TripleO::Services::ComputeNeutronCorePlugin',
  97     'OS::TripleO::Services::ComputeNeutronMetadataAgent',
  98     'OS::TripleO::Services::ComputeNeutronOvsAgent',
  99     'OS::TripleO::Services::ComputeNeutronL3Agent'
 100 ]
 101
 102 NFS_VARS = [
 103     'NovaNfsEnabled',
 104     'GlanceNfsEnabled',
 105     'CinderNfsEnabledBackend'
 106 ]
 107
 108
 109 def build_sdn_env_list(ds, sdn_map, env_list=None):
 110     """
 111     Builds a list of SDN environment files to be used in the deploy cmd.
 112
 113     This function recursively searches an sdn_map.  First the sdn controller is
 114     matched and then the function looks for enabled features for that
 115     controller to determine which environment files should be used.  By
 116     default the feature will be checked if set to true in deploy settings to be
 117     added to the list.  If a feature does not have a boolean value, then the
 118     key and value pair to compare with are checked as a tuple (k,v).
 119
 120     :param ds: deploy settings
 121     :param sdn_map: SDN map to recursively search
 122     :param env_list: recursive var to hold previously found env_list
 123     :return: A list of env files
 124     """
 125     if env_list is None:
 126         env_list = list()
 127     for k, v in sdn_map.items():
 128         if ds['sdn_controller'] == k or (k in ds and ds[k]):
 129             if isinstance(v, dict):
 130                 # Append default SDN env file first
 131                 # The assumption is that feature-enabled SDN env files
 132                 # override and do not conflict with previously set default
 133                 # settings
 134                 if ds['sdn_controller'] == k and 'default' in v:
 135                     env_list.append(os.path.join(con.THT_ENV_DIR,
 136                                                  v['default']))
 137                 env_list.extend(build_sdn_env_list(ds, v))
 138             # check if the value is not a boolean
 139             elif isinstance(v, tuple):
 140                     if ds[k] == v[0]:
 141                         env_list.append(os.path.join(con.THT_ENV_DIR, v[1]))
 142             else:
 143                 env_list.append(os.path.join(con.THT_ENV_DIR, v))
 144     if len(env_list) == 0:
 145         try:
 146             env_list.append(os.path.join(
 147                 con.THT_ENV_DIR, sdn_map['default']))
 148         except KeyError:
 149             logging.warning("Unable to find default file for SDN")
 150
 151     return env_list
 152
 153
 154 def get_docker_sdn_files(ds_opts):
 155     """
 156     Returns docker env file for detected SDN
 157     :param ds_opts: deploy options
 158     :return: list of docker THT env files for an SDN
 159     """
 160     docker_services = con.VALID_DOCKER_SERVICES
 161     tht_dir = con.THT_DOCKER_ENV_DIR
 162     sdn_env_list = build_sdn_env_list(ds_opts, SDN_FILE_MAP)
 163     for i, sdn_file in enumerate(sdn_env_list):
 164         sdn_base = os.path.basename(sdn_file)
 165         if sdn_base in docker_services:
 166             if docker_services[sdn_base] is not None:
 167                 sdn_env_list[i] = \
 168                     os.path.join(tht_dir, docker_services[sdn_base])
 169             else:
 170                 sdn_env_list[i] = os.path.join(tht_dir, sdn_base)
 171     return sdn_env_list
 172
 173
 174 def create_deploy_cmd(ds, ns, inv, tmp_dir,
 175                       virtual, env_file='opnfv-environment.yaml',
 176                       net_data=False):
 177
 178     logging.info("Creating deployment command")
 179     deploy_options = ['network-environment.yaml']
 180
 181     ds_opts = ds['deploy_options']
 182
 183     if ds_opts['containers']:
 184         deploy_options.append(os.path.join(con.THT_ENV_DIR,
 185                                            'docker.yaml'))
 186
 187     if ds['global_params']['ha_enabled']:
 188         if ds_opts['containers']:
 189             deploy_options.append(os.path.join(con.THT_ENV_DIR,
 190                                                'docker-ha.yaml'))
 191         else:
 192             deploy_options.append(os.path.join(con.THT_ENV_DIR,
 193                                                'puppet-pacemaker.yaml'))
 194
 195     if env_file:
 196         deploy_options.append(env_file)
 197
 198     if ds_opts['containers']:
 199         deploy_options.append('docker-images.yaml')
 200         sdn_docker_files = get_docker_sdn_files(ds_opts)
 201         for sdn_docker_file in sdn_docker_files:
 202             deploy_options.append(sdn_docker_file)
 203     else:
 204         deploy_options += build_sdn_env_list(ds_opts, SDN_FILE_MAP)
 205
 206     for k, v in OTHER_FILE_MAP.items():
 207         if k in ds_opts and ds_opts[k]:
 208             if ds_opts['containers']:
 209                 deploy_options.append(os.path.join(con.THT_DOCKER_ENV_DIR,
 210                                                    "{}.yaml".format(k)))
 211             else:
 212                 deploy_options.append(os.path.join(con.THT_ENV_DIR, v))
 213
 214     # TODO(trozet) Fix this check to look for if ceph is in controller services
 215     # and not use name of the file
 216     if ds_opts['ceph'] and 'csit' not in env_file:
 217         prep_storage_env(ds, ns, virtual, tmp_dir)
 218         deploy_options.append(os.path.join(con.THT_ENV_DIR,
 219                                            'storage-environment.yaml'))
 220     if ds_opts['sriov']:
 221         prep_sriov_env(ds, tmp_dir)
 222
 223     # Check for 'k8s' here intentionally, as we may support other values
 224     # such as openstack/openshift for 'vim' option.
 225     if ds_opts['vim'] == 'k8s':
 226         deploy_options.append('kubernetes-environment.yaml')
 227
 228     if virtual:
 229         deploy_options.append('virtual-environment.yaml')
 230     else:
 231         deploy_options.append('baremetal-environment.yaml')
 232
 233     num_control, num_compute = inv.get_node_counts()
 234     if num_control > 1 and not ds['global_params']['ha_enabled']:
 235         num_control = 1
 236     if platform.machine() == 'aarch64':
 237         # aarch64 deploys were not completing in the default 90 mins.
 238         # Not sure if this is related to the hardware the OOO support
 239         # was developed on or the virtualization support in CentOS
 240         # Either way it will probably get better over time  as the aarch
 241         # support matures in CentOS and deploy time should be tested in
 242         # the future so this multiplier can be removed.
 243         con.DEPLOY_TIMEOUT *= 2
 244     cmd = "openstack overcloud deploy --templates --timeout {} " \
 245           .format(con.DEPLOY_TIMEOUT)
 246     # build cmd env args
 247     for option in deploy_options:
 248         cmd += " -e {}".format(option)
 249     cmd += " --ntp-server {}".format(ns['ntp'][0])
 250     cmd += " --control-scale {}".format(num_control)
 251     cmd += " --compute-scale {}".format(num_compute)
 252     cmd += ' --control-flavor control --compute-flavor compute'
 253     if net_data:
 254         cmd += ' --networks-file network_data.yaml'
 255     libvirt_type = 'kvm'
 256     if virtual and (platform.machine() != 'aarch64'):
 257         with open('/sys/module/kvm_intel/parameters/nested') as f:
 258             nested_kvm = f.read().strip()
 259             if nested_kvm != 'Y':
 260                 libvirt_type = 'qemu'
 261     elif virtual and (platform.machine() == 'aarch64'):
 262         libvirt_type = 'qemu'
 263     cmd += ' --libvirt-type {}'.format(libvirt_type)
 264     if platform.machine() == 'aarch64':
 265         cmd += ' --override-ansible-cfg /home/stack/ansible.cfg '
 266     logging.info("Deploy command set: {}".format(cmd))
 267
 268     with open(os.path.join(tmp_dir, 'deploy_command'), 'w') as fh:
 269         fh.write(cmd)
 270     return cmd
 271
 272
 273 def prep_image(ds, ns, img, tmp_dir, root_pw=None, docker_tag=None,
 274                patches=None):
 275     """
 276     Locates sdn image and preps for deployment.
 277     :param ds: deploy settings
 278     :param ns: network settings
 279     :param img: sdn image
 280     :param tmp_dir: dir to store modified sdn image
 281     :param root_pw: password to configure for overcloud image
 282     :param docker_tag: Docker image tag for RDO version (default None)
 283     :param patches: List of patches to apply to overcloud image
 284     :return: None
 285     """
 286     # TODO(trozet): Come up with a better way to organize this logic in this
 287     # function
 288     logging.info("Preparing image: {} for deployment".format(img))
 289     if not os.path.isfile(img):
 290         logging.error("Missing SDN image {}".format(img))
 291         raise ApexDeployException("Missing SDN image file: {}".format(img))
 292
 293     ds_opts = ds['deploy_options']
 294     virt_cmds = list()
 295     sdn = ds_opts['sdn_controller']
 296     patched_containers = set()
 297     # we need this due to rhbz #1436021
 298     # fixed in systemd-219-37.el7
 299     if sdn is not False:
 300         logging.info("Neutron openvswitch-agent disabled")
 301         virt_cmds.extend([{
 302             con.VIRT_RUN_CMD:
 303                 "rm -f /etc/systemd/system/multi-user.target.wants/"
 304                 "neutron-openvswitch-agent.service"},
 305             {
 306             con.VIRT_RUN_CMD:
 307                 "rm -f /usr/lib/systemd/system/neutron-openvswitch-agent"
 308                 ".service"
 309         }])
 310
 311     if ns.get('http_proxy', ''):
 312         virt_cmds.append({
 313             con.VIRT_RUN_CMD:
 314                 "echo 'http_proxy={}' >> /etc/environment".format(
 315                     ns['http_proxy'])})
 316
 317     if ns.get('https_proxy', ''):
 318         virt_cmds.append({
 319             con.VIRT_RUN_CMD:
 320                 "echo 'https_proxy={}' >> /etc/environment".format(
 321                     ns['https_proxy'])})
 322
 323     tmp_oc_image = os.path.join(tmp_dir, 'overcloud-full.qcow2')
 324     shutil.copyfile(img, tmp_oc_image)
 325     logging.debug("Temporary overcloud image stored as: {}".format(
 326         tmp_oc_image))
 327
 328     if ds_opts['vpn']:
 329         oc_builder.inject_quagga(tmp_oc_image, tmp_dir)
 330         virt_cmds.append({con.VIRT_RUN_CMD: "chmod +x /etc/rc.d/rc.local"})
 331         virt_cmds.append({
 332             con.VIRT_RUN_CMD:
 333                 "echo 'sudo /opt/quagga/etc/init.d/zrpcd start' > "
 334                 "/opt/quagga/etc/init.d/zrpcd_start.sh"})
 335         virt_cmds.append({
 336             con.VIRT_RUN_CMD: "chmod +x /opt/quagga/etc/init.d/"
 337                               "zrpcd_start.sh"})
 338         virt_cmds.append({
 339             con.VIRT_RUN_CMD: "sed -i '$a /opt/quagga/etc/"
 340                               "init.d/zrpcd_start.sh' /etc/rc.local "})
 341         virt_cmds.append({
 342             con.VIRT_RUN_CMD: "sed -i '$a /opt/quagga/etc/"
 343                               "init.d/zrpcd_start.sh' /etc/rc.d/rc.local"})
 344         logging.info("ZRPCD process started")
 345
 346     dataplane = ds_opts['dataplane']
 347     if dataplane == 'ovs_dpdk' or dataplane == 'fdio':
 348         logging.info("Enabling kernel modules for dpdk")
 349         # file to module mapping
 350         uio_types = {
 351             os.path.join(tmp_dir, 'vfio_pci.modules'): 'vfio_pci',
 352             os.path.join(tmp_dir, 'uio_pci_generic.modules'): 'uio_pci_generic'
 353         }
 354         for mod_file, mod in uio_types.items():
 355             with open(mod_file, 'w') as fh:
 356                 fh.write('#!/bin/bash\n')
 357                 fh.write('exec /sbin/modprobe {}'.format(mod))
 358                 fh.close()
 359
 360             virt_cmds.extend([
 361                 {con.VIRT_UPLOAD: "{}:/etc/sysconfig/modules/".format(
 362                     mod_file)},
 363                 {con.VIRT_RUN_CMD: "chmod 0755 /etc/sysconfig/modules/"
 364                                    "{}".format(os.path.basename(mod_file))}
 365             ])
 366     if root_pw:
 367         pw_op = "password:{}".format(root_pw)
 368         virt_cmds.append({con.VIRT_PW: pw_op})
 369
 370     # FIXME(trozet) ovs build is failing in CentOS 7.6
 371     # if dataplane == 'ovs':
 372         # FIXME(trozet) remove this after RDO is updated with fix for
 373         # https://bugzilla.redhat.com/show_bug.cgi?id=1544892
 374         # https://review.rdoproject.org/r/#/c/13839/
 375         # oc_builder.inject_ovs_nsh(tmp_oc_image, tmp_dir)
 376
 377     if dataplane == 'fdio':
 378         # Patch neutron with using OVS external interface for router
 379         # and add generic linux NS interface driver
 380         virt_cmds.append(
 381             {con.VIRT_RUN_CMD: "cd /usr/lib/python2.7/site-packages && patch "
 382                                "-p1 < neutron-patch-NSDriver.patch"})
 383         if sdn is False:
 384             virt_cmds.extend([
 385                 {con.VIRT_RUN_CMD: "yum remove -y vpp-lib"},
 386                 {con.VIRT_RUN_CMD: "yum install -y "
 387                                    "/root/nosdn_vpp_rpms/*.rpm"}
 388             ])
 389
 390     undercloud_admin_ip = ns['networks'][con.ADMIN_NETWORK][
 391         'installer_vm']['ip']
 392     if sdn == 'opendaylight':
 393         oc_builder.inject_opendaylight(
 394             odl_version=ds_opts['odl_version'],
 395             image=tmp_oc_image,
 396             tmp_dir=tmp_dir,
 397             uc_ip=undercloud_admin_ip,
 398             os_version=ds_opts['os_version'],
 399             docker_tag=docker_tag,
 400         )
 401         if docker_tag:
 402             patched_containers = patched_containers.union({'opendaylight'})
 403
 404     if patches:
 405         if ds_opts['os_version'] == 'master':
 406             branch = ds_opts['os_version']
 407         else:
 408             branch = "stable/{}".format(ds_opts['os_version'])
 409         logging.info('Adding patches to overcloud')
 410         patched_containers = patched_containers.union(
 411             c_builder.add_upstream_patches(patches,
 412                                            tmp_oc_image, tmp_dir,
 413                                            branch,
 414                                            uc_ip=undercloud_admin_ip,
 415                                            docker_tag=docker_tag))
 416     # if containers with ceph, and no ceph device we need to use a
 417     # persistent loop device for Ceph OSDs
 418     if docker_tag and ds_opts['ceph_device'] == '/dev/loop3':
 419         tmp_losetup = os.path.join(tmp_dir, 'losetup.service')
 420         with open(tmp_losetup, 'w') as fh:
 421             fh.write(LOSETUP_SERVICE)
 422         virt_cmds.extend([
 423             {con.VIRT_UPLOAD: "{}:/usr/lib/systemd/system/".format(tmp_losetup)
 424              },
 425             {con.VIRT_RUN_CMD: 'truncate /srv/data.img --size {}'
 426                 .format(LOOP_DEVICE_SIZE)},
 427             {con.VIRT_RUN_CMD: 'systemctl daemon-reload'},
 428             {con.VIRT_RUN_CMD: 'systemctl enable losetup.service'},
 429         ])
 430     # TODO(trozet) remove this after LP#173474 is fixed
 431     dhcp_unit = '/usr/lib/systemd/system/dhcp-interface@.service'
 432     virt_cmds.append(
 433         {con.VIRT_RUN_CMD: "crudini --del {} Unit "
 434                            "ConditionPathExists".format(dhcp_unit)})
 435     # Prep for NFS
 436     virt_cmds.extend([
 437         {con.VIRT_INSTALL: "nfs-utils"},
 438         {con.VIRT_RUN_CMD: "ln -s /usr/lib/systemd/system/nfs-server.service "
 439                            "/etc/systemd/system/multi-user.target.wants/"
 440                            "nfs-server.service"},
 441         {con.VIRT_RUN_CMD: "mkdir -p /glance"},
 442         {con.VIRT_RUN_CMD: "mkdir -p /cinder"},
 443         {con.VIRT_RUN_CMD: "mkdir -p /nova"},
 444         {con.VIRT_RUN_CMD: "chmod 777 /glance"},
 445         {con.VIRT_RUN_CMD: "chmod 777 /cinder"},
 446         {con.VIRT_RUN_CMD: "chmod 777 /nova"},
 447         {con.VIRT_RUN_CMD: "chown nfsnobody:nfsnobody /glance"},
 448         {con.VIRT_RUN_CMD: "chown nfsnobody:nfsnobody /cinder"},
 449         {con.VIRT_RUN_CMD: "chown nfsnobody:nfsnobody /nova"},
 450         {con.VIRT_RUN_CMD: "echo '/glance *(rw,sync,"
 451                            "no_root_squash,no_acl)' > /etc/exports"},
 452         {con.VIRT_RUN_CMD: "echo '/cinder *(rw,sync,"
 453                            "no_root_squash,no_acl)' >> /etc/exports"},
 454         {con.VIRT_RUN_CMD: "echo '/nova *(rw,sync,"
 455                            "no_root_squash,no_acl)' >> /etc/exports"},
 456         {con.VIRT_RUN_CMD: "exportfs -avr"},
 457     ])
 458     virt_utils.virt_customize(virt_cmds, tmp_oc_image)
 459     logging.info("Overcloud image customization complete")
 460     return patched_containers
 461
 462
 463 def make_ssh_key():
 464     """
 465     Creates public and private ssh keys with 1024 bit RSA encryption
 466     :return: private, public key
 467     """
 468     key = rsa.generate_private_key(
 469         backend=crypto_default_backend(),
 470         public_exponent=65537,
 471         key_size=1024
 472     )
 473
 474     private_key = key.private_bytes(
 475         crypto_serialization.Encoding.PEM,
 476         crypto_serialization.PrivateFormat.PKCS8,
 477         crypto_serialization.NoEncryption())
 478     public_key = key.public_key().public_bytes(
 479         crypto_serialization.Encoding.OpenSSH,
 480         crypto_serialization.PublicFormat.OpenSSH
 481     )
 482     return private_key.decode('utf-8'), public_key.decode('utf-8')
 483
 484
 485 def prep_env(ds, ns, inv, opnfv_env, net_env, tmp_dir):
 486     """
 487     Creates modified opnfv/network environments for deployment
 488     :param ds: deploy settings
 489     :param ns: network settings
 490     :param inv: node inventory
 491     :param opnfv_env: file path for opnfv-environment file
 492     :param net_env: file path for network-environment file
 493     :param tmp_dir: Apex tmp dir
 494     :return:
 495     """
 496
 497     logging.info("Preparing opnfv-environment and network-environment files")
 498     ds_opts = ds['deploy_options']
 499     tmp_opnfv_env = os.path.join(tmp_dir, os.path.basename(opnfv_env))
 500     shutil.copyfile(opnfv_env, tmp_opnfv_env)
 501     tenant_nic_map = ns['networks']['tenant']['nic_mapping']
 502     tenant_nic = dict()
 503     tenant_nic['Controller'] = tenant_nic_map['controller']['members'][0]
 504     tenant_nic['NovaCompute'] = tenant_nic_map['compute']['members'][0]
 505     external_nic_map = ns['networks']['external'][0]['nic_mapping']
 506     external_nic = dict()
 507     external_nic['NovaCompute'] = external_nic_map['compute']['members'][0]
 508
 509     # SSH keys
 510     private_key, public_key = make_ssh_key()
 511
 512     num_control, num_compute = inv.get_node_counts()
 513     if num_control > 1 and not ds['global_params']['ha_enabled']:
 514         num_control = 1
 515
 516     # Make easier/faster variables to index in the file editor
 517     if 'performance' in ds_opts:
 518         perf = True
 519         # vpp
 520         if 'vpp' in ds_opts['performance']['Compute']:
 521             perf_vpp_comp = ds_opts['performance']['Compute']['vpp']
 522         else:
 523             perf_vpp_comp = None
 524         if 'vpp' in ds_opts['performance']['Controller']:
 525             perf_vpp_ctrl = ds_opts['performance']['Controller']['vpp']
 526         else:
 527             perf_vpp_ctrl = None
 528
 529         # ovs
 530         if 'ovs' in ds_opts['performance']['Compute']:
 531             perf_ovs_comp = ds_opts['performance']['Compute']['ovs']
 532         else:
 533             perf_ovs_comp = None
 534
 535         # kernel
 536         if 'kernel' in ds_opts['performance']['Compute']:
 537             perf_kern_comp = ds_opts['performance']['Compute']['kernel']
 538         else:
 539             perf_kern_comp = None
 540     else:
 541         perf = False
 542
 543     tenant_settings = ns['networks']['tenant']
 544     tenant_vlan_enabled = 'tenant' in ns.enabled_network_list and \
 545         ns['networks']['tenant'].get('segmentation_type') == 'vlan'
 546
 547     # Modify OPNFV environment
 548     # TODO: Change to build a dict and outputting yaml rather than parsing
 549     for line in fileinput.input(tmp_opnfv_env, inplace=True):
 550         line = line.strip('\n')
 551         output_line = line
 552         if 'CloudDomain' in line:
 553             output_line = "  CloudDomain: {}".format(ns['domain_name'])
 554         elif 'replace_private_key' in line:
 555             output_line = "    private_key: |\n"
 556             key_out = ''
 557             for line in private_key.splitlines():
 558                 key_out += "      {}\n".format(line)
 559             output_line += key_out
 560         elif 'replace_public_key' in line:
 561             output_line = "    public_key: '{}'".format(public_key)
 562         elif ((perf and perf_kern_comp) or ds_opts.get('rt_kvm')) and \
 563                 'resource_registry' in line:
 564             output_line = "resource_registry:\n" \
 565                           "  OS::TripleO::NodeUserData: first-boot.yaml"
 566         elif 'ComputeExtraConfigPre' in line and \
 567                 ds_opts['dataplane'] == 'ovs_dpdk':
 568             output_line = '  OS::TripleO::ComputeExtraConfigPre: ' \
 569                           './ovs-dpdk-preconfig.yaml'
 570         elif 'NeutronNetworkVLANRanges' in line:
 571             vlan_setting = ''
 572             if tenant_vlan_enabled:
 573                 if ns['networks']['tenant']['overlay_id_range']:
 574                     vlan_setting = ns['networks']['tenant']['overlay_id_range']
 575                     if 'datacentre' not in vlan_setting:
 576                         vlan_setting += ',datacentre:1:1000'
 577             # SRIOV networks are VLAN based provider networks. In order to
 578             # simplify the deployment, nfv_sriov will be the default physnet.
 579             # VLANs are not needed in advance, and the user will have to create
 580             # the network specifying the segmentation-id.
 581             if ds_opts['sriov']:
 582                 if vlan_setting:
 583                     vlan_setting += ",nfv_sriov"
 584                 else:
 585                     vlan_setting = "datacentre:1:1000,nfv_sriov"
 586             if vlan_setting:
 587                 output_line = "  NeutronNetworkVLANRanges: " + vlan_setting
 588         elif 'NeutronBridgeMappings' in line and tenant_vlan_enabled:
 589             if tenant_settings['overlay_id_range']:
 590                 physnets = tenant_settings['overlay_id_range'].split(',')
 591                 output_line = "  NeutronBridgeMappings: "
 592                 for physnet in physnets:
 593                     physnet_name = physnet.split(':')[0]
 594                     if physnet_name != 'datacentre':
 595                         output_line += "{}:br-vlan,".format(physnet_name)
 596                 output_line += "datacentre:br-ex"
 597         elif 'OpenDaylightProviderMappings' in line and tenant_vlan_enabled \
 598                 and ds_opts['sdn_controller'] == 'opendaylight':
 599             if tenant_settings['overlay_id_range']:
 600                 physnets = tenant_settings['overlay_id_range'].split(',')
 601                 output_line = "  OpenDaylightProviderMappings: "
 602                 for physnet in physnets:
 603                     physnet_name = physnet.split(':')[0]
 604                     if physnet_name != 'datacentre':
 605                         output_line += "{}:br-vlan,".format(physnet_name)
 606                 output_line += "datacentre:br-ex"
 607         elif 'NeutronNetworkType' in line and tenant_vlan_enabled:
 608             output_line = "  NeutronNetworkType: vlan\n" \
 609                           "  NeutronTunnelTypes: ''"
 610
 611         if ds_opts['sdn_controller'] == 'opendaylight' and \
 612                 'odl_vpp_routing_node' in ds_opts:
 613             if 'opendaylight::vpp_routing_node' in line:
 614                 output_line = ("    opendaylight::vpp_routing_node: {}.{}"
 615                                .format(ds_opts['odl_vpp_routing_node'],
 616                                        ns['domain_name']))
 617         elif not ds_opts['sdn_controller'] and ds_opts['dataplane'] == 'fdio':
 618             if 'NeutronVPPAgentPhysnets' in line:
 619                 # VPP interface tap0 will be used for external network
 620                 # connectivity.
 621                 output_line = ("  NeutronVPPAgentPhysnets: "
 622                                "'datacentre:{},external:tap0'"
 623                                .format(tenant_nic['Controller']))
 624         elif ds_opts['sdn_controller'] == 'opendaylight' and ds_opts.get(
 625                 'dvr') is True:
 626             if 'OS::TripleO::Services::NeutronDhcpAgent' in line:
 627                 output_line = ''
 628             elif 'NeutronDhcpAgentsPerNetwork' in line:
 629                 if num_compute == 0:
 630                     num_dhcp_agents = num_control
 631                 else:
 632                     num_dhcp_agents = num_compute
 633                 output_line = ("  NeutronDhcpAgentsPerNetwork: {}"
 634                                .format(num_dhcp_agents))
 635             elif 'ComputeServices' in line:
 636                 output_line = ("  ComputeServices:\n"
 637                                "    - OS::TripleO::Services::NeutronDhcpAgent")
 638
 639         if perf:
 640             for role in 'NovaCompute', 'Controller':
 641                 if role == 'NovaCompute':
 642                     perf_opts = perf_vpp_comp
 643                 else:
 644                     perf_opts = perf_vpp_ctrl
 645                 cfg = "{}ExtraConfig".format(role)
 646                 if cfg in line and perf_opts:
 647                     perf_line = ''
 648                     if 'main-core' in perf_opts:
 649                         perf_line += ("\n    fdio::vpp_cpu_main_core: '{}'"
 650                                       .format(perf_opts['main-core']))
 651                     if 'corelist-workers' in perf_opts:
 652                         perf_line += ("\n    "
 653                                       "fdio::vpp_cpu_corelist_workers: '{}'"
 654                                       .format(perf_opts['corelist-workers']))
 655                     if ds_opts['sdn_controller'] == 'opendaylight' and \
 656                             ds_opts['dataplane'] == 'fdio':
 657                         if role == 'NovaCompute':
 658                             perf_line += ("\n    "
 659                                           "tripleo::profile::base::neutron::"
 660                                           "agents::honeycomb::"
 661                                           "interface_role_mapping:"
 662                                           " ['{}:tenant-interface',"
 663                                           "'{}:public-interface']"
 664                                           .format(tenant_nic[role],
 665                                                   external_nic[role]))
 666                         else:
 667                             perf_line += ("\n    "
 668                                           "tripleo::profile::base::neutron::"
 669                                           "agents::honeycomb::"
 670                                           "interface_role_mapping:"
 671                                           " ['{}:tenant-interface']"
 672                                           .format(tenant_nic[role]))
 673                     if perf_line:
 674                         output_line = ("  {}:{}".format(cfg, perf_line))
 675
 676             if ds_opts['dataplane'] == 'ovs_dpdk' and perf_ovs_comp:
 677                 for k, v in OVS_PERF_MAP.items():
 678                     if k in line and v in perf_ovs_comp:
 679                         output_line = "  {}: '{}'".format(k, perf_ovs_comp[v])
 680
 681             # kernel args
 682             # (FIXME) use compute's kernel settings for all nodes for now.
 683             if perf_kern_comp:
 684                 if 'NovaSchedulerDefaultFilters' in line:
 685                     output_line = \
 686                         "  NovaSchedulerDefaultFilters: 'RamFilter," \
 687                         "ComputeFilter,AvailabilityZoneFilter," \
 688                         "ComputeCapabilitiesFilter," \
 689                         "ImagePropertiesFilter,NUMATopologyFilter'"
 690                 elif 'ComputeKernelArgs' in line:
 691                     kernel_args = ''
 692                     for k, v in perf_kern_comp.items():
 693                         kernel_args += "{}={} ".format(k, v)
 694                     if kernel_args:
 695                         output_line = "  ComputeKernelArgs: '{}'".\
 696                             format(kernel_args)
 697
 698         print(output_line)
 699
 700     # Merge compute services into control services if only a single
 701     # node deployment
 702     if num_compute == 0:
 703         with open(tmp_opnfv_env, 'r') as fh:
 704             data = yaml.safe_load(fh)
 705         param_data = data['parameter_defaults']
 706         logging.info("All in one deployment detected")
 707         logging.info("Disabling NFS in env file")
 708         # Check to see if any parameters are set for Compute
 709         for param in param_data.keys():
 710             if param != 'ComputeServices' and param.startswith('Compute'):
 711                 logging.warning("Compute parameter set, but will not be used "
 712                                 "in deployment: {}. Please use Controller "
 713                                 "based parameters when using All-in-one "
 714                                 "deployments".format(param))
 715             if param in NFS_VARS:
 716                 param_data[param] = False
 717         logging.info("Checking if service merging required into "
 718                      "control services")
 719         if ('ControllerServices' in param_data and 'ComputeServices' in
 720                 param_data):
 721             logging.info("Services detected in environment file. Merging...")
 722             ctrl_services = param_data['ControllerServices']
 723             cmp_services = param_data['ComputeServices']
 724             param_data['ControllerServices'] = list(set().union(
 725                 ctrl_services, cmp_services))
 726             for dup_service in DUPLICATE_COMPUTE_SERVICES:
 727                 if dup_service in param_data['ControllerServices']:
 728                     param_data['ControllerServices'].remove(dup_service)
 729             param_data.pop('ComputeServices')
 730             logging.debug("Merged controller services: {}".format(
 731                 pprint.pformat(param_data['ControllerServices'])
 732             ))
 733         else:
 734             logging.info("No services detected in env file, not merging "
 735                          "services")
 736         with open(tmp_opnfv_env, 'w') as fh:
 737             yaml.safe_dump(data, fh, default_flow_style=False)
 738
 739     logging.info("opnfv-environment file written to {}".format(tmp_opnfv_env))
 740     with open(tmp_opnfv_env, 'r') as fh:
 741         logging.debug("opnfv-environment content is : {}".format(
 742             pprint.pformat(yaml.safe_load(fh.read()))
 743         ))
 744
 745
 746 def generate_ceph_key():
 747     key = os.urandom(16)
 748     header = struct.pack('<hiih', 1, int(time.time()), 0, len(key))
 749     return base64.b64encode(header + key)
 750
 751
 752 def prep_storage_env(ds, ns, virtual, tmp_dir):
 753     """
 754     Creates storage environment file for deployment.  Source file is copied by
 755     undercloud playbook to host.
 756     :param ds:
 757     :param ns:
 758     :param virtual:
 759     :param tmp_dir:
 760     :return:
 761     """
 762     ds_opts = ds['deploy_options']
 763     storage_file = os.path.join(tmp_dir, 'storage-environment.yaml')
 764     if not os.path.isfile(storage_file):
 765         logging.error("storage-environment file is not in tmp directory: {}. "
 766                       "Check if file was copied from "
 767                       "undercloud".format(tmp_dir))
 768         raise ApexDeployException("storage-environment file not copied from "
 769                                   "undercloud")
 770     for line in fileinput.input(storage_file, inplace=True):
 771         line = line.strip('\n')
 772         if 'CephClusterFSID' in line:
 773             print("  CephClusterFSID: {}".format(str(uuid.uuid4())))
 774         elif 'CephMonKey' in line:
 775             print("  CephMonKey: {}".format(generate_ceph_key().decode(
 776                 'utf-8')))
 777         elif 'CephAdminKey' in line:
 778             print("  CephAdminKey: {}".format(generate_ceph_key().decode(
 779                 'utf-8')))
 780         elif 'CephClientKey' in line:
 781             print("  CephClientKey: {}".format(generate_ceph_key().decode(
 782                 'utf-8')))
 783         else:
 784             print(line)
 785
 786     if ds_opts['containers']:
 787         ceph_params = {}
 788
 789         # max pgs allowed are calculated as num_mons * 200. Therefore we
 790         # set number of pgs and pools so that the total will be less:
 791         # num_pgs * num_pools * num_osds
 792         ceph_params['CephPoolDefaultSize'] = 2
 793         ceph_params['CephPoolDefaultPgNum'] = 32
 794         if virtual:
 795             ceph_params['CephAnsibleExtraConfig'] = {
 796                 'centos_package_dependencies': [],
 797                 'ceph_osd_docker_memory_limit': '1g',
 798                 'ceph_mds_docker_memory_limit': '1g',
 799             }
 800         ceph_device = ds_opts['ceph_device']
 801         ceph_params['CephAnsibleDisksConfig'] = {
 802             'devices': [ceph_device],
 803             'journal_size': 512,
 804             'osd_scenario': 'collocated'
 805         }
 806         utils.edit_tht_env(storage_file, 'parameter_defaults', ceph_params)
 807     # TODO(trozet): remove following block as we only support containers now
 808     elif 'ceph_device' in ds_opts and ds_opts['ceph_device']:
 809         with open(storage_file, 'a') as fh:
 810             fh.write('  ExtraConfig:\n')
 811             fh.write("    ceph::profile::params::osds:{{{}:{{}}}}\n".format(
 812                 ds_opts['ceph_device']
 813             ))
 814
 815
 816 def prep_sriov_env(ds, tmp_dir):
 817     """
 818     Creates SRIOV environment file for deployment. Source file is copied by
 819     undercloud playbook to host.
 820     :param ds:
 821     :param tmp_dir:
 822     :return:
 823     """
 824     ds_opts = ds['deploy_options']
 825     sriov_iface = ds_opts['sriov']
 826     sriov_file = os.path.join(tmp_dir, 'neutron-opendaylight-sriov.yaml')
 827     if not os.path.isfile(sriov_file):
 828         logging.error("sriov-environment file is not in tmp directory: {}. "
 829                       "Check if file was copied from "
 830                       "undercloud".format(tmp_dir))
 831         raise ApexDeployException("sriov-environment file not copied from "
 832                                   "undercloud")
 833     # TODO(rnoriega): Instead of line editing, refactor this code to load
 834     # yaml file into a dict, edit it and write the file back.
 835     for line in fileinput.input(sriov_file, inplace=True):
 836         line = line.strip('\n')
 837         if 'NovaSchedulerDefaultFilters' in line:
 838             print("  {}".format(line[3:]))
 839         elif 'NovaSchedulerAvailableFilters' in line:
 840             print("  {}".format(line[3:]))
 841         elif 'NeutronPhysicalDevMappings' in line:
 842             print("  NeutronPhysicalDevMappings: \"nfv_sriov:{}\""
 843                   .format(sriov_iface))
 844         elif 'NeutronSriovNumVFs' in line:
 845             print("  NeutronSriovNumVFs: \"{}:8\"".format(sriov_iface))
 846         elif 'NovaPCIPassthrough' in line:
 847             print("  NovaPCIPassthrough:")
 848         elif 'devname' in line:
 849             print("    - devname: \"{}\"".format(sriov_iface))
 850         elif 'physical_network' in line:
 851             print("      physical_network: \"nfv_sriov\"")
 852         else:
 853             print(line)
 854
 855
 856 def external_network_cmds(ns, ds):
 857     """
 858     Generates external network openstack commands
 859     :param ns: network settings
 860     :param ds: deploy settings
 861     :return: list of commands to configure external network
 862     """
 863     ds_opts = ds['deploy_options']
 864     external_physnet = 'datacentre'
 865     if ds_opts['dataplane'] == 'fdio' and \
 866        ds_opts['sdn_controller'] != 'opendaylight':
 867         external_physnet = 'external'
 868     if 'external' in ns.enabled_network_list:
 869         net_config = ns['networks']['external'][0]
 870         external = True
 871         pool_start, pool_end = net_config['floating_ip_range']
 872     else:
 873         net_config = ns['networks']['admin']
 874         external = False
 875         pool_start, pool_end = ns['apex']['networks']['admin'][
 876             'introspection_range']
 877     nic_config = net_config['nic_mapping']
 878     gateway = net_config['gateway']
 879     cmds = list()
 880     # create network command
 881     if nic_config['compute']['vlan'] == 'native':
 882         ext_type = 'flat'
 883     else:
 884         ext_type = "vlan --provider-segment {}".format(nic_config[
 885                                                        'compute']['vlan'])
 886     cmds.append("openstack network create external --project service "
 887                 "--external --provider-network-type {} "
 888                 "--provider-physical-network {}"
 889                 .format(ext_type, external_physnet))
 890     # create subnet command
 891     cidr = net_config['cidr']
 892     subnet_cmd = "openstack subnet create external-subnet --project " \
 893                  "service --network external --no-dhcp --gateway {} " \
 894                  "--allocation-pool start={},end={} --subnet-range " \
 895                  "{}".format(gateway, pool_start, pool_end, str(cidr))
 896     if external and cidr.version == 6:
 897         subnet_cmd += ' --ip-version 6'
 898     cmds.append(subnet_cmd)
 899     logging.debug("Neutron external network commands determined "
 900                   "as: {}".format(cmds))
 901     return cmds
 902
 903
 904 def create_congress_cmds(overcloud_file):
 905     drivers = ['nova', 'neutronv2', 'cinder', 'glancev2', 'keystone', 'doctor']
 906     overcloudrc = parsers.parse_overcloudrc(overcloud_file)
 907     logging.info("Creating congress commands")
 908     try:
 909         ds_cfg = [
 910             "username={}".format(overcloudrc['OS_USERNAME']),
 911             "tenant_name={}".format(overcloudrc['OS_PROJECT_NAME']),
 912             "password={}".format(overcloudrc['OS_PASSWORD']),
 913             "auth_url={}".format(overcloudrc['OS_AUTH_URL'])
 914         ]
 915     except KeyError:
 916         logging.error("Unable to find all keys required for congress in "
 917                       "overcloudrc: OS_USERNAME, OS_PROJECT_NAME, "
 918                       "OS_PASSWORD, OS_AUTH_URL.  Please check overcloudrc "
 919                       "file: {}".format(overcloud_file))
 920         raise
 921     cmds = list()
 922     ds_cfg = '--config ' + ' --config '.join(ds_cfg)
 923
 924     for driver in drivers:
 925         if driver == 'doctor':
 926             cmd = "{} \"{}\"".format(driver, driver)
 927         else:
 928             cmd = "{} \"{}\" {}".format(driver, driver, ds_cfg)
 929         if driver == 'nova':
 930             cmd += ' --config api_version="2.34"'
 931         logging.debug("Congress command created: {}".format(cmd))
 932         cmds.append(cmd)
 933     return cmds