diff options
| -rw-r--r-- | lib/python/apex/common/constants.py | 4 | ||||
| -rw-r--r-- | lib/python/apex/network_environment.py | 9 | ||||
| -rw-r--r-- | lib/python/apex/network_settings.py | 150 | ||||
| -rwxr-xr-x | lib/python/apex_python_utils.py | 3 | ||||
| -rw-r--r-- | tests/test_apex_network_settings.py | 4 |
5 files changed, 96 insertions, 74 deletions
diff --git a/lib/python/apex/common/constants.py b/lib/python/apex/common/constants.py index ae8ffe31..dfb6267b 100644 --- a/lib/python/apex/common/constants.py +++ b/lib/python/apex/common/constants.py @@ -15,7 +15,9 @@ API_NETWORK = 'api_network' OPNFV_NETWORK_TYPES = [ADMIN_NETWORK, PRIVATE_NETWORK, PUBLIC_NETWORK, STORAGE_NETWORK, API_NETWORK] DNS_SERVERS = ["8.8.8.8", "8.8.4.4"] -ROLES = ['compute', 'controller'] +COMPUTE = 'compute' +CONTROLLER = 'controller' +ROLES = [COMPUTE, CONTROLLER] DOMAIN_NAME = 'localdomain.com' COMPUTE_PRE = "OS::TripleO::ComputeExtraConfigPre" CONTROLLER_PRE = "OS::TripleO::ControllerExtraConfigPre" diff --git a/lib/python/apex/network_environment.py b/lib/python/apex/network_environment.py index bf81b98d..22dcc352 100644 --- a/lib/python/apex/network_environment.py +++ b/lib/python/apex/network_environment.py @@ -59,17 +59,16 @@ class NetworkEnvironment: self.netenv_obj = yaml.load(net_env_fh) self._update_net_environment(net_settings) - def _update_net_environment(self, settings_obj): + def _update_net_environment(self, net_settings): """ Updates Network Environment according to Network Settings :param: network settings object :return: None """ - if not settings_obj: + if not net_settings: raise NetworkEnvException("Network Settings does not exist") - net_settings = settings_obj.get_network_settings() - enabled_networks = settings_obj.get_enabled_networks() + enabled_networks = net_settings.get_enabled_networks() param_def = 'parameter_defaults' reg = 'resource_registry' for key, prefix in TENANT_RESOURCES.items(): @@ -201,7 +200,7 @@ class NetworkEnvironment: # Set IPv6 related flags to True. Not that we do not set those to False # when IPv4 is configured, we'll use the default or whatever the user # may have set. - if settings_obj.get_ip_addr_family() == 6: + if net_settings.get_ip_addr_family() == 6: for flag in IPV6_FLAGS: self.netenv_obj[param_def][flag] = True diff --git a/lib/python/apex/network_settings.py b/lib/python/apex/network_settings.py index c81256eb..ca91b8cf 100644 --- a/lib/python/apex/network_settings.py +++ b/lib/python/apex/network_settings.py @@ -11,10 +11,22 @@ import yaml import logging import ipaddress from . import ip_utils -from .common import constants, utils - - -class NetworkSettings: +from .common.utils import str2bool +from .common.constants import ( + ADMIN_NETWORK, + PRIVATE_NETWORK, + PUBLIC_NETWORK, + STORAGE_NETWORK, + API_NETWORK, + OPNFV_NETWORK_TYPES, + DNS_SERVERS, + DOMAIN_NAME, + ROLES, + COMPUTE, + CONTROLLER) + + +class NetworkSettings(dict): """ This class parses APEX network settings yaml file into an object. It generates or detects all missing fields for deployment. @@ -27,13 +39,35 @@ class NetworkSettings: deployment script move to python. """ def __init__(self, filename, network_isolation): - with open(filename, 'r') as network_settings_file: - self.settings_obj = yaml.load(network_settings_file) - self.network_isolation = network_isolation - self.enabled_network_list = [] - self.nics = {'compute': dict(), 'controller': dict()} - self.nics_specified = {'compute': False, 'controller': False} - self._validate_input() + init_dict = {} + if type(filename) is str: + with open(filename, 'r') as network_settings_file: + init_dict = yaml.load(network_settings_file) + else: + # assume input is a dict to build from + init_dict = filename + + super().__init__(init_dict) + + if 'apex' in self: + # merge two dics Nondestructively + def merge(pri, sec): + for key, val in sec.items(): + if key in pri: + if type(val) is dict: + merge(pri[key], val) + # else + # do not overwrite what's already there + else: + pri[key] = val + # merge the apex specific config into the first class settings + merge(self, copy(self['apex'])) + + self.network_isolation = network_isolation + self.enabled_network_list = [] + self.nics = {COMPUTE: {}, CONTROLLER: {}} + self.nics_specified = {COMPUTE: False, CONTROLLER: False} + self._validate_input() def _validate_input(self): """ @@ -41,23 +75,23 @@ class NetworkSettings: NetworkSettingsException will be raised if validation fails. """ - if constants.ADMIN_NETWORK not in self.settings_obj or \ - not utils.str2bool(self.settings_obj[constants.ADMIN_NETWORK].get( + if ADMIN_NETWORK not in self or \ + not str2bool(self[ADMIN_NETWORK].get( 'enabled')): raise NetworkSettingsException("You must enable admin_network " "and configure it explicitly or " "use auto-detection") if self.network_isolation and \ - (constants.PUBLIC_NETWORK not in self.settings_obj or not - utils.str2bool(self.settings_obj[constants.PUBLIC_NETWORK].get( + (PUBLIC_NETWORK not in self or not + str2bool(self[PUBLIC_NETWORK].get( 'enabled'))): raise NetworkSettingsException("You must enable public_network " "and configure it explicitly or " "use auto-detection") - for network in constants.OPNFV_NETWORK_TYPES: - if network in self.settings_obj: - if utils.str2bool(self.settings_obj[network].get('enabled')): + for network in OPNFV_NETWORK_TYPES: + if network in self: + if str2bool(self[network].get('enabled')): logging.info("{} enabled".format(network)) self._config_required_settings(network) self._config_ip_range(network=network, @@ -73,10 +107,8 @@ class NetworkSettings: logging.info("{} is not in specified, will collapse with " "admin_network".format(network)) - self.settings_obj['dns_servers'] = self.settings_obj.get( - 'dns_servers', constants.DNS_SERVERS) - self.settings_obj['domain_name'] = self.settings_obj.get( - 'domain_name', constants.DOMAIN_NAME) + self['dns_servers'] = self.get('dns_servers', DNS_SERVERS) + self['domain_name'] = self.get('domain_name', DOMAIN_NAME) def _validate_overcloud_nic_order(self, network): """ @@ -92,20 +124,18 @@ class NetworkSettings: :return: None """ - for role in constants.ROLES: + for role in ROLES: interface = role+'_interface' nic_index = self.get_enabled_networks().index(network) + 1 - if interface in self.settings_obj[network]: - if any(y == self.settings_obj[network][interface] for x, y in + if interface in self[network]: + if any(y == self[network][interface] for x, y in self.nics[role].items()): raise NetworkSettingsException("Duplicate {} already " "specified for " "another network" - .format(self.settings_obj - [network] + .format(self[network] [interface])) - self.nics[role][network] = self.settings_obj[network][ - interface] + self.nics[role][network] = self[network][interface] self.nics_specified[role] = True logging.info("{} nic order specified for network {" "}".format(role, network)) @@ -135,28 +165,28 @@ class NetworkSettings: be an ipaddress.network object, replacing the NIC name. """ # if vlan not defined then default it to native - if network is not constants.ADMIN_NETWORK: - if 'vlan' not in self.settings_obj[network]: - self.settings_obj[network]['vlan'] = 'native' + if network is not ADMIN_NETWORK: + if 'vlan' not in self[network]: + self[network]['vlan'] = 'native' - cidr = self.settings_obj[network].get('cidr') - nic_name = self.settings_obj[network].get('bridged_interface') + cidr = self[network].get('cidr') + nic_name = self[network].get('bridged_interface') if cidr: - cidr = ipaddress.ip_network(self.settings_obj[network]['cidr']) - self.settings_obj[network]['cidr'] = cidr + cidr = ipaddress.ip_network(self[network]['cidr']) + self[network]['cidr'] = cidr logging.info("{}_cidr: {}".format(network, cidr)) return 0 elif nic_name: # If cidr is not specified, we need to know if we should find # IPv6 or IPv4 address on the interface - if utils.str2bool(self.settings_obj[network].get('ipv6')): + if str2bool(self[network].get('ipv6')): address_family = 6 else: address_family = 4 nic_interface = ip_utils.get_interface(nic_name, address_family) if nic_interface: - self.settings_obj[network]['bridged_interface'] = nic_interface + self[network]['bridged_interface'] = nic_interface logging.info("{}_bridged_interface: {}". format(network, nic_interface)) return 0 @@ -182,17 +212,17 @@ class NetworkSettings: The spec for start_offset, end_offset and count are identical to ip_utils.get_ip_range. """ - ip_range = self.settings_obj[network].get(setting) - interface = self.settings_obj[network].get('bridged_interface') + ip_range = self[network].get(setting) + interface = self[network].get('bridged_interface') if not ip_range: - cidr = self.settings_obj[network].get('cidr') + cidr = self[network].get('cidr') ip_range = ip_utils.get_ip_range(start_offset=start_offset, end_offset=end_offset, count=count, cidr=cidr, interface=interface) - self.settings_obj[network][setting] = ip_range + self[network][setting] = ip_range logging.info("{}_{}: {}".format(network, setting, ip_range)) @@ -204,13 +234,13 @@ class NetworkSettings: The spec for offset is identical to ip_utils.get_ip """ - ip = self.settings_obj[network].get(setting) - interface = self.settings_obj[network].get('bridged_interface') + ip = self[network].get(setting) + interface = self[network].get('bridged_interface') if not ip: - cidr = self.settings_obj[network].get('cidr') + cidr = self[network].get('cidr') ip = ip_utils.get_ip(offset, cidr, interface) - self.settings_obj[network][setting] = ip + self[network][setting] = ip logging.info("{}_{}: {}".format(network, setting, ip)) @@ -226,14 +256,14 @@ class NetworkSettings: - floating_ip_range - gateway """ - if network == constants.ADMIN_NETWORK: + if network == ADMIN_NETWORK: self._config_ip(network, 'provisioner_ip', 1) self._config_ip_range(network=network, setting='dhcp_range', start_offset=2, count=9) self._config_ip_range(network=network, setting='introspection_range', start_offset=11, count=9) - elif network == constants.PUBLIC_NETWORK: + elif network == PUBLIC_NETWORK: self._config_ip(network, 'provisioner_ip', 1) self._config_ip_range(network=network, setting='floating_ip_range', @@ -247,18 +277,18 @@ class NetworkSettings: If cidr is specified, we always use the first address in the address space for gateway. Otherwise, we detect the system gateway. """ - gateway = self.settings_obj[network].get('gateway') - interface = self.settings_obj[network].get('bridged_interface') + gateway = self[network].get('gateway') + interface = self[network].get('bridged_interface') if not gateway: - cidr = self.settings_obj[network].get('cidr') + cidr = self[network].get('cidr') if cidr: gateway = ip_utils.get_ip(1, cidr) else: gateway = ip_utils.find_gateway(interface) if gateway: - self.settings_obj[network]['gateway'] = gateway + self[network]['gateway'] = gateway else: raise NetworkSettingsException("Failed to set gateway") @@ -273,18 +303,17 @@ class NetworkSettings: """ bash_str = '' for network in self.enabled_network_list: - for key, value in self.settings_obj[network].items(): + for key, value in self[network].items(): bash_str += "{}_{}={}\n".format(network, key, value) bash_str += "enabled_network_list='{}'\n" \ .format(' '.join(self.enabled_network_list)) bash_str += "ip_addr_family={}\n".format(self.get_ip_addr_family()) dns_list = "" - for dns_server in self.settings_obj['dns_servers']: + for dns_server in self['dns_servers']: dns_list = dns_list + "{} ".format(dns_server) dns_list = dns_list.strip() bash_str += "dns_servers=\'{}\'\n".format(dns_list) - bash_str += "domain_name=\'{}\'\n".format(self.settings_obj[ - 'domain_name']) + bash_str += "domain_name=\'{}\'\n".format(self['domain_name']) if path: with open(path, 'w') as file: file.write(bash_str) @@ -299,19 +328,12 @@ class NetworkSettings: IPv6. """ for network in self.enabled_network_list: - cidr = ipaddress.ip_network(self.settings_obj[network]['cidr']) + cidr = ipaddress.ip_network(self[network]['cidr']) if cidr.version == 6: return 6 return 4 - def get_network_settings(self): - """ - Getter for network settings - :return: network settings dictionary - """ - return self.settings_obj - def get_enabled_networks(self): """ Getter for enabled network list diff --git a/lib/python/apex_python_utils.py b/lib/python/apex_python_utils.py index 8ea40f2c..dcf483d1 100755 --- a/lib/python/apex_python_utils.py +++ b/lib/python/apex_python_utils.py @@ -97,14 +97,13 @@ def build_nic_template(args): network_settings = NetworkSettings(args.net_settings_file, args.network_isolation) - settings = network_settings.settings_obj env = Environment(loader=FileSystemLoader(template_dir)) template = env.get_template(template) # gather vlan values into a dict net_list = copy(args.enabled_networks).split(' ') net_list.remove(ADMIN_NETWORK) - vlans_vals = map(lambda x: settings[x]['vlan'], net_list) + vlans_vals = map(lambda x: network_settings[x]['vlan'], net_list) vlans = dict(zip(net_list, vlans_vals)) nics = network_settings.nics diff --git a/tests/test_apex_network_settings.py b/tests/test_apex_network_settings.py index 45c26ed4..ff61cc4b 100644 --- a/tests/test_apex_network_settings.py +++ b/tests/test_apex_network_settings.py @@ -44,7 +44,7 @@ class TestNetworkSettings(object): def test_get_network_settings(self): ns = NetworkSettings('../config/network/network_settings.yaml', True) - assert_is_instance(ns.get_network_settings(), dict) + assert_is_instance(ns, dict) for role in ['controller', 'compute']: nic_index = 1 for network in ['admin_network', 'private_network', @@ -57,7 +57,7 @@ class TestNetworkSettings(object): ns = NetworkSettings( '../tests/config/network_settings_nics_not_specified.yaml', True) - assert_is_instance(ns.get_network_settings(), dict) + assert_is_instance(ns, dict) for role in ['controller', 'compute']: nic_index = 1 for network in ['admin_network', 'private_network', |