summaryrefslogtreecommitdiffstats
path: root/lib/python/apex
diff options
context:
space:
mode:
authorTim Rozet <trozet@redhat.com>2016-05-31 17:40:11 -0400
committerTim Rozet <trozet@redhat.com>2016-06-02 21:04:40 -0400
commit68fc16c4fc98d26bbb58cda6ce7945c2ac6d79bc (patch)
treed2eb7f5ccf29f66e58c7cf2b1c3575c52604adb7 /lib/python/apex
parent46a44b6c0789b32e84a6166f913b2c9a61e29cc3 (diff)
Migrates network environment parsing to python
Change-Id: Ibaf20a2960a9f4b5e3f256fbed12a61d7606a967 Signed-off-by: Tim Rozet <trozet@redhat.com>
Diffstat (limited to 'lib/python/apex')
-rw-r--r--lib/python/apex/__init__.py3
-rw-r--r--lib/python/apex/common/__init__.py0
-rw-r--r--lib/python/apex/common/constants.py16
-rw-r--r--lib/python/apex/common/utils.py15
-rw-r--r--lib/python/apex/network_environment.py135
-rw-r--r--lib/python/apex/network_settings.py (renamed from lib/python/apex/net_env.py)50
6 files changed, 198 insertions, 21 deletions
diff --git a/lib/python/apex/__init__.py b/lib/python/apex/__init__.py
index 2efc64f4..5b158501 100644
--- a/lib/python/apex/__init__.py
+++ b/lib/python/apex/__init__.py
@@ -8,5 +8,6 @@
##############################################################################
-from .net_env import NetworkSettings
+from .network_settings import NetworkSettings
from .deploy_env import DeploySettings
+from .network_environment import NetworkEnvironment
diff --git a/lib/python/apex/common/__init__.py b/lib/python/apex/common/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/lib/python/apex/common/__init__.py
diff --git a/lib/python/apex/common/constants.py b/lib/python/apex/common/constants.py
new file mode 100644
index 00000000..506b7b2b
--- /dev/null
+++ b/lib/python/apex/common/constants.py
@@ -0,0 +1,16 @@
+##############################################################################
+# Copyright (c) 2016 Tim Rozet (trozet@redhat.com) and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+ADMIN_NETWORK = 'admin_network'
+PRIVATE_NETWORK = 'private_network'
+PUBLIC_NETWORK = 'public_network'
+STORAGE_NETWORK = 'storage_network'
+API_NETWORK = 'api_network'
+OPNFV_NETWORK_TYPES = [ADMIN_NETWORK, PRIVATE_NETWORK, PUBLIC_NETWORK,
+ STORAGE_NETWORK, API_NETWORK]
diff --git a/lib/python/apex/common/utils.py b/lib/python/apex/common/utils.py
new file mode 100644
index 00000000..b7678a20
--- /dev/null
+++ b/lib/python/apex/common/utils.py
@@ -0,0 +1,15 @@
+##############################################################################
+# Copyright (c) 2016 Tim Rozet (trozet@redhat.com) and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+
+def str2bool(var):
+ if isinstance(var, bool):
+ return var
+ else:
+ return var.lower() in ("true", "yes")
diff --git a/lib/python/apex/network_environment.py b/lib/python/apex/network_environment.py
new file mode 100644
index 00000000..e6f0135a
--- /dev/null
+++ b/lib/python/apex/network_environment.py
@@ -0,0 +1,135 @@
+##############################################################################
+# Copyright (c) 2016 Tim Rozet (trozet@redhat.com) and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+import yaml
+import re
+from .common import constants
+
+PORTS = '/ports'
+# Resources defined by <resource name>: <prefix>
+TENANT_RESOURCES = {'OS::TripleO::Network::Tenant': None,
+ 'OS::TripleO::Controller::Ports::TenantPort': PORTS,
+ 'OS::TripleO::Compute::Ports::TenantPort': PORTS}
+STORAGE_RESOURCES = {'OS::TripleO::Network::Storage': None,
+ 'OS::TripleO::Network::Ports::StorageVipPort': PORTS,
+ 'OS::TripleO::Controller::Ports::StoragePort': PORTS,
+ 'OS::TripleO::Compute::Ports::StoragePort': PORTS}
+
+
+class NetworkEnvironment:
+ """
+ This class creates a Network Environment to be used in TripleO Heat
+ Templates.
+
+ The class builds upon an existing network-environment file and modifies
+ based on a NetworkSettings object.
+ """
+ def __init__(self, net_settings, filename):
+ with open(filename, 'r') as net_env_fh:
+ self.netenv_obj = yaml.load(net_env_fh)
+ if net_settings:
+ settings_obj = net_settings.get_network_settings()
+ enabled_networks = net_settings.get_enabled_networks()
+ self.netenv_obj = \
+ self._update_net_environment(settings_obj,
+ enabled_networks)
+ else:
+ raise NetworkEnvException("Network Settings does not exist")
+
+ def _update_net_environment(self, net_settings, enabled_networks):
+ """
+ Updates Network Environment according to Network Settings
+ :param: network settings dictionary
+ :param: enabled network list
+ :return: None
+ """
+ param_def = 'parameter_defaults'
+ reg = 'resource_registry'
+ for key, prefix in TENANT_RESOURCES.items():
+ if prefix is None:
+ prefix = ''
+ m = re.split('%s/\w+\.yaml' % prefix, self.netenv_obj[reg][key])
+ if m is not None:
+ tht_dir = m[0]
+ break
+ if not tht_dir:
+ raise NetworkEnvException('Unable to parse THT Directory')
+ admin_cidr = net_settings[constants.ADMIN_NETWORK]['cidr']
+ admin_prefix = str(admin_cidr.prefixlen)
+ self.netenv_obj[param_def]['ControlPlaneSubnetCidr'] = admin_prefix
+ self.netenv_obj[param_def]['ControlPlaneDefaultRoute'] = \
+ net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
+ public_cidr = net_settings[constants.PUBLIC_NETWORK]['cidr']
+ self.netenv_obj[param_def]['ExternalNetCidr'] = str(public_cidr)
+ public_range = net_settings[constants.PUBLIC_NETWORK][
+ 'usable_ip_range'].split(',')
+ self.netenv_obj[param_def]['ExternalAllocationPools'] = \
+ [{'start':
+ public_range[0],
+ 'end': public_range[1]
+ }]
+ self.netenv_obj[param_def]['ExternalInterfaceDefaultRoute'] = \
+ net_settings[constants.PUBLIC_NETWORK]['gateway']
+ self.netenv_obj[param_def]['EC2MetadataIp'] = \
+ net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
+
+ if constants.PRIVATE_NETWORK in enabled_networks:
+ priv_range = net_settings[constants.PRIVATE_NETWORK][
+ 'usable_ip_range'].split(',')
+ self.netenv_obj[param_def]['TenantAllocationPools'] = \
+ [{'start':
+ priv_range[0],
+ 'end': priv_range[1]
+ }]
+ priv_cidr = net_settings[constants.PRIVATE_NETWORK]['cidr']
+ self.netenv_obj[param_def]['TenantNetCidr'] = str(priv_cidr)
+ postfix = '/tenant.yaml'
+ else:
+ postfix = '/noop.yaml'
+
+ for key, prefix in TENANT_RESOURCES.items():
+ if prefix is None:
+ prefix = ''
+ self.netenv_obj[reg][key] = tht_dir + prefix + postfix
+
+ if constants.STORAGE_NETWORK in enabled_networks:
+ storage_range = net_settings[constants.STORAGE_NETWORK][
+ 'usable_ip_range'].split(',')
+ self.netenv_obj[param_def]['StorageAllocationPools'] = \
+ [{'start':
+ storage_range[0],
+ 'end':
+ storage_range[1]
+ }]
+ storage_cidr = net_settings[constants.STORAGE_NETWORK]['cidr']
+ self.netenv_obj[param_def]['StorageNetCidr'] = str(storage_cidr)
+ postfix = '/storage.yaml'
+ else:
+ postfix = '/noop.yaml'
+
+ for key, prefix in STORAGE_RESOURCES.items():
+ if prefix is None:
+ prefix = ''
+ self.netenv_obj[reg][key] = tht_dir + prefix + postfix
+ return self.netenv_obj
+
+ def get_netenv_settings(self):
+ """
+ Getter for netenv settings
+ :return: Dictionary of network environment settings
+ """
+ return self.netenv_obj
+
+
+class NetworkEnvException(Exception):
+ def __init__(self, value):
+ self.value = value
+
+ def __str__(self):
+ return self.value
diff --git a/lib/python/apex/net_env.py b/lib/python/apex/network_settings.py
index 3ca28f8a..ea7f4ca9 100644
--- a/lib/python/apex/net_env.py
+++ b/lib/python/apex/network_settings.py
@@ -7,20 +7,11 @@
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
-
import yaml
import logging
import ipaddress
from . import ip_utils
-
-
-ADMIN_NETWORK = 'admin_network'
-PRIVATE_NETWORK = 'private_network'
-PUBLIC_NETWORK = 'public_network'
-STORAGE_NETWORK = 'storage_network'
-API_NETWORK = 'api_network'
-OPNFV_NETWORK_TYPES = [ADMIN_NETWORK, PRIVATE_NETWORK, PUBLIC_NETWORK,
- STORAGE_NETWORK, API_NETWORK]
+from .common import constants, utils
class NetworkSettings:
@@ -48,21 +39,23 @@ class NetworkSettings:
NetworkSettingsException will be raised if validation fails.
"""
- if ADMIN_NETWORK not in self.settings_obj or \
- self.settings_obj[ADMIN_NETWORK].get('enabled') != True:
+ if constants.ADMIN_NETWORK not in self.settings_obj or \
+ not utils.str2bool(self.settings_obj[constants.ADMIN_NETWORK].get(
+ 'enabled')):
raise NetworkSettingsException("You must enable admin_network "
"and configure it explicitly or "
"use auto-detection")
if self.network_isolation and \
- (PUBLIC_NETWORK not in self.settings_obj or
- self.settings_obj[PUBLIC_NETWORK].get('enabled') != True):
+ (constants.PUBLIC_NETWORK not in self.settings_obj or not
+ utils.str2bool(self.settings_obj[constants.PUBLIC_NETWORK].get(
+ 'enabled'))):
raise NetworkSettingsException("You must enable public_network "
"and configure it explicitly or "
"use auto-detection")
- for network in OPNFV_NETWORK_TYPES:
+ for network in constants.OPNFV_NETWORK_TYPES:
if network in self.settings_obj:
- if self.settings_obj[network].get('enabled') == True:
+ if utils.str2bool(self.settings_obj[network].get('enabled')):
logging.info("{} enabled".format(network))
self._config_required_settings(network)
self._config_ip_range(network=network,
@@ -99,7 +92,7 @@ class NetworkSettings:
elif nic_name:
# If cidr is not specified, we need to know if we should find
# IPv6 or IPv4 address on the interface
- if self.settings_obj[network].get('ipv6') == True:
+ if utils.str2bool(self.settings_obj[network].get('ipv6')):
address_family = 6
else:
address_family = 4
@@ -175,14 +168,14 @@ class NetworkSettings:
- floating_ip
- gateway
"""
- if network == ADMIN_NETWORK:
+ if network == constants.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 == PUBLIC_NETWORK:
+ elif network == constants.PUBLIC_NETWORK:
self._config_ip(network, 'provisioner_ip', 1)
self._config_ip_range(network=network,
setting='floating_ip',
@@ -213,7 +206,6 @@ class NetworkSettings:
logging.info("{}_gateway: {}".format(network, gateway))
-
def dump_bash(self, path=None):
"""
Prints settings for bash consumption.
@@ -248,9 +240,27 @@ class NetworkSettings:
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
+ :return: list of enabled networks
+ """
+ return self.enabled_network_list
+
+
class NetworkSettingsException(Exception):
def __init__(self, value):
self.value = value
def __str__(self):
return self.value
+
+
+