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         admin_cidr = net_settings[constants.ADMIN_NETWORK]['cidr']
  73         admin_prefix = str(admin_cidr.prefixlen)
  74         self.netenv_obj[param_def]['ControlPlaneSubnetCidr'] = admin_prefix
  75         self.netenv_obj[param_def]['ControlPlaneDefaultRoute'] = \
  76             net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
  77         public_cidr = net_settings[constants.PUBLIC_NETWORK]['cidr']
  78         self.netenv_obj[param_def]['ExternalNetCidr'] = str(public_cidr)
  79         public_range = net_settings[constants.PUBLIC_NETWORK][
  80                                          'usable_ip_range'].split(',')
  81         self.netenv_obj[param_def]['ExternalAllocationPools'] = \
  82             [{'start':
  83               public_range[0],
  84               'end': public_range[1]
  85               }]
  86         self.netenv_obj[param_def]['ExternalInterfaceDefaultRoute'] = \
  87             net_settings[constants.PUBLIC_NETWORK]['gateway']
  88         self.netenv_obj[param_def]['EC2MetadataIp'] = \
  89             net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
  90         self.netenv_obj[param_def]['DnsServers'] = net_settings['dns_servers']
  91
  92         if public_cidr.version == 6:
  93             postfix = '/external_v6.yaml'
  94         else:
  95             postfix = '/external.yaml'
  96
  97         for key, prefix in EXTERNAL_RESOURCES.items():
  98             if prefix is None:
  99                 prefix = ''
 100             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 101
 102
 103         if constants.PRIVATE_NETWORK in enabled_networks:
 104             priv_range = net_settings[constants.PRIVATE_NETWORK][
 105                 'usable_ip_range'].split(',')
 106             self.netenv_obj[param_def]['TenantAllocationPools'] = \
 107                 [{'start':
 108                   priv_range[0],
 109                   'end': priv_range[1]
 110                   }]
 111             priv_cidr = net_settings[constants.PRIVATE_NETWORK]['cidr']
 112             self.netenv_obj[param_def]['TenantNetCidr'] = str(priv_cidr)
 113             if priv_cidr.version == 6:
 114                 postfix = '/tenant_v6.yaml'
 115             else:
 116                 postfix = '/tenant.yaml'
 117         else:
 118             postfix = '/noop.yaml'
 119
 120         for key, prefix in TENANT_RESOURCES.items():
 121             if prefix is None:
 122                 prefix = ''
 123             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 124
 125         if constants.STORAGE_NETWORK in enabled_networks:
 126             storage_range = net_settings[constants.STORAGE_NETWORK][
 127                 'usable_ip_range'].split(',')
 128             self.netenv_obj[param_def]['StorageAllocationPools'] = \
 129                 [{'start':
 130                   storage_range[0],
 131                   'end':
 132                   storage_range[1]
 133                   }]
 134             storage_cidr = net_settings[constants.STORAGE_NETWORK]['cidr']
 135             self.netenv_obj[param_def]['StorageNetCidr'] = str(storage_cidr)
 136             if storage_cidr.version == 6:
 137                 postfix = '/storage_v6.yaml'
 138             else:
 139                 postfix = '/storage.yaml'
 140         else:
 141             postfix = '/noop.yaml'
 142
 143         for key, prefix in STORAGE_RESOURCES.items():
 144             if prefix is None:
 145                 prefix = ''
 146             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 147
 148         if constants.API_NETWORK in enabled_networks:
 149             api_range = net_settings[constants.API_NETWORK][
 150                 'usable_ip_range'].split(',')
 151             self.netenv_obj[param_def]['InternalApiAllocationPools'] = \
 152                 [{'start':
 153                       api_range[0],
 154                   'end':
 155                       api_range[1]
 156                   }]
 157             api_cidr = net_settings[constants.API_NETWORK]['cidr']
 158             self.netenv_obj[param_def]['InternalApiNetCidr'] = str(api_cidr)
 159             if api_cidr.version == 6:
 160                 postfix = '/internal_api_v6.yaml'
 161             else:
 162                 postfix = '/internal_api.yaml'
 163
 164
 165         else:
 166             postfix = '/noop.yaml'
 167
 168         for key, prefix in API_RESOURCES.items():
 169             if prefix is None:
 170                 prefix = ''
 171             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 172
 173         # Set IPv6 related flags to True. Not that we do not set those to False
 174         # when IPv4 is configured, we'll use the default or whatever the user
 175         # may have set.
 176         if settings_obj.get_ip_addr_family() == 6:
 177             for flag in IPV6_FLAGS:
 178                 self.netenv_obj[param_def][flag] = True
 179
 180     def get_netenv_settings(self):
 181         """
 182         Getter for netenv settings
 183         :return: Dictionary of network environment settings
 184         """
 185         return self.netenv_obj
 186
 187
 188 class NetworkEnvException(Exception):
 189     def __init__(self, value):
 190         self.value = value
 191
 192     def __str__(self):
 193             return self.value