def __init__(self, conf, driver): # XXX maybe we need a better name: conf
"""Create a BigipTenantManager."""
self.conf = conf
self.driver = driver
self.system_helper = SystemHelper()
self.network_helper = NetworkHelper()
self.service_adapter = self.driver.service_adapter
def __init__(self, conf, driver): # XXX maybe we need a better name: conf
"""Create a BigipTenantManager."""
self.conf = conf
self.driver = driver
self.system_helper = SystemHelper()
self.network_helper = NetworkHelper()
self.service_adapter = self.driver.service_adapter
def __init__(self, driver, f5_global_routed_mode):
self.conf = driver.conf
self.driver = driver
self.f5_global_routed_mode = f5_global_routed_mode
self.vlan_binding = None
self.fdb_connector = None
self.interface_mapping = {}
self.tagging_mapping = {}
self.system_helper = SystemHelper()
self.network_helper = NetworkHelper()
self.service_adapter = ServiceModelAdapter(self.conf)
if not f5_global_routed_mode:
self.fdb_connector = FDBConnectorML2(self.conf)
if self.conf.vlan_binding_driver:
try:
self.vlan_binding = importutils.import_object(
self.conf.vlan_binding_driver, self.conf, self)
except ImportError:
LOG.error('Failed to import VLAN binding driver: %s'
% self.conf.vlan_binding_driver)
raise
# map format is phynet:interface:tagged
for maps in self.conf.f5_external_physical_mappings:
intmap = maps.split(':')
net_key = str(intmap[0]).strip()
if len(intmap) > 3:
net_key = net_key + ':' + str(intmap[3]).strip()
self.interface_mapping[net_key] = str(intmap[1]).strip()
self.tagging_mapping[net_key] = str(intmap[2]).strip()
LOG.debug('physical_network %s = interface %s, tagged %s'
% (net_key, intmap[1], intmap[2]))
def _init_bigip_managers(self):
if self.conf.vlan_binding_driver:
try:
self.vlan_binding = importutils.import_object(
self.conf.vlan_binding_driver, self.conf, self)
except ImportError:
LOG.error('Failed to import VLAN binding driver: %s'
% self.conf.vlan_binding_driver)
if self.conf.l3_binding_driver:
try:
self.l3_binding = importutils.import_object(
self.conf.l3_binding_driver, self.conf, self)
except ImportError:
LOG.error('Failed to import L3 binding driver: %s'
% self.conf.l3_binding_driver)
else:
LOG.debug('No L3 binding driver configured.'
' No L3 binding will be done.')
self.service_adapter = ServiceModelAdapter(self.conf)
self.tenant_manager = BigipTenantManager(self.conf, self)
self.cluster_manager = ClusterManager()
self.system_helper = SystemHelper()
self.lbaas_builder = LBaaSBuilder(self.conf, self)
if self.conf.f5_global_routed_mode:
self.network_builder = None
else:
self.network_builder = NetworkServiceBuilder(
self.conf,
self,
self.conf.f5_global_routed_mode)
def test_purge_folder(track_bigip_cfg, bigip, services, icd_config,
icontrol_driver):
env_prefix = icd_config['environment_prefix']
service_iter = iter(services)
validator = ResourceValidator(bigip, env_prefix)
# create loadbalancer
service = service_iter.next()
lb_reader = LoadbalancerReader(service)
folder = '{0}_{1}'.format(env_prefix, lb_reader.tenant_id())
icontrol_driver._common_service_handler(service)
assert bigip.folder_exists(folder)
# create listener
service = service_iter.next()
listener = service['listeners'][0]
icontrol_driver._common_service_handler(service)
validator.assert_virtual_valid(listener, folder)
# create pool
service = service_iter.next()
pool = service['pools'][0]
icontrol_driver._common_service_handler(service)
validator.assert_pool_valid(pool, folder)
# create l7policy with l7rule attached to the above created
# listener
service = service_iter.next()
icontrol_driver._common_service_handler(service)
service = service_iter.next()
icontrol_driver._common_service_handler(service)
validator.assert_policy_valid(listener, folder)
sh = SystemHelper()
sh.purge_folder_contents(bigip.bigip, folder)
# delete folder and check that it does not exist
sh.purge_folder(bigip.bigip, folder)
assert not bigip.folder_exists(folder)
def test_purge_folder(track_bigip_cfg, bigip, services, icd_config,
icontrol_driver):
env_prefix = icd_config['environment_prefix']
service_iter = iter(services)
validator = ResourceValidator(bigip, env_prefix)
# create loadbalancer
service = service_iter.next()
lb_reader = LoadbalancerReader(service)
folder = '{0}_{1}'.format(env_prefix, lb_reader.tenant_id())
icontrol_driver._common_service_handler(service)
assert bigip.folder_exists(folder)
# create listener
service = service_iter.next()
listener = service['listeners'][0]
icontrol_driver._common_service_handler(service)
validator.assert_virtual_valid(listener, folder)
# create pool
service = service_iter.next()
pool = service['pools'][0]
icontrol_driver._common_service_handler(service)
validator.assert_pool_valid(pool, folder)
# create l7policy with l7rule attached to the above created
# listener
service = service_iter.next()
icontrol_driver._common_service_handler(service)
service = service_iter.next()
icontrol_driver._common_service_handler(service)
validator.assert_policy_valid(listener, folder)
sh = SystemHelper()
sh.purge_folder_contents(bigip.bigip, folder)
# delete folder and check that it does not exist
sh.purge_folder(bigip.bigip, folder)
assert not bigip.folder_exists(folder)
class BigipTenantManager(object):
"""Create network connectivity for a bigip."""
def __init__(self, conf, driver): # XXX maybe we need a better name: conf
"""Create a BigipTenantManager."""
self.conf = conf
self.driver = driver
self.system_helper = SystemHelper()
self.network_helper = NetworkHelper()
self.service_adapter = self.driver.service_adapter
def assure_tenant_created(self, service):
"""Create tenant partition.
This method modifies its argument 'service' in place.
This method adds a 'traffic_group" key to the service
dict with a value of traffic_group_string_id. But aren't
traffic_groups a bigIP device concept? And wasn't (until
this method was called) the service object a configuration
entirely defined by neutron? Also for neutron->device
adaptations shouldn't we be using ServiceModelAdapter... though I
suppose this is the other way.
"""
tenant_id = service['loadbalancer']['tenant_id']
traffic_group = self.driver.service_to_traffic_group(service)
traffic_group = '/Common/' + traffic_group
service["traffic_group"] = traffic_group # modify the passed dict
# create tenant folder
folder_name = self.service_adapter.get_folder_name(tenant_id)
LOG.debug("Creating tenant folder %s" % folder_name)
for bigip in self.driver.get_config_bigips():
if not self.system_helper.folder_exists(bigip, folder_name):
folder = self.service_adapter.get_folder(service)
# This folder is a dict config obj, that can be passed to
# folder.create in the SDK
try:
self.system_helper.create_folder(bigip, folder)
except Exception as err:
# XXX Maybe we can make this more specific?
LOG.exception("Error creating folder %s" %
(folder))
raise f5ex.SystemCreationException(
"Folder creation error for tenant %s" %
(tenant_id))
if not self.driver.disconnected_service.network_exists(
bigip, folder_name):
try:
self.driver.disconnected_service.create_network(
bigip, folder_name)
except Exception as err:
LOG.exception("Error creating disconnected network %s." %
(folder_name))
raise f5ex.SystemCreationException(
"Disconnected network create error for tenant %s" %
(tenant_id))
# create tenant route domain
if self.conf.use_namespaces:
for bigip in self.driver.get_all_bigips():
if not self.network_helper.route_domain_exists(bigip,
folder_name):
try:
self.network_helper.create_route_domain(
bigip,
folder_name,
self.conf.f5_route_domain_strictness)
except Exception as err:
LOG.exception(err.message)
raise f5ex.RouteDomainCreationException(
"Failed to create route domain for "
"tenant in %s" % (folder_name))
def assure_tenant_cleanup(self, service, all_subnet_hints):
"""Delete tenant partition."""
# Called for every bigip only in replication mode,
# otherwise called once.
for bigip in self.driver.get_config_bigips():
subnet_hints = all_subnet_hints[bigip.device_name]
self._assure_bigip_tenant_cleanup(bigip, service, subnet_hints)
# called for every bigip only in replication mode.
# otherwise called once
def _assure_bigip_tenant_cleanup(self, bigip, service, subnet_hints):
tenant_id = service['loadbalancer']['tenant_id']
self._remove_tenant_replication_mode(bigip, tenant_id)
def _remove_tenant_replication_mode(self, bigip, tenant_id):
# Remove tenant in replication sync-mode
partition = self.service_adapter.get_folder_name(tenant_id)
domain_names = self.network_helper.get_route_domain_names(bigip,
partition)
for domain_name in domain_names:
try:
self.network_helper.delete_route_domain(bigip,
partition,
domain_name)
except Exception as err:
LOG.error("Failed to delete route domain %s. "
"%s. Manual intervention might be required."
% (domain_name, err.message))
if self.driver.disconnected_service.network_exists(
bigip, partition):
try:
self.driver.disconnected_service.delete_network(bigip,
partition)
except Exception as err:
LOG.error("Failed to delete disconnected network %s. "
"%s. Manual intervention might be required."
% (partition, err.message))
try:
self.system_helper.delete_folder(bigip, partition)
except Exception as err:
LOG.error(
"Folder deletion exception for tenant partition %s occurred."
% tenant_id)
LOG.exception("%s" % err.message)
raise f5ex.SystemDeleteException(
"Failed to destroy folder %s manual cleanup might be "
"required." % partition)
class BigipTenantManager(object):
"""Create network connectivity for a bigip."""
def __init__(self, conf, driver): # XXX maybe we need a better name: conf
"""Create a BigipTenantManager."""
self.conf = conf
self.driver = driver
self.system_helper = SystemHelper()
self.network_helper = NetworkHelper()
self.service_adapter = self.driver.service_adapter
def assure_tenant_created(self, service):
"""Create tenant partition.
This method modifies its argument 'service' in place.
This method adds a 'traffic_group" key to the service
dict with a value of traffic_group_string_id. But aren't
traffic_groups a bigIP device concept? And wasn't (until
this method was called) the service object a configuration
entirely defined by neutron? Also for neutron->device
adaptations shouldn't we be using ServiceModelAdapter... though I
suppose this is the other way.
"""
tenant_id = service['loadbalancer']['tenant_id']
traffic_group = self.driver.service_to_traffic_group(service)
traffic_group = '/Common/' + traffic_group
service["traffic_group"] = traffic_group # modify the passed dict
# create tenant folder
folder_name = self.service_adapter.get_folder_name(tenant_id)
LOG.debug("Creating tenant folder %s" % folder_name)
for bigip in self.driver.get_config_bigips():
if not self.system_helper.folder_exists(bigip, folder_name):
folder = self.service_adapter.get_folder(service)
# This folder is a dict config obj, that can be passed to
# folder.create in the SDK
try:
self.system_helper.create_folder(bigip, folder)
except Exception as err:
# XXX Maybe we can make this more specific?
LOG.exception("Error creating folder %s" % (folder))
raise f5ex.SystemCreationException(
"Folder creation error for tenant %s" % (tenant_id))
# create tenant route domain
if self.conf.use_namespaces:
for bigip in self.driver.get_all_bigips():
if not self.network_helper.route_domain_exists(
bigip, folder_name):
try:
self.network_helper.create_route_domain(
bigip, folder_name,
self.conf.f5_route_domain_strictness)
except Exception as err:
LOG.exception(err.message)
raise f5ex.RouteDomainCreationException(
"Failed to create route domain for "
"tenant in %s" % (folder_name))
def assure_tenant_cleanup(self, service, all_subnet_hints):
"""Delete tenant partition."""
# Called for every bigip only in replication mode,
# otherwise called once.
for bigip in self.driver.get_config_bigips():
subnet_hints = all_subnet_hints[bigip.device_name]
self._assure_bigip_tenant_cleanup(bigip, service, subnet_hints)
# called for every bigip only in replication mode.
# otherwise called once
def _assure_bigip_tenant_cleanup(self, bigip, service, subnet_hints):
tenant_id = service['loadbalancer']['tenant_id']
self._remove_tenant_replication_mode(bigip, tenant_id)
def _remove_tenant_replication_mode(self, bigip, tenant_id):
# Remove tenant in replication sync-mode
partition = self.service_adapter.get_folder_name(tenant_id)
domain_names = self.network_helper.get_route_domain_names(
bigip, partition)
for domain_name in domain_names:
try:
self.network_helper.delete_route_domain(
bigip, partition, domain_name)
except Exception as err:
LOG.debug("Failed to delete route domain %s. "
"%s. Manual intervention might be required." %
(domain_name, err.message))
try:
self.system_helper.delete_folder(bigip, partition)
except Exception as err:
LOG.debug(
"Folder deletion exception for tenant partition %s occurred. "
"Manual cleanup might be required." % (tenant_id))
import requests
from requests.packages.urllib3.exceptions import InsecureRequestWarning
requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
from f5_openstack_agent.lbaasv2.drivers.bigip.network_helper import \
NetworkHelper
from f5_openstack_agent.lbaasv2.drivers.bigip.system_helper import \
SystemHelper
from pprint import pprint
from requests.exceptions import HTTPError
network_helper = NetworkHelper()
system_helper = SystemHelper()
default_partition = 'test'
def log_test_call(func):
def wrapper(func, *args, **kwargs):
print("\nRunning %s" % func.func_name)
return func(*args, **kwargs)
return decorator.decorator(wrapper, func)
def delete_resource(resource):
try:
resource.delete()
except HTTPError as err:
if err.response.status_code != 404:
class BigipTenantManager(object):
"""Create network connectivity for a bigip."""
def __init__(self, conf, driver):
"""Create a BigipTenantManager."""
self.conf = conf
self.driver = driver
self.system_helper = SystemHelper()
self.network_helper = NetworkHelper()
self.service_adapter = self.driver.service_adapter
def assure_tenant_created(self, service):
"""Create tenant partition."""
tenant_id = service["loadbalancer"]["tenant_id"]
traffic_group = self.driver.service_to_traffic_group(service)
traffic_group = "/Common/" + traffic_group
service["traffic_group"] = traffic_group
# create tenant folder
folder_name = self.service_adapter.get_folder_name(tenant_id)
LOG.debug("have folder name %s" % folder_name)
for bigip in self.driver.get_config_bigips():
if not self.system_helper.folder_exists(bigip, folder_name):
folder = self.service_adapter.get_folder(service)
self.system_helper.create_folder(bigip, folder)
# folder must sync before route domains are created.
self.driver.sync_if_clustered()
# create tenant route domain
if self.conf.use_namespaces:
for bigip in self.driver.get_all_bigips():
if not self.network_helper.route_domain_exists(bigip, folder_name):
self.network_helper.create_route_domain(bigip, folder_name, self.conf.f5_route_domain_strictness)
def assure_tenant_cleanup(self, service, all_subnet_hints):
"""Delete tenant partition."""
# Called for every bigip only in replication mode,
# otherwise called once.
for bigip in self.driver.get_config_bigips():
subnet_hints = all_subnet_hints[bigip.device_name]
self._assure_bigip_tenant_cleanup(bigip, service, subnet_hints)
# called for every bigip only in replication mode.
# otherwise called once
def _assure_bigip_tenant_cleanup(self, bigip, service, subnet_hints):
tenant_id = service["loadbalancer"]["tenant_id"]
if self.conf.f5_sync_mode == "replication":
self._remove_tenant_replication_mode(bigip, tenant_id)
else:
self._remove_tenant_autosync_mode(bigip, tenant_id)
def _remove_tenant_replication_mode(self, bigip, tenant_id):
# Remove tenant in replication sync-mode
partition = self.service_adapter.get_folder_name(tenant_id)
domain_names = self.network_helper.get_route_domain_names(bigip, partition)
if domain_names:
for domain_name in domain_names:
self.network_helper.delete_route_domain(bigip, partition, domain_name)
# sudslog = std_logging.getLogger('suds.client')
# sudslog.setLevel(std_logging.FATAL)
self.system_helper.force_root_folder(bigip)
# sudslog.setLevel(std_logging.ERROR)
try:
self.system_helper.delete_folder(bigip, partition)
except f5ex.SystemDeleteException:
self.system_helper.purge_folder_contents(bigip, partition)
self.system_helper.delete_folder(bigip, partition)
def _remove_tenant_autosync_mode(self, bigip, tenant_id):
partition = self.service_adapter.get_folder_name(tenant_id)
# Remove tenant in autosync sync-mode
# all domains must be gone before we attempt to delete
# the folder or it won't delete due to not being empty
for set_bigip in self.driver.get_all_bigips():
self.network_helper.delete_route_domain(set_bigip, partition, None)
sudslog = std_logging.getLogger("suds.client")
sudslog.setLevel(std_logging.FATAL)
self.system_helper.force_root_folder(set_bigip)
sudslog.setLevel(std_logging.ERROR)
# we need to ensure that the following folder deletion
# is clearly the last change that needs to be synced.
self.driver.sync_if_clustered()
greenthread.sleep(5)
try:
self.system_helper.delete_folder(bigip, partition)
except f5ex.SystemDeleteException:
self.system_helper.purge_folder_contents(bigip, partition)
self.system_helper.delete_folder(bigip, partition)
# Need to make sure this folder delete syncs before
# something else runs and changes the current folder to
# the folder being deleted which will cause big problems.
self.driver.sync_if_clustered()
class iControlDriver(LBaaSBaseDriver):
def __init__(self, conf, registerOpts=True):
# The registerOpts parameter allows a test to
# turn off config option handling so that it can
# set the options manually instead. """
super(iControlDriver, self).__init__(conf)
self.conf = conf
if registerOpts:
self.conf.register_opts(OPTS)
self.hostnames = None
self.device_type = conf.f5_device_type
self.plugin_rpc = None
self.__last_connect_attempt = None
self.connected = False
# BIG-IP containers
self.__bigips = {}
self.__traffic_groups = []
self.agent_configurations = {}
self.tenant_manager = None
self.cluster_manager = None
self.system_helper = None
self.lbaas_builder = None
self.service_adapter = None
self.vlan_binding = None
self.l3_binding = None
if self.conf.f5_global_routed_mode:
LOG.info('WARNING - f5_global_routed_mode enabled.'
' There will be no L2 or L3 orchestration'
' or tenant isolation provisioned. All vips'
' and pool members must be routable through'
' pre-provisioned SelfIPs.')
self.conf.use_namespaces = False
self.conf.f5_snat_mode = True
self.conf.f5_snat_addresses_per_subnet = 0
self.agent_configurations['tunnel_types'] = []
self.agent_configurations['bridge_mappings'] = {}
else:
self.agent_configurations['tunnel_types'] = \
self.conf.advertised_tunnel_types
for net_id in self.conf.common_network_ids:
LOG.debug('network %s will be mapped to /Common/%s'
% (net_id, self.conf.common_network_ids[net_id]))
self.agent_configurations['common_networks'] = \
self.conf.common_network_ids
LOG.debug('Setting static ARP population to %s'
% self.conf.f5_populate_static_arp)
f5const.FDB_POPULATE_STATIC_ARP = self.conf.f5_populate_static_arp
self._init_bigip_hostnames()
self._init_bigip_managers()
self.connect_bigips()
LOG.info('iControlDriver initialized to %d bigips with username:%s'
% (len(self.__bigips), self.conf.icontrol_username))
LOG.info('iControlDriver dynamic agent configurations:%s'
% self.agent_configurations)
def connect_bigips(self):
self._init_bigips()
if self.conf.f5_global_routed_mode:
local_ips = []
else:
local_ips = self.network_builder.initialize_tunneling()
self._init_agent_config(local_ips)
def post_init(self):
# run any post initialized tasks, now that the agent
# is fully connected
if self.vlan_binding:
LOG.debug(
'Getting BIG-IP device interface for VLAN Binding')
self.vlan_binding.register_bigip_interfaces()
if self.l3_binding:
LOG.debug('Getting BIG-IP MAC Address for L3 Binding')
self.l3_binding.register_bigip_mac_addresses()
if self.network_builder:
self.network_builder.post_init()
def _init_bigip_managers(self):
if self.conf.vlan_binding_driver:
try:
self.vlan_binding = importutils.import_object(
self.conf.vlan_binding_driver, self.conf, self)
except ImportError:
LOG.error('Failed to import VLAN binding driver: %s'
% self.conf.vlan_binding_driver)
if self.conf.l3_binding_driver:
try:
self.l3_binding = importutils.import_object(
self.conf.l3_binding_driver, self.conf, self)
except ImportError:
LOG.error('Failed to import L3 binding driver: %s'
% self.conf.l3_binding_driver)
else:
LOG.debug('No L3 binding driver configured.'
' No L3 binding will be done.')
self.service_adapter = ServiceModelAdapter(self.conf)
self.tenant_manager = BigipTenantManager(self.conf, self)
self.cluster_manager = ClusterManager()
self.system_helper = SystemHelper()
self.lbaas_builder = LBaaSBuilder(self.conf, self)
if self.conf.f5_global_routed_mode:
self.network_builder = None
else:
self.network_builder = NetworkServiceBuilder(
self.conf,
self,
self.conf.f5_global_routed_mode)
def _init_bigip_hostnames(self):
# Validate and parse bigip credentials
if not self.conf.icontrol_hostname:
raise InvalidConfigurationOption(
opt_name='icontrol_hostname',
opt_value='valid hostname or IP address'
)
if not self.conf.icontrol_username:
raise InvalidConfigurationOption(
opt_name='icontrol_username',
opt_value='valid username'
)
if not self.conf.icontrol_password:
raise InvalidConfigurationOption(
opt_name='icontrol_password',
opt_value='valid password'
)
self.hostnames = self.conf.icontrol_hostname.split(',')
self.hostnames = [item.strip() for item in self.hostnames]
self.hostnames = sorted(self.hostnames)
# Setting an agent_id is the flag to the agent manager
# that your plugin has initialized correctly. If you
# don't set one, the agent manager will not register
# with Neutron as a valid agent.
if self.conf.environment_prefix:
self.agent_id = str(
uuid.uuid5(uuid.NAMESPACE_DNS,
self.conf.environment_prefix +
'.' + self.hostnames[0])
)
else:
self.agent_id = str(
uuid.uuid5(uuid.NAMESPACE_DNS, self.hostnames[0])
)
def _init_bigips(self):
# Connect to all BIG-IPs
if self.connected:
return
try:
if not self.conf.debug:
sudslog = std_logging.getLogger('suds.client')
sudslog.setLevel(std_logging.FATAL)
requests_log = std_logging.getLogger(
"requests.packages.urllib3")
requests_log.setLevel(std_logging.ERROR)
requests_log.propagate = False
else:
requests_log = std_logging.getLogger(
"requests.packages.urllib3")
requests_log.setLevel(std_logging.DEBUG)
requests_log.propagate = True
self.__last_connect_attempt = datetime.datetime.now()
first_bigip = self._open_bigip(self.hostnames[0])
self._init_bigip(first_bigip, self.hostnames[0], None)
self.__bigips[self.hostnames[0]] = first_bigip
device_group_name = self._validate_ha(first_bigip)
self._init_traffic_groups(first_bigip)
# connect to the rest of the devices
for hostname in self.hostnames[1:]:
bigip = self._open_bigip(hostname)
self._init_bigip(bigip, hostname, device_group_name)
self.__bigips[hostname] = bigip
self.connected = True
except NeutronException as exc:
LOG.error('Could not communicate with all ' +
'iControl devices: %s' % exc.msg)
greenthread.sleep(5)
raise
except Exception as exc:
LOG.error('Could not communicate with all ' +
'iControl devices: %s' % exc.message)
greenthread.sleep(5)
raise
def _open_bigip(self, hostname):
# Open bigip connection """
LOG.info('Opening iControl connection to %s @ %s' %
(self.conf.icontrol_username, hostname))
return BigIP(hostname,
self.conf.icontrol_username,
self.conf.icontrol_password,
loglevel=logging.DEBUG)
def _init_bigip(self, bigip, hostname, check_group_name=None):
# Prepare a bigip for usage
major_version, minor_version = self._validate_bigip_version(
bigip, hostname)
device_group_name = None
extramb = self.system_helper.get_provision_extramb(bigip)
if int(extramb) < f5const.MIN_EXTRA_MB:
raise f5ex.ProvisioningExtraMBValidateFailed(
'Device %s BIG-IP not provisioned for '
'management LARGE.' % hostname)
if self.conf.f5_ha_type == 'pair' and \
self.cluster_manager.get_sync_status(bigip) == 'Standalone':
raise f5ex.BigIPClusterInvalidHA(
'HA mode is pair and bigip %s in standalone mode'
% hostname)
if self.conf.f5_ha_type == 'scalen' and \
self.cluster_manager.get_sync_status(bigip) == 'Standalone':
raise f5ex.BigIPClusterInvalidHA(
'HA mode is pair and bigip %s in standalone mode'
% hostname)
if self.conf.f5_ha_type != 'standalone':
device_group_name = self.cluster_manager.get_device_group(bigip)
if not device_group_name:
raise f5ex.BigIPClusterInvalidHA(
'HA mode is %s and no sync failover '
'device group found for device %s.'
% (self.conf.f5_ha_type, hostname))
if check_group_name and device_group_name != check_group_name:
raise f5ex.BigIPClusterInvalidHA(
'Invalid HA. Device %s is in device group'
' %s but should be in %s.'
% (hostname, device_group_name, check_group_name))
bigip.device_group_name = device_group_name
if self.network_builder:
for network in self.conf.common_network_ids.values():
if not self.network_builder.vlan_exists(network,
folder='Common'):
raise f5ex.MissingNetwork(
'Common network %s on %s does not exist'
% (network, bigip.hostname))
bigip.device_name = self.cluster_manager.get_device_name(bigip)
bigip.mac_addresses = self.system_helper.get_mac_addresses(bigip)
LOG.debug("Initialized BIG-IP %s with MAC addresses %s" %
(bigip.device_name, ', '.join(bigip.mac_addresses)))
bigip.device_interfaces = \
self.system_helper.get_interface_macaddresses_dict(bigip)
bigip.assured_networks = []
bigip.assured_tenant_snat_subnets = {}
bigip.assured_gateway_subnets = []
if self.conf.f5_ha_type != 'standalone':
if self.conf.f5_sync_mode == 'autosync':
self.cluster_manager.enable_auto_sync(bigip, device_group_name)
else:
self.cluster_manager.disable_auto_sync(bigip,
device_group_name)
# Turn off tunnel syncing... our VTEPs are local SelfIPs
if self.system_helper.get_tunnel_sync(bigip) == 'enable':
self.system_helper.set_tunnel_sync(bigip, enabled=False)
LOG.debug('Connected to iControl %s @ %s ver %s.%s'
% (self.conf.icontrol_username, hostname,
major_version, minor_version))
return bigip
def _validate_ha(self, first_bigip):
# if there was only one address supplied and
# this is not a standalone device, get the
# devices trusted by this device. """
device_group_name = None
if self.conf.f5_ha_type == 'standalone':
if len(self.hostnames) != 1:
raise f5ex.BigIPClusterInvalidHA(
'HA mode is standalone and %d hosts found.'
% len(self.hostnames))
elif self.conf.f5_ha_type == 'pair':
device_group_name = self.cluster_manager.\
get_device_group(first_bigip)
if len(self.hostnames) != 2:
mgmt_addrs = []
devices = self.cluster_manager.devices(first_bigip,
device_group_name)
for device in devices:
mgmt_addrs.append(
self.cluster_manager.get_mgmt_addr_by_device(device))
self.hostnames = mgmt_addrs
if len(self.hostnames) != 2:
raise f5ex.BigIPClusterInvalidHA(
'HA mode is pair and %d hosts found.'
% len(self.hostnames))
elif self.conf.f5_ha_type == 'scalen':
device_group_name = self.cluster_manager.\
get_device_group(first_bigip)
if len(self.hostnames) < 2:
mgmt_addrs = []
devices = self.cluster_manager.devices(first_bigip,
device_group_name)
for device in devices:
mgmt_addrs.append(
self.cluster_manager.get_mgmt_addr_by_device(
first_bigip, device))
self.hostnames = mgmt_addrs
return device_group_name
def _init_agent_config(self, local_ips):
# Init agent config
icontrol_endpoints = {}
for host in self.__bigips:
hostbigip = self.__bigips[host]
ic_host = {}
ic_host['version'] = self.system_helper.get_version(hostbigip)
ic_host['device_name'] = hostbigip.device_name
ic_host['platform'] = self.system_helper.get_platform(hostbigip)
ic_host['serial_number'] = self.system_helper.get_serial_number(
hostbigip)
icontrol_endpoints[host] = ic_host
self.agent_configurations['tunneling_ips'] = local_ips
self.agent_configurations['icontrol_endpoints'] = icontrol_endpoints
if self.network_builder:
self.agent_configurations['bridge_mappings'] = \
self.network_builder.interface_mapping
def generate_capacity_score(self, capacity_policy=None):
"""Generate the capacity score of connected devices """
return 0
def set_context(self, context):
# Context to keep for database access
if self.network_builder:
self.network_builder.set_context(context)
def set_plugin_rpc(self, plugin_rpc):
# Provide Plugin RPC access
self.plugin_rpc = plugin_rpc
def set_tunnel_rpc(self, tunnel_rpc):
# Provide FDB Connector with ML2 RPC access
if self.network_builder:
self.network_builder.set_tunnel_rpc(tunnel_rpc)
def set_l2pop_rpc(self, l2pop_rpc):
# Provide FDB Connector with ML2 RPC access
if self.network_builder:
self.network_builder.set_l2pop_rpc(l2pop_rpc)
def exists(self, service):
# Check that service exists"""
return True
def flush_cache(self):
# Remove cached objects so they can be created if necessary
for bigip in self.get_all_bigips():
bigip.assured_networks = []
bigip.assured_tenant_snat_subnets = {}
bigip.assured_gateway_subnets = []
@serialized('create_loadbalancer')
@is_connected
def create_loadbalancer(self, loadbalancer, service):
"""Create virtual server"""
self._common_service_handler(service)
@serialized('update_loadbalancer')
@is_connected
def update_loadbalancer(self, old_loadbalancer, loadbalancer, service):
"""Update virtual server"""
self._common_service_handler(service)
@serialized('delete_loadbalancer')
@is_connected
def delete_loadbalancer(self, loadbalancer, service):
"""Delete loadbalancer"""
self._common_service_handler(service, True)
@serialized('create_listener')
@is_connected
def create_listener(self, listener, service):
"""Create virtual server"""
LOG.debug("Creating listener")
self._common_service_handler(service)
@serialized('update_listener')
@is_connected
def update_listener(self, old_listener, listener, service):
"""Update virtual server"""
self._common_service_handler(service)
@serialized('delete_listener')
@is_connected
def delete_listener(self, listener, service):
"""Delete virtual server"""
self._common_service_handler(service)
@serialized('create_pool')
@is_connected
def create_pool(self, pool, service):
"""Create lb pool"""
self._common_service_handler(service)
@serialized('update_pool')
@is_connected
def update_pool(self, old_pool, pool, service):
"""Update lb pool"""
self._common_service_handler(service)
@serialized('delete_pool')
@is_connected
def delete_pool(self, pool, service):
"""Delete lb pool"""
self._common_service_handler(service)
@serialized('create_member')
@is_connected
def create_member(self, member, service):
"""Create pool member"""
self._common_service_handler(service)
@serialized('update_member')
@is_connected
def update_member(self, old_member, member, service):
"""Update pool member"""
self._common_service_handler(service)
@serialized('delete_member')
@is_connected
def delete_member(self, member, service):
"""Delete pool member"""
self._common_service_handler(service)
@serialized('create_health_monitor')
@is_connected
def create_health_monitor(self, health_monitor, service):
"""Create pool health monitor"""
self._common_service_handler(service)
return True
@serialized('update_health_monitor')
@is_connected
def update_health_monitor(self, old_health_monitor,
health_monitor, pool, service):
"""Update pool health monitor"""
self._common_service_handler(service)
return True
@serialized('delete_health_monitor')
@is_connected
def delete_health_monitor(self, health_monitor, service):
"""Delete pool health monitor"""
self._common_service_handler(service)
return True
# pylint: enable=unused-argument
@is_connected
def get_stats(self, service):
"""Get service stats"""
# use pool stats because the pool_id is the
# the service definition...
stats = {}
stats[lb_const.STATS_IN_BYTES] = 0
stats[lb_const.STATS_OUT_BYTES] = 0
stats[lb_const.STATS_ACTIVE_CONNECTIONS] = 0
stats[lb_const.STATS_TOTAL_CONNECTIONS] = 0
# add a members stats return dictionary
members = {}
for hostbigip in self.get_all_bigips():
# It appears that stats are collected for pools in a pending delete
# state which means that if those messages are queued (or delayed)
# it can result in the process of a stats request after the pool
# and tenant are long gone. Check if the tenant exists.
if not service['pool'] or not hostbigip.system.folder_exists(
OBJ_PREFIX + service['pool']['tenant_id']):
return None
pool = service['pool']
pool_stats = hostbigip.pool.get_statistics(
name=pool['id'],
folder=pool['tenant_id'],
config_mode=self.conf.icontrol_config_mode)
if 'STATISTIC_SERVER_SIDE_BYTES_IN' in pool_stats:
stats[lb_const.STATS_IN_BYTES] += \
pool_stats['STATISTIC_SERVER_SIDE_BYTES_IN']
stats[lb_const.STATS_OUT_BYTES] += \
pool_stats['STATISTIC_SERVER_SIDE_BYTES_OUT']
stats[lb_const.STATS_ACTIVE_CONNECTIONS] += \
pool_stats['STATISTIC_SERVER_SIDE_CURRENT_CONNECTIONS']
stats[lb_const.STATS_TOTAL_CONNECTIONS] += \
pool_stats['STATISTIC_SERVER_SIDE_TOTAL_CONNECTIONS']
# are there members to update status
if 'members' in service:
# only query BIG-IP pool members if they
# not in a state indicating provisioning or error
# provisioning the pool member
some_members_require_status_update = False
update_if_status = [plugin_const.ACTIVE,
plugin_const.DOWN,
plugin_const.INACTIVE]
if plugin_const.ACTIVE not in update_if_status:
update_if_status.append(plugin_const.ACTIVE)
for member in service['members']:
if member['status'] in update_if_status:
some_members_require_status_update = True
# are we have members who are in a
# state to update there status
if some_members_require_status_update:
# query pool members on each BIG-IP
monitor_states = \
hostbigip.pool.get_members_monitor_status(
name=pool['id'],
folder=pool['tenant_id'],
config_mode=self.conf.icontrol_config_mode
)
for member in service['members']:
if member['status'] in update_if_status:
# create the entry for this
# member in the return status
# dictionary set to ACTIVE
if not member['id'] in members:
members[member['id']] = \
{'status': plugin_const.INACTIVE}
# check if it down or up by monitor
# and update the status
for state in monitor_states:
# matched the pool member
# by address and port number
if member['address'] == \
strip_domain_address(
state['addr']) and \
int(member['protocol_port']) == \
int(state['port']):
# if the monitor says member is up
if state['state'] == \
'MONITOR_STATUS_UP' or \
state['state'] == \
'MONITOR_STATUS_UNCHECKED':
# set ACTIVE as long as the
# status was not set to 'DOWN'
# on another BIG-IP
if members[
member['id']]['status'] != \
'DOWN':
if member['admin_state_up']:
members[member['id']][
'status'] = \
plugin_const.ACTIVE
else:
members[member['id']][
'status'] = \
plugin_const.INACTIVE
else:
members[member['id']]['status'] = \
plugin_const.DOWN
stats['members'] = members
return stats
@serialized('remove_orphans')
def remove_orphans(self, all_pools):
"""Remove out-of-date configuration on big-ips """
existing_tenants = []
existing_pools = []
for pool in all_pools:
existing_tenants.append(pool['tenant_id'])
existing_pools.append(pool['pool_id'])
for bigip in self.get_all_bigips():
bigip.pool.purge_orphaned_pools(existing_pools)
for bigip in self.get_all_bigips():
bigip.system.purge_orphaned_folders_contents(existing_tenants)
sudslog = std_logging.getLogger('suds.client')
sudslog.setLevel(std_logging.FATAL)
for bigip in self.get_all_bigips():
bigip.system.force_root_folder()
sudslog.setLevel(std_logging.ERROR)
for bigip in self.get_all_bigips():
bigip.system.purge_orphaned_folders(existing_tenants)
def fdb_add(self, fdb):
# Add (L2toL3) forwarding database entries
self.remove_ips_from_fdb_update(fdb)
for bigip in self.get_all_bigips():
self.network_builder.add_bigip_fdb(bigip, fdb)
def fdb_remove(self, fdb):
# Remove (L2toL3) forwarding database entries
self.remove_ips_from_fdb_update(fdb)
for bigip in self.get_all_bigips():
self.network_builder.remove_bigip_fdb(bigip, fdb)
def fdb_update(self, fdb):
# Update (L2toL3) forwarding database entries
self.remove_ips_from_fdb_update(fdb)
for bigip in self.get_all_bigips():
self.network_builder.update_bigip_fdb(bigip, fdb)
# remove ips from fdb update so we do not try to
# add static arps for them because we do not have
# enough information to determine the route domain
def remove_ips_from_fdb_update(self, fdb):
for network_id in fdb:
network = fdb[network_id]
mac_ips_by_vtep = network['ports']
for vtep in mac_ips_by_vtep:
mac_ips = mac_ips_by_vtep[vtep]
for mac_ip in mac_ips:
mac_ip[1] = None
def tunnel_update(self, **kwargs):
# Tunnel Update from Neutron Core RPC
pass
def tunnel_sync(self):
# Only sync when supported types are present
if not [i for i in self.agent_configurations['tunnel_types']
if i in ['gre', 'vxlan']]:
return
tunnel_ips = []
for bigip in self.get_all_bigips():
if bigip.local_ip:
tunnel_ips.append(bigip.local_ip)
self.network_builder.tunnel_sync(tunnel_ips)
@serialized('sync')
@is_connected
def sync(self, service):
"""Sync service defintion to device"""
# plugin_rpc may not be set when unit testing
if self.plugin_rpc:
# Get the latest service. It may have changed.
service = self.plugin_rpc.get_service_by_pool_id(
service['pool']['id'],
self.conf.f5_global_routed_mode
)
if service['pool']:
self._common_service_handler(service)
else:
LOG.debug("Attempted sync of deleted pool")
@serialized('backup_configuration')
@is_connected
def backup_configuration(self):
# Save Configuration on Devices
for bigip in self.get_all_bigips():
LOG.debug('_backup_configuration: saving device %s.'
% bigip.hostname)
self.cluster_manager.save_config(bigip)
def _service_exists(self, service):
# Returns whether the bigip has a pool for the service
if not service['loadbalancer']:
return False
# bigip = self.get_bigip()
# return bigip.pool.exists(
# name=service['pool']['id'],
# folder=service['pool']['tenant_id'],
# config_mode=self.conf.icontrol_config_mode)
return True
def _common_service_handler(self, service, delete_partition=False):
# Assure that the service is configured on bigip(s)
start_time = time()
if not service['loadbalancer']:
LOG.error("_common_service_handler: Service loadbalancer is None")
return
self.tenant_manager.assure_tenant_created(service)
LOG.debug(" _assure_tenant_created took %.5f secs" %
(time() - start_time))
traffic_group = self.service_to_traffic_group(service)
LOG.debug("XXXXXXXXXX: traffic group created ")
if self.network_builder:
start_time = time()
self.network_builder.prep_service_networking(
service, traffic_group)
if time() - start_time > .001:
LOG.debug(" _prep_service_networking "
"took %.5f secs" % (time() - start_time))
all_subnet_hints = {}
LOG.debug("XXXXXXXXXX: getting bigip configs")
for bigip in self.get_config_bigips():
# check_for_delete_subnets:
# keep track of which subnets we should check to delete
# for a deleted vip or member
# do_not_delete_subnets:
# If we add an IP to a subnet we must not delete the subnet
all_subnet_hints[bigip.device_name] = \
{'check_for_delete_subnets': {},
'do_not_delete_subnets': []}
LOG.debug("XXXXXXXXX: Pre assure service")
self.lbaas_builder.assure_service(service,
traffic_group,
all_subnet_hints)
LOG.debug("XXXXXXXXX: Post assure service")
if self.network_builder:
start_time = time()
try:
self.network_builder.post_service_networking(
service, all_subnet_hints)
except NeutronException as exc:
LOG.error("post_service_networking exception: %s"
% str(exc.msg))
except Exception as exc:
LOG.error("post_service_networking exception: %s"
% str(exc.message))
LOG.debug(" _post_service_networking took %.5f secs" %
(time() - start_time))
# only delete partition if loadbalancer is being deleted
if delete_partition:
try:
self.tenant_manager.assure_tenant_cleanup(service,
all_subnet_hints)
except Exception as err:
LOG.error("Error deleting tenant partition. Message: %s"
% err.message)
self._update_service_status(service)
def _update_service_status(self, service):
"""Update status of objects in OpenStack """
if not self.plugin_rpc:
LOG.error("Cannot update status in Neutron without "
"RPC handler.")
return
if 'members' in service:
# Call update_members_status
self._update_member_status(service['members'])
if 'healthmonitors' in service:
# Call update_monitor_status
self._update_health_monitor_status(
service['healthmonitors']
)
if 'pools' in service:
# Call update_pool_status
self._update_pool_status(
service['pools']
)
if 'listeners' in service:
# Call update_listener_status
self._update_listener_status(
service['listeners']
)
self._update_loadbalancer_status(
service['loadbalancer']
)
def _update_member_status(self, members):
"""Update member status in OpenStack """
for member in members:
if 'provisioning_status' in member:
provisioning_status = member['provisioning_status']
if (provisioning_status == plugin_const.PENDING_CREATE or
provisioning_status == plugin_const.PENDING_UPDATE):
self.plugin_rpc.update_member_status(
member['id'],
plugin_const.ACTIVE,
lb_const.ONLINE
)
elif provisioning_status == plugin_const.PENDING_DELETE:
self.plugin_rpc.member_destroyed(
member['id'])
def _update_health_monitor_status(self, health_monitors):
"""Update pool monitor status in OpenStack """
for health_monitor in health_monitors:
if 'provisioning_status' in health_monitor:
provisioning_status = health_monitor['provisioning_status']
if (provisioning_status == plugin_const.PENDING_CREATE or
provisioning_status == plugin_const.PENDING_UPDATE):
self.plugin_rpc.update_health_monitor_status(
health_monitor['id'],
plugin_const.ACTIVE,
lb_const.ONLINE
)
elif provisioning_status == plugin_const.PENDING_DELETE:
self.plugin_rpc.health_monitor_destroyed(
health_monitor['id'])
@log_helpers.log_method_call
def _update_pool_status(self, pools):
"""Update pool status in OpenStack """
for pool in pools:
if 'provisioning_status' in pool:
provisioning_status = pool['provisioning_status']
if (provisioning_status == plugin_const.PENDING_CREATE or
provisioning_status == plugin_const.PENDING_UPDATE):
self.plugin_rpc.update_pool_status(
pool['id'],
plugin_const.ACTIVE,
lb_const.ONLINE
)
elif provisioning_status == plugin_const.PENDING_DELETE:
self.plugin_rpc.pool_destroyed(
pool['id'])
@log_helpers.log_method_call
def _update_listener_status(self, listeners):
"""Update listener status in OpenStack """
for listener in listeners:
if 'provisioning_status' in listener:
provisioning_status = listener['provisioning_status']
if (provisioning_status == plugin_const.PENDING_CREATE or
provisioning_status == plugin_const.PENDING_UPDATE):
self.plugin_rpc.update_listener_status(
listener['id'],
plugin_const.ACTIVE,
lb_const.ONLINE
)
elif provisioning_status == plugin_const.PENDING_DELETE:
self.plugin_rpc.listener_destroyed(
listener['id'])
@log_helpers.log_method_call
def _update_loadbalancer_status(self, loadbalancer):
"""Update loadbalancer status in OpenStack """
provisioning_status = loadbalancer['provisioning_status']
if (provisioning_status == plugin_const.PENDING_CREATE or
provisioning_status == plugin_const.PENDING_UPDATE):
self.plugin_rpc.update_loadbalancer_status(
loadbalancer['id'],
plugin_const.ACTIVE,
lb_const.ONLINE)
elif provisioning_status == plugin_const.PENDING_DELETE:
self.plugin_rpc.loadbalancer_destroyed(
loadbalancer['id'])
else:
LOG.error('Loadbalancer provisioning status is invalid')
def service_to_traffic_group(self, service):
# Hash service tenant id to index of traffic group
return self.tenant_to_traffic_group(
service['loadbalancer']['tenant_id'])
def tenant_to_traffic_group(self, tenant_id):
# Hash tenant id to index of traffic group
hexhash = hashlib.md5(tenant_id).hexdigest()
tg_index = int(hexhash, 16) % len(self.__traffic_groups)
return self.__traffic_groups[tg_index]
def get_bigip(self):
# Get one consistent big-ip
hostnames = sorted(self.__bigips)
for i in range(len(hostnames)):
try:
bigip = self.__bigips[hostnames[i]]
return bigip
except urllib2.URLError:
pass
raise urllib2.URLError('cannot communicate to any bigips')
def get_bigip_hosts(self):
# Get all big-ips hostnames under management
return self.__bigips
def get_all_bigips(self):
# Get all big-ips under management
return self.__bigips.values()
def get_config_bigips(self):
# Return a list of big-ips that need to be configured.
# In replication sync mode, we configure all big-ips
# individually. In autosync mode we only use one big-ip
# and then sync the configuration to the other big-ips.
if self.conf.f5_sync_mode == 'replication':
return self.get_all_bigips()
else:
return [self.get_bigip()]
def get_inbound_throughput(self, bigip, global_statistics=None):
pass
def get_outbound_throughput(self, bigip, global_statistics=None):
pass
def get_throughput(self, bigip=None, global_statistics=None):
pass
def get_active_connections(self, bigip=None, global_statistics=None):
pass
def get_ssltps(self, bigip=None, global_statistics=None):
pass
def get_node_count(self, bigip=None, global_statistics=None):
pass
def get_clientssl_profile_count(self, bigip=None, global_statistics=None):
pass
def get_tenant_count(self, bigip=None, global_statistics=None):
pass
def get_tunnel_count(self, bigip=None, global_statistics=None):
pass
def get_vlan_count(self, bigip=None, global_statistics=None):
pass
def get_route_domain_count(self, bigip=None, global_statistics=None):
pass
def _init_traffic_groups(self, bigip):
self.__traffic_groups = self.cluster_manager.get_traffic_groups(bigip)
if 'traffic-group-local-only' in self.__traffic_groups:
self.__traffic_groups.remove('traffic-group-local-only')
self.__traffic_groups.sort()
def sync_if_clustered(self):
# sync device group if not in replication mode
if self.conf.f5_ha_type == 'standalone' or \
self.conf.f5_sync_mode == 'replication' or \
len(self.get_all_bigips()) < 2:
return
bigip = self.get_bigip()
self._sync_with_retries(bigip)
def _sync_with_retries(self, bigip, force_now=False,
attempts=4, retry_delay=130):
# sync device group
for attempt in range(1, attempts + 1):
LOG.debug('Syncing Cluster... attempt %d of %d'
% (attempt, attempts))
try:
if attempt != 1:
force_now = False
self.cluster_manager.sync(bigip.device_group_name,
force_now=force_now)
LOG.debug('Cluster synced.')
return
except Exception as exc:
LOG.error('ERROR: Cluster sync failed: %s' % exc)
if attempt == attempts:
raise
LOG.error('Wait another %d seconds for devices '
'to recover from failed sync.' % retry_delay)
greenthread.sleep(retry_delay)
def _validate_bigip_version(self, bigip, hostname):
# Ensure the BIG-IP has sufficient version
major_version = self.system_helper.get_major_version(bigip)
if major_version < f5const.MIN_TMOS_MAJOR_VERSION:
raise f5ex.MajorVersionValidateFailed(
'Device %s must be at least TMOS %s.%s'
% (hostname, f5const.MIN_TMOS_MAJOR_VERSION,
f5const.MIN_TMOS_MINOR_VERSION))
minor_version = self.system_helper.get_minor_version(bigip)
if minor_version < f5const.MIN_TMOS_MINOR_VERSION:
raise f5ex.MinorVersionValidateFailed(
'Device %s must be at least TMOS %s.%s'
% (hostname, f5const.MIN_TMOS_MAJOR_VERSION,
f5const.MIN_TMOS_MINOR_VERSION))
return major_version, minor_version
def system_helper():
return SystemHelper()
