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