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