2 # Copyright 2016 RIFT.IO Inc
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
20 import ncclient
.asyncio_manager
32 from collections
import deque
33 from collections
import defaultdict
37 gi
.require_version('RwYang', '1.0')
38 gi
.require_version('RwNsdYang', '1.0')
39 gi
.require_version('RwDts', '1.0')
40 gi
.require_version('RwNsmYang', '1.0')
41 gi
.require_version('RwNsrYang', '1.0')
42 gi
.require_version('RwTypes', '1.0')
43 gi
.require_version('RwVlrYang', '1.0')
44 gi
.require_version('RwVnfrYang', '1.0')
45 from gi
.repository
import (
61 import rift
.mano
.ncclient
62 import rift
.mano
.config_data
.config
63 import rift
.mano
.dts
as mano_dts
65 from . import rwnsm_conman
as conman
67 from . import publisher
69 from . import config_value_pool
70 from . import rwvnffgmgr
71 from . import scale_group
74 class NetworkServiceRecordState(Enum
):
75 """ Network Service Record State """
79 VNFFG_INIT_PHASE
= 104
85 VL_TERMINATE_PHASE
= 111
86 VNF_TERMINATE_PHASE
= 112
87 VNFFG_TERMINATE_PHASE
= 113
94 class NetworkServiceRecordError(Exception):
95 """ Network Service Record Error """
99 class NetworkServiceDescriptorError(Exception):
100 """ Network Service Descriptor Error """
104 class VirtualNetworkFunctionRecordError(Exception):
105 """ Virtual Network Function Record Error """
109 class NetworkServiceDescriptorNotFound(Exception):
110 """ Cannot find Network Service Descriptor"""
114 class NetworkServiceDescriptorRefCountExists(Exception):
115 """ Network Service Descriptor reference count exists """
119 class NetworkServiceDescriptorUnrefError(Exception):
120 """ Failed to unref a network service descriptor """
124 class NsrInstantiationFailed(Exception):
125 """ Failed to instantiate network service """
129 class VnfInstantiationFailed(Exception):
130 """ Failed to instantiate virtual network function"""
134 class VnffgInstantiationFailed(Exception):
135 """ Failed to instantiate virtual network function"""
139 class VnfDescriptorError(Exception):
140 """Failed to instantiate virtual network function"""
144 class ScalingOperationError(Exception):
148 class ScaleGroupMissingError(Exception):
152 class PlacementGroupError(Exception):
156 class NsrNsdUpdateError(Exception):
160 class NsrVlUpdateError(NsrNsdUpdateError
):
164 class VlRecordState(Enum
):
165 """ VL Record State """
167 INSTANTIATION_PENDING
= 102
169 TERMINATE_PENDING
= 104
174 class VnffgRecordState(Enum
):
175 """ VNFFG Record State """
177 INSTANTIATION_PENDING
= 102
179 TERMINATE_PENDING
= 104
184 class VnffgRecord(object):
185 """ Vnffg Records class"""
188 def __init__(self
, dts
, log
, loop
, vnffgmgr
, nsr
, nsr_name
, vnffgd_msg
, sdn_account_name
):
193 self
._vnffgmgr
= vnffgmgr
195 self
._nsr
_name
= nsr_name
196 self
._vnffgd
_msg
= vnffgd_msg
197 if sdn_account_name
is None:
198 self
._sdn
_account
_name
= ''
200 self
._sdn
_account
_name
= sdn_account_name
202 self
._vnffgr
_id
= str(uuid
.uuid4())
203 self
._vnffgr
_rsp
_id
= list()
204 self
._vnffgr
_state
= VnffgRecordState
.INIT
209 return self
._vnffgr
_id
213 """ state of this VNF """
214 return self
._vnffgr
_state
216 def fetch_vnffgr(self
):
218 Get VNFFGR message to be published
221 if self
._vnffgr
_state
== VnffgRecordState
.INIT
:
222 vnffgr_dict
= {"id": self
._vnffgr
_id
,
223 "nsd_id": self
._nsr
.nsd_id
,
224 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
225 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
226 "sdn_account": self
._sdn
_account
_name
,
227 "operational_status": 'init',
229 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
230 elif self
._vnffgr
_state
== VnffgRecordState
.TERMINATED
:
231 vnffgr_dict
= {"id": self
._vnffgr
_id
,
232 "nsd_id": self
._nsr
.nsd_id
,
233 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
234 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
235 "sdn_account": self
._sdn
_account
_name
,
236 "operational_status": 'terminated',
238 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
241 vnffgr
= self
._vnffgmgr
.fetch_vnffgr(self
._vnffgr
_id
)
243 self
._log
.exception("Fetching VNFFGR for VNFFG with id %s failed", self
._vnffgr
_id
)
244 self
._vnffgr
_state
= VnffgRecordState
.FAILED
245 vnffgr_dict
= {"id": self
._vnffgr
_id
,
246 "nsd_id": self
._nsr
.nsd_id
,
247 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
248 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
249 "sdn_account": self
._sdn
_account
_name
,
250 "operational_status": 'failed',
252 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
257 def vnffgr_create_msg(self
):
258 """ Virtual Link Record message for Creating VLR in VNS """
259 vnffgr_dict
= {"id": self
._vnffgr
_id
,
260 "nsd_id": self
._nsr
.nsd_id
,
261 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
262 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
263 "sdn_account": self
._sdn
_account
_name
,
265 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
266 for rsp
in self
._vnffgd
_msg
.rsp
:
267 vnffgr_rsp
= vnffgr
.rsp
.add()
268 vnffgr_rsp
.id = str(uuid
.uuid4())
269 vnffgr_rsp
.name
= self
._nsr
.name
+ '.' + rsp
.name
270 self
._vnffgr
_rsp
_id
.append(vnffgr_rsp
.id)
271 vnffgr_rsp
.vnffgd_rsp_id_ref
= rsp
.id
272 vnffgr_rsp
.vnffgd_rsp_name_ref
= rsp
.name
273 for rsp_cp_ref
in rsp
.vnfd_connection_point_ref
:
274 vnfd
= [vnfr
.vnfd
for vnfr
in self
._nsr
.vnfrs
.values() if vnfr
.vnfd
.id == rsp_cp_ref
.vnfd_id_ref
]
275 self
._log
.debug("VNFD message during VNFFG instantiation is %s",vnfd
)
276 if len(vnfd
) > 0 and vnfd
[0].has_field('service_function_type'):
277 self
._log
.debug("Service Function Type for VNFD ID %s is %s",rsp_cp_ref
.vnfd_id_ref
, vnfd
[0].service_function_type
)
279 self
._log
.error("Service Function Type not available for VNFD ID %s; Skipping in chain",rsp_cp_ref
.vnfd_id_ref
)
282 vnfr_cp_ref
= vnffgr_rsp
.vnfr_connection_point_ref
.add()
283 vnfr_cp_ref
.member_vnf_index_ref
= rsp_cp_ref
.member_vnf_index_ref
284 vnfr_cp_ref
.hop_number
= rsp_cp_ref
.order
285 vnfr_cp_ref
.vnfd_id_ref
=rsp_cp_ref
.vnfd_id_ref
286 vnfr_cp_ref
.service_function_type
= vnfd
[0].service_function_type
287 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
288 if (nsr_vnfr
.vnfd
.id == vnfr_cp_ref
.vnfd_id_ref
and
289 nsr_vnfr
.member_vnf_index
== vnfr_cp_ref
.member_vnf_index_ref
):
290 vnfr_cp_ref
.vnfr_id_ref
= nsr_vnfr
.id
291 vnfr_cp_ref
.vnfr_name_ref
= nsr_vnfr
.name
292 vnfr_cp_ref
.vnfr_connection_point_ref
= rsp_cp_ref
.vnfd_connection_point_ref
294 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
295 self
._log
.debug(" Received VNFR is %s", vnfr
)
296 while vnfr
.operational_status
!= 'running':
297 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
298 if vnfr
.operational_status
== 'failed':
299 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
300 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
301 yield from asyncio
.sleep(2, loop
=self
._loop
)
302 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
303 self
._log
.debug("Received VNFR is %s", vnfr
)
305 vnfr_cp_ref
.connection_point_params
.mgmt_address
= vnfr
.mgmt_interface
.ip_address
306 for cp
in vnfr
.connection_point
:
307 if cp
.name
== vnfr_cp_ref
.vnfr_connection_point_ref
:
308 vnfr_cp_ref
.connection_point_params
.port_id
= cp
.connection_point_id
309 vnfr_cp_ref
.connection_point_params
.name
= self
._nsr
.name
+ '.' + cp
.name
310 for vdu
in vnfr
.vdur
:
311 for ext_intf
in vdu
.external_interface
:
312 if ext_intf
.name
== vnfr_cp_ref
.vnfr_connection_point_ref
:
313 vnfr_cp_ref
.connection_point_params
.vm_id
= vdu
.vim_id
314 self
._log
.debug("VIM ID for CP %s in VNFR %s is %s",cp
.name
,nsr_vnfr
.id,
315 vnfr_cp_ref
.connection_point_params
.vm_id
)
318 vnfr_cp_ref
.connection_point_params
.address
= cp
.ip_address
319 vnfr_cp_ref
.connection_point_params
.port
= VnffgRecord
.SFF_DP_PORT
321 for vnffgd_classifier
in self
._vnffgd
_msg
.classifier
:
322 _rsp
= [rsp
for rsp
in vnffgr
.rsp
if rsp
.vnffgd_rsp_id_ref
== vnffgd_classifier
.rsp_id_ref
]
324 rsp_id_ref
= _rsp
[0].id
325 rsp_name
= _rsp
[0].name
327 self
._log
.error("RSP with ID %s not found during classifier creation for classifier id %s",vnffgd_classifier
.rsp_id_ref
,vnffgd_classifier
.id)
329 vnffgr_classifier
= vnffgr
.classifier
.add()
330 vnffgr_classifier
.id = vnffgd_classifier
.id
331 vnffgr_classifier
.name
= self
._nsr
.name
+ '.' + vnffgd_classifier
.name
332 _rsp
[0].classifier_name
= vnffgr_classifier
.name
333 vnffgr_classifier
.rsp_id_ref
= rsp_id_ref
334 vnffgr_classifier
.rsp_name
= rsp_name
335 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
336 if (nsr_vnfr
.vnfd
.id == vnffgd_classifier
.vnfd_id_ref
and
337 nsr_vnfr
.member_vnf_index
== vnffgd_classifier
.member_vnf_index_ref
):
338 vnffgr_classifier
.vnfr_id_ref
= nsr_vnfr
.id
339 vnffgr_classifier
.vnfr_name_ref
= nsr_vnfr
.name
340 vnffgr_classifier
.vnfr_connection_point_ref
= vnffgd_classifier
.vnfd_connection_point_ref
342 if nsr_vnfr
.vnfd
.service_function_chain
== 'CLASSIFIER':
343 vnffgr_classifier
.sff_name
= nsr_vnfr
.name
345 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
346 self
._log
.debug(" Received VNFR is %s", vnfr
)
347 while vnfr
.operational_status
!= 'running':
348 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
349 if vnfr
.operational_status
== 'failed':
350 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
351 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
352 yield from asyncio
.sleep(2, loop
=self
._loop
)
353 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
354 self
._log
.debug("Received VNFR is %s", vnfr
)
356 for cp
in vnfr
.connection_point
:
357 if cp
.name
== vnffgr_classifier
.vnfr_connection_point_ref
:
358 vnffgr_classifier
.port_id
= cp
.connection_point_id
359 vnffgr_classifier
.ip_address
= cp
.ip_address
360 for vdu
in vnfr
.vdur
:
361 for ext_intf
in vdu
.external_interface
:
362 if ext_intf
.name
== vnffgr_classifier
.vnfr_connection_point_ref
:
363 vnffgr_classifier
.vm_id
= vdu
.vim_id
364 self
._log
.debug("VIM ID for CP %s in VNFR %s is %s",cp
.name
,nsr_vnfr
.id,
365 vnfr_cp_ref
.connection_point_params
.vm_id
)
368 self
._log
.info("VNFFGR msg to be sent is %s", vnffgr
)
372 def vnffgr_nsr_sff_list(self
):
373 """ SFF List for VNFR """
375 sf_list
= [nsr_vnfr
.name
for nsr_vnfr
in self
._nsr
.vnfrs
.values() if nsr_vnfr
.vnfd
.service_function_chain
== 'SF']
377 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
378 if (nsr_vnfr
.vnfd
.service_function_chain
== 'CLASSIFIER' or nsr_vnfr
.vnfd
.service_function_chain
== 'SFF'):
379 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
380 self
._log
.debug(" Received VNFR is %s", vnfr
)
381 while vnfr
.operational_status
!= 'running':
382 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
383 if vnfr
.operational_status
== 'failed':
384 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
385 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
386 yield from asyncio
.sleep(2, loop
=self
._loop
)
387 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
388 self
._log
.debug("Received VNFR is %s", vnfr
)
390 sff
= RwsdnYang
.VNFFGSff()
391 sff_list
[nsr_vnfr
.vnfd
.id] = sff
392 sff
.name
= nsr_vnfr
.name
393 sff
.function_type
= nsr_vnfr
.vnfd
.service_function_chain
395 sff
.mgmt_address
= vnfr
.mgmt_interface
.ip_address
396 sff
.mgmt_port
= VnffgRecord
.SFF_MGMT_PORT
397 for cp
in vnfr
.connection_point
:
398 sff_dp
= sff
.dp_endpoints
.add()
399 sff_dp
.name
= self
._nsr
.name
+ '.' + cp
.name
400 sff_dp
.address
= cp
.ip_address
401 sff_dp
.port
= VnffgRecord
.SFF_DP_PORT
402 if nsr_vnfr
.vnfd
.service_function_chain
== 'SFF':
403 for sf_name
in sf_list
:
404 _sf
= sff
.vnfr_list
.add()
405 _sf
.vnfr_name
= sf_name
410 def instantiate(self
):
411 """ Instantiate this VNFFG """
413 self
._log
.info("Instaniating VNFFGR with vnffgd %s",
417 vnffgr_request
= yield from self
.vnffgr_create_msg()
418 vnffg_sff_list
= yield from self
.vnffgr_nsr_sff_list()
421 vnffgr
= self
._vnffgmgr
.create_vnffgr(vnffgr_request
,self
._vnffgd
_msg
.classifier
,vnffg_sff_list
)
422 except Exception as e
:
423 self
._log
.exception("VNFFG instantiation failed: %s", str(e
))
424 self
._vnffgr
_state
= VnffgRecordState
.FAILED
425 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFFGR %s failure" % (self
.id, vnffgr_request
.id))
427 self
._vnffgr
_state
= VnffgRecordState
.INSTANTIATION_PENDING
429 self
._log
.info("Instantiated VNFFGR :%s", vnffgr
)
430 self
._vnffgr
_state
= VnffgRecordState
.ACTIVE
432 self
._log
.info("Invoking update_state to update NSR state for NSR ID: %s", self
._nsr
.id)
433 yield from self
._nsr
.update_state()
435 def vnffgr_in_vnffgrm(self
):
436 """ Is there a VNFR record in VNFM """
437 if (self
._vnffgr
_state
== VnffgRecordState
.ACTIVE
or
438 self
._vnffgr
_state
== VnffgRecordState
.INSTANTIATION_PENDING
or
439 self
._vnffgr
_state
== VnffgRecordState
.FAILED
):
446 """ Terminate this VNFFGR """
447 if not self
.vnffgr_in_vnffgrm():
448 self
._log
.error("Ignoring terminate request for id %s in state %s",
449 self
.id, self
._vnffgr
_state
)
452 self
._log
.info("Terminating VNFFGR id:%s", self
.id)
453 self
._vnffgr
_state
= VnffgRecordState
.TERMINATE_PENDING
455 self
._vnffgmgr
.terminate_vnffgr(self
._vnffgr
_id
)
457 self
._vnffgr
_state
= VnffgRecordState
.TERMINATED
458 self
._log
.debug("Terminated VNFFGR id:%s", self
.id)
461 class VirtualLinkRecord(object):
462 """ Virtual Link Records class"""
465 def create_record(dts
, log
, loop
, nsr_name
, vld_msg
, cloud_account_name
, om_datacenter
, ip_profile
, nsr_id
, restart_mode
=False):
466 """Creates a new VLR object based on the given data.
468 If restart mode is enabled, then we look for existing records in the
469 DTS and create a VLR records using the exiting data(ID)
474 vlr_obj
= VirtualLinkRecord(
487 res_iter
= yield from dts
.query_read(
488 "D,/vlr:vlr-catalog/vlr:vlr",
489 rwdts
.XactFlag
.MERGE
)
492 response
= yield from fut
493 vlr
= response
.result
495 # Check if the record is already present, if so use the ID of
496 # the existing record. Since the name of the record is uniquely
497 # formed we can use it as a search key!
498 if vlr
.name
== vlr_obj
.name
:
499 vlr_obj
.reset_id(vlr
.id)
504 def __init__(self
, dts
, log
, loop
, nsr_name
, vld_msg
, cloud_account_name
, om_datacenter
, ip_profile
, nsr_id
):
508 self
._nsr
_name
= nsr_name
509 self
._vld
_msg
= vld_msg
510 self
._cloud
_account
_name
= cloud_account_name
511 self
._om
_datacenter
_name
= om_datacenter
512 self
._assigned
_subnet
= None
513 self
._nsr
_id
= nsr_id
514 self
._ip
_profile
= ip_profile
515 self
._vlr
_id
= str(uuid
.uuid4())
516 self
._state
= VlRecordState
.INIT
517 self
._prev
_state
= None
521 """ path for this object """
522 return "D,/vlr:vlr-catalog/vlr:vlr[vlr:id = '{}']".format(self
._vlr
_id
)
531 """ Get NSR name for this VL """
536 """ Virtual Link Desciptor """
540 def assigned_subnet(self
):
541 """ Subnet assigned to this VL"""
542 return self
._assigned
_subnet
547 Get the name for this VLR.
548 VLR name is "nsr name:VLD name"
550 if self
.vld_msg
.vim_network_name
:
551 return self
.vld_msg
.vim_network_name
552 elif self
.vld_msg
.name
== "multisite":
553 # This is a temporary hack to identify manually provisioned inter-site network
554 return self
.vld_msg
.name
556 return self
._nsr
_name
+ "." + self
.vld_msg
.name
559 def cloud_account_name(self
):
560 """ Cloud account that this VLR should be created in """
561 return self
._cloud
_account
_name
564 def om_datacenter_name(self
):
565 """ Datacenter that this VLR should be created in """
566 return self
._om
_datacenter
_name
570 """ Get the VLR path from VLR """
571 return (VirtualLinkRecord
.XPATH
+ "[vlr:id = '{}']").format(vlr
.id)
579 def state(self
, value
):
580 """ VLR set state """
584 def prev_state(self
):
585 """ VLR previous state """
586 return self
._prev
_state
589 def prev_state(self
, value
):
590 """ VLR set previous state """
591 self
._prev
_state
= value
595 """ Virtual Link Record message for Creating VLR in VNS """
596 vld_fields
= ["short_name",
604 vld_copy_dict
= {k
: v
for k
, v
in self
.vld_msg
.as_dict().items()
607 vlr_dict
= {"id": self
._vlr
_id
,
608 "nsr_id_ref": self
._nsr
_id
,
609 "vld_ref": self
.vld_msg
.id,
611 "cloud_account": self
.cloud_account_name
,
612 "om_datacenter": self
.om_datacenter_name
,
615 if self
._ip
_profile
and self
._ip
_profile
.has_field('ip_profile_params'):
616 vlr_dict
['ip_profile_params' ] = self
._ip
_profile
.ip_profile_params
.as_dict()
618 vlr_dict
.update(vld_copy_dict
)
619 vlr
= RwVlrYang
.YangData_Vlr_VlrCatalog_Vlr
.from_dict(vlr_dict
)
622 def reset_id(self
, vlr_id
):
623 self
._vlr
_id
= vlr_id
625 def create_nsr_vlr_msg(self
, vnfrs
):
626 """ The VLR message"""
627 nsr_vlr
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vlr()
628 nsr_vlr
.vlr_ref
= self
._vlr
_id
629 nsr_vlr
.assigned_subnet
= self
.assigned_subnet
630 nsr_vlr
.cloud_account
= self
.cloud_account_name
631 nsr_vlr
.om_datacenter
= self
.om_datacenter_name
633 for conn
in self
.vld_msg
.vnfd_connection_point_ref
:
635 if (vnfr
.vnfd
.id == conn
.vnfd_id_ref
and
636 vnfr
.member_vnf_index
== conn
.member_vnf_index_ref
and
637 self
.cloud_account_name
== vnfr
.cloud_account_name
and
638 self
.om_datacenter_name
== vnfr
.om_datacenter_name
):
639 cp_entry
= nsr_vlr
.vnfr_connection_point_ref
.add()
640 cp_entry
.vnfr_id
= vnfr
.id
641 cp_entry
.connection_point
= conn
.vnfd_connection_point_ref
646 def instantiate(self
):
647 """ Instantiate this VL """
649 self
._log
.debug("Instaniating VLR key %s, vld %s",
650 self
.xpath
, self
._vld
_msg
)
652 self
._state
= VlRecordState
.INSTANTIATION_PENDING
653 self
._log
.debug("Executing VL create path:%s msg:%s",
654 self
.xpath
, self
.vlr_msg
)
656 with self
._dts
.transaction(flags
=0) as xact
:
657 block
= xact
.block_create()
658 block
.add_query_create(self
.xpath
, self
.vlr_msg
)
659 self
._log
.debug("Executing VL create path:%s msg:%s",
660 self
.xpath
, self
.vlr_msg
)
661 res_iter
= yield from block
.execute(now
=True)
667 self
._state
= VlRecordState
.FAILED
668 raise NsrInstantiationFailed("Failed NS %s instantiation due to empty response" % self
.id)
670 if vlr
.operational_status
== 'failed':
671 self
._log
.debug("NS Id:%s VL creation failed for vlr id %s", self
.id, vlr
.id)
672 self
._state
= VlRecordState
.FAILED
673 raise NsrInstantiationFailed("Failed VL %s instantiation (%s)" % (vlr
.id, vlr
.operational_status_details
))
675 self
._log
.info("Instantiated VL with xpath %s and vlr:%s",
677 self
._state
= VlRecordState
.ACTIVE
678 self
._assigned
_subnet
= vlr
.assigned_subnet
680 def vlr_in_vns(self
):
681 """ Is there a VLR record in VNS """
682 if (self
._state
== VlRecordState
.ACTIVE
or
683 self
._state
== VlRecordState
.INSTANTIATION_PENDING
or
684 self
._state
== VlRecordState
.TERMINATE_PENDING
or
685 self
._state
== VlRecordState
.FAILED
):
692 """ Terminate this VL """
693 if not self
.vlr_in_vns():
694 self
._log
.debug("Ignoring terminate request for id %s in state %s",
695 self
.id, self
._state
)
698 self
._log
.debug("Terminating VL id:%s", self
.id)
699 self
._state
= VlRecordState
.TERMINATE_PENDING
701 with self
._dts
.transaction(flags
=0) as xact
:
702 block
= xact
.block_create()
703 block
.add_query_delete(self
.xpath
)
704 yield from block
.execute(flags
=0, now
=True)
706 self
._state
= VlRecordState
.TERMINATED
707 self
._log
.debug("Terminated VL id:%s", self
.id)
710 class VnfRecordState(Enum
):
711 """ Vnf Record State """
713 INSTANTIATION_PENDING
= 102
715 TERMINATE_PENDING
= 104
720 class VirtualNetworkFunctionRecord(object):
721 """ Virtual Network Function Record class"""
722 XPATH
= "D,/vnfr:vnfr-catalog/vnfr:vnfr"
726 def create_record(dts
, log
, loop
, vnfd
, const_vnfd_msg
, nsd_id
, nsr_name
,
727 cloud_account_name
, om_datacenter_name
, nsr_id
, group_name
, group_instance_id
,
728 placement_groups
, restart_mode
=False):
729 """Creates a new VNFR object based on the given data.
731 If restart mode is enabled, then we look for existing records in the
732 DTS and create a VNFR records using the exiting data(ID)
735 VirtualNetworkFunctionRecord
737 vnfr_obj
= VirtualNetworkFunctionRecord(
751 restart_mode
=restart_mode
)
754 res_iter
= yield from dts
.query_read(
755 "D,/vnfr:vnfr-catalog/vnfr:vnfr",
756 rwdts
.XactFlag
.MERGE
)
759 response
= yield from fut
760 vnfr
= response
.result
762 if vnfr
.name
== vnfr_obj
.name
:
763 vnfr_obj
.reset_id(vnfr
.id)
780 group_instance_id
=None,
781 placement_groups
= [],
782 restart_mode
= False):
787 self
._const
_vnfd
_msg
= const_vnfd_msg
788 self
._nsd
_id
= nsd_id
789 self
._nsr
_name
= nsr_name
790 self
._nsr
_id
= nsr_id
791 self
._cloud
_account
_name
= cloud_account_name
792 self
._om
_datacenter
_name
= om_datacenter_name
793 self
._group
_name
= group_name
794 self
._group
_instance
_id
= group_instance_id
795 self
._placement
_groups
= placement_groups
796 self
._config
_status
= NsrYang
.ConfigStates
.INIT
798 self
._prev
_state
= VnfRecordState
.INIT
799 self
._state
= VnfRecordState
.INIT
800 self
._state
_failed
_reason
= None
802 self
.config_store
= rift
.mano
.config_data
.config
.ConfigStore(self
._log
)
805 self
._vnfr
_id
= str(uuid
.uuid4())
807 self
._vnfr
_msg
= self
.create_vnfr_msg()
808 self
._log
.debug("Set VNFR {} config type to {}".
809 format(self
.name
, self
.config_type
))
810 self
.restart_mode
= restart_mode
813 if group_name
is None and group_instance_id
is not None:
814 raise ValueError("Group instance id must not be provided with an empty group name")
824 return "D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id = '{}']".format(self
.id)
829 return self
._vnfr
_msg
832 def const_vnfr_msg(self
):
834 return RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_ConstituentVnfrRef(vnfr_id
=self
.id,cloud_account
=self
.cloud_account_name
,om_datacenter
=self
._om
_datacenter
_name
)
842 def cloud_account_name(self
):
843 """ Cloud account that this VNF should be created in """
844 return self
._cloud
_account
_name
847 def om_datacenter_name(self
):
848 """ Datacenter that this VNF should be created in """
849 return self
._om
_datacenter
_name
854 """ Is this VNF actve """
855 return True if self
._state
== VnfRecordState
.ACTIVE
else False
859 """ state of this VNF """
863 def state_failed_reason(self
):
864 """ Error message in case this VNF is in failed state """
865 return self
._state
_failed
_reason
868 def member_vnf_index(self
):
869 """ Member VNF index """
870 return self
._const
_vnfd
_msg
.member_vnf_index
875 return self
._nsr
_name
879 """ Name of this VNFR """
880 if self
._name
is not None:
883 name_tags
= [self
._nsr
_name
]
885 if self
._group
_name
is not None:
886 name_tags
.append(self
._group
_name
)
888 if self
._group
_instance
_id
is not None:
889 name_tags
.append(str(self
._group
_instance
_id
))
891 name_tags
.extend([self
.vnfd
.name
, str(self
.member_vnf_index
)])
893 self
._name
= "__".join(name_tags
)
898 def vnfr_xpath(vnfr
):
899 """ Get the VNFR path from VNFR """
900 return (VirtualNetworkFunctionRecord
.XPATH
+ "[vnfr:id = '{}']").format(vnfr
.id)
903 def config_type(self
):
904 cfg_types
= ['netconf', 'juju', 'script']
905 for method
in cfg_types
:
906 if self
._vnfd
.vnf_configuration
.has_field(method
):
911 def config_status(self
):
912 """Return the config status as YANG ENUM string"""
913 self
._log
.debug("Map VNFR {} config status {} ({})".
914 format(self
.name
, self
._config
_status
, self
.config_type
))
915 if self
.config_type
== 'none':
916 return 'config_not_needed'
917 elif self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURED
:
919 elif self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
924 def set_state(self
, state
):
925 """ set the state of this object """
926 self
._prev
_state
= self
._state
929 def reset_id(self
, vnfr_id
):
930 self
._vnfr
_id
= vnfr_id
931 self
._vnfr
_msg
= self
.create_vnfr_msg()
934 self
.config_store
.merge_vnfd_config(
937 self
.member_vnf_index
,
940 def create_vnfr_msg(self
):
941 """ VNFR message for this VNFR """
949 vnfd_copy_dict
= {k
: v
for k
, v
in self
._vnfd
.as_dict().items() if k
in vnfd_fields
}
952 "nsr_id_ref": self
._nsr
_id
,
953 "vnfd_ref": self
.vnfd
.id,
955 "cloud_account": self
._cloud
_account
_name
,
956 "om_datacenter": self
._om
_datacenter
_name
,
957 "config_status": self
.config_status
959 vnfr_dict
.update(vnfd_copy_dict
)
961 vnfr
= RwVnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr
.from_dict(vnfr_dict
)
962 vnfr
.member_vnf_index_ref
= self
.member_vnf_index
963 vnfr
.vnf_configuration
.from_dict(self
._vnfd
.vnf_configuration
.as_dict())
965 if self
._vnfd
.mgmt_interface
.has_field("port"):
966 vnfr
.mgmt_interface
.port
= self
._vnfd
.mgmt_interface
.port
968 for group_info
in self
._placement
_groups
:
969 group
= vnfr
.placement_groups_info
.add()
970 group
.from_dict(group_info
.as_dict())
972 # UI expects the monitoring param field to exist
973 vnfr
.monitoring_param
= []
975 self
._log
.debug("Get vnfr_msg for VNFR {} : {}".format(self
.name
, vnfr
))
979 def update_vnfm(self
):
980 self
._log
.debug("Send an update to VNFM for VNFR {} with {}".
981 format(self
.name
, self
.vnfr_msg
))
982 yield from self
._dts
.query_update(
984 rwdts
.XactFlag
.TRACE
,
988 def get_config_status(self
):
989 """Return the config status as YANG ENUM"""
990 return self
._config
_status
993 def set_config_status(self
, status
):
995 def status_to_string(status
):
997 NsrYang
.ConfigStates
.INIT
: 'init',
998 NsrYang
.ConfigStates
.CONFIGURING
: 'configuring',
999 NsrYang
.ConfigStates
.CONFIG_NOT_NEEDED
: 'config_not_needed',
1000 NsrYang
.ConfigStates
.CONFIGURED
: 'configured',
1001 NsrYang
.ConfigStates
.FAILED
: 'failed',
1004 return status_dc
[status
]
1006 self
._log
.debug("Update VNFR {} from {} ({}) to {}".
1007 format(self
.name
, self
._config
_status
,
1008 self
.config_type
, status
))
1009 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURED
:
1010 self
._log
.error("Updating already configured VNFR {}".
1014 if self
._config
_status
!= status
:
1016 self
._config
_status
= status
1017 # I don't think this is used. Original implementor can check.
1018 # Caused Exception, so corrected it by status_to_string
1019 # But not sure whats the use of this variable?
1020 self
.vnfr_msg
.config_status
= status_to_string(status
)
1021 except Exception as e
:
1022 self
._log
.error("Exception=%s", str(e
))
1025 self
._log
.debug("Updated VNFR {} status to {}".format(self
.name
, status
))
1027 if self
._config
_status
!= NsrYang
.ConfigStates
.INIT
:
1029 # Publish only after VNFM has the VNFR created
1030 yield from self
.update_vnfm()
1031 except Exception as e
:
1032 self
._log
.error("Exception updating VNFM with new status {} of VNFR {}: {}".
1033 format(status
, self
.name
, e
))
1034 self
._log
.exception(e
)
1036 def is_configured(self
):
1037 if self
.config_type
== 'none':
1040 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURED
:
1046 def instantiate(self
, nsr
):
1047 """ Instantiate this VNFR"""
1049 self
._log
.debug("Instaniating VNFR key %s, vnfd %s",
1050 self
.xpath
, self
._vnfd
)
1052 self
._log
.debug("Create VNF with xpath %s and vnfr %s",
1053 self
.xpath
, self
.vnfr_msg
)
1055 self
.set_state(VnfRecordState
.INSTANTIATION_PENDING
)
1057 def find_vlr_for_cp(conn
):
1058 """ Find VLR for the given connection point """
1059 for vlr
in nsr
.vlrs
:
1060 for vnfd_cp
in vlr
.vld_msg
.vnfd_connection_point_ref
:
1061 if (vnfd_cp
.vnfd_id_ref
== self
._vnfd
.id and
1062 vnfd_cp
.vnfd_connection_point_ref
== conn
.name
and
1063 vnfd_cp
.member_vnf_index_ref
== self
.member_vnf_index
and
1064 vlr
.cloud_account_name
== self
.cloud_account_name
):
1065 self
._log
.debug("Found VLR for cp_name:%s and vnf-index:%d",
1066 conn
.name
, self
.member_vnf_index
)
1070 # For every connection point in the VNFD fill in the identifier
1071 for conn_p
in self
._vnfd
.connection_point
:
1072 cpr
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr_ConnectionPoint()
1073 cpr
.name
= conn_p
.name
1074 cpr
.type_yang
= conn_p
.type_yang
1075 vlr_ref
= find_vlr_for_cp(conn_p
)
1077 msg
= "Failed to find VLR for cp = %s" % conn_p
.name
1078 self
._log
.debug("%s", msg
)
1079 # raise VirtualNetworkFunctionRecordError(msg)
1082 cpr
.vlr_ref
= vlr_ref
.id
1083 self
.vnfr_msg
.connection_point
.append(cpr
)
1084 self
._log
.debug("Connection point [%s] added, vnf id=%s vnfd id=%s",
1085 cpr
, self
.vnfr_msg
.id, self
.vnfr_msg
.vnfd_ref
)
1087 if not self
.restart_mode
:
1088 yield from self
._dts
.query_create(self
.xpath
,
1092 yield from self
._dts
.query_update(self
.xpath
,
1096 self
._log
.info("Created VNF with xpath %s and vnfr %s",
1097 self
.xpath
, self
.vnfr_msg
)
1099 self
._log
.info("Instantiated VNFR with xpath %s and vnfd %s, vnfr %s",
1100 self
.xpath
, self
._vnfd
, self
.vnfr_msg
)
1103 def update_state(self
, vnfr_msg
):
1104 """ Update this VNFR"""
1105 if vnfr_msg
.operational_status
== "running":
1106 if self
.vnfr_msg
.operational_status
!= "running":
1107 yield from self
.is_active()
1108 elif vnfr_msg
.operational_status
== "failed":
1109 yield from self
.instantiation_failed(failed_reason
=vnfr_msg
.operational_status_details
)
1112 def is_active(self
):
1113 """ This VNFR is active """
1114 self
._log
.debug("VNFR %s is active", self
._vnfr
_id
)
1115 self
.set_state(VnfRecordState
.ACTIVE
)
1118 def instantiation_failed(self
, failed_reason
=None):
1119 """ This VNFR instantiation failed"""
1120 self
._log
.error("VNFR %s instantiation failed", self
._vnfr
_id
)
1121 self
.set_state(VnfRecordState
.FAILED
)
1122 self
._state
_failed
_reason
= failed_reason
1124 def vnfr_in_vnfm(self
):
1125 """ Is there a VNFR record in VNFM """
1126 if (self
._state
== VnfRecordState
.ACTIVE
or
1127 self
._state
== VnfRecordState
.INSTANTIATION_PENDING
or
1128 self
._state
== VnfRecordState
.FAILED
):
1134 def terminate(self
):
1135 """ Terminate this VNF """
1136 if not self
.vnfr_in_vnfm():
1137 self
._log
.debug("Ignoring terminate request for id %s in state %s",
1138 self
.id, self
._state
)
1141 self
._log
.debug("Terminating VNF id:%s", self
.id)
1142 self
.set_state(VnfRecordState
.TERMINATE_PENDING
)
1143 with self
._dts
.transaction(flags
=0) as xact
:
1144 block
= xact
.block_create()
1145 block
.add_query_delete(self
.xpath
)
1146 yield from block
.execute(flags
=0)
1147 self
.set_state(VnfRecordState
.TERMINATED
)
1148 self
._log
.debug("Terminated VNF id:%s", self
.id)
1151 class NetworkServiceStatus(object):
1152 """ A class representing the Network service's status """
1153 MAX_EVENTS_RECORDED
= 10
1154 """ Network service Status class"""
1155 def __init__(self
, dts
, log
, loop
):
1160 self
._state
= NetworkServiceRecordState
.INIT
1161 self
._events
= deque([])
1164 def create_notification(self
, evt
, evt_desc
, evt_details
):
1165 xp
= "N,/rw-nsr:nsm-notification"
1166 notif
= RwNsrYang
.YangNotif_RwNsr_NsmNotification()
1168 notif
.description
= evt_desc
1169 notif
.details
= evt_details
if evt_details
is not None else None
1171 yield from self
._dts
.query_create(xp
, rwdts
.XactFlag
.ADVISE
, notif
)
1172 self
._log
.info("Notification called by creating dts query: %s", notif
)
1174 def record_event(self
, evt
, evt_desc
, evt_details
):
1175 """ Record an event """
1176 self
._log
.debug("Recording event - evt %s, evt_descr %s len = %s",
1177 evt
, evt_desc
, len(self
._events
))
1178 if len(self
._events
) >= NetworkServiceStatus
.MAX_EVENTS_RECORDED
:
1179 self
._events
.popleft()
1180 self
._events
.append((int(time
.time()), evt
, evt_desc
,
1181 evt_details
if evt_details
is not None else None))
1183 self
._loop
.create_task(self
.create_notification(evt
,evt_desc
,evt_details
))
1185 def set_state(self
, state
):
1186 """ set the state of this status object """
1190 """ Return the state as a yang enum string """
1191 state_to_str_map
= {"INIT": "init",
1192 "VL_INIT_PHASE": "vl_init_phase",
1193 "VNF_INIT_PHASE": "vnf_init_phase",
1194 "VNFFG_INIT_PHASE": "vnffg_init_phase",
1195 "SCALING_GROUP_INIT_PHASE": "scaling_group_init_phase",
1196 "RUNNING": "running",
1197 "SCALING_OUT": "scaling_out",
1198 "SCALING_IN": "scaling_in",
1199 "TERMINATE_RCVD": "terminate_rcvd",
1200 "TERMINATE": "terminate",
1201 "VL_TERMINATE_PHASE": "vl_terminate_phase",
1202 "VNF_TERMINATE_PHASE": "vnf_terminate_phase",
1203 "VNFFG_TERMINATE_PHASE": "vnffg_terminate_phase",
1204 "TERMINATED": "terminated",
1206 "VL_INSTANTIATE": "vl_instantiate",
1207 "VL_TERMINATE": "vl_terminate",
1209 return state_to_str_map
[self
._state
.name
]
1213 """ State of this status object """
1218 """ Network Service Record as a message"""
1221 for entry
in self
._events
:
1222 event
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_OperationalEvents()
1225 event
.timestamp
, event
.event
, event
.description
, event
.details
= entry
1226 event_list
.append(event
)
1230 class NetworkServiceRecord(object):
1231 """ Network service record """
1232 XPATH
= "D,/nsr:ns-instance-opdata/nsr:nsr"
1234 def __init__(self
, dts
, log
, loop
, nsm
, nsm_plugin
, nsr_cfg_msg
, sdn_account_name
, restart_mode
=False):
1239 self
._nsr
_cfg
_msg
= nsr_cfg_msg
1240 self
._nsm
_plugin
= nsm_plugin
1241 self
._sdn
_account
_name
= sdn_account_name
1244 self
._nsr
_msg
= None
1245 self
._nsr
_regh
= None
1250 self
._param
_pools
= {}
1251 self
._scaling
_groups
= {}
1252 self
._create
_time
= int(time
.time())
1253 self
._op
_status
= NetworkServiceStatus(dts
, log
, loop
)
1254 self
._config
_status
= NsrYang
.ConfigStates
.CONFIGURING
1255 self
._config
_status
_details
= None
1257 self
.restart_mode
= restart_mode
1258 self
.config_store
= rift
.mano
.config_data
.config
.ConfigStore(self
._log
)
1259 self
._debug
_running
= False
1260 self
._is
_active
= False
1261 self
._vl
_phase
_completed
= False
1262 self
._vnf
_phase
_completed
= False
1265 # Initalise the state to init
1266 # The NSR moves through the following transitions
1267 # 1. INIT -> VLS_READY once all the VLs in the NSD are created
1268 # 2. VLS_READY - VNFS_READY when all the VNFs in the NSD are created
1269 # 3. VNFS_READY - READY when the NSR is published
1271 self
.set_state(NetworkServiceRecordState
.INIT
)
1273 self
.substitute_input_parameters
= InputParameterSubstitution(self
._log
)
1276 def nsm_plugin(self
):
1278 return self
._nsm
_plugin
1280 def set_state(self
, state
):
1281 """ Set state for this NSR"""
1282 self
._log
.debug("Setting state to %s", state
)
1283 # We are in init phase and is moving to the next state
1284 # The new state could be a FAILED state or VNF_INIIT_PHASE
1285 if self
.state
== NetworkServiceRecordState
.VL_INIT_PHASE
:
1286 self
._vl
_phase
_completed
= True
1288 if self
.state
== NetworkServiceRecordState
.VNF_INIT_PHASE
:
1289 self
._vnf
_phase
_completed
= True
1291 self
._op
_status
.set_state(state
)
1295 """ Get id for this NSR"""
1296 return self
._nsr
_cfg
_msg
.id
1300 """ Name of this network service record """
1301 return self
._nsr
_cfg
_msg
.name
1304 def cloud_account_name(self
):
1305 return self
._nsr
_cfg
_msg
.cloud_account
1308 def om_datacenter_name(self
):
1309 if self
._nsr
_cfg
_msg
.has_field('om_datacenter'):
1310 return self
._nsr
_cfg
_msg
.om_datacenter
1315 """State of this NetworkServiceRecord"""
1316 return self
._op
_status
.state
1320 """ Is this NSR active ?"""
1321 return True if self
._op
_status
.state
== NetworkServiceRecordState
.RUNNING
else False
1325 """ VLRs associated with this NSR"""
1330 """ VNFRs associated with this NSR"""
1335 """ VNFFGRs associated with this NSR"""
1336 return self
._vnffgrs
1339 def scaling_groups(self
):
1340 """ Scaling groups associated with this NSR """
1341 return self
._scaling
_groups
1344 def param_pools(self
):
1345 """ Parameter value pools associated with this NSR"""
1346 return self
._param
_pools
1349 def nsr_cfg_msg(self
):
1350 return self
._nsr
_cfg
_msg
1353 def nsr_cfg_msg(self
, msg
):
1354 self
._nsr
_cfg
_msg
= msg
1358 """ NSD Protobuf for this NSR """
1359 if self
._nsd
is not None:
1361 self
._nsd
= self
._nsr
_cfg
_msg
.nsd
1366 """ NSD ID for this NSR """
1367 return self
.nsd_msg
.id
1371 ''' Get a new job id for config primitive'''
1376 def config_status(self
):
1377 """ Config status for NSR """
1378 return self
._config
_status
1380 def resolve_placement_group_cloud_construct(self
, input_group
):
1382 Returns the cloud specific construct for placement group
1384 copy_dict
= ['name', 'requirement', 'strategy']
1386 for group_info
in self
._nsr
_cfg
_msg
.nsd_placement_group_maps
:
1387 if group_info
.placement_group_ref
== input_group
.name
:
1388 group
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr_PlacementGroupsInfo()
1389 group_dict
= {k
:v
for k
,v
in
1390 group_info
.as_dict().items() if k
!= 'placement_group_ref'}
1391 for param
in copy_dict
:
1392 group_dict
.update({param
: getattr(input_group
, param
)})
1393 group
.from_dict(group_dict
)
1399 return "NSR(name={}, nsd_id={}, cloud_account={})".format(
1400 self
.name
, self
.nsd_id
, self
.cloud_account_name
1403 def _get_vnfd(self
, vnfd_id
, config_xact
):
1404 """ Fetch vnfd msg for the passed vnfd id """
1405 return self
._nsm
.get_vnfd(vnfd_id
, config_xact
)
1407 def _get_vnfd_cloud_account(self
, vnfd_member_index
):
1408 """ Fetch Cloud Account for the passed vnfd id """
1409 if self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1410 vim_accounts
= [(vnf
.cloud_account
,vnf
.om_datacenter
) for vnf
in self
._nsr
_cfg
_msg
.vnf_cloud_account_map \
1411 if vnfd_member_index
== vnf
.member_vnf_index_ref
]
1412 if vim_accounts
and vim_accounts
[0]:
1413 return vim_accounts
[0]
1414 return (self
.cloud_account_name
,self
.om_datacenter_name
)
1416 def _get_constituent_vnfd_msg(self
, vnf_index
):
1417 for const_vnfd
in self
.nsd_msg
.constituent_vnfd
:
1418 if const_vnfd
.member_vnf_index
== vnf_index
:
1421 raise ValueError("Constituent VNF index %s not found" % vnf_index
)
1423 def record_event(self
, evt
, evt_desc
, evt_details
=None, state
=None):
1424 """ Record an event """
1425 self
._op
_status
.record_event(evt
, evt_desc
, evt_details
)
1426 if state
is not None:
1427 self
.set_state(state
)
1429 def scaling_trigger_str(self
, trigger
):
1430 SCALING_TRIGGER_STRS
= {
1431 NsdYang
.ScalingTrigger
.PRE_SCALE_IN
: 'pre-scale-in',
1432 NsdYang
.ScalingTrigger
.POST_SCALE_IN
: 'post-scale-in',
1433 NsdYang
.ScalingTrigger
.PRE_SCALE_OUT
: 'pre-scale-out',
1434 NsdYang
.ScalingTrigger
.POST_SCALE_OUT
: 'post-scale-out',
1437 return SCALING_TRIGGER_STRS
[trigger
]
1438 except Exception as e
:
1439 self
._log
.error("Scaling trigger mapping error for {} : {}".
1441 self
._log
.exception(e
)
1442 return "Unknown trigger"
1445 def instantiate_vls(self
):
1447 This function instantiates VLs for every VL in this Network Service
1449 self
._log
.debug("Instantiating %d VLs in NSD id %s", len(self
._vlrs
),
1451 for vlr
in self
._vlrs
:
1452 yield from self
.nsm_plugin
.instantiate_vl(self
, vlr
)
1453 vlr
.state
= VlRecordState
.ACTIVE
1456 def create(self
, config_xact
):
1457 """ Create this network service"""
1458 # Create virtual links for all the external vnf
1459 # connection points in this NS
1460 yield from self
.create_vls()
1462 # Create VNFs in this network service
1463 yield from self
.create_vnfs(config_xact
)
1465 # Create VNFFG for network service
1466 self
.create_vnffgs()
1468 # Create Scaling Groups for each scaling group in NSD
1469 self
.create_scaling_groups()
1471 # Create Parameter Pools
1472 self
.create_param_pools()
1475 def apply_scale_group_config_script(self
, script
, group
, scale_instance
, trigger
, vnfrs
=None):
1476 """ Apply config based on script for scale group """
1479 def add_vnfrs_data(vnfrs_list
):
1480 """ Add as a dict each of the VNFRs data """
1482 for vnfr
in vnfrs_list
:
1483 self
._log
.debug("Add VNFR {} data".format(vnfr
))
1485 vnfr_data
['name'] = vnfr
.name
1486 if trigger
in [NsdYang
.ScalingTrigger
.PRE_SCALE_IN
, NsdYang
.ScalingTrigger
.POST_SCALE_OUT
]:
1487 # Get VNF management and other IPs, etc
1488 opdata
= yield from self
.fetch_vnfr(vnfr
.xpath
)
1489 self
._log
.debug("VNFR {} op data: {}".format(vnfr
.name
, opdata
))
1491 vnfr_data
['rw_mgmt_ip'] = opdata
.mgmt_interface
.ip_address
1492 vnfr_data
['rw_mgmt_port'] = opdata
.mgmt_interface
.port
1493 except Exception as e
:
1494 self
._log
.error("Unable to get management IP for vnfr {}:{}".
1495 format(vnfr
.name
, e
))
1498 vnfr_data
['connection_points'] = []
1499 for cp
in opdata
.connection_point
:
1501 con_pt
['name'] = cp
.name
1502 con_pt
['ip_address'] = cp
.ip_address
1503 vnfr_data
['connection_points'].append(con_pt
)
1504 except Exception as e
:
1505 self
._log
.error("Exception getting connections points for VNFR {}: {}".
1506 format(vnfr
.name
, e
))
1508 vnfrs_data
.append(vnfr_data
)
1509 self
._log
.debug("VNFRs data: {}".format(vnfrs_data
))
1513 def add_nsr_data(nsr
):
1515 nsr_data
['name'] = nsr
.name
1518 if script
is None or len(script
) == 0:
1519 self
._log
.error("Script not provided for scale group config: {}".format(group
.name
))
1522 if script
[0] == '/':
1525 path
= os
.path
.join(os
.environ
['RIFT_INSTALL'], "usr/bin", script
)
1526 if not os
.path
.exists(path
):
1527 self
._log
.error("Config faled for scale group {}: Script does not exist at {}".
1528 format(group
.name
, path
))
1531 # Build a YAML file with all parameters for the script to execute
1532 # The data consists of 5 sections
1534 # 2. Scale group config
1535 # 3. VNFRs in the scale group
1536 # 4. VNFRs outside scale group
1539 data
['trigger'] = group
.trigger_map(trigger
)
1540 data
['config'] = group
.group_msg
.as_dict()
1543 data
["vnfrs_in_group"] = yield from add_vnfrs_data(vnfrs
)
1545 data
["vnfrs_in_group"] = yield from add_vnfrs_data(scale_instance
.vnfrs
)
1547 data
["vnfrs_others"] = yield from add_vnfrs_data(self
.vnfrs
.values())
1548 data
["nsr"] = add_nsr_data(self
)
1551 with tempfile
.NamedTemporaryFile(delete
=False) as tmp_file
:
1552 tmp_file
.write(yaml
.dump(data
, default_flow_style
=True)
1555 self
._log
.debug("Creating a temp file: {} with input data: {}".
1556 format(tmp_file
.name
, data
))
1558 cmd
= "{} {}".format(path
, tmp_file
.name
)
1559 self
._log
.debug("Running the CMD: {}".format(cmd
))
1560 proc
= yield from asyncio
.create_subprocess_shell(cmd
, loop
=self
._loop
)
1561 rc
= yield from proc
.wait()
1563 self
._log
.error("The script {} for scale group {} config returned: {}".
1564 format(script
, group
.name
, rc
))
1572 def apply_scaling_group_config(self
, trigger
, group
, scale_instance
, vnfrs
=None):
1573 """ Apply the config for the scaling group based on trigger """
1574 if group
is None or scale_instance
is None:
1578 def update_config_status(success
=True, err_msg
=None):
1579 self
._log
.debug("Update %s config status to %r : %s",
1580 scale_instance
, success
, err_msg
)
1581 if (scale_instance
.config_status
== "failed"):
1582 # Do not update the config status if it is already in failed state
1585 if scale_instance
.config_status
== "configured":
1586 # Update only to failed state an already configured scale instance
1588 scale_instance
.config_status
= "failed"
1589 scale_instance
.config_err_msg
= err_msg
1590 yield from self
.update_state()
1592 # We are in configuring state
1593 # Only after post scale out mark instance as configured
1594 if trigger
== NsdYang
.ScalingTrigger
.POST_SCALE_OUT
:
1596 scale_instance
.config_status
= "configured"
1598 scale_instance
.config_status
= "failed"
1599 scale_instance
.config_err_msg
= err_msg
1600 yield from self
.update_state()
1602 config
= group
.trigger_config(trigger
)
1606 self
._log
.debug("Scaling group {} config: {}".format(group
.name
, config
))
1607 if config
.has_field("ns_config_primitive_name_ref"):
1608 config_name
= config
.ns_config_primitive_name_ref
1609 nsd_msg
= self
.nsd_msg
1610 config_primitive
= None
1611 for ns_cfg_prim
in nsd_msg
.service_primitive
:
1612 if ns_cfg_prim
.name
== config_name
:
1613 config_primitive
= ns_cfg_prim
1616 if config_primitive
is None:
1617 raise ValueError("Could not find ns_cfg_prim %s in nsr %s" % (config_name
, self
.name
))
1619 self
._log
.debug("Scaling group {} config primitive: {}".format(group
.name
, config_primitive
))
1620 if config_primitive
.has_field("user_defined_script"):
1621 rc
= yield from self
.apply_scale_group_config_script(config_primitive
.user_defined_script
,
1622 group
, scale_instance
, trigger
, vnfrs
)
1625 err_msg
= "Failed config for trigger {} using config script '{}'". \
1626 format(self
.scaling_trigger_str(trigger
),
1627 config_primitive
.user_defined_script
)
1628 yield from update_config_status(success
=rc
, err_msg
=err_msg
)
1631 err_msg
= "Failed config for trigger {} as config script is not specified". \
1632 format(self
.scaling_trigger_str(trigger
))
1633 yield from update_config_status(success
=False, err_msg
=err_msg
)
1634 raise NotImplementedError("Only script based config support for scale group for now: {}".
1637 err_msg
= "Failed config for trigger {} as config primitive is not specified".\
1638 format(self
.scaling_trigger_str(trigger
))
1639 yield from update_config_status(success
=False, err_msg
=err_msg
)
1640 self
._log
.error("Config primitive not specified for config action in scale group %s" %
1644 def create_scaling_groups(self
):
1645 """ This function creates a NSScalingGroup for every scaling
1646 group defined in he NSD"""
1648 for scaling_group_msg
in self
.nsd_msg
.scaling_group_descriptor
:
1649 self
._log
.debug("Found scaling_group %s in nsr id %s",
1650 scaling_group_msg
.name
, self
.id)
1652 group_record
= scale_group
.ScalingGroup(
1657 self
._scaling
_groups
[group_record
.name
] = group_record
1660 def create_scale_group_instance(self
, group_name
, index
, config_xact
, is_default
=False):
1661 group
= self
._scaling
_groups
[group_name
]
1662 scale_instance
= group
.create_instance(index
, is_default
)
1666 self
._log
.debug("Creating %u VNFs associated with NS id %s scaling group %s",
1667 len(self
.nsd_msg
.constituent_vnfd
), self
.id, self
)
1670 for vnf_index
, count
in group
.vnf_index_count_map
.items():
1671 const_vnfd_msg
= self
._get
_constituent
_vnfd
_msg
(vnf_index
)
1672 vnfd_msg
= self
._get
_vnfd
(const_vnfd_msg
.vnfd_id_ref
, config_xact
)
1674 cloud_account_name
, om_datacenter_name
= self
._get
_vnfd
_cloud
_account
(const_vnfd_msg
.member_vnf_index
)
1675 if cloud_account_name
is None:
1676 cloud_account_name
= self
.cloud_account_name
1677 for _
in range(count
):
1678 vnfr
= yield from self
.create_vnf_record(vnfd_msg
, const_vnfd_msg
, cloud_account_name
, om_datacenter_name
, group_name
, index
)
1679 scale_instance
.add_vnfr(vnfr
)
1685 def instantiate_instance():
1686 self
._log
.debug("Creating %s VNFRS", scale_instance
)
1687 vnfrs
= yield from create_vnfs()
1688 yield from self
.publish()
1690 self
._log
.debug("Instantiating %s VNFRS for %s", len(vnfrs
), scale_instance
)
1691 scale_instance
.operational_status
= "vnf_init_phase"
1692 yield from self
.update_state()
1695 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.PRE_SCALE_OUT
,
1696 group
, scale_instance
, vnfrs
)
1698 self
._log
.error("Pre scale out config for scale group {} ({}) failed".
1699 format(group
.name
, index
))
1700 scale_instance
.operational_status
= "failed"
1702 yield from self
.instantiate_vnfs(vnfrs
)
1704 except Exception as e
:
1705 self
._log
.exception("Failed to begin instantiatiation of vnfs for scale group {}: {}".
1706 format(group
.name
, e
))
1707 self
._log
.exception(e
)
1708 scale_instance
.operational_status
= "failed"
1710 yield from self
.update_state()
1712 yield from instantiate_instance()
1715 def delete_scale_group_instance(self
, group_name
, index
):
1716 group
= self
._scaling
_groups
[group_name
]
1717 scale_instance
= group
.get_instance(index
)
1718 if scale_instance
.is_default
:
1719 raise ScalingOperationError("Cannot terminate a default scaling group instance")
1721 scale_instance
.operational_status
= "terminate"
1722 yield from self
.update_state()
1725 def terminate_instance():
1726 self
._log
.debug("Terminating %s VNFRS" % scale_instance
)
1727 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.PRE_SCALE_IN
,
1728 group
, scale_instance
)
1730 self
._log
.error("Pre scale in config for scale group {} ({}) failed".
1731 format(group
.name
, index
))
1733 # Going ahead with terminate, even if there is an error in pre-scale-in config
1734 # as this could be result of scale out failure and we need to cleanup this group
1735 yield from self
.terminate_vnfrs(scale_instance
.vnfrs
)
1736 group
.delete_instance(index
)
1738 scale_instance
.operational_status
= "vnf_terminate_phase"
1739 yield from self
.update_state()
1741 yield from terminate_instance()
1744 def _update_scale_group_instances_status(self
):
1746 def post_scale_out_task(group
, instance
):
1747 # Apply post scale out config once all VNFRs are active
1748 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.POST_SCALE_OUT
,
1750 instance
.operational_status
= "running"
1752 self
._log
.debug("Scale out for group {} and instance {} succeeded".
1753 format(group
.name
, instance
.instance_id
))
1755 self
._log
.error("Post scale out config for scale group {} ({}) failed".
1756 format(group
.name
, instance
.instance_id
))
1758 yield from self
.update_state()
1760 group_instances
= {group
: group
.instances
for group
in self
._scaling
_groups
.values()}
1761 for group
, instances
in group_instances
.items():
1762 self
._log
.debug("Updating %s instance status", group
)
1763 for instance
in instances
:
1764 instance_vnf_state_list
= [vnfr
.state
for vnfr
in instance
.vnfrs
]
1765 self
._log
.debug("Got vnfr instance states: %s", instance_vnf_state_list
)
1766 if instance
.operational_status
== "vnf_init_phase":
1767 if all([state
== VnfRecordState
.ACTIVE
for state
in instance_vnf_state_list
]):
1768 instance
.operational_status
= "running"
1770 # Create a task for post scale out to allow us to sleep before attempting
1771 # to configure newly created VM's
1772 self
._loop
.create_task(post_scale_out_task(group
, instance
))
1774 elif any([state
== VnfRecordState
.FAILED
for state
in instance_vnf_state_list
]):
1775 self
._log
.debug("Scale out for group {} and instance {} failed".
1776 format(group
.name
, instance
.instance_id
))
1777 instance
.operational_status
= "failed"
1779 elif instance
.operational_status
== "vnf_terminate_phase":
1780 if all([state
== VnfRecordState
.TERMINATED
for state
in instance_vnf_state_list
]):
1781 instance
.operational_status
= "terminated"
1782 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.POST_SCALE_IN
,
1785 self
._log
.debug("Scale in for group {} and instance {} succeeded".
1786 format(group
.name
, instance
.instance_id
))
1788 self
._log
.error("Post scale in config for scale group {} ({}) failed".
1789 format(group
.name
, instance
.instance_id
))
1791 def create_vnffgs(self
):
1792 """ This function creates VNFFGs for every VNFFG in the NSD
1793 associated with this NSR"""
1795 for vnffgd
in self
.nsd_msg
.vnffgd
:
1796 self
._log
.debug("Found vnffgd %s in nsr id %s", vnffgd
, self
.id)
1797 vnffgr
= VnffgRecord(self
._dts
,
1800 self
._nsm
._vnffgmgr
,
1804 self
._sdn
_account
_name
1806 self
._vnffgrs
[vnffgr
.id] = vnffgr
1808 def resolve_vld_ip_profile(self
, nsd_msg
, vld
):
1809 if not vld
.has_field('ip_profile_ref'):
1811 profile
= [ profile
for profile
in nsd_msg
.ip_profiles
if profile
.name
== vld
.ip_profile_ref
]
1812 return profile
[0] if profile
else None
1815 def _create_vls(self
, vld
, cloud_account
,om_datacenter
):
1816 """Create a VLR in the cloud account specified using the given VLD
1820 cloud_account : Cloud account name
1825 vlr
= yield from VirtualLinkRecord
.create_record(
1833 self
.resolve_vld_ip_profile(self
.nsd_msg
, vld
),
1835 restart_mode
=self
.restart_mode
)
1839 def _extract_cloud_accounts_for_vl(self
, vld
):
1841 Extracts the list of cloud accounts from the NS Config obj
1844 1. Cloud accounts based connection point (vnf_cloud_account_map)
1846 vld : VLD yang object
1851 cloud_account_list
= []
1853 if self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1854 # Handle case where cloud_account is None
1856 for vnf
in self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1857 if vnf
.cloud_account
is not None or vnf
.om_datacenter
is not None:
1858 vnf_cloud_map
[vnf
.member_vnf_index_ref
] = (vnf
.cloud_account
,vnf
.om_datacenter
)
1860 for vnfc
in vld
.vnfd_connection_point_ref
:
1861 cloud_account
= vnf_cloud_map
.get(
1862 vnfc
.member_vnf_index_ref
,
1863 (self
.cloud_account_name
,self
.om_datacenter_name
))
1865 cloud_account_list
.append(cloud_account
)
1867 if self
._nsr
_cfg
_msg
.vl_cloud_account_map
:
1868 for vld_map
in self
._nsr
_cfg
_msg
.vl_cloud_account_map
:
1869 if vld_map
.vld_id_ref
== vld
.id:
1870 for cloud_account
in vld_map
.cloud_accounts
:
1871 cloud_account_list
.extend((cloud_account
,None))
1872 for om_datacenter
in vld_map
.om_datacenters
:
1873 cloud_account_list
.extend((None,om_datacenter
))
1875 # If no config has been provided then fall-back to the default
1877 if not cloud_account_list
:
1878 cloud_account_list
= [(self
.cloud_account_name
,self
.om_datacenter_name
)]
1880 self
._log
.debug("VL {} cloud accounts: {}".
1881 format(vld
.name
, cloud_account_list
))
1882 return set(cloud_account_list
)
1885 def create_vls(self
):
1886 """ This function creates VLs for every VLD in the NSD
1887 associated with this NSR"""
1888 for vld
in self
.nsd_msg
.vld
:
1889 self
._log
.debug("Found vld %s in nsr id %s", vld
, self
.id)
1890 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1891 for cloud_account
,om_datacenter
in cloud_account_list
:
1892 vlr
= yield from self
._create
_vls
(vld
, cloud_account
,om_datacenter
)
1893 self
._vlrs
.append(vlr
)
1897 def create_vl_instance(self
, vld
):
1898 self
._log
.debug("Create VL for {}: {}".format(self
.id, vld
.as_dict()))
1899 # Check if the VL is already present
1901 for vl
in self
._vlrs
:
1902 if vl
.vld_msg
.id == vld
.id:
1903 self
._log
.debug("The VLD %s already in NSR %s as VLR %s with status %s",
1904 vld
.id, self
.id, vl
.id, vl
.state
)
1906 if vlr
.state
!= VlRecordState
.TERMINATED
:
1907 err_msg
= "VLR for VL %s in NSR %s already instantiated", \
1909 self
._log
.error(err_msg
)
1910 raise NsrVlUpdateError(err_msg
)
1914 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1915 for account
in cloud_account_list
:
1916 vlr
= yield from self
._create
_vls
(vld
, account
)
1917 self
._vlrs
.append(vlr
)
1919 vlr
.state
= VlRecordState
.INSTANTIATION_PENDING
1920 yield from self
.update_state()
1923 yield from self
.nsm_plugin
.instantiate_vl(self
, vlr
)
1924 vlr
.state
= VlRecordState
.ACTIVE
1926 except Exception as e
:
1927 err_msg
= "Error instantiating VL for NSR {} and VLD {}: {}". \
1928 format(self
.id, vld
.id, e
)
1929 self
._log
.error(err_msg
)
1930 self
._log
.exception(e
)
1931 vlr
.state
= VlRecordState
.FAILED
1933 yield from self
.update_state()
1936 def delete_vl_instance(self
, vld
):
1937 for vlr
in self
._vlrs
:
1938 if vlr
.vld_msg
.id == vld
.id:
1939 self
._log
.debug("Found VLR %s for VLD %s in NSR %s",
1940 vlr
.id, vld
.id, self
.id)
1941 vlr
.state
= VlRecordState
.TERMINATE_PENDING
1942 yield from self
.update_state()
1945 yield from self
.nsm_plugin
.terminate_vl(vlr
)
1946 vlr
.state
= VlRecordState
.TERMINATED
1947 self
._vlrs
.remove(vlr
)
1949 except Exception as e
:
1950 err_msg
= "Error terminating VL for NSR {} and VLD {}: {}". \
1951 format(self
.id, vld
.id, e
)
1952 self
._log
.error(err_msg
)
1953 self
._log
.exception(e
)
1954 vlr
.state
= VlRecordState
.FAILED
1956 yield from self
.update_state()
1960 def create_vnfs(self
, config_xact
):
1962 This function creates VNFs for every VNF in the NSD
1963 associated with this NSR
1965 self
._log
.debug("Creating %u VNFs associated with this NS id %s",
1966 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
1968 for const_vnfd
in self
.nsd_msg
.constituent_vnfd
:
1969 if not const_vnfd
.start_by_default
:
1970 self
._log
.debug("start_by_default set to False in constituent VNF (%s). Skipping start.",
1971 const_vnfd
.member_vnf_index
)
1974 vnfd_msg
= self
._get
_vnfd
(const_vnfd
.vnfd_id_ref
, config_xact
)
1975 cloud_account_name
,om_datacenter_name
= self
._get
_vnfd
_cloud
_account
(const_vnfd
.member_vnf_index
)
1976 if cloud_account_name
is None:
1977 cloud_account_name
= self
.cloud_account_name
1978 yield from self
.create_vnf_record(vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
)
1981 def get_placement_groups(self
, vnfd_msg
, const_vnfd
):
1982 placement_groups
= []
1983 for group
in self
.nsd_msg
.placement_groups
:
1984 for member_vnfd
in group
.member_vnfd
:
1985 if (member_vnfd
.vnfd_id_ref
== vnfd_msg
.id) and \
1986 (member_vnfd
.member_vnf_index_ref
== const_vnfd
.member_vnf_index
):
1987 group_info
= self
.resolve_placement_group_cloud_construct(group
)
1988 if group_info
is None:
1989 self
._log
.error("Could not resolve cloud-construct for placement group: %s", group
.name
)
1990 ### raise PlacementGroupError("Could not resolve cloud-construct for placement group: {}".format(group.name))
1992 self
._log
.info("Successfully resolved cloud construct for placement group: %s for VNF: %s (Member Index: %s)",
1995 const_vnfd
.member_vnf_index
)
1996 placement_groups
.append(group_info
)
1997 return placement_groups
2000 def create_vnf_record(self
, vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
, group_name
=None, group_instance_id
=None):
2001 # Fetch the VNFD associated with this VNF
2002 placement_groups
= self
.get_placement_groups(vnfd_msg
, const_vnfd
)
2003 self
._log
.info("Cloud Account for VNF %d is %s",const_vnfd
.member_vnf_index
,cloud_account_name
)
2004 self
._log
.info("Launching VNF: %s (Member Index: %s) in NSD plancement Groups: %s",
2006 const_vnfd
.member_vnf_index
,
2007 [ group
.name
for group
in placement_groups
])
2008 vnfr
= yield from VirtualNetworkFunctionRecord
.create_record(self
._dts
,
2021 restart_mode
=self
.restart_mode
,
2023 if vnfr
.id in self
._vnfrs
:
2024 err
= "VNF with VNFR id %s already in vnf list" % (vnfr
.id,)
2025 raise NetworkServiceRecordError(err
)
2027 self
._vnfrs
[vnfr
.id] = vnfr
2028 self
._nsm
.vnfrs
[vnfr
.id] = vnfr
2030 yield from vnfr
.set_config_status(NsrYang
.ConfigStates
.INIT
)
2032 self
._log
.debug("Added VNFR %s to NSM VNFR list with id %s",
2038 def create_param_pools(self
):
2039 for param_pool
in self
.nsd_msg
.parameter_pool
:
2040 self
._log
.debug("Found parameter pool %s in nsr id %s", param_pool
, self
.id)
2042 start_value
= param_pool
.range.start_value
2043 end_value
= param_pool
.range.end_value
2044 if end_value
< start_value
:
2045 raise NetworkServiceRecordError(
2046 "Parameter pool %s has invalid range (start: {}, end: {})".format(
2047 start_value
, end_value
2051 self
._param
_pools
[param_pool
.name
] = config_value_pool
.ParameterValuePool(
2054 range(start_value
, end_value
)
2058 def fetch_vnfr(self
, vnfr_path
):
2059 """ Fetch VNFR record """
2061 self
._log
.debug("Fetching VNFR with key %s while instantiating %s",
2063 res_iter
= yield from self
._dts
.query_read(vnfr_path
, rwdts
.XactFlag
.MERGE
)
2065 for ent
in res_iter
:
2066 res
= yield from ent
2072 def instantiate_vnfs(self
, vnfrs
):
2074 This function instantiates VNFs for every VNF in this Network Service
2076 self
._log
.debug("Instantiating %u VNFs in NS %s", len(vnfrs
), self
.id)
2078 self
._log
.debug("Instantiating VNF: %s in NS %s", vnf
, self
.id)
2079 yield from self
.nsm_plugin
.instantiate_vnf(self
, vnf
)
2082 def instantiate_vnffgs(self
):
2084 This function instantiates VNFFGs for every VNFFG in this Network Service
2086 self
._log
.debug("Instantiating %u VNFFGs in NS %s",
2087 len(self
.nsd_msg
.vnffgd
), self
.id)
2088 for _
, vnfr
in self
.vnfrs
.items():
2089 while vnfr
.state
in [VnfRecordState
.INSTANTIATION_PENDING
, VnfRecordState
.INIT
]:
2090 self
._log
.debug("Received vnfr state for vnfr %s is %s; retrying",vnfr
.name
,vnfr
.state
)
2091 yield from asyncio
.sleep(2, loop
=self
._loop
)
2092 if vnfr
.state
== VnfRecordState
.ACTIVE
:
2093 self
._log
.debug("Received vnfr state for vnfr %s is %s ",vnfr
.name
,vnfr
.state
)
2096 self
._log
.debug("Received vnfr state for vnfr %s is %s; failing vnffg creation",vnfr
.name
,vnfr
.state
)
2097 self
._vnffgr
_state
= VnffgRecordState
.FAILED
2100 self
._log
.info("Waiting for 90 seconds for VMs to come up")
2101 yield from asyncio
.sleep(90, loop
=self
._loop
)
2102 self
._log
.info("Starting VNFFG orchestration")
2103 for vnffg
in self
._vnffgrs
.values():
2104 self
._log
.debug("Instantiating VNFFG: %s in NS %s", vnffg
, self
.id)
2105 yield from vnffg
.instantiate()
2108 def instantiate_scaling_instances(self
, config_xact
):
2109 """ Instantiate any default scaling instances in this Network Service """
2110 for group
in self
._scaling
_groups
.values():
2111 for i
in range(group
.min_instance_count
):
2112 self
._log
.debug("Instantiating %s default scaling instance %s", group
, i
)
2113 yield from self
.create_scale_group_instance(
2114 group
.name
, i
, config_xact
, is_default
=True
2117 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2118 if group_msg
.scaling_group_name_ref
!= group
.name
:
2121 for instance
in group_msg
.instance
:
2122 self
._log
.debug("Reloading %s scaling instance %s", group_msg
, instance
.id)
2123 yield from self
.create_scale_group_instance(
2124 group
.name
, instance
.id, config_xact
, is_default
=False
2127 def has_scaling_instances(self
):
2128 """ Return boolean indicating if the network service has default scaling groups """
2129 for group
in self
._scaling
_groups
.values():
2130 if group
.min_instance_count
> 0:
2133 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2134 if len(group_msg
.instance
) > 0:
2141 """ This function publishes this NSR """
2142 self
._nsr
_msg
= self
.create_msg()
2144 self
._log
.debug("Publishing the NSR with xpath %s and nsr %s",
2148 if self
._debug
_running
:
2149 self
._log
.debug("Publishing NSR in RUNNING state!")
2152 with self
._dts
.transaction() as xact
:
2153 yield from self
._nsm
.nsr_handler
.update(xact
, self
.nsr_xpath
, self
._nsr
_msg
)
2154 if self
._op
_status
.state
== NetworkServiceRecordState
.RUNNING
:
2155 self
._debug
_running
= True
2158 def unpublish(self
, xact
):
2159 """ Unpublish this NSR object """
2160 self
._log
.debug("Unpublishing Network service id %s", self
.id)
2161 yield from self
._nsm
.nsr_handler
.delete(xact
, self
.nsr_xpath
)
2164 def nsr_xpath(self
):
2165 """ Returns the xpath associated with this NSR """
2167 "D,/nsr:ns-instance-opdata" +
2168 "/nsr:nsr[nsr:ns-instance-config-ref = '{}']"
2172 def xpath_from_nsr(nsr
):
2173 """ Returns the xpath associated with this NSR op data"""
2174 return (NetworkServiceRecord
.XPATH
+
2175 "[nsr:ns-instance-config-ref = '{}']").format(nsr
.id)
2178 def nsd_xpath(self
):
2179 """ Return NSD config xpath."""
2181 "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}']"
2182 ).format(self
.nsd_id
)
2185 def instantiate(self
, config_xact
):
2186 """"Instantiates a NetworkServiceRecord.
2188 This function instantiates a Network service
2189 which involves the following steps,
2191 * Instantiate every VL in NSD by sending create VLR request to DTS.
2192 * Instantiate every VNF in NSD by sending create VNF reuqest to DTS.
2193 * Publish the NSR details to DTS
2196 nsr: The NSR configuration request containing nsr-id and nsd
2197 config_xact: The configuration transaction which initiated the instatiation
2200 NetworkServiceRecordError if the NSR creation fails
2206 self
._log
.debug("Instantiating NS - %s xact - %s", self
, config_xact
)
2208 # Move the state to INIITALIZING
2209 self
.set_state(NetworkServiceRecordState
.INIT
)
2211 event_descr
= "Instantiation Request Received NSR Id:%s" % self
.id
2212 self
.record_event("instantiating", event_descr
)
2215 self
._nsd
= self
._nsr
_cfg
_msg
.nsd
2218 # Update ref count if nsd present in catalog
2219 self
._nsm
.get_nsd_ref(self
.nsd_id
)
2221 except NetworkServiceDescriptorError
:
2222 # This could be an NSD not in the nsd-catalog
2225 # Merge any config and initial config primitive values
2226 self
.config_store
.merge_nsd_config(self
.nsd_msg
)
2227 self
._log
.debug("Merged NSD: {}".format(self
.nsd_msg
.as_dict()))
2229 event_descr
= "Fetched NSD with descriptor id %s" % self
.nsd_id
2230 self
.record_event("nsd-fetched", event_descr
)
2232 if self
._nsd
is None:
2233 msg
= "Failed to fetch NSD with nsd-id [%s] for nsr-id %s"
2234 self
._log
.debug(msg
, self
.nsd_id
, self
.id)
2235 raise NetworkServiceRecordError(self
)
2237 self
._log
.debug("Got nsd result %s", self
._nsd
)
2239 # Substitute any input parameters
2240 self
.substitute_input_parameters(self
._nsd
, self
._nsr
_cfg
_msg
)
2243 yield from self
.create(config_xact
)
2245 # Publish the NSR to DTS
2246 yield from self
.publish()
2249 def do_instantiate():
2251 Instantiate network service
2253 self
._log
.debug("Instantiating VLs nsr id [%s] nsd id [%s]",
2254 self
.id, self
.nsd_id
)
2256 # instantiate the VLs
2257 event_descr
= ("Instantiating %s external VLs for NSR id %s" %
2258 (len(self
.nsd_msg
.vld
), self
.id))
2259 self
.record_event("begin-external-vls-instantiation", event_descr
)
2261 self
.set_state(NetworkServiceRecordState
.VL_INIT_PHASE
)
2263 yield from self
.instantiate_vls()
2265 # Publish the NSR to DTS
2266 yield from self
.publish()
2268 event_descr
= ("Finished instantiating %s external VLs for NSR id %s" %
2269 (len(self
.nsd_msg
.vld
), self
.id))
2270 self
.record_event("end-external-vls-instantiation", event_descr
)
2272 self
.set_state(NetworkServiceRecordState
.VNF_INIT_PHASE
)
2274 self
._log
.debug("Instantiating VNFs ...... nsr[%s], nsd[%s]",
2275 self
.id, self
.nsd_id
)
2277 # instantiate the VNFs
2278 event_descr
= ("Instantiating %s VNFS for NSR id %s" %
2279 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2281 self
.record_event("begin-vnf-instantiation", event_descr
)
2283 yield from self
.instantiate_vnfs(self
._vnfrs
.values())
2285 self
._log
.debug(" Finished instantiating %d VNFs for NSR id %s",
2286 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
2288 event_descr
= ("Finished instantiating %s VNFs for NSR id %s" %
2289 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2290 self
.record_event("end-vnf-instantiation", event_descr
)
2292 if len(self
.vnffgrs
) > 0:
2293 #self.set_state(NetworkServiceRecordState.VNFFG_INIT_PHASE)
2294 event_descr
= ("Instantiating %s VNFFGS for NSR id %s" %
2295 (len(self
.nsd_msg
.vnffgd
), self
.id))
2297 self
.record_event("begin-vnffg-instantiation", event_descr
)
2299 yield from self
.instantiate_vnffgs()
2301 event_descr
= ("Finished instantiating %s VNFFGDs for NSR id %s" %
2302 (len(self
.nsd_msg
.vnffgd
), self
.id))
2303 self
.record_event("end-vnffg-instantiation", event_descr
)
2305 if self
.has_scaling_instances():
2306 event_descr
= ("Instantiating %s Scaling Groups for NSR id %s" %
2307 (len(self
._scaling
_groups
), self
.id))
2309 self
.record_event("begin-scaling-group-instantiation", event_descr
)
2310 yield from self
.instantiate_scaling_instances(config_xact
)
2311 self
.record_event("end-scaling-group-instantiation", event_descr
)
2313 # Give the plugin a chance to deploy the network service now that all
2314 # virtual links and vnfs are instantiated
2315 yield from self
.nsm_plugin
.deploy(self
._nsr
_msg
)
2317 self
._log
.debug("Publishing NSR...... nsr[%s], nsd[%s]",
2318 self
.id, self
.nsd_id
)
2320 # Publish the NSR to DTS
2321 yield from self
.publish()
2323 self
._log
.debug("Published NSR...... nsr[%s], nsd[%s]",
2324 self
.id, self
.nsd_id
)
2326 def on_instantiate_done(fut
):
2327 # If the do_instantiate fails, then publish NSR with failed result
2328 if fut
.exception() is not None:
2329 self
._log
.error("NSR instantiation failed for NSR id %s: %s", self
.id, str(fut
.exception()))
2330 self
._loop
.create_task(self
.instantiation_failed(failed_reason
=str(fut
.exception())))
2332 instantiate_task
= self
._loop
.create_task(do_instantiate())
2333 instantiate_task
.add_done_callback(on_instantiate_done
)
2336 def set_config_status(self
, status
, status_details
=None):
2337 if self
.config_status
!= status
:
2338 self
._log
.debug("Updating NSR {} status for {} to {}".
2339 format(self
.name
, self
.config_status
, status
))
2340 self
._config
_status
= status
2341 self
._config
_status
_details
= status_details
2343 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2344 self
.record_event("config-failed", "NS configuration failed",
2345 evt_details
=self
._config
_status
_details
)
2347 yield from self
.publish()
2350 def is_active(self
):
2351 """ This NS is active """
2352 self
.set_state(NetworkServiceRecordState
.RUNNING
)
2356 # Publish the NSR to DTS
2357 self
._log
.debug("Network service %s is active ", self
.id)
2358 self
._is
_active
= True
2360 event_descr
= "NSR in running state for NSR id %s" % self
.id
2361 self
.record_event("ns-running", event_descr
)
2363 yield from self
.publish()
2366 def instantiation_failed(self
, failed_reason
=None):
2367 """ The NS instantiation failed"""
2368 self
._log
.error("Network service id:%s, name:%s instantiation failed",
2370 self
.set_state(NetworkServiceRecordState
.FAILED
)
2372 event_descr
= "Instantiation of NS %s failed" % self
.id
2373 self
.record_event("ns-failed", event_descr
, evt_details
=failed_reason
)
2375 # Publish the NSR to DTS
2376 yield from self
.publish()
2379 def terminate_vnfrs(self
, vnfrs
):
2380 """ Terminate VNFRS in this network service """
2381 self
._log
.debug("Terminating VNFs in network service %s", self
.id)
2383 yield from self
.nsm_plugin
.terminate_vnf(vnfr
)
2386 def terminate(self
):
2387 """ Terminate a NetworkServiceRecord."""
2388 def terminate_vnffgrs():
2389 """ Terminate VNFFGRS in this network service """
2390 self
._log
.debug("Terminating VNFFGRs in network service %s", self
.id)
2391 for vnffgr
in self
.vnffgrs
.values():
2392 yield from vnffgr
.terminate()
2394 def terminate_vlrs():
2395 """ Terminate VLRs in this netork service """
2396 self
._log
.debug("Terminating VLs in network service %s", self
.id)
2397 for vlr
in self
.vlrs
:
2398 yield from self
.nsm_plugin
.terminate_vl(vlr
)
2399 vlr
.state
= VlRecordState
.TERMINATED
2401 self
._log
.debug("Terminating network service id %s", self
.id)
2403 # Move the state to TERMINATE
2404 self
.set_state(NetworkServiceRecordState
.TERMINATE
)
2405 event_descr
= "Terminate being processed for NS Id:%s" % self
.id
2406 self
.record_event("terminate", event_descr
)
2408 # Move the state to VNF_TERMINATE_PHASE
2409 self
._log
.debug("Terminating VNFFGs in NS ID: %s", self
.id)
2410 self
.set_state(NetworkServiceRecordState
.VNFFG_TERMINATE_PHASE
)
2411 event_descr
= "Terminating VNFFGS in NS Id:%s" % self
.id
2412 self
.record_event("terminating-vnffgss", event_descr
)
2413 yield from terminate_vnffgrs()
2415 # Move the state to VNF_TERMINATE_PHASE
2416 self
.set_state(NetworkServiceRecordState
.VNF_TERMINATE_PHASE
)
2417 event_descr
= "Terminating VNFS in NS Id:%s" % self
.id
2418 self
.record_event("terminating-vnfs", event_descr
)
2419 yield from self
.terminate_vnfrs(self
.vnfrs
.values())
2421 # Move the state to VL_TERMINATE_PHASE
2422 self
.set_state(NetworkServiceRecordState
.VL_TERMINATE_PHASE
)
2423 event_descr
= "Terminating VLs in NS Id:%s" % self
.id
2424 self
.record_event("terminating-vls", event_descr
)
2425 yield from terminate_vlrs()
2427 yield from self
.nsm_plugin
.terminate_ns(self
)
2429 # Move the state to TERMINATED
2430 self
.set_state(NetworkServiceRecordState
.TERMINATED
)
2431 event_descr
= "Terminated NS Id:%s" % self
.id
2432 self
.record_event("terminated", event_descr
)
2435 """"Enable a NetworkServiceRecord."""
2439 """"Disable a NetworkServiceRecord."""
2442 def map_config_status(self
):
2443 self
._log
.debug("Config status for ns {} is {}".
2444 format(self
.name
, self
._config
_status
))
2445 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURING
:
2446 return 'configuring'
2447 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2451 def vl_phase_completed(self
):
2452 """ Are VLs created in this NS?"""
2453 return self
._vl
_phase
_completed
2455 def vnf_phase_completed(self
):
2456 """ Are VLs created in this NS?"""
2457 return self
._vnf
_phase
_completed
2459 def create_msg(self
):
2460 """ The network serice record as a message """
2461 nsr_dict
= {"ns_instance_config_ref": self
.id}
2462 nsr
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr
.from_dict(nsr_dict
)
2463 #nsr.cloud_account = self.cloud_account_name
2464 nsr
.sdn_account
= self
._sdn
_account
_name
2465 nsr
.name_ref
= self
.name
2466 nsr
.nsd_ref
= self
.nsd_id
2467 nsr
.nsd_name_ref
= self
.nsd_msg
.name
2468 nsr
.operational_events
= self
._op
_status
.msg
2469 nsr
.operational_status
= self
._op
_status
.yang_str()
2470 nsr
.config_status
= self
.map_config_status()
2471 nsr
.config_status_details
= self
._config
_status
_details
2472 nsr
.create_time
= self
._create
_time
2474 for cfg_prim
in self
.nsd_msg
.service_primitive
:
2475 cfg_prim
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_ServicePrimitive
.from_dict(
2477 nsr
.service_primitive
.append(cfg_prim
)
2479 for init_cfg
in self
.nsd_msg
.initial_config_primitive
:
2480 prim
= NsrYang
.NsrInitialConfigPrimitive
.from_dict(
2482 nsr
.initial_config_primitive
.append(prim
)
2484 if self
.vl_phase_completed():
2485 for vlr
in self
.vlrs
:
2486 nsr
.vlr
.append(vlr
.create_nsr_vlr_msg(self
.vnfrs
.values()))
2488 if self
.vnf_phase_completed():
2489 for vnfr_id
in self
.vnfrs
:
2490 nsr
.constituent_vnfr_ref
.append(self
.vnfrs
[vnfr_id
].const_vnfr_msg
)
2491 for vnffgr
in self
.vnffgrs
.values():
2492 nsr
.vnffgr
.append(vnffgr
.fetch_vnffgr())
2493 for scaling_group
in self
._scaling
_groups
.values():
2494 nsr
.scaling_group_record
.append(scaling_group
.create_record_msg())
2498 def all_vnfs_active(self
):
2499 """ Are all VNFS in this NS active? """
2500 for _
, vnfr
in self
.vnfrs
.items():
2501 if vnfr
.active
is not True:
2506 def update_state(self
):
2507 """ Re-evaluate this NS's state """
2508 curr_state
= self
._op
_status
.state
2510 if curr_state
== NetworkServiceRecordState
.TERMINATED
:
2511 self
._log
.debug("NS (%s) in terminated state, not updating state", self
.id)
2514 new_state
= NetworkServiceRecordState
.RUNNING
2515 self
._log
.info("Received update_state for nsr: %s, curr-state: %s",
2516 self
.id, curr_state
)
2518 # Check all the VNFRs are present
2519 for _
, vnfr
in self
.vnfrs
.items():
2520 if vnfr
.state
in [VnfRecordState
.ACTIVE
, VnfRecordState
.TERMINATED
]:
2522 elif vnfr
.state
== VnfRecordState
.FAILED
:
2523 if vnfr
._prev
_state
!= vnfr
.state
:
2524 event_descr
= "Instantiation of VNF %s failed" % vnfr
.id
2525 event_error_details
= vnfr
.state_failed_reason
2526 self
.record_event("vnf-failed", event_descr
, evt_details
=event_error_details
)
2527 vnfr
.set_state(VnfRecordState
.FAILED
)
2529 self
._log
.info("VNF state did not change, curr=%s, prev=%s",
2530 vnfr
.state
, vnfr
._prev
_state
)
2531 new_state
= NetworkServiceRecordState
.FAILED
2534 self
._log
.info("VNF %s in NSR %s is still not active; current state is: %s",
2535 vnfr
.id, self
.id, vnfr
.state
)
2536 new_state
= curr_state
2538 # If new state is RUNNING; check all VLs
2539 if new_state
== NetworkServiceRecordState
.RUNNING
:
2540 for vl
in self
.vlrs
:
2542 if vl
.state
in [VlRecordState
.ACTIVE
, VlRecordState
.TERMINATED
]:
2544 elif vl
.state
== VlRecordState
.FAILED
:
2545 if vl
.prev_state
!= vl
.state
:
2546 event_descr
= "Instantiation of VL %s failed" % vl
.id
2547 event_error_details
= vl
.state_failed_reason
2548 self
.record_event("vl-failed", event_descr
, evt_details
=event_error_details
)
2549 vl
.prev_state
= vl
.state
2551 self
._log
.debug("VL %s already in failed state")
2553 if vl
.state
in [VlRecordState
.INSTANTIATION_PENDING
, VlRecordState
.INIT
]:
2554 new_state
= NetworkServiceRecordState
.VL_INSTANTIATE
2557 if vl
.state
in [VlRecordState
.TERMINATE_PENDING
]:
2558 new_state
= NetworkServiceRecordState
.VL_TERMINATE
2561 # If new state is RUNNING; check VNFFGRs are also active
2562 if new_state
== NetworkServiceRecordState
.RUNNING
:
2563 for _
, vnffgr
in self
.vnffgrs
.items():
2564 self
._log
.info("Checking vnffgr state for nsr %s is: %s",
2565 self
.id, vnffgr
.state
)
2566 if vnffgr
.state
== VnffgRecordState
.ACTIVE
:
2568 elif vnffgr
.state
== VnffgRecordState
.FAILED
:
2569 event_descr
= "Instantiation of VNFFGR %s failed" % vnffgr
.id
2570 self
.record_event("vnffg-failed", event_descr
)
2571 new_state
= NetworkServiceRecordState
.FAILED
2574 self
._log
.info("VNFFGR %s in NSR %s is still not active; current state is: %s",
2575 vnffgr
.id, self
.id, vnffgr
.state
)
2576 new_state
= curr_state
2578 # Update all the scaling group instance operational status to
2579 # reflect the state of all VNFR within that instance
2580 yield from self
._update
_scale
_group
_instances
_status
()
2582 for _
, group
in self
._scaling
_groups
.items():
2583 if group
.state
== scale_group
.ScaleGroupState
.SCALING_OUT
:
2584 new_state
= NetworkServiceRecordState
.SCALING_OUT
2586 elif group
.state
== scale_group
.ScaleGroupState
.SCALING_IN
:
2587 new_state
= NetworkServiceRecordState
.SCALING_IN
2590 if new_state
!= curr_state
:
2591 self
._log
.debug("Changing state of Network service %s from %s to %s",
2592 self
.id, curr_state
, new_state
)
2593 if new_state
== NetworkServiceRecordState
.RUNNING
:
2594 yield from self
.is_active()
2595 elif new_state
== NetworkServiceRecordState
.FAILED
:
2596 # If the NS is already active and we entered scaling_in, scaling_out,
2597 # do not mark the NS as failing if scaling operation failed.
2598 if curr_state
in [NetworkServiceRecordState
.SCALING_OUT
,
2599 NetworkServiceRecordState
.SCALING_IN
] and self
._is
_active
:
2600 new_state
= NetworkServiceRecordState
.RUNNING
2601 self
.set_state(new_state
)
2603 yield from self
.instantiation_failed()
2605 self
.set_state(new_state
)
2607 yield from self
.publish()
2610 class InputParameterSubstitution(object):
2612 This class is responsible for substituting input parameters into an NSD.
2615 def __init__(self
, log
):
2616 """Create an instance of InputParameterSubstitution
2619 log - a logger for this object to use
2624 def __call__(self
, nsd
, nsr_config
):
2625 """Substitutes input parameters from the NSR config into the NSD
2627 This call modifies the provided NSD with the input parameters that are
2628 contained in the NSR config.
2631 nsd - a GI NSD object
2632 nsr_config - a GI NSR config object
2635 if nsd
is None or nsr_config
is None:
2638 # Create a lookup of the xpath elements that this descriptor allows
2640 optional_input_parameters
= set()
2641 for input_parameter
in nsd
.input_parameter_xpath
:
2642 optional_input_parameters
.add(input_parameter
.xpath
)
2644 # Apply the input parameters to the descriptor
2645 if nsr_config
.input_parameter
:
2646 for param
in nsr_config
.input_parameter
:
2647 if param
.xpath
not in optional_input_parameters
:
2648 msg
= "tried to set an invalid input parameter ({})"
2649 self
.log
.error(msg
.format(param
.xpath
))
2653 "input-parameter:{} = {}".format(
2660 xpath
.setxattr(nsd
, param
.xpath
, param
.value
)
2662 except Exception as e
:
2663 self
.log
.exception(e
)
2666 class NetworkServiceDescriptor(object):
2668 Network service descriptor class
2671 def __init__(self
, dts
, log
, loop
, nsd
, nsm
):
2683 """ Returns nsd id """
2688 """ Returns name of nsd """
2689 return self
._nsd
.name
2692 def ref_count(self
):
2693 """ Returns reference count"""
2694 return self
._ref
_count
2697 """ Returns whether nsd is in use or not """
2698 return True if self
.ref_count
> 0 else False
2701 """ Take a reference on this object """
2702 self
._ref
_count
+= 1
2705 """ Release reference on this object """
2706 if self
.ref_count
< 1:
2707 msg
= ("Unref on a NSD object - nsd id %s, ref_count = %s" %
2708 (self
.id, self
.ref_count
))
2709 self
._log
.critical(msg
)
2710 raise NetworkServiceDescriptorError(msg
)
2711 self
._ref
_count
-= 1
2715 """ Return the message associated with this NetworkServiceDescriptor"""
2719 def path_for_id(nsd_id
):
2720 """ Return path for the passed nsd_id"""
2721 return "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}'".format(nsd_id
)
2724 """ Return the message associated with this NetworkServiceDescriptor"""
2725 return NetworkServiceDescriptor
.path_for_id(self
.id)
2727 def update(self
, nsd
):
2728 """ Update the NSD descriptor """
2732 class NsdDtsHandler(object):
2733 """ The network service descriptor DTS handler """
2734 XPATH
= "C,/nsd:nsd-catalog/nsd:nsd"
2736 def __init__(self
, dts
, log
, loop
, nsm
):
2746 """ Return registration handle """
2751 """ Register for Nsd create/update/delete/read requests from dts """
2753 def on_apply(dts
, acg
, xact
, action
, scratch
):
2754 """Apply the configuration"""
2755 is_recovery
= xact
.xact
is None and action
== rwdts
.AppconfAction
.INSTALL
2756 self
._log
.debug("Got nsd apply cfg (xact:%s) (action:%s)",
2758 # Create/Update an NSD record
2759 for cfg
in self
._regh
.get_xact_elements(xact
):
2760 # Only interested in those NSD cfgs whose ID was received in prepare callback
2761 if cfg
.id in scratch
.get('nsds', []) or is_recovery
:
2762 self
._nsm
.update_nsd(cfg
)
2764 scratch
.pop('nsds', None)
2766 return RwTypes
.RwStatus
.SUCCESS
2769 def delete_nsd_libs(nsd_id
):
2770 """ Remove any files uploaded with NSD and stored under $RIFT_ARTIFACTS/libs/<id> """
2772 rift_artifacts_dir
= os
.environ
['RIFT_ARTIFACTS']
2773 nsd_dir
= os
.path
.join(rift_artifacts_dir
, 'launchpad/libs', nsd_id
)
2775 if os
.path
.exists (nsd_dir
):
2776 shutil
.rmtree(nsd_dir
, ignore_errors
=True)
2777 except Exception as e
:
2778 self
._log
.error("Exception in cleaning up NSD libs {}: {}".
2780 self
._log
.excpetion(e
)
2783 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2784 """ Prepare callback from DTS for NSD config """
2786 self
._log
.info("Got nsd prepare - config received nsd id %s, msg %s",
2789 fref
= ProtobufC
.FieldReference
.alloc()
2790 fref
.goto_whole_message(msg
.to_pbcm())
2792 if fref
.is_field_deleted():
2793 # Delete an NSD record
2794 self
._log
.debug("Deleting NSD with id %s", msg
.id)
2795 if self
._nsm
.nsd_in_use(msg
.id):
2796 self
._log
.debug("Cannot delete NSD in use - %s", msg
.id)
2797 err
= "Cannot delete an NSD in use - %s" % msg
.id
2798 raise NetworkServiceDescriptorRefCountExists(err
)
2800 yield from delete_nsd_libs(msg
.id)
2801 self
._nsm
.delete_nsd(msg
.id)
2803 # Add this NSD to scratch to create/update in apply callback
2804 nsds
= scratch
.setdefault('nsds', [])
2806 # acg._scratch['nsds'].append(msg.id)
2808 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2811 "Registering for NSD config using xpath: %s",
2812 NsdDtsHandler
.XPATH
,
2815 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2816 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2817 # Need a list in scratch to store NSDs to create/update later
2818 # acg._scratch['nsds'] = list()
2819 self
._regh
= acg
.register(
2820 xpath
=NsdDtsHandler
.XPATH
,
2821 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
2822 on_prepare
=on_prepare
)
2825 class VnfdDtsHandler(object):
2826 """ DTS handler for VNFD config changes """
2827 XPATH
= "C,/vnfd:vnfd-catalog/vnfd:vnfd"
2829 def __init__(self
, dts
, log
, loop
, nsm
):
2838 """ DTS registration handle """
2843 """ Register for VNFD configuration"""
2846 def on_apply(dts
, acg
, xact
, action
, scratch
):
2847 """Apply the configuration"""
2848 self
._log
.debug("Got NSM VNFD apply (xact: %s) (action: %s)(scr: %s)",
2849 xact
, action
, scratch
)
2851 # Create/Update a VNFD record
2852 for cfg
in self
._regh
.get_xact_elements(xact
):
2853 # Only interested in those VNFD cfgs whose ID was received in prepare callback
2854 if cfg
.id in scratch
.get('vnfds', []):
2855 self
._nsm
.update_vnfd(cfg
)
2857 for cfg
in self
._regh
.elements
:
2858 if cfg
.id in scratch
.get('deleted_vnfds', []):
2859 yield from self
._nsm
.delete_vnfd(cfg
.id)
2861 scratch
.pop('vnfds', None)
2862 scratch
.pop('deleted_vnfds', None)
2865 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2866 """ on prepare callback """
2867 self
._log
.debug("Got on prepare for VNFD (path: %s) (action: %s) (msg: %s)",
2868 ks_path
.to_xpath(RwNsmYang
.get_schema()), xact_info
.query_action
, msg
)
2870 fref
= ProtobufC
.FieldReference
.alloc()
2871 fref
.goto_whole_message(msg
.to_pbcm())
2873 # Handle deletes in prepare_callback, but adds/updates in apply_callback
2874 if fref
.is_field_deleted():
2875 self
._log
.debug("Adding msg to deleted field")
2876 deleted_vnfds
= scratch
.setdefault('deleted_vnfds', [])
2877 deleted_vnfds
.append(msg
.id)
2879 # Add this VNFD to scratch to create/update in apply callback
2880 vnfds
= scratch
.setdefault('vnfds', [])
2881 vnfds
.append(msg
.id)
2883 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2886 "Registering for VNFD config using xpath: %s",
2887 VnfdDtsHandler
.XPATH
,
2889 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2890 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2891 # Need a list in scratch to store VNFDs to create/update later
2892 # acg._scratch['vnfds'] = list()
2893 # acg._scratch['deleted_vnfds'] = list()
2894 self
._regh
= acg
.register(
2895 xpath
=VnfdDtsHandler
.XPATH
,
2896 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY
,
2897 on_prepare
=on_prepare
)
2899 class NsrRpcDtsHandler(object):
2900 """ The network service instantiation RPC DTS handler """
2901 EXEC_NSR_CONF_XPATH
= "I,/nsr:start-network-service"
2902 EXEC_NSR_CONF_O_XPATH
= "O,/nsr:start-network-service"
2903 NETCONF_IP_ADDRESS
= "127.0.0.1"
2905 RESTCONF_PORT
= 8888
2906 NETCONF_USER
= "admin"
2907 NETCONF_PW
= "admin"
2908 REST_BASE_V2_URL
= 'https://{}:{}/v2/api/'.format("127.0.0.1",8888)
2910 def __init__(self
, dts
, log
, loop
, nsm
):
2917 self
._ns
_regh
= None
2919 self
._manager
= None
2920 self
._nsr
_config
_url
= NsrRpcDtsHandler
.REST_BASE_V2_URL
+ 'config/ns-instance-config'
2922 self
._model
= RwYang
.Model
.create_libncx()
2923 self
._model
.load_schema_ypbc(RwNsrYang
.get_schema())
2927 """ Return the NS manager instance """
2931 def wrap_netconf_config_xml(xml
):
2932 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
2936 def _connect(self
, timeout_secs
=240):
2938 start_time
= time
.time()
2939 while (time
.time() - start_time
) < timeout_secs
:
2942 self
._log
.debug("Attemping NsmTasklet netconf connection.")
2944 manager
= yield from ncclient
.asyncio_manager
.asyncio_connect(
2946 host
=NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
,
2947 port
=NsrRpcDtsHandler
.NETCONF_PORT
,
2948 username
=NsrRpcDtsHandler
.NETCONF_USER
,
2949 password
=NsrRpcDtsHandler
.NETCONF_PW
,
2951 look_for_keys
=False,
2952 hostkey_verify
=False,
2957 except ncclient
.transport
.errors
.SSHError
as e
:
2958 self
._log
.warning("Netconf connection to launchpad %s failed: %s",
2959 NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
, str(e
))
2961 yield from asyncio
.sleep(5, loop
=self
._loop
)
2963 raise NsrInstantiationFailed("Failed to connect to Launchpad within %s seconds" %
2966 def _apply_ns_instance_config(self
,payload_dict
):
2967 #self._log.debug("At apply NS instance config with payload %s",payload_dict)
2968 req_hdr
= {'accept':'application/vnd.yang.data+json','content-type':'application/vnd.yang.data+json'}
2969 response
=requests
.post(self
._nsr
_config
_url
, headers
=req_hdr
, auth
=('admin', 'admin'),data
=payload_dict
,verify
=False)
2974 """ Register for NS monitoring read from dts """
2976 def on_ns_config_prepare(xact_info
, action
, ks_path
, msg
):
2977 """ prepare callback from dts start-network-service"""
2978 assert action
== rwdts
.QueryAction
.RPC
2980 rpc_op
= NsrYang
.YangOutput_Nsr_StartNetworkService
.from_dict({
2981 "nsr_id":str(uuid
.uuid4())
2984 if not ('name' in rpc_ip
and 'nsd_ref' in rpc_ip
and ('cloud_account' in rpc_ip
or 'om_datacenter' in rpc_ip
)):
2985 self
._log
.error("Mandatory parameters name or nsd_ref or cloud account not found in start-network-service {}".format(rpc_ip
))
2988 self
._log
.debug("start-network-service RPC input: {}".format(rpc_ip
))
2991 # Add used value to the pool
2992 self
._log
.debug("RPC output: {}".format(rpc_op
))
2994 nsd_copy
= self
.nsm
.get_nsd(rpc_ip
.nsd_ref
)
2996 #if not self._manager:
2997 # self._manager = yield from self._connect()
2999 self
._log
.debug("Configuring ns-instance-config with name %s nsd-ref: %s",
3000 rpc_ip
.name
, rpc_ip
.nsd_ref
)
3002 ns_instance_config_dict
= {"id":rpc_op
.nsr_id
, "admin_status":"ENABLED"}
3003 ns_instance_config_copy_dict
= {k
:v
for k
, v
in rpc_ip
.as_dict().items()
3004 if k
in RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr().fields
}
3005 ns_instance_config_dict
.update(ns_instance_config_copy_dict
)
3007 ns_instance_config
= RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.from_dict(ns_instance_config_dict
)
3008 ns_instance_config
.nsd
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_Nsd()
3009 ns_instance_config
.nsd
.from_dict(nsd_copy
.msg
.as_dict())
3011 payload_dict
= ns_instance_config
.to_json(self
._model
)
3012 #xml = ns_instance_config.to_xml_v2(self._model)
3013 #netconf_xml = self.wrap_netconf_config_xml(xml)
3015 #self._log.debug("Sending configure ns-instance-config xml to %s: %s",
3016 # netconf_xml, NsrRpcDtsHandler.NETCONF_IP_ADDRESS)
3017 self
._log
.debug("Sending configure ns-instance-config json to %s: %s",
3018 self
._nsr
_config
_url
,ns_instance_config
)
3020 #response = yield from self._manager.edit_config(
3022 # config=netconf_xml,
3024 response
= yield from self
._loop
.run_in_executor(
3026 self
._apply
_ns
_instance
_config
,
3029 response
.raise_for_status()
3030 self
._log
.debug("Received edit config response: %s", response
.json())
3032 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
,
3033 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
,
3035 except Exception as e
:
3036 self
._log
.error("Exception processing the "
3037 "start-network-service: {}".format(e
))
3038 self
._log
.exception(e
)
3039 xact_info
.respond_xpath(rwdts
.XactRspCode
.NACK
,
3040 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
)
3043 hdl_ns
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_ns_config_prepare
,)
3045 with self
._dts
.group_create() as group
:
3046 self
._ns
_regh
= group
.register(xpath
=NsrRpcDtsHandler
.EXEC_NSR_CONF_XPATH
,
3048 flags
=rwdts
.Flag
.PUBLISHER
,
3052 class NsrDtsHandler(object):
3053 """ The network service DTS handler """
3054 NSR_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr"
3055 SCALE_INSTANCE_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group/nsr:instance"
3057 def __init__(self
, dts
, log
, loop
, nsm
):
3063 self
._nsr
_regh
= None
3064 self
._scale
_regh
= None
3068 """ Return the NS manager instance """
3073 """ Register for Nsr create/update/delete/read requests from dts """
3075 def nsr_id_from_keyspec(ks
):
3076 nsr_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.schema().keyspec_to_entry(ks
)
3077 nsr_id
= nsr_path_entry
.key00
.id
3080 def group_name_from_keyspec(ks
):
3081 group_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
.schema().keyspec_to_entry(ks
)
3082 group_name
= group_path_entry
.key00
.scaling_group_name_ref
3085 def is_instance_in_reg_elements(nsr_id
, group_name
, instance_id
):
3086 """ Return boolean indicating if scaling group instance was already commited previously.
3088 By looking at the existing elements in this registration handle (elements not part
3089 of this current xact), we can tell if the instance was configured previously without
3090 keeping any application state.
3092 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3093 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3094 elem_group_name
= group_name_from_keyspec(keyspec
)
3096 if elem_nsr_id
!= nsr_id
or group_name
!= elem_group_name
:
3099 if instance_cfg
.id == instance_id
:
3104 def get_scale_group_instance_delta(nsr_id
, group_name
, xact
):
3105 delta
= {"added": [], "deleted": []}
3106 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3107 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3108 if elem_nsr_id
!= nsr_id
:
3111 elem_group_name
= group_name_from_keyspec(keyspec
)
3112 if elem_group_name
!= group_name
:
3115 delta
["added"].append(instance_cfg
.id)
3117 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(include_keyspec
=True):
3118 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3119 if elem_nsr_id
!= nsr_id
:
3122 elem_group_name
= group_name_from_keyspec(keyspec
)
3123 if elem_group_name
!= group_name
:
3126 if instance_cfg
.id in delta
["added"]:
3127 delta
["added"].remove(instance_cfg
.id)
3129 delta
["deleted"].append(instance_cfg
.id)
3134 def update_nsr_nsd(nsr_id
, xact
, scratch
):
3137 def get_nsr_vl_delta(nsr_id
, xact
, scratch
):
3138 delta
= {"added": [], "deleted": []}
3139 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3140 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3141 if elem_nsr_id
!= nsr_id
:
3144 if 'vld' in instance_cfg
.nsd
:
3145 for vld
in instance_cfg
.nsd
.vld
:
3146 delta
["added"].append(vld
)
3148 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3149 self
._log
.debug("NSR update: %s", instance_cfg
)
3150 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3151 if elem_nsr_id
!= nsr_id
:
3154 if 'vld' in instance_cfg
.nsd
:
3155 for vld
in instance_cfg
.nsd
.vld
:
3156 if vld
in delta
["added"]:
3157 delta
["added"].remove(vld
)
3159 delta
["deleted"].append(vld
)
3163 vl_delta
= yield from get_nsr_vl_delta(nsr_id
, xact
, scratch
)
3164 self
._log
.debug("Got NSR:%s VL instance delta: %s", nsr_id
, vl_delta
)
3166 for vld
in vl_delta
["added"]:
3167 yield from self
._nsm
.nsr_instantiate_vl(nsr_id
, vld
)
3169 for vld
in vl_delta
["deleted"]:
3170 yield from self
._nsm
.nsr_terminate_vl(nsr_id
, vld
)
3172 def get_add_delete_update_cfgs(dts_member_reg
, xact
, key_name
, scratch
):
3173 # Unfortunately, it is currently difficult to figure out what has exactly
3174 # changed in this xact without Pbdelta support (RIFT-4916)
3175 # As a workaround, we can fetch the pre and post xact elements and
3176 # perform a comparison to figure out adds/deletes/updates
3177 xact_cfgs
= list(dts_member_reg
.get_xact_elements(xact
))
3178 curr_cfgs
= list(dts_member_reg
.elements
)
3180 xact_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in xact_cfgs
}
3181 curr_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in curr_cfgs
}
3184 added_keys
= set(xact_key_map
) - set(curr_key_map
)
3185 added_cfgs
= [xact_key_map
[key
] for key
in added_keys
]
3188 deleted_keys
= set(curr_key_map
) - set(xact_key_map
)
3189 deleted_cfgs
= [curr_key_map
[key
] for key
in deleted_keys
]
3192 updated_keys
= set(curr_key_map
) & set(xact_key_map
)
3193 updated_cfgs
= [xact_key_map
[key
] for key
in updated_keys
3194 if xact_key_map
[key
] != curr_key_map
[key
]]
3196 return added_cfgs
, deleted_cfgs
, updated_cfgs
3198 def on_apply(dts
, acg
, xact
, action
, scratch
):
3199 """Apply the configuration"""
3200 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3201 xact
, action
, scratch
)
3203 def handle_create_nsr(msg
, restart_mode
=False):
3204 # Handle create nsr requests """
3205 # Do some validations
3206 if not msg
.has_field("nsd"):
3207 err
= "NSD not provided"
3208 self
._log
.error(err
)
3209 raise NetworkServiceRecordError(err
)
3211 self
._log
.debug("Creating NetworkServiceRecord %s from nsr config %s",
3212 msg
.id, msg
.as_dict())
3213 nsr
= self
.nsm
.create_nsr(msg
, restart_mode
=restart_mode
)
3216 def handle_delete_nsr(msg
):
3218 def delete_instantiation(ns_id
):
3219 """ Delete instantiation """
3220 with self
._dts
.transaction() as xact
:
3221 yield from self
._nsm
.terminate_ns(ns_id
, xact
)
3223 # Handle delete NSR requests
3224 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3225 # Terminate the NSR instance
3226 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3228 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3229 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3230 nsr
.record_event("terminate-rcvd", event_descr
)
3232 self
._loop
.create_task(delete_instantiation(msg
.id))
3235 def begin_instantiation(nsr
):
3236 # Begin instantiation
3237 self
._log
.info("Beginning NS instantiation: %s", nsr
.id)
3238 yield from self
._nsm
.instantiate_ns(nsr
.id, xact
)
3240 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3241 xact
, action
, scratch
)
3243 if action
== rwdts
.AppconfAction
.INSTALL
and xact
.id is None:
3244 for element
in self
._nsr
_regh
.elements
:
3245 nsr
= handle_create_nsr(element
, restart_mode
=True)
3246 self
._loop
.create_task(begin_instantiation(nsr
))
3249 (added_msgs
, deleted_msgs
, updated_msgs
) = get_add_delete_update_cfgs(self
._nsr
_regh
,
3253 self
._log
.debug("Added: %s, Deleted: %s, Updated: %s", added_msgs
,
3254 deleted_msgs
, updated_msgs
)
3256 for msg
in added_msgs
:
3257 if msg
.id not in self
._nsm
.nsrs
:
3258 self
._log
.info("Create NSR received in on_apply to instantiate NS:%s", msg
.id)
3259 nsr
= handle_create_nsr(msg
)
3260 self
._loop
.create_task(begin_instantiation(nsr
))
3262 for msg
in deleted_msgs
:
3263 self
._log
.info("Delete NSR received in on_apply to terminate NS:%s", msg
.id)
3265 handle_delete_nsr(msg
)
3267 self
._log
.exception("Failed to terminate NS:%s", msg
.id)
3269 for msg
in updated_msgs
:
3270 self
._log
.info("Update NSR received in on_apply: %s", msg
)
3272 self
._nsm
.nsr_update_cfg(msg
.id, msg
)
3275 self
._loop
.create_task(update_nsr_nsd(msg
.id, xact
, scratch
))
3277 for group
in msg
.scaling_group
:
3278 instance_delta
= get_scale_group_instance_delta(msg
.id, group
.scaling_group_name_ref
, xact
)
3279 self
._log
.debug("Got NSR:%s scale group instance delta: %s", msg
.id, instance_delta
)
3281 for instance_id
in instance_delta
["added"]:
3282 self
._nsm
.scale_nsr_out(msg
.id, group
.scaling_group_name_ref
, instance_id
, xact
)
3284 for instance_id
in instance_delta
["deleted"]:
3285 self
._nsm
.scale_nsr_in(msg
.id, group
.scaling_group_name_ref
, instance_id
)
3288 return RwTypes
.RwStatus
.SUCCESS
3291 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
3292 """ Prepare calllback from DTS for NSR """
3294 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3295 action
= xact_info
.query_action
3297 "Got Nsr prepare callback (xact: %s) (action: %s) (info: %s), %s:%s)",
3298 xact
, action
, xact_info
, xpath
, msg
3302 def delete_instantiation(ns_id
):
3303 """ Delete instantiation """
3304 yield from self
._nsm
.terminate_ns(ns_id
, None)
3306 def handle_delete_nsr():
3307 """ Handle delete NSR requests """
3308 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3309 # Terminate the NSR instance
3310 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3312 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3313 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3314 nsr
.record_event("terminate-rcvd", event_descr
)
3316 self
._loop
.create_task(delete_instantiation(msg
.id))
3318 fref
= ProtobufC
.FieldReference
.alloc()
3319 fref
.goto_whole_message(msg
.to_pbcm())
3321 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
, rwdts
.QueryAction
.DELETE
]:
3322 # if this is an NSR create
3323 if action
!= rwdts
.QueryAction
.DELETE
and msg
.id not in self
._nsm
.nsrs
:
3324 # Ensure the Cloud account/datacenter has been specified
3325 if not msg
.has_field("cloud_account") and not msg
.has_field("om_datacenter"):
3326 raise NsrInstantiationFailed("Cloud account or datacenter not specified in NSR")
3328 # Check if nsd is specified
3329 if not msg
.has_field("nsd"):
3330 raise NsrInstantiationFailed("NSD not specified in NSR")
3333 nsr
= self
._nsm
.nsrs
[msg
.id]
3335 if msg
.has_field("nsd"):
3336 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3337 raise NsrVlUpdateError("Unable to update VL when NSR not in running state")
3338 if 'vld' not in msg
.nsd
or len(msg
.nsd
.vld
) == 0:
3339 raise NsrVlUpdateError("NS config NSD should have atleast 1 VLD defined")
3341 if msg
.has_field("scaling_group"):
3342 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3343 raise ScalingOperationError("Unable to perform scaling action when NS is not in running state")
3345 if len(msg
.scaling_group
) > 1:
3346 raise ScalingOperationError("Only a single scaling group can be configured at a time")
3348 for group_msg
in msg
.scaling_group
:
3349 num_new_group_instances
= len(group_msg
.instance
)
3350 if num_new_group_instances
> 1:
3351 raise ScalingOperationError("Only a single scaling instance can be modified at a time")
3353 elif num_new_group_instances
== 1:
3354 scale_group
= nsr
.scaling_groups
[group_msg
.scaling_group_name_ref
]
3355 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
]:
3356 if len(scale_group
.instances
) == scale_group
.max_instance_count
:
3357 raise ScalingOperationError("Max instances for %s reached" % scale_group
)
3359 acg
.handle
.prepare_complete_ok(xact_info
.handle
)
3362 self
._log
.debug("Registering for NSR config using xpath: %s",
3363 NsrDtsHandler
.NSR_XPATH
)
3365 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
3366 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
3367 self
._nsr
_regh
= acg
.register(xpath
=NsrDtsHandler
.NSR_XPATH
,
3368 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
3369 on_prepare
=on_prepare
)
3371 self
._scale
_regh
= acg
.register(
3372 xpath
=NsrDtsHandler
.SCALE_INSTANCE_XPATH
,
3373 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY| rwdts
.Flag
.CACHE
,
3377 class NsrOpDataDtsHandler(object):
3378 """ The network service op data DTS handler """
3379 XPATH
= "D,/nsr:ns-instance-opdata/nsr:nsr"
3381 def __init__(self
, dts
, log
, loop
, nsm
):
3390 """ Return the registration handle"""
3395 """ Return the NS manager instance """
3400 """ Register for Nsr op data publisher registration"""
3401 self
._log
.debug("Registering Nsr op data path %s as publisher",
3402 NsrOpDataDtsHandler
.XPATH
)
3404 hdl
= rift
.tasklets
.DTS
.RegistrationHandler()
3405 handlers
= rift
.tasklets
.Group
.Handler()
3406 with self
._dts
.group_create(handler
=handlers
) as group
:
3407 self
._regh
= group
.register(xpath
=NsrOpDataDtsHandler
.XPATH
,
3409 flags
=rwdts
.Flag
.PUBLISHER | rwdts
.Flag
.NO_PREP_READ | rwdts
.Flag
.DATASTORE
)
3412 def create(self
, path
, msg
):
3414 Create an NS record in DTS with the path and message
3416 self
._log
.debug("Creating NSR %s:%s", path
, msg
)
3417 self
.regh
.create_element(path
, msg
)
3418 self
._log
.debug("Created NSR, %s:%s", path
, msg
)
3421 def update(self
, path
, msg
, flags
=rwdts
.XactFlag
.REPLACE
):
3423 Update an NS record in DTS with the path and message
3425 self
._log
.debug("Updating NSR, %s:%s regh = %s", path
, msg
, self
.regh
)
3426 self
.regh
.update_element(path
, msg
, flags
)
3427 self
._log
.debug("Updated NSR, %s:%s", path
, msg
)
3430 def delete(self
, path
):
3432 Update an NS record in DTS with the path and message
3434 self
._log
.debug("Deleting NSR path:%s", path
)
3435 self
.regh
.delete_element(path
)
3436 self
._log
.debug("Deleted NSR path:%s", path
)
3439 class VnfrDtsHandler(object):
3440 """ The virtual network service DTS handler """
3441 XPATH
= "D,/vnfr:vnfr-catalog/vnfr:vnfr"
3443 def __init__(self
, dts
, log
, loop
, nsm
):
3453 """ Return registration handle """
3458 """ Return the NS manager instance """
3463 """ Register for vnfr create/update/delete/ advises from dts """
3465 def on_commit(xact_info
):
3466 """ The transaction has been committed """
3467 self
._log
.debug("Got vnfr commit (xact_info: %s)", xact_info
)
3468 return rwdts
.MemberRspCode
.ACTION_OK
3471 def on_prepare(xact_info
, action
, ks_path
, msg
):
3472 """ prepare callback from dts """
3473 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3475 "Got vnfr on_prepare cb (xact_info: %s, action: %s): %s:%s",
3476 xact_info
, action
, ks_path
, msg
3479 schema
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr
.schema()
3480 path_entry
= schema
.keyspec_to_entry(ks_path
)
3481 if path_entry
.key00
.id not in self
._nsm
._vnfrs
:
3482 self
._log
.error("%s request for non existent record path %s",
3484 xact_info
.respond_xpath(rwdts
.XactRspCode
.NA
, xpath
)
3488 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3489 if action
== rwdts
.QueryAction
.CREATE
or action
== rwdts
.QueryAction
.UPDATE
:
3490 yield from self
._nsm
.update_vnfr(msg
)
3491 elif action
== rwdts
.QueryAction
.DELETE
:
3492 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3493 self
._nsm
.delete_vnfr(path_entry
.key00
.id)
3495 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
, xpath
)
3497 self
._log
.debug("Registering for VNFR using xpath: %s",
3498 VnfrDtsHandler
.XPATH
,)
3500 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_commit
=on_commit
,
3501 on_prepare
=on_prepare
,)
3502 with self
._dts
.group_create() as group
:
3503 self
._regh
= group
.register(xpath
=VnfrDtsHandler
.XPATH
,
3505 flags
=(rwdts
.Flag
.SUBSCRIBER
),)
3508 class NsdRefCountDtsHandler(object):
3509 """ The NSD Ref Count DTS handler """
3510 XPATH
= "D,/nsr:ns-instance-opdata/rw-nsr:nsd-ref-count"
3512 def __init__(self
, dts
, log
, loop
, nsm
):
3522 """ Return registration handle """
3527 """ Return the NS manager instance """
3532 """ Register for NSD ref count read from dts """
3535 def on_prepare(xact_info
, action
, ks_path
, msg
):
3536 """ prepare callback from dts """
3537 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3539 if action
== rwdts
.QueryAction
.READ
:
3540 schema
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount
.schema()
3541 path_entry
= schema
.keyspec_to_entry(ks_path
)
3542 nsd_list
= yield from self
._nsm
.get_nsd_refcount(path_entry
.key00
.nsd_id_ref
)
3543 for xpath
, msg
in nsd_list
:
3544 xact_info
.respond_xpath(rsp_code
=rwdts
.XactRspCode
.MORE
,
3547 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
3549 raise NetworkServiceRecordError("Not supported operation %s" % action
)
3551 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_prepare
,)
3552 with self
._dts
.group_create() as group
:
3553 self
._regh
= group
.register(xpath
=NsdRefCountDtsHandler
.XPATH
,
3555 flags
=rwdts
.Flag
.PUBLISHER
,)
3558 class NsManager(object):
3559 """ The Network Service Manager class"""
3560 def __init__(self
, dts
, log
, loop
,
3561 nsr_handler
, vnfr_handler
, vlr_handler
, ro_plugin_selector
,
3562 vnffgmgr
, vnfd_pub_handler
, cloud_account_handler
):
3566 self
._nsr
_handler
= nsr_handler
3567 self
._vnfr
_pub
_handler
= vnfr_handler
3568 self
._vlr
_pub
_handler
= vlr_handler
3569 self
._vnffgmgr
= vnffgmgr
3570 self
._vnfd
_pub
_handler
= vnfd_pub_handler
3571 self
._cloud
_account
_handler
= cloud_account_handler
3573 self
._ro
_plugin
_selector
= ro_plugin_selector
3574 self
._ncclient
= rift
.mano
.ncclient
.NcClient(
3586 self
.cfgmgr_obj
= conman
.ROConfigManager(log
, loop
, dts
, self
)
3588 # TODO: All these handlers should move to tasklet level.
3589 # Passing self is often an indication of bad design
3590 self
._nsd
_dts
_handler
= NsdDtsHandler(dts
, log
, loop
, self
)
3591 self
._vnfd
_dts
_handler
= VnfdDtsHandler(dts
, log
, loop
, self
)
3592 self
._dts
_handlers
= [self
._nsd
_dts
_handler
,
3593 VnfrDtsHandler(dts
, log
, loop
, self
),
3594 NsdRefCountDtsHandler(dts
, log
, loop
, self
),
3595 NsrDtsHandler(dts
, log
, loop
, self
),
3596 ScalingRpcHandler(log
, dts
, loop
, self
.scale_rpc_callback
),
3597 NsrRpcDtsHandler(dts
,log
,loop
,self
),
3598 self
._vnfd
_dts
_handler
,
3619 def nsr_handler(self
):
3620 """" NSR handler """
3621 return self
._nsr
_handler
3625 """" So Obj handler """
3630 """ NSRs in this NSM"""
3635 """ NSDs in this NSM"""
3640 """ VNFDs in this NSM"""
3645 """ VNFRs in this NSM"""
3649 def nsr_pub_handler(self
):
3650 """ NSR publication handler """
3651 return self
._nsr
_handler
3654 def vnfr_pub_handler(self
):
3655 """ VNFR publication handler """
3656 return self
._vnfr
_pub
_handler
3659 def vlr_pub_handler(self
):
3660 """ VLR publication handler """
3661 return self
._vlr
_pub
_handler
3664 def vnfd_pub_handler(self
):
3665 return self
._vnfd
_pub
_handler
3669 """ Register all static DTS handlers """
3670 for dts_handle
in self
._dts
_handlers
:
3671 yield from dts_handle
.register()
3674 def get_ns_by_nsr_id(self
, nsr_id
):
3675 """ get NSR by nsr id """
3676 if nsr_id
not in self
._nsrs
:
3677 raise NetworkServiceRecordError("NSR id %s not found" % nsr_id
)
3679 return self
._nsrs
[nsr_id
]
3681 def scale_nsr_out(self
, nsr_id
, scale_group_name
, instance_id
, config_xact
):
3682 self
.log
.debug("Scale out NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3687 nsr
= self
._nsrs
[nsr_id
]
3688 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3689 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3691 self
._loop
.create_task(nsr
.create_scale_group_instance(scale_group_name
, instance_id
, config_xact
))
3693 def scale_nsr_in(self
, nsr_id
, scale_group_name
, instance_id
):
3694 self
.log
.debug("Scale in NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3699 nsr
= self
._nsrs
[nsr_id
]
3700 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3701 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3703 self
._loop
.create_task(nsr
.delete_scale_group_instance(scale_group_name
, instance_id
))
3705 def scale_rpc_callback(self
, xact
, msg
, action
):
3706 """Callback handler for RPC calls
3708 xact : Transaction Handler
3710 action : Scaling Action
3712 ScalingGroupInstance
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup_Instance
3713 ScalingGroup
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
3715 xpath
= ('C,/nsr:ns-instance-config/nsr:nsr[nsr:id="{}"]').format(
3717 instance
= ScalingGroupInstance
.from_dict({"id": msg
.instance_id
})
3720 def get_nsr_scaling_group():
3721 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3723 for result
in results
:
3724 res
= yield from result
3725 nsr_config
= res
.result
3727 for scaling_group
in nsr_config
.scaling_group
:
3728 if scaling_group
.scaling_group_name_ref
== msg
.scaling_group_name_ref
:
3731 scaling_group
= nsr_config
.scaling_group
.add()
3732 scaling_group
.scaling_group_name_ref
= msg
.scaling_group_name_ref
3734 return (nsr_config
, scaling_group
)
3737 def update_config(nsr_config
):
3738 xml
= self
._ncclient
.convert_to_xml(RwNsrYang
, nsr_config
)
3739 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
3740 yield from self
._ncclient
.connect()
3741 yield from self
._ncclient
.manager
.edit_config(target
="running", config
=xml
, default_operation
="replace")
3745 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3746 scaling_group
.instance
.append(instance
)
3747 yield from update_config(nsr_config
)
3751 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3752 scaling_group
.instance
.remove(instance
)
3753 yield from update_config(nsr_config
)
3755 if action
== ScalingRpcHandler
.ACTION
.SCALE_OUT
:
3756 self
._loop
.create_task(scale_out())
3758 self
._loop
.create_task(scale_in())
3760 # Opdata based calls, disabled for now!
3761 # if action == ScalingRpcHandler.ACTION.SCALE_OUT:
3762 # self.scale_nsr_out(
3764 # msg.scaling_group_name_ref,
3768 # self.scale_nsr_in(
3770 # msg.scaling_group_name_ref,
3773 def nsr_update_cfg(self
, nsr_id
, msg
):
3774 nsr
= self
._nsrs
[nsr_id
]
3775 nsr
.nsr_cfg_msg
= msg
3777 def nsr_instantiate_vl(self
, nsr_id
, vld
):
3778 self
.log
.debug("NSR {} create VL {}".format(nsr_id
, vld
))
3779 nsr
= self
._nsrs
[nsr_id
]
3780 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3781 raise NsrVlUpdateError("Cannot perform VL instantiate if NSR is not in running state")
3783 # Not calling in a separate task as this is called from a separate task
3784 yield from nsr
.create_vl_instance(vld
)
3786 def nsr_terminate_vl(self
, nsr_id
, vld
):
3787 self
.log
.debug("NSR {} delete VL {}".format(nsr_id
, vld
.id))
3788 nsr
= self
._nsrs
[nsr_id
]
3789 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3790 raise NsrVlUpdateError("Cannot perform VL terminate if NSR is not in running state")
3792 # Not calling in a separate task as this is called from a separate task
3793 yield from nsr
.delete_vl_instance(vld
)
3795 def create_nsr(self
, nsr_msg
, restart_mode
=False):
3796 """ Create an NSR instance """
3797 if nsr_msg
.id in self
._nsrs
:
3798 msg
= "NSR id %s already exists" % nsr_msg
.id
3799 self
._log
.error(msg
)
3800 raise NetworkServiceRecordError(msg
)
3802 self
._log
.info("Create NetworkServiceRecord nsr id %s from nsd_id %s",
3806 nsm_plugin
= self
._ro
_plugin
_selector
.ro_plugin
3807 sdn_account_name
= self
._cloud
_account
_handler
.get_cloud_account_sdn_name(nsr_msg
.cloud_account
)
3809 nsr
= NetworkServiceRecord(self
._dts
,
3816 restart_mode
=restart_mode
3818 self
._nsrs
[nsr_msg
.id] = nsr
3819 nsm_plugin
.create_nsr(nsr_msg
, nsr_msg
.nsd
)
3823 def delete_nsr(self
, nsr_id
):
3825 Delete NSR with the passed nsr id
3827 del self
._nsrs
[nsr_id
]
3830 def instantiate_ns(self
, nsr_id
, config_xact
):
3831 """ Instantiate an NS instance """
3832 self
._log
.debug("Instantiating Network service id %s", nsr_id
)
3833 if nsr_id
not in self
._nsrs
:
3834 err
= "NSR id %s not found " % nsr_id
3835 self
._log
.error(err
)
3836 raise NetworkServiceRecordError(err
)
3838 nsr
= self
._nsrs
[nsr_id
]
3839 yield from nsr
.nsm_plugin
.instantiate_ns(nsr
, config_xact
)
3842 def update_vnfr(self
, vnfr
):
3843 """Create/Update an VNFR """
3845 vnfr_state
= self
._vnfrs
[vnfr
.id].state
3846 self
._log
.debug("Updating VNFR with state %s: vnfr %s", vnfr_state
, vnfr
)
3848 yield from self
._vnfrs
[vnfr
.id].update_state(vnfr
)
3849 nsr
= self
.find_nsr_for_vnfr(vnfr
.id)
3850 yield from nsr
.update_state()
3852 def find_nsr_for_vnfr(self
, vnfr_id
):
3853 """ Find the NSR which )has the passed vnfr id"""
3854 for nsr
in list(self
.nsrs
.values()):
3855 for vnfr
in list(nsr
.vnfrs
.values()):
3856 if vnfr
.id == vnfr_id
:
3860 def delete_vnfr(self
, vnfr_id
):
3861 """ Delete VNFR with the passed id"""
3862 del self
._vnfrs
[vnfr_id
]
3864 def get_nsd_ref(self
, nsd_id
):
3865 """ Get network service descriptor for the passed nsd_id
3867 nsd
= self
.get_nsd(nsd_id
)
3872 def get_nsr_config(self
, nsd_id
):
3873 xpath
= "C,/nsr:ns-instance-config"
3874 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3876 for result
in results
:
3877 entry
= yield from result
3878 ns_instance_config
= entry
.result
3880 for nsr
in ns_instance_config
.nsr
:
3881 if nsr
.nsd
.id == nsd_id
:
3887 def nsd_unref_by_nsr_id(self
, nsr_id
):
3888 """ Unref the network service descriptor based on NSR id """
3889 self
._log
.debug("NSR Unref called for Nsr Id:%s", nsr_id
)
3890 if nsr_id
in self
._nsrs
:
3891 nsr
= self
._nsrs
[nsr_id
]
3894 nsd
= self
.get_nsd(nsr
.nsd_id
)
3895 self
._log
.debug("Releasing ref on NSD %s held by NSR %s - Curr %d",
3896 nsd
.id, nsr
.id, nsd
.ref_count
)
3898 except NetworkServiceDescriptorError
:
3899 # We store a copy of NSD in NSR and the NSD in nsd-catalog
3904 self
._log
.error("Cannot find NSR with id %s", nsr_id
)
3905 raise NetworkServiceDescriptorUnrefError("No NSR with id" % nsr_id
)
3908 def nsd_unref(self
, nsd_id
):
3909 """ Unref the network service descriptor associated with the id """
3910 nsd
= self
.get_nsd(nsd_id
)
3913 def get_nsd(self
, nsd_id
):
3914 """ Get network service descriptor for the passed nsd_id"""
3915 if nsd_id
not in self
._nsds
:
3916 self
._log
.error("Cannot find NSD id:%s", nsd_id
)
3917 raise NetworkServiceDescriptorError("Cannot find NSD id:%s", nsd_id
)
3919 return self
._nsds
[nsd_id
]
3921 def create_nsd(self
, nsd_msg
):
3922 """ Create a network service descriptor """
3923 self
._log
.debug("Create network service descriptor - %s", nsd_msg
)
3924 if nsd_msg
.id in self
._nsds
:
3925 self
._log
.error("Cannot create NSD %s -NSD ID already exists", nsd_msg
)
3926 raise NetworkServiceDescriptorError("NSD already exists-%s", nsd_msg
.id)
3928 nsd
= NetworkServiceDescriptor(
3935 self
._nsds
[nsd_msg
.id] = nsd
3939 def update_nsd(self
, nsd
):
3940 """ update the Network service descriptor """
3941 self
._log
.debug("Update network service descriptor - %s", nsd
)
3942 if nsd
.id not in self
._nsds
:
3943 self
._log
.debug("No NSD found - creating NSD id = %s", nsd
.id)
3944 self
.create_nsd(nsd
)
3946 self
._log
.debug("Updating NSD id = %s, nsd = %s", nsd
.id, nsd
)
3947 self
._nsds
[nsd
.id].update(nsd
)
3949 def delete_nsd(self
, nsd_id
):
3950 """ Delete the Network service descriptor with the passed id """
3951 self
._log
.debug("Deleting the network service descriptor - %s", nsd_id
)
3952 if nsd_id
not in self
._nsds
:
3953 self
._log
.debug("Delete NSD failed - cannot find nsd-id %s", nsd_id
)
3954 raise NetworkServiceDescriptorNotFound("Cannot find %s", nsd_id
)
3956 if nsd_id
not in self
._nsds
:
3957 self
._log
.debug("Cannot delete NSD id %s reference exists %s",
3959 self
._nsds
[nsd_id
].ref_count
)
3960 raise NetworkServiceDescriptorRefCountExists(
3961 "Cannot delete :%s, ref_count:%s",
3963 self
._nsds
[nsd_id
].ref_count
)
3965 del self
._nsds
[nsd_id
]
3967 def get_vnfd_config(self
, xact
):
3968 vnfd_dts_reg
= self
._vnfd
_dts
_handler
.regh
3969 for cfg
in vnfd_dts_reg
.get_xact_elements(xact
):
3970 if cfg
.id not in self
._vnfds
:
3971 self
.create_vnfd(cfg
)
3973 def get_vnfd(self
, vnfd_id
, xact
):
3974 """ Get virtual network function descriptor for the passed vnfd_id"""
3975 if vnfd_id
not in self
._vnfds
:
3976 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
3977 self
.get_vnfd_config(xact
)
3979 if vnfd_id
not in self
._vnfds
:
3980 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
3981 raise VnfDescriptorError("Cannot find VNFD id:%s", vnfd_id
)
3983 return self
._vnfds
[vnfd_id
]
3985 def create_vnfd(self
, vnfd
):
3986 """ Create a virtual network function descriptor """
3987 self
._log
.debug("Create virtual network function descriptor - %s", vnfd
)
3988 if vnfd
.id in self
._vnfds
:
3989 self
._log
.error("Cannot create VNFD %s -VNFD ID already exists", vnfd
)
3990 raise VnfDescriptorError("VNFD already exists-%s", vnfd
.id)
3992 self
._vnfds
[vnfd
.id] = vnfd
3993 return self
._vnfds
[vnfd
.id]
3995 def update_vnfd(self
, vnfd
):
3996 """ Update the virtual network function descriptor """
3997 self
._log
.debug("Update virtual network function descriptor- %s", vnfd
)
3999 # Hack to remove duplicates from leaf-lists - to be fixed by RIFT-6511
4000 for ivld
in vnfd
.internal_vld
:
4001 ivld
.internal_connection_point_ref
= list(set(ivld
.internal_connection_point_ref
))
4003 if vnfd
.id not in self
._vnfds
:
4004 self
._log
.debug("No VNFD found - creating VNFD id = %s", vnfd
.id)
4005 self
.create_vnfd(vnfd
)
4007 self
._log
.debug("Updating VNFD id = %s, vnfd = %s", vnfd
.id, vnfd
)
4008 self
._vnfds
[vnfd
.id] = vnfd
4011 def delete_vnfd(self
, vnfd_id
):
4012 """ Delete the virtual network function descriptor with the passed id """
4013 self
._log
.debug("Deleting the virtual network function descriptor - %s", vnfd_id
)
4014 if vnfd_id
not in self
._vnfds
:
4015 self
._log
.debug("Delete VNFD failed - cannot find vnfd-id %s", vnfd_id
)
4016 raise VnfDescriptorError("Cannot find %s", vnfd_id
)
4018 del self
._vnfds
[vnfd_id
]
4020 def nsd_in_use(self
, nsd_id
):
4021 """ Is the NSD with the passed id in use """
4022 self
._log
.debug("Is this NSD in use - msg:%s", nsd_id
)
4023 if nsd_id
in self
._nsds
:
4024 return self
._nsds
[nsd_id
].in_use()
4028 def publish_nsr(self
, xact
, path
, msg
):
4029 """ Publish a NSR """
4030 self
._log
.debug("Publish NSR with path %s, msg %s",
4032 yield from self
.nsr_handler
.update(xact
, path
, msg
)
4035 def unpublish_nsr(self
, xact
, path
):
4036 """ Un Publish an NSR """
4037 self
._log
.debug("Publishing delete NSR with path %s", path
)
4038 yield from self
.nsr_handler
.delete(path
, xact
)
4040 def vnfr_is_ready(self
, vnfr_id
):
4041 """ VNFR with the id is ready """
4042 self
._log
.debug("VNFR id %s ready", vnfr_id
)
4043 if vnfr_id
not in self
._vnfds
:
4044 err
= "Did not find VNFR ID with id %s" % vnfr_id
4045 self
._log
.critical("err")
4046 raise VirtualNetworkFunctionRecordError(err
)
4047 self
._vnfrs
[vnfr_id
].is_ready()
4050 def get_nsd_refcount(self
, nsd_id
):
4051 """ Get the nsd_list from this NSM"""
4053 def nsd_refcount_xpath(nsd_id
):
4054 """ xpath for ref count entry """
4055 return (NsdRefCountDtsHandler
.XPATH
+
4056 "[rw-nsr:nsd-id-ref = '{}']").format(nsd_id
)
4059 if nsd_id
is None or nsd_id
== "":
4060 for nsd
in self
._nsds
.values():
4061 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4062 nsd_msg
.nsd_id_ref
= nsd
.id
4063 nsd_msg
.instance_ref_count
= nsd
.ref_count
4064 nsd_list
.append((nsd_refcount_xpath(nsd
.id), nsd_msg
))
4065 elif nsd_id
in self
._nsds
:
4066 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4067 nsd_msg
.nsd_id_ref
= self
._nsds
[nsd_id
].id
4068 nsd_msg
.instance_ref_count
= self
._nsds
[nsd_id
].ref_count
4069 nsd_list
.append((nsd_refcount_xpath(nsd_id
), nsd_msg
))
4074 def terminate_ns(self
, nsr_id
, xact
):
4076 Terminate network service for the given NSR Id
4079 # Terminate the instances/networks assocaited with this nw service
4080 self
._log
.debug("Terminating the network service %s", nsr_id
)
4081 yield from self
._nsrs
[nsr_id
].terminate()
4084 yield from self
.nsd_unref_by_nsr_id(nsr_id
)
4086 # Unpublish the NSR record
4087 self
._log
.debug("Unpublishing the network service %s", nsr_id
)
4088 yield from self
._nsrs
[nsr_id
].unpublish(xact
)
4090 # Finaly delete the NS instance from this NS Manager
4091 self
._log
.debug("Deletng the network service %s", nsr_id
)
4092 self
.delete_nsr(nsr_id
)
4095 class NsmRecordsPublisherProxy(object):
4096 """ This class provides a publisher interface that allows plugin objects
4097 to publish NSR/VNFR/VLR"""
4099 def __init__(self
, dts
, log
, loop
, nsr_pub_hdlr
, vnfr_pub_hdlr
, vlr_pub_hdlr
):
4103 self
._nsr
_pub
_hdlr
= nsr_pub_hdlr
4104 self
._vlr
_pub
_hdlr
= vlr_pub_hdlr
4105 self
._vnfr
_pub
_hdlr
= vnfr_pub_hdlr
4108 def publish_nsr(self
, xact
, nsr
):
4109 """ Publish an NSR """
4110 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4111 return (yield from self
._nsr
_pub
_hdlr
.update(xact
, path
, nsr
))
4114 def unpublish_nsr(self
, xact
, nsr
):
4115 """ Unpublish an NSR """
4116 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4117 return (yield from self
._nsr
_pub
_hdlr
.delete(xact
, path
))
4120 def publish_vnfr(self
, xact
, vnfr
):
4121 """ Publish an VNFR """
4122 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4123 return (yield from self
._vnfr
_pub
_hdlr
.update(xact
, path
, vnfr
))
4126 def unpublish_vnfr(self
, xact
, vnfr
):
4127 """ Unpublish a VNFR """
4128 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4129 return (yield from self
._vnfr
_pub
_hdlr
.delete(xact
, path
))
4132 def publish_vlr(self
, xact
, vlr
):
4133 """ Publish a VLR """
4134 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4135 return (yield from self
._vlr
_pub
_hdlr
.update(xact
, path
, vlr
))
4138 def unpublish_vlr(self
, xact
, vlr
):
4139 """ Unpublish a VLR """
4140 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4141 return (yield from self
._vlr
_pub
_hdlr
.delete(xact
, path
))
4144 class ScalingRpcHandler(mano_dts
.DtsHandler
):
4145 """ The Network service Monitor DTS handler """
4146 SCALE_IN_INPUT_XPATH
= "I,/nsr:exec-scale-in"
4147 SCALE_IN_OUTPUT_XPATH
= "O,/nsr:exec-scale-in"
4149 SCALE_OUT_INPUT_XPATH
= "I,/nsr:exec-scale-out"
4150 SCALE_OUT_OUTPUT_XPATH
= "O,/nsr:exec-scale-out"
4152 ACTION
= Enum('ACTION', 'SCALE_IN SCALE_OUT')
4154 def __init__(self
, log
, dts
, loop
, callback
=None):
4155 super().__init
__(log
, dts
, loop
)
4156 self
.callback
= callback
4157 self
.last_instance_id
= defaultdict(int)
4163 def on_scale_in_prepare(xact_info
, action
, ks_path
, msg
):
4164 assert action
== rwdts
.QueryAction
.RPC
4168 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_IN
)
4170 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleIn
.from_dict({
4171 "instance_id": msg
.instance_id
})
4173 xact_info
.respond_xpath(
4174 rwdts
.XactRspCode
.ACK
,
4175 self
.__class
__.SCALE_IN_OUTPUT_XPATH
,
4178 except Exception as e
:
4179 self
.log
.exception(e
)
4180 xact_info
.respond_xpath(
4181 rwdts
.XactRspCode
.NACK
,
4182 self
.__class
__.SCALE_IN_OUTPUT_XPATH
)
4185 def on_scale_out_prepare(xact_info
, action
, ks_path
, msg
):
4186 assert action
== rwdts
.QueryAction
.RPC
4189 scaling_group
= msg
.scaling_group_name_ref
4190 if not msg
.instance_id
:
4191 last_instance_id
= self
.last_instance_id
[scale_group
]
4192 msg
.instance_id
= last_instance_id
+ 1
4193 self
.last_instance_id
[scale_group
] += 1
4196 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_OUT
)
4198 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleOut
.from_dict({
4199 "instance_id": msg
.instance_id
})
4201 xact_info
.respond_xpath(
4202 rwdts
.XactRspCode
.ACK
,
4203 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
,
4206 except Exception as e
:
4207 self
.log
.exception(e
)
4208 xact_info
.respond_xpath(
4209 rwdts
.XactRspCode
.NACK
,
4210 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
)
4212 scale_in_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4213 on_prepare
=on_scale_in_prepare
)
4214 scale_out_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4215 on_prepare
=on_scale_out_prepare
)
4217 with self
.dts
.group_create() as group
:
4219 xpath
=self
.__class
__.SCALE_IN_INPUT_XPATH
,
4220 handler
=scale_in_hdl
,
4221 flags
=rwdts
.Flag
.PUBLISHER
)
4223 xpath
=self
.__class
__.SCALE_OUT_INPUT_XPATH
,
4224 handler
=scale_out_hdl
,
4225 flags
=rwdts
.Flag
.PUBLISHER
)
4228 class NsmTasklet(rift
.tasklets
.Tasklet
):
4230 The network service manager tasklet
4232 def __init__(self
, *args
, **kwargs
):
4233 super(NsmTasklet
, self
).__init
__(*args
, **kwargs
)
4234 self
.rwlog
.set_category("rw-mano-log")
4235 self
.rwlog
.set_subcategory("nsm")
4240 self
._ro
_plugin
_selector
= None
4241 self
._vnffgmgr
= None
4243 self
._nsr
_handler
= None
4244 self
._vnfr
_pub
_handler
= None
4245 self
._vlr
_pub
_handler
= None
4246 self
._vnfd
_pub
_handler
= None
4247 self
._scale
_cfg
_handler
= None
4249 self
._records
_publisher
_proxy
= None
4252 """ The task start callback """
4253 super(NsmTasklet
, self
).start()
4254 self
.log
.info("Starting NsmTasklet")
4256 self
.log
.debug("Registering with dts")
4257 self
._dts
= rift
.tasklets
.DTS(self
.tasklet_info
,
4258 RwNsmYang
.get_schema(),
4260 self
.on_dts_state_change
)
4262 self
.log
.debug("Created DTS Api GI Object: %s", self
._dts
)
4268 print("Caught Exception in NSM stop:", sys
.exc_info()[0])
4271 def on_instance_started(self
):
4272 """ Task instance started callback """
4273 self
.log
.debug("Got instance started callback")
4277 """ Task init callback """
4278 self
.log
.debug("Got instance started callback")
4280 self
.log
.debug("creating config account handler")
4282 self
._nsr
_pub
_handler
= publisher
.NsrOpDataDtsHandler(self
._dts
, self
.log
, self
.loop
)
4283 yield from self
._nsr
_pub
_handler
.register()
4285 self
._vnfr
_pub
_handler
= publisher
.VnfrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4286 yield from self
._vnfr
_pub
_handler
.register()
4288 self
._vlr
_pub
_handler
= publisher
.VlrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4289 yield from self
._vlr
_pub
_handler
.register()
4291 manifest
= self
.tasklet_info
.get_pb_manifest()
4292 use_ssl
= manifest
.bootstrap_phase
.rwsecurity
.use_ssl
4293 ssl_cert
= manifest
.bootstrap_phase
.rwsecurity
.cert
4294 ssl_key
= manifest
.bootstrap_phase
.rwsecurity
.key
4296 self
._vnfd
_pub
_handler
= publisher
.VnfdPublisher(use_ssl
, ssl_cert
, ssl_key
, self
.loop
)
4298 self
._records
_publisher
_proxy
= NsmRecordsPublisherProxy(
4302 self
._nsr
_pub
_handler
,
4303 self
._vnfr
_pub
_handler
,
4304 self
._vlr
_pub
_handler
,
4307 # Register the NSM to receive the nsm plugin
4308 # when cloud account is configured
4309 self
._ro
_plugin
_selector
= cloud
.ROAccountPluginSelector(
4313 self
._records
_publisher
_proxy
,
4315 yield from self
._ro
_plugin
_selector
.register()
4317 self
._cloud
_account
_handler
= cloud
.CloudAccountConfigSubscriber(
4322 yield from self
._cloud
_account
_handler
.register()
4324 self
._vnffgmgr
= rwvnffgmgr
.VnffgMgr(self
._dts
, self
.log
, self
.log_hdl
, self
.loop
)
4325 yield from self
._vnffgmgr
.register()
4327 self
._nsm
= NsManager(
4331 self
._nsr
_pub
_handler
,
4332 self
._vnfr
_pub
_handler
,
4333 self
._vlr
_pub
_handler
,
4334 self
._ro
_plugin
_selector
,
4336 self
._vnfd
_pub
_handler
,
4337 self
._cloud
_account
_handler
4340 yield from self
._nsm
.register()
4344 """ Task run callback """
4348 def on_dts_state_change(self
, state
):
4349 """Take action according to current dts state to transition
4350 application into the corresponding application state
4353 state - current dts state
4356 rwdts
.State
.INIT
: rwdts
.State
.REGN_COMPLETE
,
4357 rwdts
.State
.CONFIG
: rwdts
.State
.RUN
,
4361 rwdts
.State
.INIT
: self
.init
,
4362 rwdts
.State
.RUN
: self
.run
,
4365 # Transition application to next state
4366 handler
= handlers
.get(state
, None)
4367 if handler
is not None:
4368 yield from handler()
4370 # Transition dts to next state
4371 next_state
= switch
.get(state
, None)
4372 if next_state
is not None:
4373 self
.log
.debug("Changing state to %s", next_state
)
4374 self
._dts
.handle
.set_state(next_state
)