apex/network/network_environment.py

   1 ##############################################################################
   2 # Copyright (c) 2016 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 re
  11 import yaml
  12
  13 from apex.settings.network_settings import NetworkSettings
  14 from apex.common.constants import (
  15     CONTROLLER,
  16     COMPUTE,
  17     ADMIN_NETWORK,
  18     TENANT_NETWORK,
  19     STORAGE_NETWORK,
  20     EXTERNAL_NETWORK,
  21     API_NETWORK,
  22     DEFAULT_OS_VERSION,
  23 )
  24
  25 HEAT_NONE = 'OS::Heat::None'
  26 PORTS = '/ports'
  27 # Resources defined by <resource name>: <prefix>
  28 EXTERNAL_RESOURCES = {'OS::TripleO::Network::External': None,
  29                       'OS::TripleO::Network::Ports::ExternalVipPort': PORTS,
  30                       'OS::TripleO::Controller::Ports::ExternalPort': PORTS,
  31                       'OS::TripleO::Compute::Ports::ExternalPort': PORTS}
  32 TENANT_RESOURCES = {'OS::TripleO::Network::Tenant': None,
  33                     'OS::TripleO::Controller::Ports::TenantPort': PORTS,
  34                     'OS::TripleO::Compute::Ports::TenantPort': PORTS}
  35 STORAGE_RESOURCES = {'OS::TripleO::Network::Storage': None,
  36                      'OS::TripleO::Network::Ports::StorageVipPort': PORTS,
  37                      'OS::TripleO::Controller::Ports::StoragePort': PORTS,
  38                      'OS::TripleO::Compute::Ports::StoragePort': PORTS}
  39 API_RESOURCES = {'OS::TripleO::Network::InternalApi': None,
  40                  'OS::TripleO::Network::Ports::InternalApiVipPort': PORTS,
  41                  'OS::TripleO::Controller::Ports::InternalApiPort': PORTS,
  42                  'OS::TripleO::Compute::Ports::InternalApiPort': PORTS}
  43 STORAGE_MGMT_RESOURCES = {
  44     'OS::TripleO::Network::StorageMgmt': None,
  45     'OS::TripleO::Network::Ports::StorageMgmtVipPort': PORTS,
  46     'OS::TripleO::Controller::Ports::StorageMgmtPort': PORTS,
  47     'OS::TripleO::Compute::Ports::StorageMgmtPort': PORTS
  48 }
  49
  50 # A list of flags that will be set to true when IPv6 is enabled
  51 IPV6_FLAGS = ["NovaIPv6", "MongoDbIPv6", "CorosyncIPv6", "CephIPv6",
  52               "RabbitIPv6", "MemcachedIPv6"]
  53
  54 reg = 'resource_registry'
  55 param_def = 'parameter_defaults'
  56
  57
  58 class NetworkEnvironment(dict):
  59     """
  60     This class creates a Network Environment to be used in TripleO Heat
  61     Templates.
  62
  63     The class builds upon an existing network-environment file and modifies
  64     based on a NetworkSettings object.
  65     """
  66     def __init__(self, net_settings, filename, compute_pre_config=False,
  67                  controller_pre_config=False, os_version=DEFAULT_OS_VERSION):
  68         """
  69         Create Network Environment according to Network Settings
  70         """
  71         init_dict = {}
  72         if not isinstance(net_settings, NetworkSettings):
  73             raise NetworkEnvException('Invalid Network Settings object')
  74         if isinstance(filename, str):
  75             with open(filename, 'r') as net_env_fh:
  76                 init_dict = yaml.safe_load(net_env_fh)
  77         super().__init__(init_dict)
  78         self._set_tht_dir()
  79         nets = net_settings['networks']
  80         self.os_version = os_version
  81         admin_cidr = nets[ADMIN_NETWORK]['cidr']
  82         admin_prefix = str(admin_cidr.prefixlen)
  83         self[param_def]['ControlPlaneSubnetCidr'] = admin_prefix
  84         self[param_def]['ControlPlaneDefaultRoute'] = \
  85             nets[ADMIN_NETWORK]['gateway']
  86         self[param_def]['EC2MetadataIp'] = \
  87             nets[ADMIN_NETWORK]['installer_vm']['ip']
  88         self[param_def]['DnsServers'] = net_settings['dns_servers']
  89
  90         if EXTERNAL_NETWORK in net_settings.enabled_network_list:
  91             external_cidr = net_settings.get_network(EXTERNAL_NETWORK)['cidr']
  92             self[param_def]['ExternalNetCidr'] = str(external_cidr)
  93             external_vlan = self._get_vlan(net_settings.get_network(
  94                                            EXTERNAL_NETWORK))
  95             if isinstance(external_vlan, int):
  96                 self[param_def]['NeutronExternalNetworkBridge'] = '""'
  97                 self[param_def]['ExternalNetworkVlanID'] = external_vlan
  98             external_range = net_settings.get_network(EXTERNAL_NETWORK)[
  99                 'overcloud_ip_range']
 100             self[param_def]['ExternalAllocationPools'] = \
 101                 [{'start': str(external_range[0]),
 102                   'end': str(external_range[1])}]
 103             self[param_def]['ExternalInterfaceDefaultRoute'] = \
 104                 net_settings.get_network(EXTERNAL_NETWORK)['gateway']
 105
 106             if external_cidr.version == 6:
 107                 postfix = '/external_v6.yaml'
 108             else:
 109                 postfix = '/external.yaml'
 110         else:
 111             postfix = '/noop.yaml'
 112
 113         # apply resource registry update for EXTERNAL_RESOURCES
 114         self._config_resource_reg(EXTERNAL_RESOURCES, postfix)
 115
 116         if TENANT_NETWORK in net_settings.enabled_network_list:
 117             tenant_range = nets[TENANT_NETWORK]['overcloud_ip_range']
 118             self[param_def]['TenantAllocationPools'] = \
 119                 [{'start': str(tenant_range[0]),
 120                   'end': str(tenant_range[1])}]
 121             tenant_cidr = nets[TENANT_NETWORK]['cidr']
 122             self[param_def]['TenantNetCidr'] = str(tenant_cidr)
 123             if tenant_cidr.version == 6:
 124                 postfix = '/tenant_v6.yaml'
 125                 # set overlay_ip_version option in Neutron ML2 config
 126                 self[param_def]['NeutronOverlayIPVersion'] = "6"
 127             else:
 128                 postfix = '/tenant.yaml'
 129
 130             tenant_vlan = self._get_vlan(nets[TENANT_NETWORK])
 131             if isinstance(tenant_vlan, int):
 132                 self[param_def]['TenantNetworkVlanID'] = tenant_vlan
 133         else:
 134             postfix = '/noop.yaml'
 135
 136         # apply resource registry update for TENANT_RESOURCES
 137         self._config_resource_reg(TENANT_RESOURCES, postfix)
 138
 139         if STORAGE_NETWORK in net_settings.enabled_network_list:
 140             storage_range = nets[STORAGE_NETWORK]['overcloud_ip_range']
 141             self[param_def]['StorageAllocationPools'] = \
 142                 [{'start': str(storage_range[0]),
 143                   'end': str(storage_range[1])}]
 144             storage_cidr = nets[STORAGE_NETWORK]['cidr']
 145             self[param_def]['StorageNetCidr'] = str(storage_cidr)
 146             if storage_cidr.version == 6:
 147                 postfix = '/storage_v6.yaml'
 148             else:
 149                 postfix = '/storage.yaml'
 150             storage_vlan = self._get_vlan(nets[STORAGE_NETWORK])
 151             if isinstance(storage_vlan, int):
 152                 self[param_def]['StorageNetworkVlanID'] = storage_vlan
 153         else:
 154             postfix = '/noop.yaml'
 155
 156         # apply resource registry update for STORAGE_RESOURCES
 157         self._config_resource_reg(STORAGE_RESOURCES, postfix)
 158
 159         if API_NETWORK in net_settings.enabled_network_list:
 160             api_range = nets[API_NETWORK]['overcloud_ip_range']
 161             self[param_def]['InternalApiAllocationPools'] = \
 162                 [{'start': str(api_range[0]),
 163                   'end': str(api_range[1])}]
 164             api_cidr = nets[API_NETWORK]['cidr']
 165             self[param_def]['InternalApiNetCidr'] = str(api_cidr)
 166             if api_cidr.version == 6:
 167                 postfix = '/internal_api_v6.yaml'
 168             else:
 169                 postfix = '/internal_api.yaml'
 170             api_vlan = self._get_vlan(nets[API_NETWORK])
 171             if isinstance(api_vlan, int):
 172                 self[param_def]['InternalApiNetworkVlanID'] = api_vlan
 173         else:
 174             postfix = '/noop.yaml'
 175
 176         # apply resource registry update for API_RESOURCES
 177         self._config_resource_reg(API_RESOURCES, postfix)
 178
 179         if self.os_version != 'ocata':
 180             self._config_resource_reg(STORAGE_MGMT_RESOURCES, '/noop.yaml')
 181
 182         # Set IPv6 related flags to True. Not that we do not set those to False
 183         # when IPv4 is configured, we'll use the default or whatever the user
 184         # may have set.
 185         if net_settings.get_ip_addr_family() == 6:
 186             for flag in IPV6_FLAGS:
 187                 self[param_def][flag] = True
 188
 189     def _get_vlan(self, network):
 190         if isinstance(network['nic_mapping'][CONTROLLER]['vlan'], int):
 191             return network['nic_mapping'][CONTROLLER]['vlan']
 192         elif isinstance(network['nic_mapping'][COMPUTE]['vlan'], int):
 193             return network['nic_mapping'][COMPUTE]['vlan']
 194         else:
 195             return 'native'
 196
 197     def _set_tht_dir(self):
 198         self.tht_dir = None
 199         for key, prefix in TENANT_RESOURCES.items():
 200             if prefix is None:
 201                 prefix = ''
 202             m = re.split('%s/\w+\.yaml' % prefix, self[reg][key])
 203             if m is not None and len(m) > 1:
 204                 self.tht_dir = m[0]
 205                 break
 206         if not self.tht_dir:
 207             raise NetworkEnvException('Unable to parse THT Directory')
 208
 209     def _config_resource_reg(self, resources, postfix):
 210         for key, prefix in resources.items():
 211             if prefix is None:
 212                 if postfix == '/noop.yaml':
 213                     if self.os_version == 'ocata':
 214                         self[reg][key] = HEAT_NONE
 215                     else:
 216                         del self[reg][key]
 217                     continue
 218                 prefix = ''
 219             self[reg][key] = self.tht_dir + prefix + postfix
 220
 221
 222 class NetworkEnvException(Exception):
 223     def __init__(self, value):
 224         self.value = value
 225
 226     def __str__(self):
 227             return self.value