##
import logging
import uuid
+import copy
import requests
from requests.auth import HTTPBasicAuth
from osm_ro.wim.sdnconn import SdnConnectorBase, SdnConnectorError
-log = logging.getLogger(__name__)
-
class OnosVpls(SdnConnectorBase):
"""
https://wiki.onosproject.org/display/ONOS/VPLS+User+Guide
"""
+ _WIM_LOGGER = "openmano.sdnconn.onosvpls"
def __init__(self, wim, wim_account, config=None, logger=None):
-
- super().__init__(wim, wim_account, config, log)
+ self.logger = logger or logging.getLogger(self._WIM_LOGGER)
+ super().__init__(wim, wim_account, config, logger)
self.user = wim_account.get("user")
self.password = wim_account.get("password")
- url = wim_account.get("wim_url")
+ url = wim.get("wim_url")
if not url:
- raise ValueError("'url' must be provided")
+ raise SdnConnectorError("'url' must be provided")
if not url.startswith("http"):
url = "http://" + url
if not url.endswith("/"):
url = url + "/"
self.url = url + "onos/v1/network/configuration"
- log.info("ONOS VPLS Connector Initialized.")
+ self.logger.info("ONOS VPLS Connector Initialized.")
def check_credentials(self):
status_code = 503
except Exception as e:
if onos_config_req:
status_code = onos_config_req.status_code
- log.exception('Error checking credentials')
+ self.logger.exception('Error checking credentials')
raise SdnConnectorError('Error checking credentials', http_code=status_code)
def get_connectivity_service_status(self, service_uuid, conn_info=None):
- onos_config_req = requests.get(self.url, auth=HTTPBasicAuth(self.user, self.password))
- onos_config_req.raise_for_status()
- onos_config = onos_config_req.json()
- for vpls in onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList']:
- if vpls['name'] == service_uuid:
- return vpls
- raise SdnConnectorError('VPLS {} not found'.format(service_uuid), http_code=404)
-
- def create_connectivity_service(self, service_type, connection_points):
- if service_type.lower() != 'elan':
- raise SdnConnectorError('Only ELAN network type is supported by ONOS VPLS.')
- onos_config_req = requests.get(self.url, auth=HTTPBasicAuth(self.user, self.password))
- onos_config_req.raise_for_status()
- onos_config = onos_config_req.json()
- service_uuid = uuid.uuid4()
-
- if 'org.onosproject.vpls' in onos_config['apps']:
- if 'vpls' not in onos_config['apps']['org.onosproject.vpls']:
- onos_config['apps']['org.onosproject.vpls']['vpls'] = {
- 'vplsList': []
- }
- for vpls in onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList']:
- if vpls['name'] == service_uuid:
- raise SdnConnectorError('Network {} already exists.'.format(service_uuid))
- onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList'].append({
- 'name': service_uuid,
- 'interfaces': []
- })
- self._pop_last_update_time(onos_config)
- else:
- onos_config['apps'] = {
- 'org.onosproject.vpls': {
- 'vpls': {
- "vplsList": [
- {
- 'name': service_uuid,
- 'interfaces': []
- }
- ]
+ try:
+ onos_config = self._get_onos_netconfig()
+ vpls_config = onos_config.get('apps', {}).get('org.onosproject.vpls')
+ if vpls_config:
+ for vpls in vpls_config.get('vpls', {}).get('vplsList'):
+ if vpls.get('name') == service_uuid:
+ return {'sdn_status': 'ACTIVE', 'sdn_info': vpls}
+
+ return {'sdn_status': 'ERROR', 'sdn_info': 'not found'}
+
+ except Exception as e:
+ self.logger.error('Exception getting connectivity service info: %s', e)
+ return {'sdn_status': 'ERROR', 'error_msg': str(e)}
+
+ def _get_onos_netconfig(self):
+ try:
+ onos_config_req = requests.get(self.url, auth=HTTPBasicAuth(self.user, self.password))
+ status_code = onos_config_req.status_code
+ if status_code == requests.codes.ok:
+ return onos_config_req.json()
+ else:
+ self.logger.info("Error obtaining network config, status code: {}".format(status_code))
+ raise SdnConnectorError("Error obtaining network config status code: {}".format(status_code),
+ http_code=status_code)
+ except requests.exceptions.ConnectionError as e:
+ self.logger.info('Exception connecting to onos: %s', e)
+ raise SdnConnectorError("Error connecting to onos: {}".format(e))
+ except Exception as e:
+ self.logger.error('Exception getting onos network config: %s', e)
+ raise SdnConnectorError("Exception getting onos network config: {}".format(e))
+
+ def _post_onos_netconfig(self, onos_config):
+ try:
+ onos_config_resp = requests.post(self.url, json=onos_config, auth=HTTPBasicAuth(self.user, self.password))
+ status_code = onos_config_resp.status_code
+ if status_code != requests.codes.ok:
+ self.logger.info("Error updating network config, status code: {}".format(status_code))
+ raise SdnConnectorError("Error obtaining network config status code: {}".format(status_code),
+ http_code=status_code)
+ except requests.exceptions.ConnectionError as e:
+ self.logger.info('Exception connecting to onos: %s', e)
+ raise SdnConnectorError("Error connecting to onos: {}".format(e))
+ except Exception as e:
+ self.logger.info('Exception posting onos network config: %s', e)
+ raise SdnConnectorError("Exception posting onos network config: {}".format(e))
+
+ def create_connectivity_service(self, service_type, connection_points, **kwargs):
+ self.logger.debug("create_connectivity_service, service_type: {}, connection_points: {}".
+ format(service_type, connection_points))
+ if service_type.lower() == 'etree':
+ raise SdnConnectorError('Only ELINE/ELAN network type is supported by ONOS VPLS.')
+
+ # FIXME ¿must check number of connection_points?
+ service_uuid = str(uuid.uuid4())
+
+ # Obtain current configuration
+ onos_config_orig = self._get_onos_netconfig()
+ # self.logger.debug("onos config: %s", onos_config_orig)
+ onos_config = copy.deepcopy(onos_config_orig)
+
+ try:
+ # Create missing interfaces, append to created_items if returned, append_port_to_onos_config
+ # returns null if it was already created
+ created_items = []
+ for port in connection_points:
+ created_ifz = self._append_port_to_onos_config(port, onos_config)
+ if created_ifz:
+ created_items.append(created_ifz[1])
+ self._post_onos_netconfig(onos_config)
+
+ # Add vpls service to config
+ encapsulation = self._get_encapsulation(connection_points)
+ interfaces = [port.get("service_endpoint_id") for port in connection_points]
+ if 'org.onosproject.vpls' in onos_config['apps']:
+ if 'vpls' not in onos_config['apps']['org.onosproject.vpls']:
+ onos_config['apps']['org.onosproject.vpls']['vpls'] = {
+ 'vplsList': []
+ }
+ for vpls in onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList']:
+ if vpls['name'] == service_uuid:
+ raise SdnConnectorError('Network {} already exists.'.format(service_uuid))
+ onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList'].append({
+ 'name': service_uuid,
+ 'interfaces': interfaces,
+ 'encapsulation': encapsulation
+ })
+ self._pop_last_update_time(onos_config)
+ else:
+ onos_config['apps'] = {
+ 'org.onosproject.vpls': {
+ 'vpls': {
+ "vplsList": [
+ {
+ 'name': service_uuid,
+ 'interfaces': interfaces,
+ 'encapsulation': encapsulation
+ }
+ ]
+ }
}
}
- }
- response = requests.post(self.url, json=onos_config, auth=HTTPBasicAuth(self.user, self.password))
- log.info(onos_config)
- response.raise_for_status()
+ # self.logger.debug("original config: %s", onos_config_orig)
+ # self.logger.debug("original config: %s", onos_config)
+ self._post_onos_netconfig(onos_config)
+
+ self.logger.debug("created connectivity_service, service_uuid: {}, created_items: {}".
+ format(service_uuid, created_items))
+ return service_uuid, {"interfaces": created_items}
+ except Exception as e:
+ self.logger.error('Exception add connection_service: %s', e)
+ # try to rollback push original config
+ try:
+ self._post_onos_netconfig(onos_config_orig)
+ except Exception as e:
+ self.logger.error('Exception rolling back to original config: %s', e)
+ # raise exception
+ if isinstance(e, SdnConnectorError):
+ raise
+ else:
+ raise SdnConnectorError("Exception create_connectivity_service: {}".format(e))
+
+ def _get_encapsulation(self, connection_points):
+ """
+ Obtains encapsulation for the vpls service from the connection_points
+ FIXME: Encapsulation is defined for the connection points but for the VPLS service the encapsulation is
+ defined at the service level so only one can be assigned
+ """
+ # check if encapsulation is vlan, check just one connection point
+ encapsulation = "NONE"
for connection_point in connection_points:
- self._add_network_port(service_uuid, connection_point)
- return service_uuid, onos_config
+ if connection_point.get("service_endpoint_encapsulation_type") == "dot1q":
+ encapsulation = "VLAN"
+ break
+ return encapsulation
- def edit_connectivity_service(self, service_uuid,
- conn_info, connection_points,
- **kwargs):
- raise SdnConnectorError('Not supported', http_code=501)
+ def edit_connectivity_service(self, service_uuid, conn_info=None, connection_points=None, **kwargs):
+ self.logger.debug("edit connectivity service, service_uuid: {}, conn_info: {}, "
+ "connection points: {} ".format(service_uuid, conn_info, connection_points))
- def delete_connectivity_service(self, service_uuid, conn_info=None):
- onos_config_req = requests.get(self.url, auth=HTTPBasicAuth(self.user, self.password))
- onos_config_req.raise_for_status()
- onos_config = onos_config_req.json()
- # Removes ports used by network from onos config
- for vpls in onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList']:
+ conn_info = conn_info or {}
+ created_ifs = conn_info.get("interfaces", [])
+
+ # Obtain current configuration
+ onos_config_orig = self._get_onos_netconfig()
+ onos_config = copy.deepcopy(onos_config_orig)
+
+ # get current service data and check if it does not exists
+ for vpls in onos_config.get('apps', {}).get('org.onosproject.vpls', {}).get('vpls', {}).get('vplsList', {}):
if vpls['name'] == service_uuid:
- for interface in vpls['interfaces']:
- for port in onos_config['ports'].values():
- for port_interface in port['interfaces']:
- if port_interface['name'] == interface:
- port['interfaces'].remove(port_interface)
- onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList'].remove(vpls)
+ self.logger.debug("service exists")
+ curr_interfaces = vpls.get("interfaces", [])
+ curr_encapsulation = vpls.get("encapsulation")
break
- self._pop_last_update_time(onos_config)
- response = requests.post(self.url, json=onos_config, auth=HTTPBasicAuth(self.user, self.password))
- response.raise_for_status()
-
- def _delete_network_port(self, net_id, port):
- onos_config_req = requests.get(self.url, auth=HTTPBasicAuth(self.user, self.password))
- onos_config_req.raise_for_status()
- onos_config = onos_config_req.json()
- for vpls in onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList']:
- if vpls['name'] == net_id:
- for interface in vpls['interfaces']:
- if interface == port['service_endpoint_id']:
- vpls['interfaces'].remove(interface)
- break
- for onos_port in onos_config['ports'].values():
- for port_interface in onos_port['interfaces']:
- if port_interface['name'] == port['service_endpoint_id']:
- onos_port['interfaces'].remove(port_interface)
+ else:
+ raise SdnConnectorError("service uuid: {} does not exist".format(service_uuid))
+
+ self.logger.debug("current interfaces: {}".format(curr_interfaces))
+ self.logger.debug("current encapsulation: {}".format(curr_encapsulation))
+
+ # new interfaces names
+ new_interfaces = [port['service_endpoint_id'] for port in connection_points]
+
+ # obtain interfaces to delete, list will contain port
+ ifs_delete = list(set(curr_interfaces) - set(new_interfaces))
+ ifs_add = list(set(new_interfaces) - set(curr_interfaces))
+ self.logger.debug("interfaces to delete: {}".format(ifs_delete))
+ self.logger.debug("interfaces to add: {}".format(ifs_add))
+
+ # check if some data of the interfaces that already existed has changed
+ # in that case delete it and add it again
+ ifs_remain = list(set(new_interfaces) & set(curr_interfaces))
+ for port in connection_points:
+ if port['service_endpoint_id'] in ifs_remain:
+ # check if there are some changes
+ curr_port_name, curr_vlan = self._get_current_port_data(onos_config, port['service_endpoint_id'])
+ new_port_name = 'of:{}/{}'.format(port['service_endpoint_encapsulation_info']['switch_dpid'],
+ port['service_endpoint_encapsulation_info']['switch_port'])
+ new_vlan = port['service_endpoint_encapsulation_info']['vlan']
+ if (curr_port_name != new_port_name or curr_vlan != new_vlan):
+ self.logger.debug("TODO: must update data interface: {}".format(port['service_endpoint_id']))
+ ifs_delete.append(port['service_endpoint_id'])
+ ifs_add.append(port['service_endpoint_id'])
+
+ new_encapsulation = self._get_encapsulation(connection_points)
+
+ try:
+ # Delete interfaces, only will delete interfaces that are in provided conn_info
+ # because these are the ones that have been created for this service
+ if ifs_delete:
+ for port in onos_config['ports'].values():
+ for port_interface in port['interfaces']:
+ interface_name = port_interface['name']
+ self.logger.debug("interface name: {}".format(port_interface['name']))
+ if interface_name in ifs_delete and interface_name in created_ifs:
+ self.logger.debug("delete interface name: {}".format(interface_name))
+ port['interfaces'].remove(port_interface)
+ created_ifs.remove(interface_name)
+
+ # Add new interfaces
+ for port in connection_points:
+ if port['service_endpoint_id'] in ifs_add:
+ created_ifz = self._append_port_to_onos_config(port, onos_config)
+ if created_ifz:
+ created_ifs.append(created_ifz[1])
+ self._pop_last_update_time(onos_config)
+ self._post_onos_netconfig(onos_config)
+
+ self.logger.debug("onos config after updating interfaces: {}".format(onos_config))
+ self.logger.debug("created_ifs after updating interfaces: {}".format(created_ifs))
+
+ # Update interfaces list in vpls service
+ for vpls in onos_config.get('apps', {}).get('org.onosproject.vpls', {}).get('vpls', {}).get('vplsList', {}):
+ if vpls['name'] == service_uuid:
+ vpls['interfaces'] = new_interfaces
+ vpls['encapsulation'] = new_encapsulation
+
+ self._pop_last_update_time(onos_config)
+ self._post_onos_netconfig(onos_config)
+ return {"interfaces": created_ifs}
+ except Exception as e:
+ self.logger.error('Exception add connection_service: %s', e)
+ # try to rollback push original config
+ try:
+ self._post_onos_netconfig(onos_config_orig)
+ except Exception as e2:
+ self.logger.error('Exception rolling back to original config: %s', e2)
+ # raise exception
+ if isinstance(e, SdnConnectorError):
+ raise
+ else:
+ raise SdnConnectorError("Exception create_connectivity_service: {}".format(e))
+
+ def delete_connectivity_service(self, service_uuid, conn_info=None):
+ self.logger.debug("delete_connectivity_service uuid: {}".format(service_uuid))
+
+ conn_info = conn_info or {}
+ created_ifs = conn_info.get("interfaces", [])
+ # Obtain current config
+ onos_config = self._get_onos_netconfig()
+
+ try:
+ # Removes ports used by network from onos config
+ for vpls in onos_config.get('apps', {}).get('org.onosproject.vpls', {}).get('vpls', {}).get('vplsList', {}):
+ if vpls['name'] == service_uuid:
+ # iterate interfaces to check if must delete them
+ for interface in vpls['interfaces']:
+ for port in onos_config['ports'].values():
+ for port_interface in port['interfaces']:
+ if port_interface['name'] == interface:
+ # Delete only created ifzs
+ if port_interface['name'] in created_ifs:
+ self.logger.debug("Delete ifz: {}".format(port_interface['name']))
+ port['interfaces'].remove(port_interface)
+ onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList'].remove(vpls)
break
- self._pop_last_update_time(onos_config)
- response = requests.post(self.url, json=onos_config, auth=HTTPBasicAuth(self.user, self.password))
- response.raise_for_status()
-
- def _add_network_port(self, net_id, port):
- onos_config_req = requests.get(self.url, auth=HTTPBasicAuth(self.user, self.password))
- onos_config_req.raise_for_status()
- onos_config = onos_config_req.json()
- self._append_port_to_onos_config(port, onos_config)
- # Interfaces need to be registered before adding them to VPLS
- response = requests.post(self.url, json=onos_config, auth=HTTPBasicAuth(self.user, self.password))
- response.raise_for_status()
- for vpls in onos_config['apps']['org.onosproject.vpls']['vpls']['vplsList']:
- if vpls['name'] == net_id:
- vpls['interfaces'].append(port['service_endpoint_id'])
- break
- self._pop_last_update_time(onos_config)
- response = requests.post(self.url, json=onos_config, auth=HTTPBasicAuth(self.user, self.password))
- response.raise_for_status()
+ else:
+ raise SdnConnectorError("service uuid: {} does not exist".format(service_uuid))
+
+ self._pop_last_update_time(onos_config)
+ self._post_onos_netconfig(onos_config)
+ self.logger.debug("deleted connectivity service uuid: {}".format(service_uuid))
+ except SdnConnectorError:
+ raise
+ except Exception as e:
+ self.logger.error('Exception delete connection_service: %s', e, exc_info=True)
+ raise SdnConnectorError("Exception delete connectivity service: {}".format(str(e)))
def _pop_last_update_time(self, onos_config):
- if 'lastUpdateTime' in onos_config['apps']['org.onosproject.vpls']['vpls']:
- onos_config['apps']['org.onosproject.vpls']['vpls'].pop('lastUpdateTime')
+ """
+ Needed before post when there are already configured vpls services to apply changes
+ """
+ onos_config['apps']['org.onosproject.vpls']['vpls'].pop('lastUpdateTime', None)
+
+ def _get_current_port_data(self, onos_config, interface_name):
+ for port_name, port in onos_config['ports'].items():
+ for port_interface in port['interfaces']:
+ if port_interface['name'] == interface_name:
+ return port_name, port_interface['vlan']
def _append_port_to_onos_config(self, port, onos_config):
+ created_item = None
port_name = 'of:{}/{}'.format(port['service_endpoint_encapsulation_info']['switch_dpid'],
- port['service_endpoint_encapsulation_info']['switch_port'])
+ port['service_endpoint_encapsulation_info']['switch_port'])
interface_config = {'name': port['service_endpoint_id']}
- if 'vlan' in port['service_endpoint_encapsulation_info'] and port['service_endpoint_encapsulation_info'][
- 'vlan']:
+ if 'vlan' in port['service_endpoint_encapsulation_info'] \
+ and port['service_endpoint_encapsulation_info']['vlan']:
interface_config['vlan'] = port['service_endpoint_encapsulation_info']['vlan']
if port_name in onos_config['ports'] and 'interfaces' in onos_config['ports'][port_name]:
for interface in onos_config['ports'][port_name]['interfaces']:
if interface['name'] == port['service_endpoint_id']:
- onos_config['ports'][port_name]['interfaces'].remove(interface)
- onos_config['ports'][port_name]['interfaces'].append(interface_config)
+ #self.logger.debug("interface with same name and port exits")
+ # interface already exists TODO ¿check vlan? ¿delete and recreate?
+ # by the moment use and do not touch
+ #onos_config['ports'][port_name]['interfaces'].remove(interface)
+ break
+ else:
+ #self.logger.debug("port with same name exits but not interface")
+ onos_config['ports'][port_name]['interfaces'].append(interface_config)
+ created_item = (port_name, port['service_endpoint_id'])
else:
+ #self.logger.debug("create port and interface")
onos_config['ports'][port_name] = {
'interfaces': [interface_config]
}
+ created_item = (port_name, port['service_endpoint_id'])
+ return created_item
if __name__ == '__main__':
- pass
- # host = '198.204.228.85'
- # port = 8181
- # onos_vpls = OnosVpls(host, port, 'onos', 'rocks')
- # ports = [
- # {
- # 'uuid': '0a43961d',
- # 'switch_dpid': '0000000000000001',
- # 'switch_port': '1',
- # 'vlan': 100
- # },
- # {
- # 'uuid': 'ade3eefc',
- # 'switch_dpid': '0000000000000003',
- # 'switch_port': '1',
- # 'vlan': 100
- # }
- # ]
- # onos_vpls.create_network('94979b37-3875-4f77-b620-01ff78f9c4fa', 'data')
- # onos_vpls.add_network_port('94979b37-3875-4f77-b620-01ff78f9c4fa', ports[0])
- # onos_vpls.add_network_port('94979b37-3875-4f77-b620-01ff78f9c4fa', ports[1])
- # onos_vpls.delete_network_port('94979b37-3875-4f77-b620-01ff78f9c4fa', ports[1])
- # onos_vpls.delete_network('94979b37-3875-4f77-b620-01ff78f9c4fa')
+ logger = logging.getLogger('openmano.sdn.onos_vpls')
+ logging.basicConfig()
+ logger.setLevel(getattr(logging, "DEBUG"))
+ # wim_url = "http://10.95.172.251:8181"
+ wim_url = "http://192.168.56.106:8181"
+ user = "karaf"
+ password = "karaf"
+ wim = {'wim_url': wim_url}
+ wim_account = {'user': user, 'password': password}
+ onos_vpls = OnosVpls(wim=wim, wim_account=wim_account, logger=logger)
+ #conn_service = onos_vpls.get_connectivity_service_status("4e1f4c8a-a874-425d-a9b5-955cb77178f8")
+ #print(conn_service)
+ service_type = 'ELAN'
+ conn_point_0 = {
+ "service_endpoint_id": "switch1:ifz1",
+ "service_endpoint_encapsulation_type": "dot1q",
+ "service_endpoint_encapsulation_info": {
+ "switch_dpid": "0000000000000011",
+ "switch_port": "1",
+ "vlan": "600"
+ }
+ }
+ conn_point_1 = {
+ "service_endpoint_id": "switch3:ifz1",
+ "service_endpoint_encapsulation_type": "dot1q",
+ "service_endpoint_encapsulation_info": {
+ "switch_dpid": "0000000000000031",
+ "switch_port": "3",
+ "vlan": "600"
+ }
+ }
+ connection_points = [conn_point_0, conn_point_1]
+ #service_uuid, conn_info = onos_vpls.create_connectivity_service(service_type, connection_points)
+ #print(service_uuid)
+ #print(conn_info)
+
+ #conn_info = None
+ conn_info = {"interfaces": ['switch1:ifz1', 'switch3:ifz1']}
+ #onos_vpls.delete_connectivity_service("70248a41-11cb-44f3-9039-c41387394a30", conn_info)
+
+ conn_point_0 = {
+ "service_endpoint_id": "switch1:ifz1",
+ "service_endpoint_encapsulation_type": "dot1q",
+ "service_endpoint_encapsulation_info": {
+ "switch_dpid": "0000000000000011",
+ "switch_port": "1",
+ "vlan": "500"
+ }
+ }
+ conn_point_2 = {
+ "service_endpoint_id": "switch1:ifz3",
+ "service_endpoint_encapsulation_type": "dot1q",
+ "service_endpoint_encapsulation_info": {
+ "switch_dpid": "0000000000000011",
+ "switch_port": "3",
+ "vlan": "500"
+ }
+ }
+ conn_point_3 = {
+ "service_endpoint_id": "switch2:ifz2",
+ "service_endpoint_encapsulation_type": "dot1q",
+ "service_endpoint_encapsulation_info": {
+ "switch_dpid": "0000000000000022",
+ "switch_port": "2",
+ "vlan": "500"
+ }
+ }
+ connection_points_2 = [conn_point_0, conn_point_3]
+ #conn_info = onos_vpls.edit_connectivity_service("c65d88be-73aa-4933-927d-57ec6bee6b41", conn_info, connection_points_2)
+ #print(conn_info)
+
+ service_status = onos_vpls.get_connectivity_service_status("c65d88be-73aa-4933-927d-57ec6bee6b41", conn_info)
+ print("service status")
+ print(service_status)