def destroy_vnf(self, vnf_id):
"""Destroys a VNF and its related NS.
This operation just is done if the NS has only one VNF (i.e. this VNF)
:param vnf_id:
Raises
------
NFVOAgentsException
"""
try:
vnf = self.client.vnf.get(vnf_id)
ns = self.client.ns.get(vnf['nsr-id-ref'])
if len(ns['constituent-vnfr-ref']) > 1:
raise NFVOAgentsException(
ERROR, "A Network Service depends on this VNF.")
vnfd_id = vnf['vnfd-id']
ns_id = ns['id']
nsd_id = ns['nsd']['_id']
self.client.ns.delete(ns_id, wait=POLLING_TIMEOUT)
logger.info("NS instance %s deleted", ns_id)
self.client.nsd.delete(nsd_id)
logger.info("NSD %s deleted", nsd_id)
self.client.vnfd.delete(vnfd_id)
logger.info("VNFD %s deleted", vnfd_id)
except ClientException as e:
raise NFVOAgentsException(ERROR, str(e))
def __init__(self, auth_url, username, password, project_name):
"""Instantiates a Tacker client
Raises
------
NFVOAgentsException
"""
auth = v3.Password(auth_url=auth_url,
username=username,
password=password,
project_name=project_name,
user_domain_name="default",
project_domain_name="default")
self.session = session.Session(auth=auth)
self.keystone = keystone_client.Client(session=self.session)
services = self.keystone.services.list(name='tacker')
if len(services) == 1:
endpoint = self.keystone.endpoints.list(service=services[0], interface='public')
if len(endpoint) == 1:
self.tacker = tacker_client.Client(session=self.session,
endpoint_url=endpoint[0].url)
else:
raise NFVOAgentsException(ERROR, "Tacker public endpoint not found")
else:
raise NFVOAgentsException(ERROR, "Tacker service not found")
def _exception_handler(self, e):
"""Exception handler for the Tacker API
This function is in charge of handling the exceptions caught from
the Tacker class and generating the appropriate NFVOAgentsException
"""
if isinstance(e, TackerClientException):
raise NFVOAgentsException(e.status_code, e.message)
elif isinstance(e, KeyError):
logger.error('Unable to find key %s in Tacker response', e)
raise NFVOAgentsException(ERROR, 'Key %s is missing' % e)
else:
logger.critical('unhandled exception: %s', e)
raise NFVOAgentsException(ERROR, str(e))
def destroy_sfc(self, sfc_id, destroy_vnf_fn):
""" Destroys an NS and its related NSD and VNFDs
:param sfc_id:
:param destroy_vnf_fn: callback function from the core module
"""
try:
ns = self.client.ns.get(sfc_id)
self.client.ns.delete(sfc_id, wait=POLLING_TIMEOUT)
logger.info("NS instance %s deleted", sfc_id)
self.client.nsd.delete(ns['nsd']['_id'])
logger.info("NSD %s deleted", ns['nsd']['_id'])
except ClientException as e:
raise NFVOAgentsException(ERROR, str(e))
constituent_vnfd = ns['nsd']['constituent-vnfd']
for vnfd in constituent_vnfd:
try:
self.client.vnfd.delete(vnfd['vnfd-id-ref'])
logger.info("VNFD %s deleted", vnfd['vnfd-id-ref'])
except ClientException as e:
logger.info("Trying to delete %s", str(e))
def list_sfcs(self):
"""Retrieves a list of NS"""
try:
ns_instances = self.client.ns.list()
except ClientException as e:
raise NFVOAgentsException(ERROR, str(e))
ns_list = []
for ns in ns_instances:
ns_id = ns['id']
name = ns['name']
if ns['operational-status'] != 'running':
state = ns['operational-status'].upper()
else:
state = ns['_admin']['deployed']['RO']['nsr_status']
sfp = ns['constituent-vnfr-ref']
# If the instantiated NS is just a VNF (not SFC), then constituent-vnfr-ref had just one element
# Note that an SFC NS has in OSM at least two VNFs in constituent-vnfr-ref
# So, by removing the first VNF we can conclude that if sfp is empty, then this NS
# is just a VNF, not an SFC.
if len(sfp) > 1:
ns_list.append({
'id': ns_id,
'name': name,
'status': state,
'vnf_chain': sfp,
'platform': OSM_NFVO
})
return ns_list
def ns_polling(self, ns_id):
"""Constantly checks the creation status of the NS.
Wait until the NS status is set to ACTIVE on OSM.
:param ns_id:
:return: an NS instance
Raises
------
NFVOAgentsException
ReRaises
------
ClientException
"""
timeout_seconds = POLLING_TIMEOUT
sleep_interval = 5
logger.info("Polling NS with id %s, please wait...", ns_id)
timeout = time() + timeout_seconds
while timeout > time():
ns = self.client.ns.get(ns_id)
try:
ns_status = ns['_admin']['deployed']['RO']['nsr_status']
except KeyError:
if ns['operational-status'] == FAILED:
raise NFVOAgentsException(ERROR, ns['detailed-status'])
ns_status = 'KEY_ERROR'
if ns_status == 'ACTIVE':
return ns
elif ns_status not in ('BUILD', 'KEY_ERROR'):
raise NFVOAgentsException(str(ns_status), 'Unexpected error.')
sleep(sleep_interval)
raise NFVOAgentsException(
TIMEOUT,
'Timeout of %ss on polling NS id %s' % (timeout_seconds, ns_id))
def get_vim_agent_instance(self):
vim = self.client.vim.get(self.vim_name)
if vim['vim_type'] != 'openstack':
msg = "VIM type %s not supported." % vim['vim_type']
logger.error(msg)
raise NFVOAgentsException(ERROR, msg)
vim_agent = OpenStackAgent(vim['vim_url'], self._vim_username,
self._vim_password, vim['vim_tenant_name'],
self.vim_name)
return vim_agent
def list_vnfs(self):
"""Retrieves a list of VNFs"""
try:
vnf_list = self.client.vnf.list()
except ClientException as e:
raise NFVOAgentsException(ERROR, str(e))
vnfs = []
for vnf in vnf_list:
vnf_id = vnf['id']
vdu0 = vnf['vdur'][0]
# OSM does not show a VNF name, just VDU names
vnf_name = vdu0.get('name')
mgmt_url = vnf.get('ip-address')
instance_name = vdu0.get('name')
vnfd_id = vnf.get('vnfd-id')
vnf_status = vdu0.get('status')
if vnf['vim-account-id'] == self.vim_id:
vnfs.append({
'vnf_id': vnf_id,
'vnf_name': vnf_name,
'instance_name': instance_name,
'mgmt_url': mgmt_url,
'vnfd_id': vnfd_id,
'vnf_status': vnf_status,
'platform': OSM_NFVO,
'domain_name': self.domain_name,
'nfvo_name': self.nfvo_name,
'vim_name': self.vim_name
})
return vnfs
def create_sfc(self, sfc_descriptor, database, sfc_uuid, sfc_name,
create_vnf_fn, destroy_vnf_fn):
"""Sends all VNFDs and the NSD to the OSM NFVO and instantiates the NS
:param sfc_descriptor:
:param database:
:param sfc_uuid:
:param sfc_name:
:param create_vnf_fn: callback function from the core module
:param destroy_vnf_fn: callback function from the core module
:return: a dict containing:
- a list of *vnf_instances* of the created SFC
- the created *vnffgd_id*
- the created *vnffg_id*
Raises
------
NFVOAgentsException
ReRaises
------
DatabaseException
"""
desc_file = 'template/osm_nsd/nsd.yaml'
nsd_file = 'template/%s_nsd.tar.gz' % sfc_uuid
vnfp_template_dir = 'template/osm_nsd/'
try:
self.client.nsd.get(sfc_name)
logger.error("NSD name '%s' already exists on %s", sfc_name,
self.nfvo_name)
raise NFVOAgentsException(
ERROR, "SFC name '%s' already exists" % sfc_name)
except NotFound:
pass
try:
self.client.ns.get(sfc_name)
logger.error("NS name '%s' already exists on %s", sfc_name,
self.nfvo_name)
raise NFVOAgentsException(
ERROR, "SFC name '%s' already exists" % sfc_name)
except NotFound:
pass
nsd = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]
nsd['id'] = sfc_uuid
nsd['name'] = sfc_name
nsd['short-name'] = sfc_name
yaml_file = open(desc_file, 'w')
yaml_file.write(yaml.dump(sfc_descriptor))
yaml_file.close()
logger.info('SFC Template UUID: %s\n%s', sfc_uuid,
self.dump_sfc_descriptor(sfc_descriptor))
constituent_vnfd = nsd.get('constituent-vnfd')
for vnfd in constituent_vnfd:
vnfd_name = vnfd.get('vnfd-id-ref')
vnfp = database.list_catalog(vnfd_name=vnfd_name)
vnfd_path = 'repository/%s/vnfd.tar.gz' % vnfp[0]['dir_id']
try:
vnfd = self.client.vnfd.get(vnfd_name)
vnfd_id = vnfd['_id']
logger.info("VNFD previously created with id %s", vnfd_id)
except NotFound:
try:
self.client.vnfd.create(vnfd_path)
vnfd_id = self.client.vnfd.get(vnfd_name)['_id']
logger.info("VNFD created with id %s", vnfd_id)
except (ClientException, NotFound) as e:
raise NFVOAgentsException(ERROR, str(e))
tar = tarfile.open(nsd_file, 'w:gz')
tar.add(vnfp_template_dir, arcname='template_nsd', recursive=True)
tar.close()
try:
self.client.nsd.create(nsd_file)
nsd_id = self.client.nsd.get(nsd['name'])['_id']
logger.info("NSD created with id %s", nsd_id)
self.client.ns.create(nsd['name'],
sfc_name,
self.vim_name,
description=' ',
wait=POLLING_TIMEOUT) # pylint: disable=unexpected-keyword-arg
ns = self.client.ns.get(nsd['name'])
logger.info("NS created with id %s", ns['_id'])
except (ClientException, NotFound) as e:
logger.error("NS %s could not be created! %s", sfc_name, str(e))
logger.error("Running rollback actions...")
self.destroy_sfc(sfc_name, destroy_vnf_fn)
raise NFVOAgentsException(ERROR, str(e))
except ClientException as e:
raise NFVOAgentsException(ERROR, str(e))
finally:
os.remove(nsd_file)
vnf_instances = ns['constituent-vnfr-ref']
return {
'vnf_instances': vnf_instances,
'nsd_id': nsd['id'],
'ns_id': ns['_id']
}
def configure_traffic_src_policy(self, sfc_descriptor, origin, src_id,
cp_out, database):
"""Includes ACL criteria according to INTERNAL or EXTERNAL traffic source
INTERNAL traffic is sourced from VNFs managed by NFVO, while EXTERNAL traffic is sourced from everything
out from NFVO networks.
This function includes specific requirements to select the source port for OSM NFVO.
One important rule is applied:
1. OSMs network_name from the origin VNF CP must be the same as the input CP of the first VNF in the chain.
:param sfc_descriptor:
:param origin: INTERNAL or EXTERNAL as in *utils module*
:param src_id: the VNF Package ID of the VNF which generates de SFC incoming traffic
:param cp_out: not user by OSM Agent
:param database:
:return: the NSD being composed
Raises
------
NFVOAgentsException
ReRaises
------
DatabaseException
"""
if origin != INTERNAL:
raise NFVOAgentsException(
ERROR,
"OSM Agent does not allow incoming traffic from external networks!"
)
vnfp = database.list_catalog(vnf_pkg_id=src_id)
vnfp_dir = vnfp[0].get('dir_id')
vnf_nsd = self._get_repository_nsd_content(vnfp_dir)
vnf_nsd = vnf_nsd['nsd:nsd-catalog']['nsd'][0]
vnfd_nsd_name = vnf_nsd.get('constituent-vnfd')[0].get('vnfd-id-ref')
sfc_descriptor = self.add_constituent_vnf_and_virtual_link(
sfc_descriptor, vnfd_nsd_name, vnf_nsd, True)
constituent_vnfd = sfc_descriptor['nsd:nsd-catalog']['nsd'][0][
'constituent-vnfd']
# the VNFs which generates the source traffic was just included as first one in NSD
vnf_id_ref = constituent_vnfd[0].get('vnfd-id-ref')
member_vnf_index = constituent_vnfd[0].get('member-vnf-index')
sfc_vld = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vld']
classifier = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vnffgd'][0][
'classifier'][0]
sfc_sfp = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vnffgd'][0][
'rsp'][0]['vnfd-connection-point-ref']
first_sfp_vnf = sfc_sfp[0]
# getting the vim-network-name from the first VNF of the SFP (RSP)
net_name = None
for sfc_vl in sfc_vld:
for sfc_cp_ref in sfc_vl.get('vnfd-connection-point-ref'):
if first_sfp_vnf.get('vnfd-id-ref') in sfc_cp_ref.values() and \
first_sfp_vnf.get('vnfd-egress-connection-point-ref') in sfc_cp_ref.values():
net_name = sfc_vl.get('vim-network-name')
break
if net_name:
break
# getting the cp_name from the source traffic based on the vim-network-name from the first SFP (RSP) VNF
vnf_cp_ref = None
for nsd_vl in vnf_nsd.get('vld'):
if nsd_vl.get('vim-network-name') == net_name:
vnf_cp_ref = nsd_vl['vnfd-connection-point-ref'][0][
'vnfd-connection-point-ref']
break
if not vnf_cp_ref:
raise NFVOAgentsException(ERROR, "No suitable CP on this VNF!")
classifier['member-vnf-index-ref'] = member_vnf_index
classifier['vnfd-id-ref'] = vnf_id_ref
classifier['vnfd-connection-point-ref'] = vnf_cp_ref
return sfc_descriptor
def compose_sfp(self, sfc_descriptor, vnfd_name, vnfp_dir, database,
options_cp_out):
"""Performs VNF Chaining in the NSD Template.
This function stands for VNF Chaining and its requirements for CPs and VLs using the SFC Template.
The following rules are taken into account:
#. Chooses the CP according to the same network of the previous CP.
If the VNF is the first one, then the first CP is chosen (disregarding the management interface).
#. If no CP is chosen automatically.
Then an NFVOAgentsException is raised stating that there aren't suitable CP for the given VNF Package
:param sfc_descriptor: the NS descriptor being composed
:param vnfd_name:
:param vnfp_dir:
:param database: not used by this function
:param options_cp_out: not used by this function
:return: the OSM SFC Descriptor (i.e. NSD) being composed
Raises
------
NFVOAgentsException
ReRaises
------
NFVOAgentsException
"""
vnf_nsd = self._get_repository_nsd_content(vnfp_dir)
vnf_nsd = vnf_nsd['nsd:nsd-catalog']['nsd'][0]
vnf_id_ref = vnf_nsd['constituent-vnfd'][0]['vnfd-id-ref']
sfc_descriptor = self.add_constituent_vnf_and_virtual_link(
sfc_descriptor, vnfd_name, vnf_nsd)
constituent_vnfd = sfc_descriptor['nsd:nsd-catalog']['nsd'][0][
'constituent-vnfd']
# the current vnfd, now is the last one which was just added
# by the previous call to "add_constituent_vnf_and_virtual_link" function
member_vnf_index = constituent_vnfd[-1].get('member-vnf-index')
sfc_vld = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vld']
sfc_sfp = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vnffgd'][0][
'rsp'][0]['vnfd-connection-point-ref']
if not sfc_sfp:
sfc_sfp = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vnffgd'][0][
'rsp'][0]['vnfd-connection-point-ref'] = []
else:
sfc_sfp = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vnffgd'][0][
'rsp'][0]['vnfd-connection-point-ref']
# Adding VNFs in RSP. Here the SFC composition happens auto-magically
mgmt_network = False
for nsd_vl in vnf_nsd.get('vld'):
# Important: The management network of the VNF Package's NSD shall contain the 'mgmt-network'
if not nsd_vl.get('mgmt-network'):
# NSD of a single VNF has just one CP in a VL
cp_name = nsd_vl['vnfd-connection-point-ref'][0][
'vnfd-connection-point-ref']
net_name = nsd_vl.get('vim-network-name')
vnffgd_cp_ref = {
'member-vnf-index-ref': member_vnf_index,
'vnfd-id-ref': vnf_id_ref,
'vnfd-ingress-connection-point-ref': cp_name,
'vnfd-egress-connection-point-ref': cp_name
} # TODO change implementation to allow different ingress and egress cp_name (as in tacker_agent)
if not sfc_sfp:
vnffgd_cp_ref['order'] = 0
sfc_sfp.append(vnffgd_cp_ref)
else:
# Checks if the previous VNF network name is the same of the current VNF network name
# It is impossible create SFC Chains crossing different VIM's subnet
previous_vnfd_cp = sfc_sfp[-1]
previous_net = None
for sfc_vl in sfc_vld:
for cp_ref in sfc_vl['vnfd-connection-point-ref']:
if cp_ref.get(
'vnfd-id-ref') == previous_vnfd_cp.get(
'vnfd-id-ref'):
if cp_ref.get('vnfd-connection-point-ref') == \
previous_vnfd_cp.get('vnfd-connection-point-ref'):
previous_net = sfc_vl.get(
'vim-network-name')
break
if previous_net:
break
if previous_net == net_name:
vnffgd_cp_ref['order'] = previous_vnfd_cp.get(
'order') + 1
sfc_sfp.append(vnffgd_cp_ref)
else:
mgmt_network = True
if mgmt_network is False:
logger.warning(
"NS Descriptor '%s' does not have a management network (mgmt-network)",
vnf_nsd['name'])
# Checks whether the current VNF was added on the SFC composition
if sfc_sfp[-1]['vnfd-id-ref'] != vnf_id_ref:
raise NFVOAgentsException(
ERROR,
"There is no suitable CP for chaining with the previous VNF!")
return sfc_descriptor
def add_constituent_vnf_and_virtual_link(self,
sfc_descriptor,
vnfd_name,
vnf_nsd,
input_vnf=False):
"""Adds VNF and its VL to the NSD
:param sfc_descriptor:
:param vnfd_name:
:param vnf_nsd:
:param input_vnf: use True if the VNF being added is used as traffic source by the classifier
:return: the NSD being composed
"""
# vnf_nsd = self._get_repository_nsd_content(vnfp_dir)
# vnf_nsd = vnf_nsd['nsd:nsd-catalog']['nsd'][0]
constituent_vnfd = sfc_descriptor['nsd:nsd-catalog']['nsd'][0][
'constituent-vnfd']
if not constituent_vnfd:
constituent_vnfd = sfc_descriptor['nsd:nsd-catalog']['nsd'][0][
'constituent-vnfd'] = []
sfc_vld = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vld'] = []
# sfc_sfp = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vnffgd'][0]['rsp'][0][
# 'vnfd-connection-point-ref'] = []
else:
sfc_vld = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vld']
# sfc_sfp = sfc_descriptor['nsd:nsd-catalog']['nsd'][0]['vnffgd'][0]['rsp'][0]['vnfd-connection-point-ref']
for vnfd in constituent_vnfd:
if vnfd_name in vnfd.values():
raise NFVOAgentsException(
ERROR,
"The selected VNF Package was already added in this SFC!")
# Adding Constituent VNFD
# the first member must be reserved for the VNF which generates the input SFC traffic
vnf_id_ref = vnf_nsd['constituent-vnfd'][0]['vnfd-id-ref']
if not input_vnf:
if len(constituent_vnfd) == 0:
member_vnf_index = 2
else:
member_vnf_index = constituent_vnfd[-1]['member-vnf-index'] + 1
constituent_vnfd.append({
'member-vnf-index': member_vnf_index,
'vnfd-id-ref': vnf_id_ref
})
else:
member_vnf_index = 1
constituent_vnfd.insert(0, {
'member-vnf-index': member_vnf_index,
'vnfd-id-ref': vnf_id_ref
})
# Adding VNF Virtual Links
for nsd_vl in vnf_nsd.get('vld'):
sfc_vls = [
sfc_vl for sfc_vl in sfc_vld
if sfc_vl['vim-network-name'] == nsd_vl['vim-network-name']
]
# NSD of a single VNF has just one CP in a VL
cp_name = nsd_vl['vnfd-connection-point-ref'][0][
'vnfd-connection-point-ref']
vl_cp_ref = {
'member-vnf-index-ref': member_vnf_index,
'vnfd-id-ref': vnf_id_ref,
'vnfd-connection-point-ref': cp_name
}
net_name = nsd_vl.get('vim-network-name')
if not sfc_vls:
vld_id = len(sfc_vld) + 1
vl = {
'id': ''.join(['vld', str(vld_id)]),
'vim-network-name': net_name,
'vnfd-connection-point-ref': [vl_cp_ref]
}
sfc_vld.append(vl)
else:
for sfc_vl in sfc_vld:
if sfc_vl.get('vim-network-name') == net_name:
if not input_vnf:
sfc_vl.get('vnfd-connection-point-ref').append(
vl_cp_ref)
else:
sfc_vl.get('vnfd-connection-point-ref').insert(
0, vl_cp_ref)
break
return sfc_descriptor
def create_vnf(self, vnfp_dir, vnfd_name, vnf_name):
"""Creates a VNF and its related NS.
:param vnfp_dir:
:param vnfd_name:
:param vnf_name:
:return: VNFD id, VNF id, and VNF ip
Raises
------
NFVOAgentsException
"""
vnfd_path = '%s/vnfd.tar.gz' % vnfp_dir
nsd_path = '%s/nsd.tar.gz' % vnfp_dir
try:
vnfd = self.client.vnfd.get(vnfd_name)
vnfd_id = vnfd['_id']
logger.info("VNFD previously created with id %s", vnfd_id)
except NotFound:
try:
self.client.vnfd.create(vnfd_path)
vnfd_id = self.client.vnfd.get(vnfd_name)['_id']
logger.info("VNFD created with id %s", vnfd_id)
except (ClientException, NotFound) as e:
raise NFVOAgentsException(ERROR, str(e))
try:
self.client.nsd.create(nsd_path)
dir_id = os.path.split(vnfp_dir)[1]
vnf_nsd = self._get_repository_nsd_content(dir_id)
nsd_name = vnf_nsd['nsd:nsd-catalog']['nsd'][0]['name']
nsd_id = self.client.nsd.get(nsd_name)['_id']
logger.info("NSD created with id %s", nsd_id)
except (ClientException, NotFound) as e:
logger.error(str(e))
self.client.vnfd.delete(vnfd_id)
raise NFVOAgentsException(ERROR, str(e))
try:
self.client.ns.create(nsd_name,
vnf_name,
self.vim_name,
description=' ',
wait=POLLING_TIMEOUT) # pylint: disable=unexpected-keyword-arg
ns = self.client.ns.get(vnf_name)
logger.info("NS created with id %s", ns['_id'])
vnf_id = ns['constituent-vnfr-ref'][0]
vnf = self.client.vnf.get(vnf_id)
except (ClientException, NotFound, NFVOAgentsException) as e:
logger.error(str(e))
logger.info("Rollback VNF creation actions are being done")
self.client.ns.delete(vnf_name)
self.client.nsd.delete(nsd_id)
self.client.vnfd.delete(vnfd_id)
logger.info("Rollback Done!")
raise NFVOAgentsException(ERROR, str(e))
vnf_ip = vnf['ip-address']
return {'vnfd_id': vnfd_id, 'vnf_id': vnf_id, 'vnf_ip': vnf_ip}