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 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
224 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
225 "sdn_account": self
._sdn
_account
_name
,
226 "operational_status": 'init',
228 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
229 elif self
._vnffgr
_state
== VnffgRecordState
.TERMINATED
:
230 vnffgr_dict
= {"id": self
._vnffgr
_id
,
231 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
232 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
233 "sdn_account": self
._sdn
_account
_name
,
234 "operational_status": 'terminated',
236 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
239 vnffgr
= self
._vnffgmgr
.fetch_vnffgr(self
._vnffgr
_id
)
241 self
._log
.exception("Fetching VNFFGR for VNFFG with id %s failed", self
._vnffgr
_id
)
242 self
._vnffgr
_state
= VnffgRecordState
.FAILED
243 vnffgr_dict
= {"id": self
._vnffgr
_id
,
244 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
245 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
246 "sdn_account": self
._sdn
_account
_name
,
247 "operational_status": 'failed',
249 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
254 def vnffgr_create_msg(self
):
255 """ Virtual Link Record message for Creating VLR in VNS """
256 vnffgr_dict
= {"id": self
._vnffgr
_id
,
257 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
258 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
259 "sdn_account": self
._sdn
_account
_name
,
261 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
262 for rsp
in self
._vnffgd
_msg
.rsp
:
263 vnffgr_rsp
= vnffgr
.rsp
.add()
264 vnffgr_rsp
.id = str(uuid
.uuid4())
265 vnffgr_rsp
.name
= self
._nsr
.name
+ '.' + rsp
.name
266 self
._vnffgr
_rsp
_id
.append(vnffgr_rsp
.id)
267 vnffgr_rsp
.vnffgd_rsp_id_ref
= rsp
.id
268 vnffgr_rsp
.vnffgd_rsp_name_ref
= rsp
.name
269 for rsp_cp_ref
in rsp
.vnfd_connection_point_ref
:
270 vnfd
= [vnfr
.vnfd
for vnfr
in self
._nsr
.vnfrs
.values() if vnfr
.vnfd
.id == rsp_cp_ref
.vnfd_id_ref
]
271 self
._log
.debug("VNFD message during VNFFG instantiation is %s",vnfd
)
272 if len(vnfd
) > 0 and vnfd
[0].has_field('service_function_type'):
273 self
._log
.debug("Service Function Type for VNFD ID %s is %s",rsp_cp_ref
.vnfd_id_ref
, vnfd
[0].service_function_type
)
275 self
._log
.error("Service Function Type not available for VNFD ID %s; Skipping in chain",rsp_cp_ref
.vnfd_id_ref
)
278 vnfr_cp_ref
= vnffgr_rsp
.vnfr_connection_point_ref
.add()
279 vnfr_cp_ref
.member_vnf_index_ref
= rsp_cp_ref
.member_vnf_index_ref
280 vnfr_cp_ref
.hop_number
= rsp_cp_ref
.order
281 vnfr_cp_ref
.vnfd_id_ref
=rsp_cp_ref
.vnfd_id_ref
282 vnfr_cp_ref
.service_function_type
= vnfd
[0].service_function_type
283 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
284 if (nsr_vnfr
.vnfd
.id == vnfr_cp_ref
.vnfd_id_ref
and
285 nsr_vnfr
.member_vnf_index
== vnfr_cp_ref
.member_vnf_index_ref
):
286 vnfr_cp_ref
.vnfr_id_ref
= nsr_vnfr
.id
287 vnfr_cp_ref
.vnfr_name_ref
= nsr_vnfr
.name
288 vnfr_cp_ref
.vnfr_connection_point_ref
= rsp_cp_ref
.vnfd_connection_point_ref
290 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
291 self
._log
.debug(" Received VNFR is %s", vnfr
)
292 while vnfr
.operational_status
!= 'running':
293 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
294 if vnfr
.operational_status
== 'failed':
295 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
296 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
297 yield from asyncio
.sleep(2, loop
=self
._loop
)
298 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
299 self
._log
.debug("Received VNFR is %s", vnfr
)
301 vnfr_cp_ref
.connection_point_params
.mgmt_address
= vnfr
.mgmt_interface
.ip_address
302 for cp
in vnfr
.connection_point
:
303 if cp
.name
== vnfr_cp_ref
.vnfr_connection_point_ref
:
304 vnfr_cp_ref
.connection_point_params
.port_id
= cp
.connection_point_id
305 vnfr_cp_ref
.connection_point_params
.name
= self
._nsr
.name
+ '.' + cp
.name
306 for vdu
in vnfr
.vdur
:
307 for ext_intf
in vdu
.external_interface
:
308 if ext_intf
.name
== vnfr_cp_ref
.vnfr_connection_point_ref
:
309 vnfr_cp_ref
.connection_point_params
.vm_id
= vdu
.vim_id
310 self
._log
.debug("VIM ID for CP %s in VNFR %s is %s",cp
.name
,nsr_vnfr
.id,
311 vnfr_cp_ref
.connection_point_params
.vm_id
)
314 vnfr_cp_ref
.connection_point_params
.address
= cp
.ip_address
315 vnfr_cp_ref
.connection_point_params
.port
= VnffgRecord
.SFF_DP_PORT
317 for vnffgd_classifier
in self
._vnffgd
_msg
.classifier
:
318 _rsp
= [rsp
for rsp
in vnffgr
.rsp
if rsp
.vnffgd_rsp_id_ref
== vnffgd_classifier
.rsp_id_ref
]
320 rsp_id_ref
= _rsp
[0].id
321 rsp_name
= _rsp
[0].name
323 self
._log
.error("RSP with ID %s not found during classifier creation for classifier id %s",vnffgd_classifier
.rsp_id_ref
,vnffgd_classifier
.id)
325 vnffgr_classifier
= vnffgr
.classifier
.add()
326 vnffgr_classifier
.id = vnffgd_classifier
.id
327 vnffgr_classifier
.name
= self
._nsr
.name
+ '.' + vnffgd_classifier
.name
328 _rsp
[0].classifier_name
= vnffgr_classifier
.name
329 vnffgr_classifier
.rsp_id_ref
= rsp_id_ref
330 vnffgr_classifier
.rsp_name
= rsp_name
331 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
332 if (nsr_vnfr
.vnfd
.id == vnffgd_classifier
.vnfd_id_ref
and
333 nsr_vnfr
.member_vnf_index
== vnffgd_classifier
.member_vnf_index_ref
):
334 vnffgr_classifier
.vnfr_id_ref
= nsr_vnfr
.id
335 vnffgr_classifier
.vnfr_name_ref
= nsr_vnfr
.name
336 vnffgr_classifier
.vnfr_connection_point_ref
= vnffgd_classifier
.vnfd_connection_point_ref
338 if nsr_vnfr
.vnfd
.service_function_chain
== 'CLASSIFIER':
339 vnffgr_classifier
.sff_name
= nsr_vnfr
.name
341 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
342 self
._log
.debug(" Received VNFR is %s", vnfr
)
343 while vnfr
.operational_status
!= 'running':
344 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
345 if vnfr
.operational_status
== 'failed':
346 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
347 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
348 yield from asyncio
.sleep(2, loop
=self
._loop
)
349 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
350 self
._log
.debug("Received VNFR is %s", vnfr
)
352 for cp
in vnfr
.connection_point
:
353 if cp
.name
== vnffgr_classifier
.vnfr_connection_point_ref
:
354 vnffgr_classifier
.port_id
= cp
.connection_point_id
355 vnffgr_classifier
.ip_address
= cp
.ip_address
356 for vdu
in vnfr
.vdur
:
357 for ext_intf
in vdu
.external_interface
:
358 if ext_intf
.name
== vnffgr_classifier
.vnfr_connection_point_ref
:
359 vnffgr_classifier
.vm_id
= vdu
.vim_id
360 self
._log
.debug("VIM ID for CP %s in VNFR %s is %s",cp
.name
,nsr_vnfr
.id,
361 vnfr_cp_ref
.connection_point_params
.vm_id
)
364 self
._log
.info("VNFFGR msg to be sent is %s", vnffgr
)
368 def vnffgr_nsr_sff_list(self
):
369 """ SFF List for VNFR """
371 sf_list
= [nsr_vnfr
.name
for nsr_vnfr
in self
._nsr
.vnfrs
.values() if nsr_vnfr
.vnfd
.service_function_chain
== 'SF']
373 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
374 if (nsr_vnfr
.vnfd
.service_function_chain
== 'CLASSIFIER' or nsr_vnfr
.vnfd
.service_function_chain
== 'SFF'):
375 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
376 self
._log
.debug(" Received VNFR is %s", vnfr
)
377 while vnfr
.operational_status
!= 'running':
378 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
379 if vnfr
.operational_status
== 'failed':
380 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
381 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
382 yield from asyncio
.sleep(2, loop
=self
._loop
)
383 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
384 self
._log
.debug("Received VNFR is %s", vnfr
)
386 sff
= RwsdnYang
.VNFFGSff()
387 sff_list
[nsr_vnfr
.vnfd
.id] = sff
388 sff
.name
= nsr_vnfr
.name
389 sff
.function_type
= nsr_vnfr
.vnfd
.service_function_chain
391 sff
.mgmt_address
= vnfr
.mgmt_interface
.ip_address
392 sff
.mgmt_port
= VnffgRecord
.SFF_MGMT_PORT
393 for cp
in vnfr
.connection_point
:
394 sff_dp
= sff
.dp_endpoints
.add()
395 sff_dp
.name
= self
._nsr
.name
+ '.' + cp
.name
396 sff_dp
.address
= cp
.ip_address
397 sff_dp
.port
= VnffgRecord
.SFF_DP_PORT
398 if nsr_vnfr
.vnfd
.service_function_chain
== 'SFF':
399 for sf_name
in sf_list
:
400 _sf
= sff
.vnfr_list
.add()
401 _sf
.vnfr_name
= sf_name
406 def instantiate(self
):
407 """ Instantiate this VNFFG """
409 self
._log
.info("Instaniating VNFFGR with vnffgd %s",
413 vnffgr_request
= yield from self
.vnffgr_create_msg()
414 vnffg_sff_list
= yield from self
.vnffgr_nsr_sff_list()
417 vnffgr
= self
._vnffgmgr
.create_vnffgr(vnffgr_request
,self
._vnffgd
_msg
.classifier
,vnffg_sff_list
)
418 except Exception as e
:
419 self
._log
.exception("VNFFG instantiation failed: %s", str(e
))
420 self
._vnffgr
_state
= VnffgRecordState
.FAILED
421 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFFGR %s failure" % (self
.id, vnffgr_request
.id))
423 self
._vnffgr
_state
= VnffgRecordState
.INSTANTIATION_PENDING
425 self
._log
.info("Instantiated VNFFGR :%s", vnffgr
)
426 self
._vnffgr
_state
= VnffgRecordState
.ACTIVE
428 self
._log
.info("Invoking update_state to update NSR state for NSR ID: %s", self
._nsr
.id)
429 yield from self
._nsr
.update_state()
431 def vnffgr_in_vnffgrm(self
):
432 """ Is there a VNFR record in VNFM """
433 if (self
._vnffgr
_state
== VnffgRecordState
.ACTIVE
or
434 self
._vnffgr
_state
== VnffgRecordState
.INSTANTIATION_PENDING
or
435 self
._vnffgr
_state
== VnffgRecordState
.FAILED
):
442 """ Terminate this VNFFGR """
443 if not self
.vnffgr_in_vnffgrm():
444 self
._log
.error("Ignoring terminate request for id %s in state %s",
445 self
.id, self
._vnffgr
_state
)
448 self
._log
.info("Terminating VNFFGR id:%s", self
.id)
449 self
._vnffgr
_state
= VnffgRecordState
.TERMINATE_PENDING
451 self
._vnffgmgr
.terminate_vnffgr(self
._vnffgr
_id
)
453 self
._vnffgr
_state
= VnffgRecordState
.TERMINATED
454 self
._log
.debug("Terminated VNFFGR id:%s", self
.id)
457 class VirtualLinkRecord(object):
458 """ Virtual Link Records class"""
459 XPATH
= "D,/vlr:vlr-catalog/vlr:vlr"
462 def create_record(dts
, log
, loop
, nsr_name
, vld_msg
, cloud_account_name
, om_datacenter
, ip_profile
, nsr_id
, restart_mode
=False):
463 """Creates a new VLR object based on the given data.
465 If restart mode is enabled, then we look for existing records in the
466 DTS and create a VLR records using the exiting data(ID)
471 vlr_obj
= VirtualLinkRecord(
484 res_iter
= yield from dts
.query_read(
485 "D,/vlr:vlr-catalog/vlr:vlr",
486 rwdts
.XactFlag
.MERGE
)
489 response
= yield from fut
490 vlr
= response
.result
492 # Check if the record is already present, if so use the ID of
493 # the existing record. Since the name of the record is uniquely
494 # formed we can use it as a search key!
495 if vlr
.name
== vlr_obj
.name
:
496 vlr_obj
.reset_id(vlr
.id)
501 def __init__(self
, dts
, log
, loop
, nsr_name
, vld_msg
, cloud_account_name
, om_datacenter
, ip_profile
, nsr_id
):
505 self
._nsr
_name
= nsr_name
506 self
._vld
_msg
= vld_msg
507 self
._cloud
_account
_name
= cloud_account_name
508 self
._om
_datacenter
_name
= om_datacenter
509 self
._assigned
_subnet
= None
510 self
._nsr
_id
= nsr_id
511 self
._ip
_profile
= ip_profile
512 self
._vlr
_id
= str(uuid
.uuid4())
513 self
._state
= VlRecordState
.INIT
514 self
._prev
_state
= None
515 self
._create
_time
= int(time
.time())
519 """ path for this object """
520 return "D,/vlr:vlr-catalog/vlr:vlr[vlr:id = '{}']".format(self
._vlr
_id
)
529 """ Get NSR name for this VL """
534 """ Virtual Link Desciptor """
538 def assigned_subnet(self
):
539 """ Subnet assigned to this VL"""
540 return self
._assigned
_subnet
545 Get the name for this VLR.
546 VLR name is "nsr name:VLD name"
548 if self
.vld_msg
.vim_network_name
:
549 return self
.vld_msg
.vim_network_name
550 elif self
.vld_msg
.name
== "multisite":
551 # This is a temporary hack to identify manually provisioned inter-site network
552 return self
.vld_msg
.name
554 return self
._nsr
_name
+ "." + self
.vld_msg
.name
557 def cloud_account_name(self
):
558 """ Cloud account that this VLR should be created in """
559 return self
._cloud
_account
_name
562 def om_datacenter_name(self
):
563 """ Datacenter that this VLR should be created in """
564 return self
._om
_datacenter
_name
568 """ Get the VLR path from VLR """
569 return (VirtualLinkRecord
.XPATH
+ "[vlr:id = '{}']").format(vlr
.id)
577 def state(self
, value
):
578 """ VLR set state """
582 def prev_state(self
):
583 """ VLR previous state """
584 return self
._prev
_state
587 def prev_state(self
, value
):
588 """ VLR set previous state """
589 self
._prev
_state
= value
593 """ Virtual Link Record message for Creating VLR in VNS """
594 vld_fields
= ["short_name",
602 vld_copy_dict
= {k
: v
for k
, v
in self
.vld_msg
.as_dict().items()
605 vlr_dict
= {"id": self
._vlr
_id
,
606 "nsr_id_ref": self
._nsr
_id
,
607 "vld_ref": self
.vld_msg
.id,
609 "create_time": self
._create
_time
,
610 "cloud_account": self
.cloud_account_name
,
611 "om_datacenter": self
.om_datacenter_name
,
614 if self
._ip
_profile
and self
._ip
_profile
.has_field('ip_profile_params'):
615 vlr_dict
['ip_profile_params' ] = self
._ip
_profile
.ip_profile_params
.as_dict()
617 vlr_dict
.update(vld_copy_dict
)
618 vlr
= RwVlrYang
.YangData_Vlr_VlrCatalog_Vlr
.from_dict(vlr_dict
)
621 def reset_id(self
, vlr_id
):
622 self
._vlr
_id
= vlr_id
624 def create_nsr_vlr_msg(self
, vnfrs
):
625 """ The VLR message"""
626 nsr_vlr
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vlr()
627 nsr_vlr
.vlr_ref
= self
._vlr
_id
628 nsr_vlr
.assigned_subnet
= self
.assigned_subnet
629 nsr_vlr
.cloud_account
= self
.cloud_account_name
630 nsr_vlr
.om_datacenter
= self
.om_datacenter_name
632 for conn
in self
.vld_msg
.vnfd_connection_point_ref
:
634 if (vnfr
.vnfd
.id == conn
.vnfd_id_ref
and
635 vnfr
.member_vnf_index
== conn
.member_vnf_index_ref
and
636 self
.cloud_account_name
== vnfr
.cloud_account_name
and
637 self
.om_datacenter_name
== vnfr
.om_datacenter_name
):
638 cp_entry
= nsr_vlr
.vnfr_connection_point_ref
.add()
639 cp_entry
.vnfr_id
= vnfr
.id
640 cp_entry
.connection_point
= conn
.vnfd_connection_point_ref
645 def instantiate(self
):
646 """ Instantiate this VL """
647 self
._log
.debug("Instaniating VLR key %s, vld %s",
648 self
.xpath
, self
._vld
_msg
)
650 self
._state
= VlRecordState
.INSTANTIATION_PENDING
651 self
._log
.debug("Executing VL create path:%s msg:%s",
652 self
.xpath
, self
.vlr_msg
)
654 with self
._dts
.transaction(flags
=0) as xact
:
655 block
= xact
.block_create()
656 block
.add_query_create(self
.xpath
, self
.vlr_msg
)
657 self
._log
.debug("Executing VL create path:%s msg:%s",
658 self
.xpath
, self
.vlr_msg
)
659 res_iter
= yield from block
.execute(now
=True)
665 self
._state
= VlRecordState
.FAILED
666 raise NsrInstantiationFailed("Failed NS %s instantiation due to empty response" % self
.id)
668 if vlr
.operational_status
== 'failed':
669 self
._log
.debug("NS Id:%s VL creation failed for vlr id %s", self
.id, vlr
.id)
670 self
._state
= VlRecordState
.FAILED
671 raise NsrInstantiationFailed("Failed VL %s instantiation (%s)" % (vlr
.id, vlr
.operational_status_details
))
673 self
._log
.info("Instantiated VL with xpath %s and vlr:%s",
675 self
._state
= VlRecordState
.ACTIVE
676 self
._assigned
_subnet
= vlr
.assigned_subnet
678 def vlr_in_vns(self
):
679 """ Is there a VLR record in VNS """
680 if (self
._state
== VlRecordState
.ACTIVE
or
681 self
._state
== VlRecordState
.INSTANTIATION_PENDING
or
682 self
._state
== VlRecordState
.TERMINATE_PENDING
or
683 self
._state
== VlRecordState
.FAILED
):
690 """ Terminate this VL """
691 if not self
.vlr_in_vns():
692 self
._log
.debug("Ignoring terminate request for id %s in state %s",
693 self
.id, self
._state
)
696 self
._log
.debug("Terminating VL id:%s", self
.id)
697 self
._state
= VlRecordState
.TERMINATE_PENDING
699 with self
._dts
.transaction(flags
=0) as xact
:
700 block
= xact
.block_create()
701 block
.add_query_delete(self
.xpath
)
702 yield from block
.execute(flags
=0, now
=True)
704 self
._state
= VlRecordState
.TERMINATED
705 self
._log
.debug("Terminated VL id:%s", self
.id)
708 class VnfRecordState(Enum
):
709 """ Vnf Record State """
711 INSTANTIATION_PENDING
= 102
713 TERMINATE_PENDING
= 104
718 class VirtualNetworkFunctionRecord(object):
719 """ Virtual Network Function Record class"""
720 XPATH
= "D,/vnfr:vnfr-catalog/vnfr:vnfr"
724 def create_record(dts
, log
, loop
, vnfd
, const_vnfd_msg
, nsd_id
, nsr_name
,
725 cloud_account_name
, om_datacenter_name
, nsr_id
, group_name
, group_instance_id
,
726 placement_groups
, restart_mode
=False):
727 """Creates a new VNFR object based on the given data.
729 If restart mode is enabled, then we look for existing records in the
730 DTS and create a VNFR records using the exiting data(ID)
733 VirtualNetworkFunctionRecord
735 vnfr_obj
= VirtualNetworkFunctionRecord(
749 restart_mode
=restart_mode
)
752 res_iter
= yield from dts
.query_read(
753 "D,/vnfr:vnfr-catalog/vnfr:vnfr",
754 rwdts
.XactFlag
.MERGE
)
757 response
= yield from fut
758 vnfr
= response
.result
760 if vnfr
.name
== vnfr_obj
.name
:
761 vnfr_obj
.reset_id(vnfr
.id)
778 group_instance_id
=None,
779 placement_groups
= [],
780 restart_mode
= False):
785 self
._const
_vnfd
_msg
= const_vnfd_msg
786 self
._nsd
_id
= nsd_id
787 self
._nsr
_name
= nsr_name
788 self
._nsr
_id
= nsr_id
789 self
._cloud
_account
_name
= cloud_account_name
790 self
._om
_datacenter
_name
= om_datacenter_name
791 self
._group
_name
= group_name
792 self
._group
_instance
_id
= group_instance_id
793 self
._placement
_groups
= placement_groups
794 self
._config
_status
= NsrYang
.ConfigStates
.INIT
795 self
._create
_time
= int(time
.time())
797 self
._prev
_state
= VnfRecordState
.INIT
798 self
._state
= VnfRecordState
.INIT
799 self
._state
_failed
_reason
= None
801 self
.config_store
= rift
.mano
.config_data
.config
.ConfigStore(self
._log
)
804 self
._vnfr
_id
= str(uuid
.uuid4())
806 self
._vnfr
_msg
= self
.create_vnfr_msg()
807 self
._log
.debug("Set VNFR {} config type to {}".
808 format(self
.name
, self
.config_type
))
809 self
.restart_mode
= restart_mode
812 if group_name
is None and group_instance_id
is not None:
813 raise ValueError("Group instance id must not be provided with an empty group name")
823 return "D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id = '{}']".format(self
.id)
828 return self
._vnfr
_msg
831 def const_vnfr_msg(self
):
833 return RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_ConstituentVnfrRef(vnfr_id
=self
.id,cloud_account
=self
.cloud_account_name
,om_datacenter
=self
._om
_datacenter
_name
)
841 def cloud_account_name(self
):
842 """ Cloud account that this VNF should be created in """
843 return self
._cloud
_account
_name
846 def om_datacenter_name(self
):
847 """ Datacenter that this VNF should be created in """
848 return self
._om
_datacenter
_name
853 """ Is this VNF actve """
854 return True if self
._state
== VnfRecordState
.ACTIVE
else False
858 """ state of this VNF """
862 def state_failed_reason(self
):
863 """ Error message in case this VNF is in failed state """
864 return self
._state
_failed
_reason
867 def member_vnf_index(self
):
868 """ Member VNF index """
869 return self
._const
_vnfd
_msg
.member_vnf_index
874 return self
._nsr
_name
878 """ Name of this VNFR """
879 if self
._name
is not None:
882 name_tags
= [self
._nsr
_name
]
884 if self
._group
_name
is not None:
885 name_tags
.append(self
._group
_name
)
887 if self
._group
_instance
_id
is not None:
888 name_tags
.append(str(self
._group
_instance
_id
))
890 name_tags
.extend([self
.vnfd
.name
, str(self
.member_vnf_index
)])
892 self
._name
= "__".join(name_tags
)
897 def vnfr_xpath(vnfr
):
898 """ Get the VNFR path from VNFR """
899 return (VirtualNetworkFunctionRecord
.XPATH
+ "[vnfr:id = '{}']").format(vnfr
.id)
902 def config_type(self
):
903 cfg_types
= ['netconf', 'juju', 'script']
904 for method
in cfg_types
:
905 if self
._vnfd
.vnf_configuration
.has_field(method
):
910 def config_status(self
):
911 """Return the config status as YANG ENUM string"""
912 self
._log
.debug("Map VNFR {} config status {} ({})".
913 format(self
.name
, self
._config
_status
, self
.config_type
))
914 if self
.config_type
== 'none':
915 return 'config_not_needed'
916 elif self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURED
:
918 elif self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
923 def set_state(self
, state
):
924 """ set the state of this object """
925 self
._prev
_state
= self
._state
928 def reset_id(self
, vnfr_id
):
929 self
._vnfr
_id
= vnfr_id
930 self
._vnfr
_msg
= self
.create_vnfr_msg()
933 self
.config_store
.merge_vnfd_config(
936 self
.member_vnf_index
,
939 def create_vnfr_msg(self
):
940 """ VNFR message for this VNFR """
948 vnfd_copy_dict
= {k
: v
for k
, v
in self
._vnfd
.as_dict().items() if k
in vnfd_fields
}
951 "nsr_id_ref": self
._nsr
_id
,
953 "cloud_account": self
._cloud
_account
_name
,
954 "om_datacenter": self
._om
_datacenter
_name
,
955 "config_status": self
.config_status
957 vnfr_dict
.update(vnfd_copy_dict
)
959 vnfr
= RwVnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr
.from_dict(vnfr_dict
)
960 vnfr
.vnfd
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr_Vnfd
.from_dict(self
.vnfd
.as_dict(),
961 ignore_missing_keys
=True)
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 if conn_p
.has_field('port_security_enabled'):
1076 cpr
.port_security_enabled
= conn_p
.port_security_enabled
1078 vlr_ref
= find_vlr_for_cp(conn_p
)
1080 msg
= "Failed to find VLR for cp = %s" % conn_p
.name
1081 self
._log
.debug("%s", msg
)
1082 # raise VirtualNetworkFunctionRecordError(msg)
1085 cpr
.vlr_ref
= vlr_ref
.id
1086 self
.vnfr_msg
.connection_point
.append(cpr
)
1087 self
._log
.debug("Connection point [%s] added, vnf id=%s vnfd id=%s",
1088 cpr
, self
.vnfr_msg
.id, self
.vnfr_msg
.vnfd
.id)
1090 if not self
.restart_mode
:
1091 yield from self
._dts
.query_create(self
.xpath
,
1095 yield from self
._dts
.query_update(self
.xpath
,
1099 self
._log
.info("Created VNF with xpath %s and vnfr %s",
1100 self
.xpath
, self
.vnfr_msg
)
1102 self
._log
.info("Instantiated VNFR with xpath %s and vnfd %s, vnfr %s",
1103 self
.xpath
, self
._vnfd
, self
.vnfr_msg
)
1106 def update_state(self
, vnfr_msg
):
1107 """ Update this VNFR"""
1108 if vnfr_msg
.operational_status
== "running":
1109 if self
.vnfr_msg
.operational_status
!= "running":
1110 yield from self
.is_active()
1111 elif vnfr_msg
.operational_status
== "failed":
1112 yield from self
.instantiation_failed(failed_reason
=vnfr_msg
.operational_status_details
)
1115 def is_active(self
):
1116 """ This VNFR is active """
1117 self
._log
.debug("VNFR %s is active", self
._vnfr
_id
)
1118 self
.set_state(VnfRecordState
.ACTIVE
)
1121 def instantiation_failed(self
, failed_reason
=None):
1122 """ This VNFR instantiation failed"""
1123 self
._log
.error("VNFR %s instantiation failed", self
._vnfr
_id
)
1124 self
.set_state(VnfRecordState
.FAILED
)
1125 self
._state
_failed
_reason
= failed_reason
1127 def vnfr_in_vnfm(self
):
1128 """ Is there a VNFR record in VNFM """
1129 if (self
._state
== VnfRecordState
.ACTIVE
or
1130 self
._state
== VnfRecordState
.INSTANTIATION_PENDING
or
1131 self
._state
== VnfRecordState
.FAILED
):
1137 def terminate(self
):
1138 """ Terminate this VNF """
1139 if not self
.vnfr_in_vnfm():
1140 self
._log
.debug("Ignoring terminate request for id %s in state %s",
1141 self
.id, self
._state
)
1144 self
._log
.debug("Terminating VNF id:%s", self
.id)
1145 self
.set_state(VnfRecordState
.TERMINATE_PENDING
)
1146 with self
._dts
.transaction(flags
=0) as xact
:
1147 block
= xact
.block_create()
1148 block
.add_query_delete(self
.xpath
)
1149 yield from block
.execute(flags
=0)
1150 self
.set_state(VnfRecordState
.TERMINATED
)
1151 self
._log
.debug("Terminated VNF id:%s", self
.id)
1154 class NetworkServiceStatus(object):
1155 """ A class representing the Network service's status """
1156 MAX_EVENTS_RECORDED
= 10
1157 """ Network service Status class"""
1158 def __init__(self
, dts
, log
, loop
):
1163 self
._state
= NetworkServiceRecordState
.INIT
1164 self
._events
= deque([])
1167 def create_notification(self
, evt
, evt_desc
, evt_details
):
1168 xp
= "N,/rw-nsr:nsm-notification"
1169 notif
= RwNsrYang
.YangNotif_RwNsr_NsmNotification()
1171 notif
.description
= evt_desc
1172 notif
.details
= evt_details
if evt_details
is not None else None
1174 yield from self
._dts
.query_create(xp
, rwdts
.XactFlag
.ADVISE
, notif
)
1175 self
._log
.info("Notification called by creating dts query: %s", notif
)
1177 def record_event(self
, evt
, evt_desc
, evt_details
):
1178 """ Record an event """
1179 self
._log
.debug("Recording event - evt %s, evt_descr %s len = %s",
1180 evt
, evt_desc
, len(self
._events
))
1181 if len(self
._events
) >= NetworkServiceStatus
.MAX_EVENTS_RECORDED
:
1182 self
._events
.popleft()
1183 self
._events
.append((int(time
.time()), evt
, evt_desc
,
1184 evt_details
if evt_details
is not None else None))
1186 self
._loop
.create_task(self
.create_notification(evt
,evt_desc
,evt_details
))
1188 def set_state(self
, state
):
1189 """ set the state of this status object """
1193 """ Return the state as a yang enum string """
1194 state_to_str_map
= {"INIT": "init",
1195 "VL_INIT_PHASE": "vl_init_phase",
1196 "VNF_INIT_PHASE": "vnf_init_phase",
1197 "VNFFG_INIT_PHASE": "vnffg_init_phase",
1198 "SCALING_GROUP_INIT_PHASE": "scaling_group_init_phase",
1199 "RUNNING": "running",
1200 "SCALING_OUT": "scaling_out",
1201 "SCALING_IN": "scaling_in",
1202 "TERMINATE_RCVD": "terminate_rcvd",
1203 "TERMINATE": "terminate",
1204 "VL_TERMINATE_PHASE": "vl_terminate_phase",
1205 "VNF_TERMINATE_PHASE": "vnf_terminate_phase",
1206 "VNFFG_TERMINATE_PHASE": "vnffg_terminate_phase",
1207 "TERMINATED": "terminated",
1209 "VL_INSTANTIATE": "vl_instantiate",
1210 "VL_TERMINATE": "vl_terminate",
1212 return state_to_str_map
[self
._state
.name
]
1216 """ State of this status object """
1221 """ Network Service Record as a message"""
1224 for entry
in self
._events
:
1225 event
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_OperationalEvents()
1228 event
.timestamp
, event
.event
, event
.description
, event
.details
= entry
1229 event_list
.append(event
)
1233 class NetworkServiceRecord(object):
1234 """ Network service record """
1235 XPATH
= "D,/nsr:ns-instance-opdata/nsr:nsr"
1237 def __init__(self
, dts
, log
, loop
, nsm
, nsm_plugin
, nsr_cfg_msg
, sdn_account_name
, key_pairs
, restart_mode
=False,
1243 self
._nsr
_cfg
_msg
= nsr_cfg_msg
1244 self
._nsm
_plugin
= nsm_plugin
1245 self
._sdn
_account
_name
= sdn_account_name
1246 self
._vlr
_handler
= vlr_handler
1249 self
._nsr
_msg
= None
1250 self
._nsr
_regh
= None
1251 self
._key
_pairs
= key_pairs
1256 self
._param
_pools
= {}
1257 self
._scaling
_groups
= {}
1258 self
._create
_time
= int(time
.time())
1259 self
._op
_status
= NetworkServiceStatus(dts
, log
, loop
)
1260 self
._config
_status
= NsrYang
.ConfigStates
.CONFIGURING
1261 self
._config
_status
_details
= None
1263 self
.restart_mode
= restart_mode
1264 self
.config_store
= rift
.mano
.config_data
.config
.ConfigStore(self
._log
)
1265 self
._debug
_running
= False
1266 self
._is
_active
= False
1267 self
._vl
_phase
_completed
= False
1268 self
._vnf
_phase
_completed
= False
1269 self
.vlr_uptime_tasks
= {}
1272 # Initalise the state to init
1273 # The NSR moves through the following transitions
1274 # 1. INIT -> VLS_READY once all the VLs in the NSD are created
1275 # 2. VLS_READY - VNFS_READY when all the VNFs in the NSD are created
1276 # 3. VNFS_READY - READY when the NSR is published
1278 self
.set_state(NetworkServiceRecordState
.INIT
)
1280 self
.substitute_input_parameters
= InputParameterSubstitution(self
._log
)
1283 def nsm_plugin(self
):
1285 return self
._nsm
_plugin
1287 def set_state(self
, state
):
1288 """ Set state for this NSR"""
1289 self
._log
.debug("Setting state to %s", state
)
1290 # We are in init phase and is moving to the next state
1291 # The new state could be a FAILED state or VNF_INIIT_PHASE
1292 if self
.state
== NetworkServiceRecordState
.VL_INIT_PHASE
:
1293 self
._vl
_phase
_completed
= True
1295 if self
.state
== NetworkServiceRecordState
.VNF_INIT_PHASE
:
1296 self
._vnf
_phase
_completed
= True
1298 self
._op
_status
.set_state(state
)
1299 self
._nsm
_plugin
.set_state(self
.id, state
)
1303 """ Get id for this NSR"""
1304 return self
._nsr
_cfg
_msg
.id
1308 """ Name of this network service record """
1309 return self
._nsr
_cfg
_msg
.name
1312 def cloud_account_name(self
):
1313 return self
._nsr
_cfg
_msg
.cloud_account
1316 def om_datacenter_name(self
):
1317 if self
._nsr
_cfg
_msg
.has_field('om_datacenter'):
1318 return self
._nsr
_cfg
_msg
.om_datacenter
1323 """State of this NetworkServiceRecord"""
1324 return self
._op
_status
.state
1328 """ Is this NSR active ?"""
1329 return True if self
._op
_status
.state
== NetworkServiceRecordState
.RUNNING
else False
1333 """ VLRs associated with this NSR"""
1338 """ VNFRs associated with this NSR"""
1343 """ VNFFGRs associated with this NSR"""
1344 return self
._vnffgrs
1347 def scaling_groups(self
):
1348 """ Scaling groups associated with this NSR """
1349 return self
._scaling
_groups
1352 def param_pools(self
):
1353 """ Parameter value pools associated with this NSR"""
1354 return self
._param
_pools
1357 def nsr_cfg_msg(self
):
1358 return self
._nsr
_cfg
_msg
1361 def nsr_cfg_msg(self
, msg
):
1362 self
._nsr
_cfg
_msg
= msg
1366 """ NSD Protobuf for this NSR """
1367 if self
._nsd
is not None:
1369 self
._nsd
= self
._nsr
_cfg
_msg
.nsd
1374 """ NSD ID for this NSR """
1375 return self
.nsd_msg
.id
1379 ''' Get a new job id for config primitive'''
1384 def config_status(self
):
1385 """ Config status for NSR """
1386 return self
._config
_status
1388 def resolve_placement_group_cloud_construct(self
, input_group
):
1390 Returns the cloud specific construct for placement group
1392 copy_dict
= ['name', 'requirement', 'strategy']
1394 for group_info
in self
._nsr
_cfg
_msg
.nsd_placement_group_maps
:
1395 if group_info
.placement_group_ref
== input_group
.name
:
1396 group
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr_PlacementGroupsInfo()
1397 group_dict
= {k
:v
for k
,v
in
1398 group_info
.as_dict().items() if k
!= 'placement_group_ref'}
1399 for param
in copy_dict
:
1400 group_dict
.update({param
: getattr(input_group
, param
)})
1401 group
.from_dict(group_dict
)
1407 return "NSR(name={}, nsd_id={}, cloud_account={})".format(
1408 self
.name
, self
.nsd_id
, self
.cloud_account_name
1411 def _get_vnfd(self
, vnfd_id
, config_xact
):
1412 """ Fetch vnfd msg for the passed vnfd id """
1413 return self
._nsm
.get_vnfd(vnfd_id
, config_xact
)
1415 def _get_vnfd_cloud_account(self
, vnfd_member_index
):
1416 """ Fetch Cloud Account for the passed vnfd id """
1417 if self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1418 vim_accounts
= [(vnf
.cloud_account
,vnf
.om_datacenter
) for vnf
in self
._nsr
_cfg
_msg
.vnf_cloud_account_map \
1419 if vnfd_member_index
== vnf
.member_vnf_index_ref
]
1420 if vim_accounts
and vim_accounts
[0]:
1421 return vim_accounts
[0]
1422 return (self
.cloud_account_name
,self
.om_datacenter_name
)
1424 def _get_constituent_vnfd_msg(self
, vnf_index
):
1425 for const_vnfd
in self
.nsd_msg
.constituent_vnfd
:
1426 if const_vnfd
.member_vnf_index
== vnf_index
:
1429 raise ValueError("Constituent VNF index %s not found" % vnf_index
)
1431 def record_event(self
, evt
, evt_desc
, evt_details
=None, state
=None):
1432 """ Record an event """
1433 self
._op
_status
.record_event(evt
, evt_desc
, evt_details
)
1434 if state
is not None:
1435 self
.set_state(state
)
1437 def scaling_trigger_str(self
, trigger
):
1438 SCALING_TRIGGER_STRS
= {
1439 NsdYang
.ScalingTrigger
.PRE_SCALE_IN
: 'pre-scale-in',
1440 NsdYang
.ScalingTrigger
.POST_SCALE_IN
: 'post-scale-in',
1441 NsdYang
.ScalingTrigger
.PRE_SCALE_OUT
: 'pre-scale-out',
1442 NsdYang
.ScalingTrigger
.POST_SCALE_OUT
: 'post-scale-out',
1445 return SCALING_TRIGGER_STRS
[trigger
]
1446 except Exception as e
:
1447 self
._log
.error("Scaling trigger mapping error for {} : {}".
1449 self
._log
.exception(e
)
1450 return "Unknown trigger"
1453 def instantiate_vls(self
):
1455 This function instantiates VLs for every VL in this Network Service
1457 self
._log
.debug("Instantiating %d VLs in NSD id %s", len(self
._vlrs
),
1459 for vlr
in self
._vlrs
:
1460 yield from self
.nsm_plugin
.instantiate_vl(self
, vlr
)
1461 vlr
.state
= VlRecordState
.ACTIVE
1462 self
.vlr_uptime_tasks
[vlr
.id] = self
._loop
.create_task(self
.vlr_uptime_update(vlr
))
1465 def vlr_uptime_update(self
, vlr
):
1468 vlr_
= RwVlrYang
.YangData_Vlr_VlrCatalog_Vlr
.from_dict({'id': vlr
.id})
1470 vlr_
.uptime
= int(time
.time()) - vlr
._create
_time
1471 yield from self
._vlr
_handler
.update(None, VirtualLinkRecord
.vlr_xpath(vlr
), vlr_
)
1472 yield from asyncio
.sleep(2, loop
=self
._loop
)
1473 except asyncio
.CancelledError
:
1474 self
._log
.debug("Received cancellation request for vlr_uptime_update task")
1475 yield from self
._vlr
_handler
.delete(None, VirtualLinkRecord
.vlr_xpath(vlr
))
1479 def create(self
, config_xact
):
1480 """ Create this network service"""
1481 # Create virtual links for all the external vnf
1482 # connection points in this NS
1483 yield from self
.create_vls()
1485 # Create VNFs in this network service
1486 yield from self
.create_vnfs(config_xact
)
1488 # Create VNFFG for network service
1489 self
.create_vnffgs()
1491 # Create Scaling Groups for each scaling group in NSD
1492 self
.create_scaling_groups()
1494 # Create Parameter Pools
1495 self
.create_param_pools()
1498 def apply_scale_group_config_script(self
, script
, group
, scale_instance
, trigger
, vnfrs
=None):
1499 """ Apply config based on script for scale group """
1502 def add_vnfrs_data(vnfrs_list
):
1503 """ Add as a dict each of the VNFRs data """
1505 for vnfr
in vnfrs_list
:
1506 self
._log
.debug("Add VNFR {} data".format(vnfr
))
1508 vnfr_data
['name'] = vnfr
.name
1509 if trigger
in [NsdYang
.ScalingTrigger
.PRE_SCALE_IN
, NsdYang
.ScalingTrigger
.POST_SCALE_OUT
]:
1510 # Get VNF management and other IPs, etc
1511 opdata
= yield from self
.fetch_vnfr(vnfr
.xpath
)
1512 self
._log
.debug("VNFR {} op data: {}".format(vnfr
.name
, opdata
))
1514 vnfr_data
['rw_mgmt_ip'] = opdata
.mgmt_interface
.ip_address
1515 vnfr_data
['rw_mgmt_port'] = opdata
.mgmt_interface
.port
1516 except Exception as e
:
1517 self
._log
.error("Unable to get management IP for vnfr {}:{}".
1518 format(vnfr
.name
, e
))
1521 vnfr_data
['connection_points'] = []
1522 for cp
in opdata
.connection_point
:
1524 con_pt
['name'] = cp
.name
1525 con_pt
['ip_address'] = cp
.ip_address
1526 vnfr_data
['connection_points'].append(con_pt
)
1527 except Exception as e
:
1528 self
._log
.error("Exception getting connections points for VNFR {}: {}".
1529 format(vnfr
.name
, e
))
1531 vnfrs_data
.append(vnfr_data
)
1532 self
._log
.debug("VNFRs data: {}".format(vnfrs_data
))
1536 def add_nsr_data(nsr
):
1538 nsr_data
['name'] = nsr
.name
1541 if script
is None or len(script
) == 0:
1542 self
._log
.error("Script not provided for scale group config: {}".format(group
.name
))
1545 if script
[0] == '/':
1548 path
= os
.path
.join(os
.environ
['RIFT_INSTALL'], "usr/bin", script
)
1549 if not os
.path
.exists(path
):
1550 self
._log
.error("Config faled for scale group {}: Script does not exist at {}".
1551 format(group
.name
, path
))
1554 # Build a YAML file with all parameters for the script to execute
1555 # The data consists of 5 sections
1557 # 2. Scale group config
1558 # 3. VNFRs in the scale group
1559 # 4. VNFRs outside scale group
1562 data
['trigger'] = group
.trigger_map(trigger
)
1563 data
['config'] = group
.group_msg
.as_dict()
1566 data
["vnfrs_in_group"] = yield from add_vnfrs_data(vnfrs
)
1568 data
["vnfrs_in_group"] = yield from add_vnfrs_data(scale_instance
.vnfrs
)
1570 data
["vnfrs_others"] = yield from add_vnfrs_data(self
.vnfrs
.values())
1571 data
["nsr"] = add_nsr_data(self
)
1574 with tempfile
.NamedTemporaryFile(delete
=False) as tmp_file
:
1575 tmp_file
.write(yaml
.dump(data
, default_flow_style
=True)
1578 self
._log
.debug("Creating a temp file: {} with input data: {}".
1579 format(tmp_file
.name
, data
))
1581 cmd
= "{} {}".format(path
, tmp_file
.name
)
1582 self
._log
.debug("Running the CMD: {}".format(cmd
))
1583 proc
= yield from asyncio
.create_subprocess_shell(cmd
, loop
=self
._loop
)
1584 rc
= yield from proc
.wait()
1586 self
._log
.error("The script {} for scale group {} config returned: {}".
1587 format(script
, group
.name
, rc
))
1595 def apply_scaling_group_config(self
, trigger
, group
, scale_instance
, vnfrs
=None):
1596 """ Apply the config for the scaling group based on trigger """
1597 if group
is None or scale_instance
is None:
1601 def update_config_status(success
=True, err_msg
=None):
1602 self
._log
.debug("Update %s config status to %r : %s",
1603 scale_instance
, success
, err_msg
)
1604 if (scale_instance
.config_status
== "failed"):
1605 # Do not update the config status if it is already in failed state
1608 if scale_instance
.config_status
== "configured":
1609 # Update only to failed state an already configured scale instance
1611 scale_instance
.config_status
= "failed"
1612 scale_instance
.config_err_msg
= err_msg
1613 yield from self
.update_state()
1615 # We are in configuring state
1616 # Only after post scale out mark instance as configured
1617 if trigger
== NsdYang
.ScalingTrigger
.POST_SCALE_OUT
:
1619 scale_instance
.config_status
= "configured"
1621 scale_instance
.config_status
= "failed"
1622 scale_instance
.config_err_msg
= err_msg
1623 yield from self
.update_state()
1625 config
= group
.trigger_config(trigger
)
1629 self
._log
.debug("Scaling group {} config: {}".format(group
.name
, config
))
1630 if config
.has_field("ns_config_primitive_name_ref"):
1631 config_name
= config
.ns_config_primitive_name_ref
1632 nsd_msg
= self
.nsd_msg
1633 config_primitive
= None
1634 for ns_cfg_prim
in nsd_msg
.service_primitive
:
1635 if ns_cfg_prim
.name
== config_name
:
1636 config_primitive
= ns_cfg_prim
1639 if config_primitive
is None:
1640 raise ValueError("Could not find ns_cfg_prim %s in nsr %s" % (config_name
, self
.name
))
1642 self
._log
.debug("Scaling group {} config primitive: {}".format(group
.name
, config_primitive
))
1643 if config_primitive
.has_field("user_defined_script"):
1644 rc
= yield from self
.apply_scale_group_config_script(config_primitive
.user_defined_script
,
1645 group
, scale_instance
, trigger
, vnfrs
)
1648 err_msg
= "Failed config for trigger {} using config script '{}'". \
1649 format(self
.scaling_trigger_str(trigger
),
1650 config_primitive
.user_defined_script
)
1651 yield from update_config_status(success
=rc
, err_msg
=err_msg
)
1654 err_msg
= "Failed config for trigger {} as config script is not specified". \
1655 format(self
.scaling_trigger_str(trigger
))
1656 yield from update_config_status(success
=False, err_msg
=err_msg
)
1657 raise NotImplementedError("Only script based config support for scale group for now: {}".
1660 err_msg
= "Failed config for trigger {} as config primitive is not specified". \
1661 format(self
.scaling_trigger_str(trigger
))
1662 yield from update_config_status(success
=False, err_msg
=err_msg
)
1663 self
._log
.error("Config primitive not specified for config action in scale group %s" %
1667 def create_scaling_groups(self
):
1668 """ This function creates a NSScalingGroup for every scaling
1669 group defined in he NSD"""
1671 for scaling_group_msg
in self
.nsd_msg
.scaling_group_descriptor
:
1672 self
._log
.debug("Found scaling_group %s in nsr id %s",
1673 scaling_group_msg
.name
, self
.id)
1675 group_record
= scale_group
.ScalingGroup(
1680 self
._scaling
_groups
[group_record
.name
] = group_record
1683 def create_scale_group_instance(self
, group_name
, index
, config_xact
, is_default
=False):
1684 group
= self
._scaling
_groups
[group_name
]
1685 scale_instance
= group
.create_instance(index
, is_default
)
1689 self
._log
.debug("Creating %u VNFs associated with NS id %s scaling group %s",
1690 len(self
.nsd_msg
.constituent_vnfd
), self
.id, self
)
1693 for vnf_index
, count
in group
.vnf_index_count_map
.items():
1694 const_vnfd_msg
= self
._get
_constituent
_vnfd
_msg
(vnf_index
)
1695 vnfd_msg
= self
._get
_vnfd
(const_vnfd_msg
.vnfd_id_ref
, config_xact
)
1697 cloud_account_name
, om_datacenter_name
= self
._get
_vnfd
_cloud
_account
(const_vnfd_msg
.member_vnf_index
)
1698 if cloud_account_name
is None:
1699 cloud_account_name
= self
.cloud_account_name
1700 for _
in range(count
):
1701 vnfr
= yield from self
.create_vnf_record(vnfd_msg
, const_vnfd_msg
, cloud_account_name
, om_datacenter_name
, group_name
, index
)
1702 scale_instance
.add_vnfr(vnfr
)
1707 def instantiate_instance():
1708 self
._log
.debug("Creating %s VNFRS", scale_instance
)
1709 vnfrs
= yield from create_vnfs()
1710 yield from self
.publish()
1712 self
._log
.debug("Instantiating %s VNFRS for %s", len(vnfrs
), scale_instance
)
1713 scale_instance
.operational_status
= "vnf_init_phase"
1714 yield from self
.update_state()
1717 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.PRE_SCALE_OUT
,
1718 group
, scale_instance
, vnfrs
)
1720 self
._log
.error("Pre scale out config for scale group {} ({}) failed".
1721 format(group
.name
, index
))
1722 scale_instance
.operational_status
= "failed"
1724 yield from self
.instantiate_vnfs(vnfrs
, scaleout
=True)
1726 except Exception as e
:
1727 self
._log
.exception("Failed to begin instantiatiation of vnfs for scale group {}: {}".
1728 format(group
.name
, e
))
1729 self
._log
.exception(e
)
1730 scale_instance
.operational_status
= "failed"
1732 yield from self
.update_state()
1734 yield from instantiate_instance()
1737 def delete_scale_group_instance(self
, group_name
, index
):
1738 group
= self
._scaling
_groups
[group_name
]
1739 scale_instance
= group
.get_instance(index
)
1740 if scale_instance
.is_default
:
1741 raise ScalingOperationError("Cannot terminate a default scaling group instance")
1743 scale_instance
.operational_status
= "terminate"
1744 yield from self
.update_state()
1747 def terminate_instance():
1748 self
._log
.debug("Terminating %s VNFRS" % scale_instance
)
1749 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.PRE_SCALE_IN
,
1750 group
, scale_instance
)
1752 self
._log
.error("Pre scale in config for scale group {} ({}) failed".
1753 format(group
.name
, index
))
1755 # Going ahead with terminate, even if there is an error in pre-scale-in config
1756 # as this could be result of scale out failure and we need to cleanup this group
1757 yield from self
.terminate_vnfrs(scale_instance
.vnfrs
)
1758 group
.delete_instance(index
)
1760 scale_instance
.operational_status
= "vnf_terminate_phase"
1761 yield from self
.update_state()
1763 yield from terminate_instance()
1766 def _update_scale_group_instances_status(self
):
1768 def post_scale_out_task(group
, instance
):
1769 # Apply post scale out config once all VNFRs are active
1770 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.POST_SCALE_OUT
,
1772 instance
.operational_status
= "running"
1774 self
._log
.debug("Scale out for group {} and instance {} succeeded".
1775 format(group
.name
, instance
.instance_id
))
1777 self
._log
.error("Post scale out config for scale group {} ({}) failed".
1778 format(group
.name
, instance
.instance_id
))
1780 yield from self
.update_state()
1782 group_instances
= {group
: group
.instances
for group
in self
._scaling
_groups
.values()}
1783 for group
, instances
in group_instances
.items():
1784 self
._log
.debug("Updating %s instance status", group
)
1785 for instance
in instances
:
1786 instance_vnf_state_list
= [vnfr
.state
for vnfr
in instance
.vnfrs
]
1787 self
._log
.debug("Got vnfr instance states: %s", instance_vnf_state_list
)
1788 if instance
.operational_status
== "vnf_init_phase":
1789 if all([state
== VnfRecordState
.ACTIVE
for state
in instance_vnf_state_list
]):
1790 instance
.operational_status
= "running"
1792 # Create a task for post scale out to allow us to sleep before attempting
1793 # to configure newly created VM's
1794 self
._loop
.create_task(post_scale_out_task(group
, instance
))
1796 elif any([state
== VnfRecordState
.FAILED
for state
in instance_vnf_state_list
]):
1797 self
._log
.debug("Scale out for group {} and instance {} failed".
1798 format(group
.name
, instance
.instance_id
))
1799 instance
.operational_status
= "failed"
1801 elif instance
.operational_status
== "vnf_terminate_phase":
1802 if all([state
== VnfRecordState
.TERMINATED
for state
in instance_vnf_state_list
]):
1803 instance
.operational_status
= "terminated"
1804 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.POST_SCALE_IN
,
1807 self
._log
.debug("Scale in for group {} and instance {} succeeded".
1808 format(group
.name
, instance
.instance_id
))
1810 self
._log
.error("Post scale in config for scale group {} ({}) failed".
1811 format(group
.name
, instance
.instance_id
))
1813 def create_vnffgs(self
):
1814 """ This function creates VNFFGs for every VNFFG in the NSD
1815 associated with this NSR"""
1817 for vnffgd
in self
.nsd_msg
.vnffgd
:
1818 self
._log
.debug("Found vnffgd %s in nsr id %s", vnffgd
, self
.id)
1819 vnffgr
= VnffgRecord(self
._dts
,
1822 self
._nsm
._vnffgmgr
,
1826 self
._sdn
_account
_name
1828 self
._vnffgrs
[vnffgr
.id] = vnffgr
1830 def resolve_vld_ip_profile(self
, nsd_msg
, vld
):
1831 self
._log
.debug("Receieved ip profile ref is %s",vld
.ip_profile_ref
)
1832 if not vld
.has_field('ip_profile_ref'):
1834 profile
= [profile
for profile
in nsd_msg
.ip_profiles
if profile
.name
== vld
.ip_profile_ref
]
1835 return profile
[0] if profile
else None
1838 def _create_vls(self
, vld
, cloud_account
,om_datacenter
):
1839 """Create a VLR in the cloud account specified using the given VLD
1843 cloud_account : Cloud account name
1848 vlr
= yield from VirtualLinkRecord
.create_record(
1856 self
.resolve_vld_ip_profile(self
.nsd_msg
, vld
),
1858 restart_mode
=self
.restart_mode
)
1862 def _extract_cloud_accounts_for_vl(self
, vld
):
1864 Extracts the list of cloud accounts from the NS Config obj
1867 1. Cloud accounts based connection point (vnf_cloud_account_map)
1869 vld : VLD yang object
1874 cloud_account_list
= []
1876 if self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1877 # Handle case where cloud_account is None
1879 for vnf
in self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1880 if vnf
.cloud_account
is not None or vnf
.om_datacenter
is not None:
1881 vnf_cloud_map
[vnf
.member_vnf_index_ref
] = (vnf
.cloud_account
,vnf
.om_datacenter
)
1883 for vnfc
in vld
.vnfd_connection_point_ref
:
1884 cloud_account
= vnf_cloud_map
.get(
1885 vnfc
.member_vnf_index_ref
,
1886 (self
.cloud_account_name
,self
.om_datacenter_name
))
1888 cloud_account_list
.append(cloud_account
)
1890 if self
._nsr
_cfg
_msg
.vl_cloud_account_map
:
1891 for vld_map
in self
._nsr
_cfg
_msg
.vl_cloud_account_map
:
1892 if vld_map
.vld_id_ref
== vld
.id:
1893 for cloud_account
in vld_map
.cloud_accounts
:
1894 cloud_account_list
.extend((cloud_account
,None))
1895 for om_datacenter
in vld_map
.om_datacenters
:
1896 cloud_account_list
.extend((None,om_datacenter
))
1898 # If no config has been provided then fall-back to the default
1900 if not cloud_account_list
:
1901 cloud_account_list
= [(self
.cloud_account_name
,self
.om_datacenter_name
)]
1903 self
._log
.debug("VL {} cloud accounts: {}".
1904 format(vld
.name
, cloud_account_list
))
1905 return set(cloud_account_list
)
1908 def create_vls(self
):
1909 """ This function creates VLs for every VLD in the NSD
1910 associated with this NSR"""
1911 for vld
in self
.nsd_msg
.vld
:
1913 self
._log
.debug("Found vld %s in nsr id %s", vld
, self
.id)
1914 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1915 for cloud_account
,om_datacenter
in cloud_account_list
:
1916 vlr
= yield from self
._create
_vls
(vld
, cloud_account
,om_datacenter
)
1917 self
._vlrs
.append(vlr
)
1921 def create_vl_instance(self
, vld
):
1922 self
._log
.debug("Create VL for {}: {}".format(self
.id, vld
.as_dict()))
1923 # Check if the VL is already present
1925 for vl
in self
._vlrs
:
1926 if vl
.vld_msg
.id == vld
.id:
1927 self
._log
.debug("The VLD %s already in NSR %s as VLR %s with status %s",
1928 vld
.id, self
.id, vl
.id, vl
.state
)
1930 if vlr
.state
!= VlRecordState
.TERMINATED
:
1931 err_msg
= "VLR for VL %s in NSR %s already instantiated", \
1933 self
._log
.error(err_msg
)
1934 raise NsrVlUpdateError(err_msg
)
1938 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1939 for account
,om_datacenter
in cloud_account_list
:
1940 vlr
= yield from self
._create
_vls
(vld
, account
,om_datacenter
)
1941 self
._vlrs
.append(vlr
)
1943 vlr
.state
= VlRecordState
.INSTANTIATION_PENDING
1944 yield from self
.update_state()
1947 yield from self
.nsm_plugin
.instantiate_vl(self
, vlr
)
1948 vlr
.state
= VlRecordState
.ACTIVE
1950 except Exception as e
:
1951 err_msg
= "Error instantiating VL for NSR {} and VLD {}: {}". \
1952 format(self
.id, vld
.id, e
)
1953 self
._log
.error(err_msg
)
1954 self
._log
.exception(e
)
1955 vlr
.state
= VlRecordState
.FAILED
1957 yield from self
.update_state()
1960 def delete_vl_instance(self
, vld
):
1961 for vlr
in self
._vlrs
:
1962 if vlr
.vld_msg
.id == vld
.id:
1963 self
._log
.debug("Found VLR %s for VLD %s in NSR %s",
1964 vlr
.id, vld
.id, self
.id)
1965 vlr
.state
= VlRecordState
.TERMINATE_PENDING
1966 yield from self
.update_state()
1969 yield from self
.nsm_plugin
.terminate_vl(vlr
)
1970 vlr
.state
= VlRecordState
.TERMINATED
1971 self
._vlrs
.remove(vlr
)
1973 except Exception as e
:
1974 err_msg
= "Error terminating VL for NSR {} and VLD {}: {}". \
1975 format(self
.id, vld
.id, e
)
1976 self
._log
.error(err_msg
)
1977 self
._log
.exception(e
)
1978 vlr
.state
= VlRecordState
.FAILED
1980 yield from self
.update_state()
1984 def create_vnfs(self
, config_xact
):
1986 This function creates VNFs for every VNF in the NSD
1987 associated with this NSR
1989 self
._log
.debug("Creating %u VNFs associated with this NS id %s",
1990 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
1992 for const_vnfd
in self
.nsd_msg
.constituent_vnfd
:
1993 if not const_vnfd
.start_by_default
:
1994 self
._log
.debug("start_by_default set to False in constituent VNF (%s). Skipping start.",
1995 const_vnfd
.member_vnf_index
)
1998 vnfd_msg
= self
._get
_vnfd
(const_vnfd
.vnfd_id_ref
, config_xact
)
1999 cloud_account_name
,om_datacenter_name
= self
._get
_vnfd
_cloud
_account
(const_vnfd
.member_vnf_index
)
2000 if cloud_account_name
is None:
2001 cloud_account_name
= self
.cloud_account_name
2002 yield from self
.create_vnf_record(vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
)
2005 def get_placement_groups(self
, vnfd_msg
, const_vnfd
):
2006 placement_groups
= []
2007 for group
in self
.nsd_msg
.placement_groups
:
2008 for member_vnfd
in group
.member_vnfd
:
2009 if (member_vnfd
.vnfd_id_ref
== vnfd_msg
.id) and \
2010 (member_vnfd
.member_vnf_index_ref
== const_vnfd
.member_vnf_index
):
2011 group_info
= self
.resolve_placement_group_cloud_construct(group
)
2012 if group_info
is None:
2013 self
._log
.error("Could not resolve cloud-construct for placement group: %s", group
.name
)
2014 ### raise PlacementGroupError("Could not resolve cloud-construct for placement group: {}".format(group.name))
2016 self
._log
.info("Successfully resolved cloud construct for placement group: %s for VNF: %s (Member Index: %s)",
2019 const_vnfd
.member_vnf_index
)
2020 placement_groups
.append(group_info
)
2021 return placement_groups
2024 def create_vnf_record(self
, vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
, group_name
=None, group_instance_id
=None):
2025 # Fetch the VNFD associated with this VNF
2026 placement_groups
= self
.get_placement_groups(vnfd_msg
, const_vnfd
)
2027 self
._log
.info("Cloud Account for VNF %d is %s",const_vnfd
.member_vnf_index
,cloud_account_name
)
2028 self
._log
.info("Launching VNF: %s (Member Index: %s) in NSD plancement Groups: %s",
2030 const_vnfd
.member_vnf_index
,
2031 [ group
.name
for group
in placement_groups
])
2032 vnfr
= yield from VirtualNetworkFunctionRecord
.create_record(self
._dts
,
2045 restart_mode
=self
.restart_mode
,
2047 if vnfr
.id in self
._vnfrs
:
2048 err
= "VNF with VNFR id %s already in vnf list" % (vnfr
.id,)
2049 raise NetworkServiceRecordError(err
)
2051 self
._vnfrs
[vnfr
.id] = vnfr
2052 self
._nsm
.vnfrs
[vnfr
.id] = vnfr
2054 yield from vnfr
.set_config_status(NsrYang
.ConfigStates
.INIT
)
2056 self
._log
.debug("Added VNFR %s to NSM VNFR list with id %s",
2062 def create_param_pools(self
):
2063 for param_pool
in self
.nsd_msg
.parameter_pool
:
2064 self
._log
.debug("Found parameter pool %s in nsr id %s", param_pool
, self
.id)
2066 start_value
= param_pool
.range.start_value
2067 end_value
= param_pool
.range.end_value
2068 if end_value
< start_value
:
2069 raise NetworkServiceRecordError(
2070 "Parameter pool %s has invalid range (start: {}, end: {})".format(
2071 start_value
, end_value
2075 self
._param
_pools
[param_pool
.name
] = config_value_pool
.ParameterValuePool(
2078 range(start_value
, end_value
)
2082 def fetch_vnfr(self
, vnfr_path
):
2083 """ Fetch VNFR record """
2085 self
._log
.debug("Fetching VNFR with key %s while instantiating %s",
2087 res_iter
= yield from self
._dts
.query_read(vnfr_path
, rwdts
.XactFlag
.MERGE
)
2089 for ent
in res_iter
:
2090 res
= yield from ent
2096 def instantiate_vnfs(self
, vnfrs
, scaleout
=False):
2098 This function instantiates VNFs for every VNF in this Network Service
2100 self
._log
.debug("Instantiating %u VNFs in NS %s", len(vnfrs
), self
.id)
2102 self
._log
.debug("Instantiating VNF: %s in NS %s", vnf
, self
.id)
2103 yield from self
.nsm_plugin
.instantiate_vnf(self
, vnf
,scaleout
)
2106 def instantiate_vnffgs(self
):
2108 This function instantiates VNFFGs for every VNFFG in this Network Service
2110 self
._log
.debug("Instantiating %u VNFFGs in NS %s",
2111 len(self
.nsd_msg
.vnffgd
), self
.id)
2112 for _
, vnfr
in self
.vnfrs
.items():
2113 while vnfr
.state
in [VnfRecordState
.INSTANTIATION_PENDING
, VnfRecordState
.INIT
]:
2114 self
._log
.debug("Received vnfr state for vnfr %s is %s; retrying",vnfr
.name
,vnfr
.state
)
2115 yield from asyncio
.sleep(2, loop
=self
._loop
)
2116 if vnfr
.state
== VnfRecordState
.ACTIVE
:
2117 self
._log
.debug("Received vnfr state for vnfr %s is %s ",vnfr
.name
,vnfr
.state
)
2120 self
._log
.debug("Received vnfr state for vnfr %s is %s; failing vnffg creation",vnfr
.name
,vnfr
.state
)
2121 self
._vnffgr
_state
= VnffgRecordState
.FAILED
2124 self
._log
.info("Waiting for 90 seconds for VMs to come up")
2125 yield from asyncio
.sleep(90, loop
=self
._loop
)
2126 self
._log
.info("Starting VNFFG orchestration")
2127 for vnffg
in self
._vnffgrs
.values():
2128 self
._log
.debug("Instantiating VNFFG: %s in NS %s", vnffg
, self
.id)
2129 yield from vnffg
.instantiate()
2132 def instantiate_scaling_instances(self
, config_xact
):
2133 """ Instantiate any default scaling instances in this Network Service """
2134 for group
in self
._scaling
_groups
.values():
2135 for i
in range(group
.min_instance_count
):
2136 self
._log
.debug("Instantiating %s default scaling instance %s", group
, i
)
2137 yield from self
.create_scale_group_instance(
2138 group
.name
, i
, config_xact
, is_default
=True
2141 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2142 if group_msg
.scaling_group_name_ref
!= group
.name
:
2145 for instance
in group_msg
.instance
:
2146 self
._log
.debug("Reloading %s scaling instance %s", group_msg
, instance
.id)
2147 yield from self
.create_scale_group_instance(
2148 group
.name
, instance
.id, config_xact
, is_default
=False
2151 def has_scaling_instances(self
):
2152 """ Return boolean indicating if the network service has default scaling groups """
2153 for group
in self
._scaling
_groups
.values():
2154 if group
.min_instance_count
> 0:
2157 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2158 if len(group_msg
.instance
) > 0:
2165 """ This function publishes this NSR """
2166 self
._nsr
_msg
= self
.create_msg()
2168 self
._log
.debug("Publishing the NSR with xpath %s and nsr %s",
2172 if self
._debug
_running
:
2173 self
._log
.debug("Publishing NSR in RUNNING state!")
2176 with self
._dts
.transaction() as xact
:
2177 yield from self
._nsm
.nsr_handler
.update(xact
, self
.nsr_xpath
, self
._nsr
_msg
)
2178 if self
._op
_status
.state
== NetworkServiceRecordState
.RUNNING
:
2179 self
._debug
_running
= True
2182 def unpublish(self
, xact
):
2183 """ Unpublish this NSR object """
2184 self
._log
.debug("Unpublishing Network service id %s", self
.id)
2185 yield from self
._nsm
.nsr_handler
.delete(xact
, self
.nsr_xpath
)
2188 def nsr_xpath(self
):
2189 """ Returns the xpath associated with this NSR """
2191 "D,/nsr:ns-instance-opdata" +
2192 "/nsr:nsr[nsr:ns-instance-config-ref = '{}']"
2196 def xpath_from_nsr(nsr
):
2197 """ Returns the xpath associated with this NSR op data"""
2198 return (NetworkServiceRecord
.XPATH
+
2199 "[nsr:ns-instance-config-ref = '{}']").format(nsr
.id)
2202 def nsd_xpath(self
):
2203 """ Return NSD config xpath."""
2205 "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}']"
2206 ).format(self
.nsd_id
)
2209 def instantiate(self
, config_xact
):
2210 """"Instantiates a NetworkServiceRecord.
2212 This function instantiates a Network service
2213 which involves the following steps,
2215 * Instantiate every VL in NSD by sending create VLR request to DTS.
2216 * Instantiate every VNF in NSD by sending create VNF reuqest to DTS.
2217 * Publish the NSR details to DTS
2220 nsr: The NSR configuration request containing nsr-id and nsd
2221 config_xact: The configuration transaction which initiated the instatiation
2224 NetworkServiceRecordError if the NSR creation fails
2230 self
._log
.debug("Instantiating NS - %s xact - %s", self
, config_xact
)
2232 # Move the state to INIITALIZING
2233 self
.set_state(NetworkServiceRecordState
.INIT
)
2235 event_descr
= "Instantiation Request Received NSR Id:%s" % self
.id
2236 self
.record_event("instantiating", event_descr
)
2239 self
._nsd
= self
._nsr
_cfg
_msg
.nsd
2242 # Update ref count if nsd present in catalog
2243 self
._nsm
.get_nsd_ref(self
.nsd_id
)
2245 except NetworkServiceDescriptorError
:
2246 # This could be an NSD not in the nsd-catalog
2249 # Merge any config and initial config primitive values
2250 self
.config_store
.merge_nsd_config(self
.nsd_msg
)
2251 self
._log
.debug("Merged NSD: {}".format(self
.nsd_msg
.as_dict()))
2253 event_descr
= "Fetched NSD with descriptor id %s" % self
.nsd_id
2254 self
.record_event("nsd-fetched", event_descr
)
2256 if self
._nsd
is None:
2257 msg
= "Failed to fetch NSD with nsd-id [%s] for nsr-id %s"
2258 self
._log
.debug(msg
, self
.nsd_id
, self
.id)
2259 raise NetworkServiceRecordError(self
)
2261 self
._log
.debug("Got nsd result %s", self
._nsd
)
2263 # Substitute any input parameters
2264 self
.substitute_input_parameters(self
._nsd
, self
._nsr
_cfg
_msg
)
2267 yield from self
.create(config_xact
)
2269 # Publish the NSR to DTS
2270 yield from self
.publish()
2273 def do_instantiate():
2275 Instantiate network service
2277 self
._log
.debug("Instantiating VLs nsr id [%s] nsd id [%s]",
2278 self
.id, self
.nsd_id
)
2280 # instantiate the VLs
2281 event_descr
= ("Instantiating %s external VLs for NSR id %s" %
2282 (len(self
.nsd_msg
.vld
), self
.id))
2283 self
.record_event("begin-external-vls-instantiation", event_descr
)
2285 self
.set_state(NetworkServiceRecordState
.VL_INIT_PHASE
)
2287 yield from self
.instantiate_vls()
2289 # Publish the NSR to DTS
2290 yield from self
.publish()
2292 event_descr
= ("Finished instantiating %s external VLs for NSR id %s" %
2293 (len(self
.nsd_msg
.vld
), self
.id))
2294 self
.record_event("end-external-vls-instantiation", event_descr
)
2296 self
.set_state(NetworkServiceRecordState
.VNF_INIT_PHASE
)
2298 self
._log
.debug("Instantiating VNFs ...... nsr[%s], nsd[%s]",
2299 self
.id, self
.nsd_id
)
2301 # instantiate the VNFs
2302 event_descr
= ("Instantiating %s VNFS for NSR id %s" %
2303 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2305 self
.record_event("begin-vnf-instantiation", event_descr
)
2307 yield from self
.instantiate_vnfs(self
._vnfrs
.values())
2309 self
._log
.debug(" Finished instantiating %d VNFs for NSR id %s",
2310 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
2312 event_descr
= ("Finished instantiating %s VNFs for NSR id %s" %
2313 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2314 self
.record_event("end-vnf-instantiation", event_descr
)
2316 if len(self
.vnffgrs
) > 0:
2317 #self.set_state(NetworkServiceRecordState.VNFFG_INIT_PHASE)
2318 event_descr
= ("Instantiating %s VNFFGS for NSR id %s" %
2319 (len(self
.nsd_msg
.vnffgd
), self
.id))
2321 self
.record_event("begin-vnffg-instantiation", event_descr
)
2323 yield from self
.instantiate_vnffgs()
2325 event_descr
= ("Finished instantiating %s VNFFGDs for NSR id %s" %
2326 (len(self
.nsd_msg
.vnffgd
), self
.id))
2327 self
.record_event("end-vnffg-instantiation", event_descr
)
2329 if self
.has_scaling_instances():
2330 event_descr
= ("Instantiating %s Scaling Groups for NSR id %s" %
2331 (len(self
._scaling
_groups
), self
.id))
2333 self
.record_event("begin-scaling-group-instantiation", event_descr
)
2334 yield from self
.instantiate_scaling_instances(config_xact
)
2335 self
.record_event("end-scaling-group-instantiation", event_descr
)
2337 # Give the plugin a chance to deploy the network service now that all
2338 # virtual links and vnfs are instantiated
2339 yield from self
.nsm_plugin
.deploy(self
._nsr
_msg
)
2341 self
._log
.debug("Publishing NSR...... nsr[%s], nsd[%s]",
2342 self
.id, self
.nsd_id
)
2344 # Publish the NSR to DTS
2345 yield from self
.publish()
2347 self
._log
.debug("Published NSR...... nsr[%s], nsd[%s]",
2348 self
.id, self
.nsd_id
)
2350 def on_instantiate_done(fut
):
2351 # If the do_instantiate fails, then publish NSR with failed result
2354 import traceback
, sys
2355 print(traceback
.format_exception(None,e
, e
.__traceback
__), file=sys
.stderr
, flush
=True)
2356 self
._log
.error("NSR instantiation failed for NSR id %s: %s", self
.id, str(e
))
2357 self
._loop
.create_task(self
.instantiation_failed(failed_reason
=str(e
)))
2359 instantiate_task
= self
._loop
.create_task(do_instantiate())
2360 instantiate_task
.add_done_callback(on_instantiate_done
)
2363 def set_config_status(self
, status
, status_details
=None):
2364 if self
.config_status
!= status
:
2365 self
._log
.debug("Updating NSR {} status for {} to {}".
2366 format(self
.name
, self
.config_status
, status
))
2367 self
._config
_status
= status
2368 self
._config
_status
_details
= status_details
2370 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2371 self
.record_event("config-failed", "NS configuration failed",
2372 evt_details
=self
._config
_status
_details
)
2374 yield from self
.publish()
2377 def is_active(self
):
2378 """ This NS is active """
2379 self
.set_state(NetworkServiceRecordState
.RUNNING
)
2383 # Publish the NSR to DTS
2384 self
._log
.debug("Network service %s is active ", self
.id)
2385 self
._is
_active
= True
2387 event_descr
= "NSR in running state for NSR id %s" % self
.id
2388 self
.record_event("ns-running", event_descr
)
2390 yield from self
.publish()
2393 def instantiation_failed(self
, failed_reason
=None):
2394 """ The NS instantiation failed"""
2395 self
._log
.error("Network service id:%s, name:%s instantiation failed",
2397 self
.set_state(NetworkServiceRecordState
.FAILED
)
2399 event_descr
= "Instantiation of NS %s failed" % self
.id
2400 self
.record_event("ns-failed", event_descr
, evt_details
=failed_reason
)
2402 # Publish the NSR to DTS
2403 yield from self
.publish()
2406 def terminate_vnfrs(self
, vnfrs
):
2407 """ Terminate VNFRS in this network service """
2408 self
._log
.debug("Terminating VNFs in network service %s", self
.id)
2410 yield from self
.nsm_plugin
.terminate_vnf(vnfr
)
2413 def terminate(self
):
2414 """ Terminate a NetworkServiceRecord."""
2415 def terminate_vnffgrs():
2416 """ Terminate VNFFGRS in this network service """
2417 self
._log
.debug("Terminating VNFFGRs in network service %s", self
.id)
2418 for vnffgr
in self
.vnffgrs
.values():
2419 yield from vnffgr
.terminate()
2421 def terminate_vlrs():
2422 """ Terminate VLRs in this netork service """
2423 self
._log
.debug("Terminating VLs in network service %s", self
.id)
2424 for vlr
in self
.vlrs
:
2425 yield from self
.nsm_plugin
.terminate_vl(vlr
)
2426 vlr
.state
= VlRecordState
.TERMINATED
2427 if vlr
.id in self
.vlr_uptime_tasks
:
2428 self
.vlr_uptime_tasks
[vlr
.id].cancel()
2430 self
._log
.debug("Terminating network service id %s", self
.id)
2432 # Move the state to TERMINATE
2433 self
.set_state(NetworkServiceRecordState
.TERMINATE
)
2434 event_descr
= "Terminate being processed for NS Id:%s" % self
.id
2435 self
.record_event("terminate", event_descr
)
2437 # Move the state to VNF_TERMINATE_PHASE
2438 self
._log
.debug("Terminating VNFFGs in NS ID: %s", self
.id)
2439 self
.set_state(NetworkServiceRecordState
.VNFFG_TERMINATE_PHASE
)
2440 event_descr
= "Terminating VNFFGS in NS Id:%s" % self
.id
2441 self
.record_event("terminating-vnffgss", event_descr
)
2442 yield from terminate_vnffgrs()
2444 # Move the state to VNF_TERMINATE_PHASE
2445 self
.set_state(NetworkServiceRecordState
.VNF_TERMINATE_PHASE
)
2446 event_descr
= "Terminating VNFS in NS Id:%s" % self
.id
2447 self
.record_event("terminating-vnfs", event_descr
)
2448 yield from self
.terminate_vnfrs(self
.vnfrs
.values())
2450 # Move the state to VL_TERMINATE_PHASE
2451 self
.set_state(NetworkServiceRecordState
.VL_TERMINATE_PHASE
)
2452 event_descr
= "Terminating VLs in NS Id:%s" % self
.id
2453 self
.record_event("terminating-vls", event_descr
)
2454 yield from terminate_vlrs()
2456 yield from self
.nsm_plugin
.terminate_ns(self
)
2458 # Move the state to TERMINATED
2459 self
.set_state(NetworkServiceRecordState
.TERMINATED
)
2460 event_descr
= "Terminated NS Id:%s" % self
.id
2461 self
.record_event("terminated", event_descr
)
2464 """"Enable a NetworkServiceRecord."""
2468 """"Disable a NetworkServiceRecord."""
2471 def map_config_status(self
):
2472 self
._log
.debug("Config status for ns {} is {}".
2473 format(self
.name
, self
._config
_status
))
2474 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURING
:
2475 return 'configuring'
2476 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2480 def vl_phase_completed(self
):
2481 """ Are VLs created in this NS?"""
2482 return self
._vl
_phase
_completed
2484 def vnf_phase_completed(self
):
2485 """ Are VLs created in this NS?"""
2486 return self
._vnf
_phase
_completed
2488 def create_msg(self
):
2489 """ The network serice record as a message """
2490 nsr_dict
= {"ns_instance_config_ref": self
.id}
2491 nsr
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr
.from_dict(nsr_dict
)
2492 #nsr.cloud_account = self.cloud_account_name
2493 nsr
.sdn_account
= self
._sdn
_account
_name
2494 nsr
.name_ref
= self
.name
2495 nsr
.nsd_ref
= self
.nsd_id
2496 nsr
.nsd_name_ref
= self
.nsd_msg
.name
2497 nsr
.operational_events
= self
._op
_status
.msg
2498 nsr
.operational_status
= self
._op
_status
.yang_str()
2499 nsr
.config_status
= self
.map_config_status()
2500 nsr
.config_status_details
= self
._config
_status
_details
2501 nsr
.create_time
= self
._create
_time
2502 nsr
.uptime
= int(time
.time()) - self
._create
_time
2504 for cfg_prim
in self
.nsd_msg
.service_primitive
:
2505 cfg_prim
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_ServicePrimitive
.from_dict(
2507 nsr
.service_primitive
.append(cfg_prim
)
2509 for init_cfg
in self
.nsd_msg
.initial_config_primitive
:
2510 prim
= NsrYang
.NsrInitialConfigPrimitive
.from_dict(
2512 nsr
.initial_config_primitive
.append(prim
)
2514 if self
.vl_phase_completed():
2515 for vlr
in self
.vlrs
:
2516 nsr
.vlr
.append(vlr
.create_nsr_vlr_msg(self
.vnfrs
.values()))
2518 if self
.vnf_phase_completed():
2519 for vnfr_id
in self
.vnfrs
:
2520 nsr
.constituent_vnfr_ref
.append(self
.vnfrs
[vnfr_id
].const_vnfr_msg
)
2521 for vnffgr
in self
.vnffgrs
.values():
2522 nsr
.vnffgr
.append(vnffgr
.fetch_vnffgr())
2523 for scaling_group
in self
._scaling
_groups
.values():
2524 nsr
.scaling_group_record
.append(scaling_group
.create_record_msg())
2528 def all_vnfs_active(self
):
2529 """ Are all VNFS in this NS active? """
2530 for _
, vnfr
in self
.vnfrs
.items():
2531 if vnfr
.active
is not True:
2536 def update_state(self
):
2537 """ Re-evaluate this NS's state """
2538 curr_state
= self
._op
_status
.state
2540 if curr_state
== NetworkServiceRecordState
.TERMINATED
:
2541 self
._log
.debug("NS (%s) in terminated state, not updating state", self
.id)
2544 new_state
= NetworkServiceRecordState
.RUNNING
2545 self
._log
.info("Received update_state for nsr: %s, curr-state: %s",
2546 self
.id, curr_state
)
2548 # Check all the VNFRs are present
2549 for _
, vnfr
in self
.vnfrs
.items():
2550 if vnfr
.state
in [VnfRecordState
.ACTIVE
, VnfRecordState
.TERMINATED
]:
2552 elif vnfr
.state
== VnfRecordState
.FAILED
:
2553 if vnfr
._prev
_state
!= vnfr
.state
:
2554 event_descr
= "Instantiation of VNF %s failed" % vnfr
.id
2555 event_error_details
= vnfr
.state_failed_reason
2556 self
.record_event("vnf-failed", event_descr
, evt_details
=event_error_details
)
2557 vnfr
.set_state(VnfRecordState
.FAILED
)
2559 self
._log
.info("VNF state did not change, curr=%s, prev=%s",
2560 vnfr
.state
, vnfr
._prev
_state
)
2561 new_state
= NetworkServiceRecordState
.FAILED
2564 self
._log
.info("VNF %s in NSR %s is still not active; current state is: %s",
2565 vnfr
.id, self
.id, vnfr
.state
)
2566 new_state
= curr_state
2568 # If new state is RUNNING; check all VLs
2569 if new_state
== NetworkServiceRecordState
.RUNNING
:
2570 for vl
in self
.vlrs
:
2572 if vl
.state
in [VlRecordState
.ACTIVE
, VlRecordState
.TERMINATED
]:
2574 elif vl
.state
== VlRecordState
.FAILED
:
2575 if vl
.prev_state
!= vl
.state
:
2576 event_descr
= "Instantiation of VL %s failed" % vl
.id
2577 event_error_details
= vl
.state_failed_reason
2578 self
.record_event("vl-failed", event_descr
, evt_details
=event_error_details
)
2579 vl
.prev_state
= vl
.state
2581 self
._log
.debug("VL %s already in failed state")
2583 if vl
.state
in [VlRecordState
.INSTANTIATION_PENDING
, VlRecordState
.INIT
]:
2584 new_state
= NetworkServiceRecordState
.VL_INSTANTIATE
2587 if vl
.state
in [VlRecordState
.TERMINATE_PENDING
]:
2588 new_state
= NetworkServiceRecordState
.VL_TERMINATE
2591 # If new state is RUNNING; check VNFFGRs are also active
2592 if new_state
== NetworkServiceRecordState
.RUNNING
:
2593 for _
, vnffgr
in self
.vnffgrs
.items():
2594 self
._log
.info("Checking vnffgr state for nsr %s is: %s",
2595 self
.id, vnffgr
.state
)
2596 if vnffgr
.state
== VnffgRecordState
.ACTIVE
:
2598 elif vnffgr
.state
== VnffgRecordState
.FAILED
:
2599 event_descr
= "Instantiation of VNFFGR %s failed" % vnffgr
.id
2600 self
.record_event("vnffg-failed", event_descr
)
2601 new_state
= NetworkServiceRecordState
.FAILED
2604 self
._log
.info("VNFFGR %s in NSR %s is still not active; current state is: %s",
2605 vnffgr
.id, self
.id, vnffgr
.state
)
2606 new_state
= curr_state
2608 # Update all the scaling group instance operational status to
2609 # reflect the state of all VNFR within that instance
2610 yield from self
._update
_scale
_group
_instances
_status
()
2612 for _
, group
in self
._scaling
_groups
.items():
2613 if group
.state
== scale_group
.ScaleGroupState
.SCALING_OUT
:
2614 new_state
= NetworkServiceRecordState
.SCALING_OUT
2616 elif group
.state
== scale_group
.ScaleGroupState
.SCALING_IN
:
2617 new_state
= NetworkServiceRecordState
.SCALING_IN
2620 if new_state
!= curr_state
:
2621 self
._log
.debug("Changing state of Network service %s from %s to %s",
2622 self
.id, curr_state
, new_state
)
2623 if new_state
== NetworkServiceRecordState
.RUNNING
:
2624 yield from self
.is_active()
2625 elif new_state
== NetworkServiceRecordState
.FAILED
:
2626 # If the NS is already active and we entered scaling_in, scaling_out,
2627 # do not mark the NS as failing if scaling operation failed.
2628 if curr_state
in [NetworkServiceRecordState
.SCALING_OUT
,
2629 NetworkServiceRecordState
.SCALING_IN
] and self
._is
_active
:
2630 new_state
= NetworkServiceRecordState
.RUNNING
2631 self
.set_state(new_state
)
2633 yield from self
.instantiation_failed()
2635 self
.set_state(new_state
)
2637 yield from self
.publish()
2640 class InputParameterSubstitution(object):
2642 This class is responsible for substituting input parameters into an NSD.
2645 def __init__(self
, log
):
2646 """Create an instance of InputParameterSubstitution
2649 log - a logger for this object to use
2654 def __call__(self
, nsd
, nsr_config
):
2655 """Substitutes input parameters from the NSR config into the NSD
2657 This call modifies the provided NSD with the input parameters that are
2658 contained in the NSR config.
2661 nsd - a GI NSD object
2662 nsr_config - a GI NSR config object
2665 if nsd
is None or nsr_config
is None:
2668 # Create a lookup of the xpath elements that this descriptor allows
2670 optional_input_parameters
= set()
2671 for input_parameter
in nsd
.input_parameter_xpath
:
2672 optional_input_parameters
.add(input_parameter
.xpath
)
2674 # Apply the input parameters to the descriptor
2675 if nsr_config
.input_parameter
:
2676 for param
in nsr_config
.input_parameter
:
2677 if param
.xpath
not in optional_input_parameters
:
2678 msg
= "tried to set an invalid input parameter ({})"
2679 self
.log
.error(msg
.format(param
.xpath
))
2683 "input-parameter:{} = {}".format(
2690 xpath
.setxattr(nsd
, param
.xpath
, param
.value
)
2692 except Exception as e
:
2693 self
.log
.exception(e
)
2696 class NetworkServiceDescriptor(object):
2698 Network service descriptor class
2701 def __init__(self
, dts
, log
, loop
, nsd
, nsm
):
2713 """ Returns nsd id """
2718 """ Returns name of nsd """
2719 return self
._nsd
.name
2722 def ref_count(self
):
2723 """ Returns reference count"""
2724 return self
._ref
_count
2727 """ Returns whether nsd is in use or not """
2728 return True if self
.ref_count
> 0 else False
2731 """ Take a reference on this object """
2732 self
._ref
_count
+= 1
2735 """ Release reference on this object """
2736 if self
.ref_count
< 1:
2737 msg
= ("Unref on a NSD object - nsd id %s, ref_count = %s" %
2738 (self
.id, self
.ref_count
))
2739 self
._log
.critical(msg
)
2740 raise NetworkServiceDescriptorError(msg
)
2741 self
._ref
_count
-= 1
2745 """ Return the message associated with this NetworkServiceDescriptor"""
2749 def path_for_id(nsd_id
):
2750 """ Return path for the passed nsd_id"""
2751 return "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}'".format(nsd_id
)
2754 """ Return the message associated with this NetworkServiceDescriptor"""
2755 return NetworkServiceDescriptor
.path_for_id(self
.id)
2757 def update(self
, nsd
):
2758 """ Update the NSD descriptor """
2762 class NsdDtsHandler(object):
2763 """ The network service descriptor DTS handler """
2764 XPATH
= "C,/nsd:nsd-catalog/nsd:nsd"
2766 def __init__(self
, dts
, log
, loop
, nsm
):
2776 """ Return registration handle """
2781 """ Register for Nsd create/update/delete/read requests from dts """
2783 def on_apply(dts
, acg
, xact
, action
, scratch
):
2784 """Apply the configuration"""
2785 is_recovery
= xact
.xact
is None and action
== rwdts
.AppconfAction
.INSTALL
2786 self
._log
.debug("Got nsd apply cfg (xact:%s) (action:%s)",
2788 # Create/Update an NSD record
2789 for cfg
in self
._regh
.get_xact_elements(xact
):
2790 # Only interested in those NSD cfgs whose ID was received in prepare callback
2791 if cfg
.id in scratch
.get('nsds', []) or is_recovery
:
2792 self
._nsm
.update_nsd(cfg
)
2794 scratch
.pop('nsds', None)
2796 return RwTypes
.RwStatus
.SUCCESS
2799 def delete_nsd_libs(nsd_id
):
2800 """ Remove any files uploaded with NSD and stored under $RIFT_ARTIFACTS/libs/<id> """
2802 rift_artifacts_dir
= os
.environ
['RIFT_ARTIFACTS']
2803 nsd_dir
= os
.path
.join(rift_artifacts_dir
, 'launchpad/libs', nsd_id
)
2805 if os
.path
.exists (nsd_dir
):
2806 shutil
.rmtree(nsd_dir
, ignore_errors
=True)
2807 except Exception as e
:
2808 self
._log
.error("Exception in cleaning up NSD libs {}: {}".
2810 self
._log
.excpetion(e
)
2813 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2814 """ Prepare callback from DTS for NSD config """
2816 self
._log
.info("Got nsd prepare - config received nsd id %s, msg %s",
2819 fref
= ProtobufC
.FieldReference
.alloc()
2820 fref
.goto_whole_message(msg
.to_pbcm())
2822 if fref
.is_field_deleted():
2823 # Delete an NSD record
2824 self
._log
.debug("Deleting NSD with id %s", msg
.id)
2825 if self
._nsm
.nsd_in_use(msg
.id):
2826 self
._log
.debug("Cannot delete NSD in use - %s", msg
.id)
2827 err
= "Cannot delete an NSD in use - %s" % msg
.id
2828 raise NetworkServiceDescriptorRefCountExists(err
)
2830 yield from delete_nsd_libs(msg
.id)
2831 self
._nsm
.delete_nsd(msg
.id)
2833 # Add this NSD to scratch to create/update in apply callback
2834 nsds
= scratch
.setdefault('nsds', [])
2836 # acg._scratch['nsds'].append(msg.id)
2838 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2841 "Registering for NSD config using xpath: %s",
2842 NsdDtsHandler
.XPATH
,
2845 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2846 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2847 # Need a list in scratch to store NSDs to create/update later
2848 # acg._scratch['nsds'] = list()
2849 self
._regh
= acg
.register(
2850 xpath
=NsdDtsHandler
.XPATH
,
2851 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
2852 on_prepare
=on_prepare
)
2855 class VnfdDtsHandler(object):
2856 """ DTS handler for VNFD config changes """
2857 XPATH
= "C,/vnfd:vnfd-catalog/vnfd:vnfd"
2859 def __init__(self
, dts
, log
, loop
, nsm
):
2868 """ DTS registration handle """
2873 """ Register for VNFD configuration"""
2876 def on_apply(dts
, acg
, xact
, action
, scratch
):
2877 """Apply the configuration"""
2878 self
._log
.debug("Got NSM VNFD apply (xact: %s) (action: %s)(scr: %s)",
2879 xact
, action
, scratch
)
2881 # Create/Update a VNFD record
2882 for cfg
in self
._regh
.get_xact_elements(xact
):
2883 # Only interested in those VNFD cfgs whose ID was received in prepare callback
2884 if cfg
.id in scratch
.get('vnfds', []):
2885 self
._nsm
.update_vnfd(cfg
)
2887 for cfg
in self
._regh
.elements
:
2888 if cfg
.id in scratch
.get('deleted_vnfds', []):
2889 yield from self
._nsm
.delete_vnfd(cfg
.id)
2891 scratch
.pop('vnfds', None)
2892 scratch
.pop('deleted_vnfds', None)
2895 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2896 """ on prepare callback """
2897 self
._log
.debug("Got on prepare for VNFD (path: %s) (action: %s) (msg: %s)",
2898 ks_path
.to_xpath(RwNsmYang
.get_schema()), xact_info
.query_action
, msg
)
2900 fref
= ProtobufC
.FieldReference
.alloc()
2901 fref
.goto_whole_message(msg
.to_pbcm())
2903 # Handle deletes in prepare_callback, but adds/updates in apply_callback
2904 if fref
.is_field_deleted():
2905 self
._log
.debug("Adding msg to deleted field")
2906 deleted_vnfds
= scratch
.setdefault('deleted_vnfds', [])
2907 deleted_vnfds
.append(msg
.id)
2909 # Add this VNFD to scratch to create/update in apply callback
2910 vnfds
= scratch
.setdefault('vnfds', [])
2911 vnfds
.append(msg
.id)
2913 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2916 "Registering for VNFD config using xpath: %s",
2917 VnfdDtsHandler
.XPATH
,
2919 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2920 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2921 # Need a list in scratch to store VNFDs to create/update later
2922 # acg._scratch['vnfds'] = list()
2923 # acg._scratch['deleted_vnfds'] = list()
2924 self
._regh
= acg
.register(
2925 xpath
=VnfdDtsHandler
.XPATH
,
2926 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY
,
2927 on_prepare
=on_prepare
)
2929 class NsrRpcDtsHandler(object):
2930 """ The network service instantiation RPC DTS handler """
2931 EXEC_NSR_CONF_XPATH
= "I,/nsr:start-network-service"
2932 EXEC_NSR_CONF_O_XPATH
= "O,/nsr:start-network-service"
2933 NETCONF_IP_ADDRESS
= "127.0.0.1"
2935 RESTCONF_PORT
= 8888
2936 NETCONF_USER
= "admin"
2937 NETCONF_PW
= "admin"
2938 REST_BASE_V2_URL
= 'https://{}:{}/v2/api/'.format("127.0.0.1",8888)
2940 def __init__(self
, dts
, log
, loop
, nsm
):
2947 self
._ns
_regh
= None
2949 self
._manager
= None
2950 self
._nsr
_config
_url
= NsrRpcDtsHandler
.REST_BASE_V2_URL
+ 'config/ns-instance-config'
2952 self
._model
= RwYang
.Model
.create_libncx()
2953 self
._model
.load_schema_ypbc(RwNsrYang
.get_schema())
2957 """ Return the NS manager instance """
2961 def wrap_netconf_config_xml(xml
):
2962 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
2966 def _connect(self
, timeout_secs
=240):
2968 start_time
= time
.time()
2969 while (time
.time() - start_time
) < timeout_secs
:
2972 self
._log
.debug("Attemping NsmTasklet netconf connection.")
2974 manager
= yield from ncclient
.asyncio_manager
.asyncio_connect(
2976 host
=NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
,
2977 port
=NsrRpcDtsHandler
.NETCONF_PORT
,
2978 username
=NsrRpcDtsHandler
.NETCONF_USER
,
2979 password
=NsrRpcDtsHandler
.NETCONF_PW
,
2981 look_for_keys
=False,
2982 hostkey_verify
=False,
2987 except ncclient
.transport
.errors
.SSHError
as e
:
2988 self
._log
.warning("Netconf connection to launchpad %s failed: %s",
2989 NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
, str(e
))
2991 yield from asyncio
.sleep(5, loop
=self
._loop
)
2993 raise NsrInstantiationFailed("Failed to connect to Launchpad within %s seconds" %
2996 def _apply_ns_instance_config(self
,payload_dict
):
2997 #self._log.debug("At apply NS instance config with payload %s",payload_dict)
2998 req_hdr
= {'accept':'application/vnd.yang.data+json','content-type':'application/vnd.yang.data+json'}
2999 response
=requests
.post(self
._nsr
_config
_url
, headers
=req_hdr
, auth
=('admin', 'admin'),data
=payload_dict
,verify
=False)
3004 """ Register for NS monitoring read from dts """
3006 def on_ns_config_prepare(xact_info
, action
, ks_path
, msg
):
3007 """ prepare callback from dts start-network-service"""
3008 assert action
== rwdts
.QueryAction
.RPC
3010 rpc_op
= NsrYang
.YangOutput_Nsr_StartNetworkService
.from_dict({
3011 "nsr_id":str(uuid
.uuid4())
3014 if not ('name' in rpc_ip
and 'nsd_ref' in rpc_ip
and ('cloud_account' in rpc_ip
or 'om_datacenter' in rpc_ip
)):
3015 self
._log
.error("Mandatory parameters name or nsd_ref or cloud account not found in start-network-service {}".format(rpc_ip
))
3018 self
._log
.debug("start-network-service RPC input: {}".format(rpc_ip
))
3021 # Add used value to the pool
3022 self
._log
.debug("RPC output: {}".format(rpc_op
))
3024 nsd_copy
= self
.nsm
.get_nsd(rpc_ip
.nsd_ref
)
3026 #if not self._manager:
3027 # self._manager = yield from self._connect()
3029 self
._log
.debug("Configuring ns-instance-config with name %s nsd-ref: %s",
3030 rpc_ip
.name
, rpc_ip
.nsd_ref
)
3032 ns_instance_config_dict
= {"id":rpc_op
.nsr_id
, "admin_status":"ENABLED"}
3033 ns_instance_config_copy_dict
= {k
:v
for k
, v
in rpc_ip
.as_dict().items()
3034 if k
in RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr().fields
}
3035 ns_instance_config_dict
.update(ns_instance_config_copy_dict
)
3037 ns_instance_config
= RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.from_dict(ns_instance_config_dict
)
3038 ns_instance_config
.nsd
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_Nsd()
3039 ns_instance_config
.nsd
.from_dict(nsd_copy
.msg
.as_dict())
3041 payload_dict
= ns_instance_config
.to_json(self
._model
)
3042 #xml = ns_instance_config.to_xml_v2(self._model)
3043 #netconf_xml = self.wrap_netconf_config_xml(xml)
3045 #self._log.debug("Sending configure ns-instance-config xml to %s: %s",
3046 # netconf_xml, NsrRpcDtsHandler.NETCONF_IP_ADDRESS)
3047 self
._log
.debug("Sending configure ns-instance-config json to %s: %s",
3048 self
._nsr
_config
_url
,ns_instance_config
)
3050 #response = yield from self._manager.edit_config(
3052 # config=netconf_xml,
3054 response
= yield from self
._loop
.run_in_executor(
3056 self
._apply
_ns
_instance
_config
,
3059 response
.raise_for_status()
3060 self
._log
.debug("Received edit config response: %s", response
.json())
3062 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
,
3063 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
,
3065 except Exception as e
:
3066 self
._log
.error("Exception processing the "
3067 "start-network-service: {}".format(e
))
3068 self
._log
.exception(e
)
3069 xact_info
.respond_xpath(rwdts
.XactRspCode
.NACK
,
3070 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
)
3073 hdl_ns
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_ns_config_prepare
,)
3075 with self
._dts
.group_create() as group
:
3076 self
._ns
_regh
= group
.register(xpath
=NsrRpcDtsHandler
.EXEC_NSR_CONF_XPATH
,
3078 flags
=rwdts
.Flag
.PUBLISHER
,
3082 class NsrDtsHandler(object):
3083 """ The network service DTS handler """
3084 NSR_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr"
3085 SCALE_INSTANCE_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group/nsr:instance"
3086 KEY_PAIR_XPATH
= "C,/nsr:key-pair"
3088 def __init__(self
, dts
, log
, loop
, nsm
):
3094 self
._nsr
_regh
= None
3095 self
._scale
_regh
= None
3096 self
._key
_pair
_regh
= None
3100 """ Return the NS manager instance """
3105 """ Register for Nsr create/update/delete/read requests from dts """
3107 def nsr_id_from_keyspec(ks
):
3108 nsr_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.schema().keyspec_to_entry(ks
)
3109 nsr_id
= nsr_path_entry
.key00
.id
3112 def group_name_from_keyspec(ks
):
3113 group_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
.schema().keyspec_to_entry(ks
)
3114 group_name
= group_path_entry
.key00
.scaling_group_name_ref
3117 def is_instance_in_reg_elements(nsr_id
, group_name
, instance_id
):
3118 """ Return boolean indicating if scaling group instance was already commited previously.
3120 By looking at the existing elements in this registration handle (elements not part
3121 of this current xact), we can tell if the instance was configured previously without
3122 keeping any application state.
3124 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3125 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3126 elem_group_name
= group_name_from_keyspec(keyspec
)
3128 if elem_nsr_id
!= nsr_id
or group_name
!= elem_group_name
:
3131 if instance_cfg
.id == instance_id
:
3136 def get_scale_group_instance_delta(nsr_id
, group_name
, xact
):
3137 delta
= {"added": [], "deleted": []}
3138 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3139 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3140 if elem_nsr_id
!= nsr_id
:
3143 elem_group_name
= group_name_from_keyspec(keyspec
)
3144 if elem_group_name
!= group_name
:
3147 delta
["added"].append(instance_cfg
.id)
3149 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(include_keyspec
=True):
3150 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3151 if elem_nsr_id
!= nsr_id
:
3154 elem_group_name
= group_name_from_keyspec(keyspec
)
3155 if elem_group_name
!= group_name
:
3158 if instance_cfg
.id in delta
["added"]:
3159 delta
["added"].remove(instance_cfg
.id)
3161 delta
["deleted"].append(instance_cfg
.id)
3166 def update_nsr_nsd(nsr_id
, xact
, scratch
):
3169 def get_nsr_vl_delta(nsr_id
, xact
, scratch
):
3170 delta
= {"added": [], "deleted": []}
3171 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3172 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3173 if elem_nsr_id
!= nsr_id
:
3176 if 'vld' in instance_cfg
.nsd
:
3177 for vld
in instance_cfg
.nsd
.vld
:
3178 delta
["added"].append(vld
)
3180 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3181 self
._log
.debug("NSR update: %s", instance_cfg
)
3182 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3183 if elem_nsr_id
!= nsr_id
:
3186 if 'vld' in instance_cfg
.nsd
:
3187 for vld
in instance_cfg
.nsd
.vld
:
3188 if vld
in delta
["added"]:
3189 delta
["added"].remove(vld
)
3191 delta
["deleted"].append(vld
)
3195 vl_delta
= yield from get_nsr_vl_delta(nsr_id
, xact
, scratch
)
3196 self
._log
.debug("Got NSR:%s VL instance delta: %s", nsr_id
, vl_delta
)
3198 for vld
in vl_delta
["added"]:
3199 yield from self
._nsm
.nsr_instantiate_vl(nsr_id
, vld
)
3201 for vld
in vl_delta
["deleted"]:
3202 yield from self
._nsm
.nsr_terminate_vl(nsr_id
, vld
)
3204 def get_add_delete_update_cfgs(dts_member_reg
, xact
, key_name
, scratch
):
3205 # Unfortunately, it is currently difficult to figure out what has exactly
3206 # changed in this xact without Pbdelta support (RIFT-4916)
3207 # As a workaround, we can fetch the pre and post xact elements and
3208 # perform a comparison to figure out adds/deletes/updates
3209 xact_cfgs
= list(dts_member_reg
.get_xact_elements(xact
))
3210 curr_cfgs
= list(dts_member_reg
.elements
)
3212 xact_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in xact_cfgs
}
3213 curr_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in curr_cfgs
}
3216 added_keys
= set(xact_key_map
) - set(curr_key_map
)
3217 added_cfgs
= [xact_key_map
[key
] for key
in added_keys
]
3220 deleted_keys
= set(curr_key_map
) - set(xact_key_map
)
3221 deleted_cfgs
= [curr_key_map
[key
] for key
in deleted_keys
]
3224 updated_keys
= set(curr_key_map
) & set(xact_key_map
)
3225 updated_cfgs
= [xact_key_map
[key
] for key
in updated_keys
3226 if xact_key_map
[key
] != curr_key_map
[key
]]
3228 return added_cfgs
, deleted_cfgs
, updated_cfgs
3230 def get_nsr_key_pairs(dts_member_reg
, xact
):
3232 for instance_cfg
, keyspec
in dts_member_reg
.get_xact_elements(xact
, include_keyspec
=True):
3233 self
._log
.debug("Key pair received is {} KS: {}".format(instance_cfg
, keyspec
))
3234 xpath
= keyspec
.to_xpath(RwNsrYang
.get_schema())
3235 key_pairs
[instance_cfg
.name
] = instance_cfg
3238 def on_apply(dts
, acg
, xact
, action
, scratch
):
3239 """Apply the configuration"""
3240 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3241 xact
, action
, scratch
)
3243 def handle_create_nsr(msg
, key_pairs
=None, restart_mode
=False):
3244 # Handle create nsr requests """
3245 # Do some validations
3246 if not msg
.has_field("nsd"):
3247 err
= "NSD not provided"
3248 self
._log
.error(err
)
3249 raise NetworkServiceRecordError(err
)
3251 self
._log
.debug("Creating NetworkServiceRecord %s from nsr config %s",
3252 msg
.id, msg
.as_dict())
3253 nsr
= self
.nsm
.create_nsr(msg
, key_pairs
=key_pairs
, restart_mode
=restart_mode
)
3256 def handle_delete_nsr(msg
):
3258 def delete_instantiation(ns_id
):
3259 """ Delete instantiation """
3260 with self
._dts
.transaction() as xact
:
3261 yield from self
._nsm
.terminate_ns(ns_id
, xact
)
3263 # Handle delete NSR requests
3264 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3265 # Terminate the NSR instance
3266 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3268 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3269 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3270 nsr
.record_event("terminate-rcvd", event_descr
)
3272 self
._loop
.create_task(delete_instantiation(msg
.id))
3275 def begin_instantiation(nsr
):
3276 # Begin instantiation
3277 self
._log
.info("Beginning NS instantiation: %s", nsr
.id)
3278 yield from self
._nsm
.instantiate_ns(nsr
.id, xact
)
3280 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3281 xact
, action
, scratch
)
3283 if action
== rwdts
.AppconfAction
.INSTALL
and xact
.id is None:
3285 for element
in self
._key
_pair
_regh
.elements
:
3286 key_pairs
.append(element
)
3287 for element
in self
._nsr
_regh
.elements
:
3288 nsr
= handle_create_nsr(element
, key_pairs
, restart_mode
=True)
3289 self
._loop
.create_task(begin_instantiation(nsr
))
3292 (added_msgs
, deleted_msgs
, updated_msgs
) = get_add_delete_update_cfgs(self
._nsr
_regh
,
3296 self
._log
.debug("Added: %s, Deleted: %s, Updated: %s", added_msgs
,
3297 deleted_msgs
, updated_msgs
)
3299 for msg
in added_msgs
:
3300 if msg
.id not in self
._nsm
.nsrs
:
3301 self
._log
.info("Create NSR received in on_apply to instantiate NS:%s", msg
.id)
3302 key_pairs
= get_nsr_key_pairs(self
._key
_pair
_regh
, xact
)
3303 nsr
= handle_create_nsr(msg
,key_pairs
)
3304 self
._loop
.create_task(begin_instantiation(nsr
))
3306 for msg
in deleted_msgs
:
3307 self
._log
.info("Delete NSR received in on_apply to terminate NS:%s", msg
.id)
3309 handle_delete_nsr(msg
)
3311 self
._log
.exception("Failed to terminate NS:%s", msg
.id)
3313 for msg
in updated_msgs
:
3314 self
._log
.info("Update NSR received in on_apply: %s", msg
)
3316 self
._nsm
.nsr_update_cfg(msg
.id, msg
)
3319 self
._loop
.create_task(update_nsr_nsd(msg
.id, xact
, scratch
))
3321 for group
in msg
.scaling_group
:
3322 instance_delta
= get_scale_group_instance_delta(msg
.id, group
.scaling_group_name_ref
, xact
)
3323 self
._log
.debug("Got NSR:%s scale group instance delta: %s", msg
.id, instance_delta
)
3325 for instance_id
in instance_delta
["added"]:
3326 self
._nsm
.scale_nsr_out(msg
.id, group
.scaling_group_name_ref
, instance_id
, xact
)
3328 for instance_id
in instance_delta
["deleted"]:
3329 self
._nsm
.scale_nsr_in(msg
.id, group
.scaling_group_name_ref
, instance_id
)
3332 return RwTypes
.RwStatus
.SUCCESS
3335 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
3336 """ Prepare calllback from DTS for NSR """
3338 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3339 action
= xact_info
.query_action
3341 "Got Nsr prepare callback (xact: %s) (action: %s) (info: %s), %s:%s)",
3342 xact
, action
, xact_info
, xpath
, msg
3346 def delete_instantiation(ns_id
):
3347 """ Delete instantiation """
3348 yield from self
._nsm
.terminate_ns(ns_id
, None)
3350 def handle_delete_nsr():
3351 """ Handle delete NSR requests """
3352 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3353 # Terminate the NSR instance
3354 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3356 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3357 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3358 nsr
.record_event("terminate-rcvd", event_descr
)
3360 self
._loop
.create_task(delete_instantiation(msg
.id))
3362 fref
= ProtobufC
.FieldReference
.alloc()
3363 fref
.goto_whole_message(msg
.to_pbcm())
3365 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
, rwdts
.QueryAction
.DELETE
]:
3366 # if this is an NSR create
3367 if action
!= rwdts
.QueryAction
.DELETE
and msg
.id not in self
._nsm
.nsrs
:
3368 # Ensure the Cloud account/datacenter has been specified
3369 if not msg
.has_field("cloud_account") and not msg
.has_field("om_datacenter"):
3370 raise NsrInstantiationFailed("Cloud account or datacenter not specified in NSR")
3372 # Check if nsd is specified
3373 if not msg
.has_field("nsd"):
3374 raise NsrInstantiationFailed("NSD not specified in NSR")
3377 nsr
= self
._nsm
.nsrs
[msg
.id]
3379 if msg
.has_field("nsd"):
3380 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3381 raise NsrVlUpdateError("Unable to update VL when NSR not in running state")
3382 if 'vld' not in msg
.nsd
or len(msg
.nsd
.vld
) == 0:
3383 raise NsrVlUpdateError("NS config NSD should have atleast 1 VLD defined")
3385 if msg
.has_field("scaling_group"):
3386 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3387 raise ScalingOperationError("Unable to perform scaling action when NS is not in running state")
3389 if len(msg
.scaling_group
) > 1:
3390 raise ScalingOperationError("Only a single scaling group can be configured at a time")
3392 for group_msg
in msg
.scaling_group
:
3393 num_new_group_instances
= len(group_msg
.instance
)
3394 if num_new_group_instances
> 1:
3395 raise ScalingOperationError("Only a single scaling instance can be modified at a time")
3397 elif num_new_group_instances
== 1:
3398 scale_group
= nsr
.scaling_groups
[group_msg
.scaling_group_name_ref
]
3399 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
]:
3400 if len(scale_group
.instances
) == scale_group
.max_instance_count
:
3401 raise ScalingOperationError("Max instances for %s reached" % scale_group
)
3403 acg
.handle
.prepare_complete_ok(xact_info
.handle
)
3406 self
._log
.debug("Registering for NSR config using xpath: %s",
3407 NsrDtsHandler
.NSR_XPATH
)
3409 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
3410 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
3411 self
._nsr
_regh
= acg
.register(xpath
=NsrDtsHandler
.NSR_XPATH
,
3412 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
3413 on_prepare
=on_prepare
)
3415 self
._scale
_regh
= acg
.register(
3416 xpath
=NsrDtsHandler
.SCALE_INSTANCE_XPATH
,
3417 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY| rwdts
.Flag
.CACHE
,
3420 self
._key
_pair
_regh
= acg
.register(
3421 xpath
=NsrDtsHandler
.KEY_PAIR_XPATH
,
3422 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
3426 class NsrOpDataDtsHandler(object):
3427 """ The network service op data DTS handler """
3428 XPATH
= "D,/nsr:ns-instance-opdata/nsr:nsr"
3430 def __init__(self
, dts
, log
, loop
, nsm
):
3439 """ Return the registration handle"""
3444 """ Return the NS manager instance """
3449 """ Register for Nsr op data publisher registration"""
3450 self
._log
.debug("Registering Nsr op data path %s as publisher",
3451 NsrOpDataDtsHandler
.XPATH
)
3453 hdl
= rift
.tasklets
.DTS
.RegistrationHandler()
3454 handlers
= rift
.tasklets
.Group
.Handler()
3455 with self
._dts
.group_create(handler
=handlers
) as group
:
3456 self
._regh
= group
.register(xpath
=NsrOpDataDtsHandler
.XPATH
,
3458 flags
=rwdts
.Flag
.PUBLISHER | rwdts
.Flag
.NO_PREP_READ | rwdts
.Flag
.DATASTORE
)
3461 def create(self
, path
, msg
):
3463 Create an NS record in DTS with the path and message
3465 self
._log
.debug("Creating NSR %s:%s", path
, msg
)
3466 self
.regh
.create_element(path
, msg
)
3467 self
._log
.debug("Created NSR, %s:%s", path
, msg
)
3470 def update(self
, path
, msg
, flags
=rwdts
.XactFlag
.REPLACE
):
3472 Update an NS record in DTS with the path and message
3474 self
._log
.debug("Updating NSR, %s:%s regh = %s", path
, msg
, self
.regh
)
3475 self
.regh
.update_element(path
, msg
, flags
)
3476 self
._log
.debug("Updated NSR, %s:%s", path
, msg
)
3479 def delete(self
, path
):
3481 Update an NS record in DTS with the path and message
3483 self
._log
.debug("Deleting NSR path:%s", path
)
3484 self
.regh
.delete_element(path
)
3485 self
._log
.debug("Deleted NSR path:%s", path
)
3488 class VnfrDtsHandler(object):
3489 """ The virtual network service DTS handler """
3490 XPATH
= "D,/vnfr:vnfr-catalog/vnfr:vnfr"
3492 def __init__(self
, dts
, log
, loop
, nsm
):
3502 """ Return registration handle """
3507 """ Return the NS manager instance """
3512 """ Register for vnfr create/update/delete/ advises from dts """
3514 def on_commit(xact_info
):
3515 """ The transaction has been committed """
3516 self
._log
.debug("Got vnfr commit (xact_info: %s)", xact_info
)
3517 return rwdts
.MemberRspCode
.ACTION_OK
3520 def on_prepare(xact_info
, action
, ks_path
, msg
):
3521 """ prepare callback from dts """
3522 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3524 "Got vnfr on_prepare cb (xact_info: %s, action: %s): %s:%s",
3525 xact_info
, action
, ks_path
, msg
3528 schema
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr
.schema()
3529 path_entry
= schema
.keyspec_to_entry(ks_path
)
3530 if path_entry
.key00
.id not in self
._nsm
._vnfrs
:
3531 self
._log
.error("%s request for non existent record path %s",
3533 xact_info
.respond_xpath(rwdts
.XactRspCode
.NA
, xpath
)
3537 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3538 if action
== rwdts
.QueryAction
.CREATE
or action
== rwdts
.QueryAction
.UPDATE
:
3539 yield from self
._nsm
.update_vnfr(msg
)
3540 elif action
== rwdts
.QueryAction
.DELETE
:
3541 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3542 self
._nsm
.delete_vnfr(path_entry
.key00
.id)
3544 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
, xpath
)
3546 self
._log
.debug("Registering for VNFR using xpath: %s",
3547 VnfrDtsHandler
.XPATH
,)
3549 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_commit
=on_commit
,
3550 on_prepare
=on_prepare
,)
3551 with self
._dts
.group_create() as group
:
3552 self
._regh
= group
.register(xpath
=VnfrDtsHandler
.XPATH
,
3554 flags
=(rwdts
.Flag
.SUBSCRIBER
),)
3557 class NsdRefCountDtsHandler(object):
3558 """ The NSD Ref Count DTS handler """
3559 XPATH
= "D,/nsr:ns-instance-opdata/rw-nsr:nsd-ref-count"
3561 def __init__(self
, dts
, log
, loop
, nsm
):
3571 """ Return registration handle """
3576 """ Return the NS manager instance """
3581 """ Register for NSD ref count read from dts """
3584 def on_prepare(xact_info
, action
, ks_path
, msg
):
3585 """ prepare callback from dts """
3586 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3588 if action
== rwdts
.QueryAction
.READ
:
3589 schema
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount
.schema()
3590 path_entry
= schema
.keyspec_to_entry(ks_path
)
3591 nsd_list
= yield from self
._nsm
.get_nsd_refcount(path_entry
.key00
.nsd_id_ref
)
3592 for xpath
, msg
in nsd_list
:
3593 xact_info
.respond_xpath(rsp_code
=rwdts
.XactRspCode
.MORE
,
3596 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
3598 raise NetworkServiceRecordError("Not supported operation %s" % action
)
3600 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_prepare
,)
3601 with self
._dts
.group_create() as group
:
3602 self
._regh
= group
.register(xpath
=NsdRefCountDtsHandler
.XPATH
,
3604 flags
=rwdts
.Flag
.PUBLISHER
,)
3607 class NsManager(object):
3608 """ The Network Service Manager class"""
3609 def __init__(self
, dts
, log
, loop
,
3610 nsr_handler
, vnfr_handler
, vlr_handler
, ro_plugin_selector
,
3611 vnffgmgr
, vnfd_pub_handler
, cloud_account_handler
):
3615 self
._nsr
_handler
= nsr_handler
3616 self
._vnfr
_pub
_handler
= vnfr_handler
3617 self
._vlr
_pub
_handler
= vlr_handler
3618 self
._vnffgmgr
= vnffgmgr
3619 self
._vnfd
_pub
_handler
= vnfd_pub_handler
3620 self
._cloud
_account
_handler
= cloud_account_handler
3622 self
._ro
_plugin
_selector
= ro_plugin_selector
3623 self
._ncclient
= rift
.mano
.ncclient
.NcClient(
3635 self
.cfgmgr_obj
= conman
.ROConfigManager(log
, loop
, dts
, self
)
3637 # TODO: All these handlers should move to tasklet level.
3638 # Passing self is often an indication of bad design
3639 self
._nsd
_dts
_handler
= NsdDtsHandler(dts
, log
, loop
, self
)
3640 self
._vnfd
_dts
_handler
= VnfdDtsHandler(dts
, log
, loop
, self
)
3641 self
._dts
_handlers
= [self
._nsd
_dts
_handler
,
3642 VnfrDtsHandler(dts
, log
, loop
, self
),
3643 NsdRefCountDtsHandler(dts
, log
, loop
, self
),
3644 NsrDtsHandler(dts
, log
, loop
, self
),
3645 ScalingRpcHandler(log
, dts
, loop
, self
.scale_rpc_callback
),
3646 NsrRpcDtsHandler(dts
,log
,loop
,self
),
3647 self
._vnfd
_dts
_handler
,
3668 def nsr_handler(self
):
3669 """" NSR handler """
3670 return self
._nsr
_handler
3674 """" So Obj handler """
3679 """ NSRs in this NSM"""
3684 """ NSDs in this NSM"""
3689 """ VNFDs in this NSM"""
3694 """ VNFRs in this NSM"""
3698 def nsr_pub_handler(self
):
3699 """ NSR publication handler """
3700 return self
._nsr
_handler
3703 def vnfr_pub_handler(self
):
3704 """ VNFR publication handler """
3705 return self
._vnfr
_pub
_handler
3708 def vlr_pub_handler(self
):
3709 """ VLR publication handler """
3710 return self
._vlr
_pub
_handler
3713 def vnfd_pub_handler(self
):
3714 return self
._vnfd
_pub
_handler
3718 """ Register all static DTS handlers """
3719 for dts_handle
in self
._dts
_handlers
:
3720 yield from dts_handle
.register()
3723 def get_ns_by_nsr_id(self
, nsr_id
):
3724 """ get NSR by nsr id """
3725 if nsr_id
not in self
._nsrs
:
3726 raise NetworkServiceRecordError("NSR id %s not found" % nsr_id
)
3728 return self
._nsrs
[nsr_id
]
3730 def scale_nsr_out(self
, nsr_id
, scale_group_name
, instance_id
, config_xact
):
3731 self
.log
.debug("Scale out NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3736 nsr
= self
._nsrs
[nsr_id
]
3737 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3738 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3740 self
._loop
.create_task(nsr
.create_scale_group_instance(scale_group_name
, instance_id
, config_xact
))
3742 def scale_nsr_in(self
, nsr_id
, scale_group_name
, instance_id
):
3743 self
.log
.debug("Scale in NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3748 nsr
= self
._nsrs
[nsr_id
]
3749 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3750 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3752 self
._loop
.create_task(nsr
.delete_scale_group_instance(scale_group_name
, instance_id
))
3754 def scale_rpc_callback(self
, xact
, msg
, action
):
3755 """Callback handler for RPC calls
3757 xact : Transaction Handler
3759 action : Scaling Action
3761 ScalingGroupInstance
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup_Instance
3762 ScalingGroup
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
3764 xpath
= ('C,/nsr:ns-instance-config/nsr:nsr[nsr:id="{}"]').format(
3766 instance
= ScalingGroupInstance
.from_dict({"id": msg
.instance_id
})
3769 def get_nsr_scaling_group():
3770 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3772 for result
in results
:
3773 res
= yield from result
3774 nsr_config
= res
.result
3776 for scaling_group
in nsr_config
.scaling_group
:
3777 if scaling_group
.scaling_group_name_ref
== msg
.scaling_group_name_ref
:
3780 scaling_group
= nsr_config
.scaling_group
.add()
3781 scaling_group
.scaling_group_name_ref
= msg
.scaling_group_name_ref
3783 return (nsr_config
, scaling_group
)
3786 def update_config(nsr_config
):
3787 xml
= self
._ncclient
.convert_to_xml(RwNsrYang
, nsr_config
)
3788 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
3789 yield from self
._ncclient
.connect()
3790 yield from self
._ncclient
.manager
.edit_config(target
="running", config
=xml
, default_operation
="replace")
3794 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3795 scaling_group
.instance
.append(instance
)
3796 yield from update_config(nsr_config
)
3800 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3801 scaling_group
.instance
.remove(instance
)
3802 yield from update_config(nsr_config
)
3804 if action
== ScalingRpcHandler
.ACTION
.SCALE_OUT
:
3805 self
._loop
.create_task(scale_out())
3807 self
._loop
.create_task(scale_in())
3809 # Opdata based calls, disabled for now!
3810 # if action == ScalingRpcHandler.ACTION.SCALE_OUT:
3811 # self.scale_nsr_out(
3813 # msg.scaling_group_name_ref,
3817 # self.scale_nsr_in(
3819 # msg.scaling_group_name_ref,
3822 def nsr_update_cfg(self
, nsr_id
, msg
):
3823 nsr
= self
._nsrs
[nsr_id
]
3824 nsr
.nsr_cfg_msg
= msg
3826 def nsr_instantiate_vl(self
, nsr_id
, vld
):
3827 self
.log
.debug("NSR {} create VL {}".format(nsr_id
, vld
))
3828 nsr
= self
._nsrs
[nsr_id
]
3829 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3830 raise NsrVlUpdateError("Cannot perform VL instantiate if NSR is not in running state")
3832 # Not calling in a separate task as this is called from a separate task
3833 yield from nsr
.create_vl_instance(vld
)
3835 def nsr_terminate_vl(self
, nsr_id
, vld
):
3836 self
.log
.debug("NSR {} delete VL {}".format(nsr_id
, vld
.id))
3837 nsr
= self
._nsrs
[nsr_id
]
3838 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3839 raise NsrVlUpdateError("Cannot perform VL terminate if NSR is not in running state")
3841 # Not calling in a separate task as this is called from a separate task
3842 yield from nsr
.delete_vl_instance(vld
)
3844 def create_nsr(self
, nsr_msg
, key_pairs
=None,restart_mode
=False):
3845 """ Create an NSR instance """
3846 if nsr_msg
.id in self
._nsrs
:
3847 msg
= "NSR id %s already exists" % nsr_msg
.id
3848 self
._log
.error(msg
)
3849 raise NetworkServiceRecordError(msg
)
3851 self
._log
.info("Create NetworkServiceRecord nsr id %s from nsd_id %s",
3855 nsm_plugin
= self
._ro
_plugin
_selector
.ro_plugin
3856 sdn_account_name
= self
._cloud
_account
_handler
.get_cloud_account_sdn_name(nsr_msg
.cloud_account
)
3858 nsr
= NetworkServiceRecord(self
._dts
,
3866 restart_mode
=restart_mode
,
3867 vlr_handler
=self
._ro
_plugin
_selector
._records
_publisher
._vlr
_pub
_hdlr
3869 self
._nsrs
[nsr_msg
.id] = nsr
3870 nsm_plugin
.create_nsr(nsr_msg
, nsr_msg
.nsd
, key_pairs
)
3874 def delete_nsr(self
, nsr_id
):
3876 Delete NSR with the passed nsr id
3878 del self
._nsrs
[nsr_id
]
3881 def instantiate_ns(self
, nsr_id
, config_xact
):
3882 """ Instantiate an NS instance """
3883 self
._log
.debug("Instantiating Network service id %s", nsr_id
)
3884 if nsr_id
not in self
._nsrs
:
3885 err
= "NSR id %s not found " % nsr_id
3886 self
._log
.error(err
)
3887 raise NetworkServiceRecordError(err
)
3889 nsr
= self
._nsrs
[nsr_id
]
3890 yield from nsr
.nsm_plugin
.instantiate_ns(nsr
, config_xact
)
3893 def update_vnfr(self
, vnfr
):
3894 """Create/Update an VNFR """
3896 vnfr_state
= self
._vnfrs
[vnfr
.id].state
3897 self
._log
.debug("Updating VNFR with state %s: vnfr %s", vnfr_state
, vnfr
)
3899 yield from self
._vnfrs
[vnfr
.id].update_state(vnfr
)
3900 nsr
= self
.find_nsr_for_vnfr(vnfr
.id)
3901 yield from nsr
.update_state()
3903 def find_nsr_for_vnfr(self
, vnfr_id
):
3904 """ Find the NSR which )has the passed vnfr id"""
3905 for nsr
in list(self
.nsrs
.values()):
3906 for vnfr
in list(nsr
.vnfrs
.values()):
3907 if vnfr
.id == vnfr_id
:
3911 def delete_vnfr(self
, vnfr_id
):
3912 """ Delete VNFR with the passed id"""
3913 del self
._vnfrs
[vnfr_id
]
3915 def get_nsd_ref(self
, nsd_id
):
3916 """ Get network service descriptor for the passed nsd_id
3918 nsd
= self
.get_nsd(nsd_id
)
3923 def get_nsr_config(self
, nsd_id
):
3924 xpath
= "C,/nsr:ns-instance-config"
3925 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3927 for result
in results
:
3928 entry
= yield from result
3929 ns_instance_config
= entry
.result
3931 for nsr
in ns_instance_config
.nsr
:
3932 if nsr
.nsd
.id == nsd_id
:
3938 def nsd_unref_by_nsr_id(self
, nsr_id
):
3939 """ Unref the network service descriptor based on NSR id """
3940 self
._log
.debug("NSR Unref called for Nsr Id:%s", nsr_id
)
3941 if nsr_id
in self
._nsrs
:
3942 nsr
= self
._nsrs
[nsr_id
]
3945 nsd
= self
.get_nsd(nsr
.nsd_id
)
3946 self
._log
.debug("Releasing ref on NSD %s held by NSR %s - Curr %d",
3947 nsd
.id, nsr
.id, nsd
.ref_count
)
3949 except NetworkServiceDescriptorError
:
3950 # We store a copy of NSD in NSR and the NSD in nsd-catalog
3955 self
._log
.error("Cannot find NSR with id %s", nsr_id
)
3956 raise NetworkServiceDescriptorUnrefError("No NSR with id" % nsr_id
)
3959 def nsd_unref(self
, nsd_id
):
3960 """ Unref the network service descriptor associated with the id """
3961 nsd
= self
.get_nsd(nsd_id
)
3964 def get_nsd(self
, nsd_id
):
3965 """ Get network service descriptor for the passed nsd_id"""
3966 if nsd_id
not in self
._nsds
:
3967 self
._log
.error("Cannot find NSD id:%s", nsd_id
)
3968 raise NetworkServiceDescriptorError("Cannot find NSD id:%s", nsd_id
)
3970 return self
._nsds
[nsd_id
]
3972 def create_nsd(self
, nsd_msg
):
3973 """ Create a network service descriptor """
3974 self
._log
.debug("Create network service descriptor - %s", nsd_msg
)
3975 if nsd_msg
.id in self
._nsds
:
3976 self
._log
.error("Cannot create NSD %s -NSD ID already exists", nsd_msg
)
3977 raise NetworkServiceDescriptorError("NSD already exists-%s", nsd_msg
.id)
3979 nsd
= NetworkServiceDescriptor(
3986 self
._nsds
[nsd_msg
.id] = nsd
3990 def update_nsd(self
, nsd
):
3991 """ update the Network service descriptor """
3992 self
._log
.debug("Update network service descriptor - %s", nsd
)
3993 if nsd
.id not in self
._nsds
:
3994 self
._log
.debug("No NSD found - creating NSD id = %s", nsd
.id)
3995 self
.create_nsd(nsd
)
3997 self
._log
.debug("Updating NSD id = %s, nsd = %s", nsd
.id, nsd
)
3998 self
._nsds
[nsd
.id].update(nsd
)
4000 def delete_nsd(self
, nsd_id
):
4001 """ Delete the Network service descriptor with the passed id """
4002 self
._log
.debug("Deleting the network service descriptor - %s", nsd_id
)
4003 if nsd_id
not in self
._nsds
:
4004 self
._log
.debug("Delete NSD failed - cannot find nsd-id %s", nsd_id
)
4005 raise NetworkServiceDescriptorNotFound("Cannot find %s", nsd_id
)
4007 if nsd_id
not in self
._nsds
:
4008 self
._log
.debug("Cannot delete NSD id %s reference exists %s",
4010 self
._nsds
[nsd_id
].ref_count
)
4011 raise NetworkServiceDescriptorRefCountExists(
4012 "Cannot delete :%s, ref_count:%s",
4014 self
._nsds
[nsd_id
].ref_count
)
4016 del self
._nsds
[nsd_id
]
4018 def get_vnfd_config(self
, xact
):
4019 vnfd_dts_reg
= self
._vnfd
_dts
_handler
.regh
4020 for cfg
in vnfd_dts_reg
.get_xact_elements(xact
):
4021 if cfg
.id not in self
._vnfds
:
4022 self
.create_vnfd(cfg
)
4024 def get_vnfd(self
, vnfd_id
, xact
):
4025 """ Get virtual network function descriptor for the passed vnfd_id"""
4026 if vnfd_id
not in self
._vnfds
:
4027 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
4028 self
.get_vnfd_config(xact
)
4030 if vnfd_id
not in self
._vnfds
:
4031 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
4032 raise VnfDescriptorError("Cannot find VNFD id:%s", vnfd_id
)
4034 return self
._vnfds
[vnfd_id
]
4036 def create_vnfd(self
, vnfd
):
4037 """ Create a virtual network function descriptor """
4038 self
._log
.debug("Create virtual network function descriptor - %s", vnfd
)
4039 if vnfd
.id in self
._vnfds
:
4040 self
._log
.error("Cannot create VNFD %s -VNFD ID already exists", vnfd
)
4041 raise VnfDescriptorError("VNFD already exists-%s", vnfd
.id)
4043 self
._vnfds
[vnfd
.id] = vnfd
4044 return self
._vnfds
[vnfd
.id]
4046 def update_vnfd(self
, vnfd
):
4047 """ Update the virtual network function descriptor """
4048 self
._log
.debug("Update virtual network function descriptor- %s", vnfd
)
4051 if vnfd
.id not in self
._vnfds
:
4052 self
._log
.debug("No VNFD found - creating VNFD id = %s", vnfd
.id)
4053 self
.create_vnfd(vnfd
)
4055 self
._log
.debug("Updating VNFD id = %s, vnfd = %s", vnfd
.id, vnfd
)
4056 self
._vnfds
[vnfd
.id] = vnfd
4059 def delete_vnfd(self
, vnfd_id
):
4060 """ Delete the virtual network function descriptor with the passed id """
4061 self
._log
.debug("Deleting the virtual network function descriptor - %s", vnfd_id
)
4062 if vnfd_id
not in self
._vnfds
:
4063 self
._log
.debug("Delete VNFD failed - cannot find vnfd-id %s", vnfd_id
)
4064 raise VnfDescriptorError("Cannot find %s", vnfd_id
)
4066 del self
._vnfds
[vnfd_id
]
4068 def nsd_in_use(self
, nsd_id
):
4069 """ Is the NSD with the passed id in use """
4070 self
._log
.debug("Is this NSD in use - msg:%s", nsd_id
)
4071 if nsd_id
in self
._nsds
:
4072 return self
._nsds
[nsd_id
].in_use()
4076 def publish_nsr(self
, xact
, path
, msg
):
4077 """ Publish a NSR """
4078 self
._log
.debug("Publish NSR with path %s, msg %s",
4080 yield from self
.nsr_handler
.update(xact
, path
, msg
)
4083 def unpublish_nsr(self
, xact
, path
):
4084 """ Un Publish an NSR """
4085 self
._log
.debug("Publishing delete NSR with path %s", path
)
4086 yield from self
.nsr_handler
.delete(path
, xact
)
4088 def vnfr_is_ready(self
, vnfr_id
):
4089 """ VNFR with the id is ready """
4090 self
._log
.debug("VNFR id %s ready", vnfr_id
)
4091 if vnfr_id
not in self
._vnfds
:
4092 err
= "Did not find VNFR ID with id %s" % vnfr_id
4093 self
._log
.critical("err")
4094 raise VirtualNetworkFunctionRecordError(err
)
4095 self
._vnfrs
[vnfr_id
].is_ready()
4098 def get_nsd_refcount(self
, nsd_id
):
4099 """ Get the nsd_list from this NSM"""
4101 def nsd_refcount_xpath(nsd_id
):
4102 """ xpath for ref count entry """
4103 return (NsdRefCountDtsHandler
.XPATH
+
4104 "[rw-nsr:nsd-id-ref = '{}']").format(nsd_id
)
4107 if nsd_id
is None or nsd_id
== "":
4108 for nsd
in self
._nsds
.values():
4109 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4110 nsd_msg
.nsd_id_ref
= nsd
.id
4111 nsd_msg
.instance_ref_count
= nsd
.ref_count
4112 nsd_list
.append((nsd_refcount_xpath(nsd
.id), nsd_msg
))
4113 elif nsd_id
in self
._nsds
:
4114 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4115 nsd_msg
.nsd_id_ref
= self
._nsds
[nsd_id
].id
4116 nsd_msg
.instance_ref_count
= self
._nsds
[nsd_id
].ref_count
4117 nsd_list
.append((nsd_refcount_xpath(nsd_id
), nsd_msg
))
4122 def terminate_ns(self
, nsr_id
, xact
):
4124 Terminate network service for the given NSR Id
4127 # Terminate the instances/networks assocaited with this nw service
4128 self
._log
.debug("Terminating the network service %s", nsr_id
)
4130 yield from self
._nsrs
[nsr_id
].terminate()
4131 except Exception as e
:
4132 self
.log
.exception("Failed to terminate NSR[id=%s]", nsr_id
)
4135 yield from self
.nsd_unref_by_nsr_id(nsr_id
)
4137 # Unpublish the NSR record
4138 self
._log
.debug("Unpublishing the network service %s", nsr_id
)
4139 yield from self
._nsrs
[nsr_id
].unpublish(xact
)
4141 # Finaly delete the NS instance from this NS Manager
4142 self
._log
.debug("Deletng the network service %s", nsr_id
)
4143 self
.delete_nsr(nsr_id
)
4146 class NsmRecordsPublisherProxy(object):
4147 """ This class provides a publisher interface that allows plugin objects
4148 to publish NSR/VNFR/VLR"""
4150 def __init__(self
, dts
, log
, loop
, nsr_pub_hdlr
, vnfr_pub_hdlr
, vlr_pub_hdlr
):
4154 self
._nsr
_pub
_hdlr
= nsr_pub_hdlr
4155 self
._vlr
_pub
_hdlr
= vlr_pub_hdlr
4156 self
._vnfr
_pub
_hdlr
= vnfr_pub_hdlr
4159 def publish_nsr(self
, xact
, nsr
):
4160 """ Publish an NSR """
4161 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4162 return (yield from self
._nsr
_pub
_hdlr
.update(xact
, path
, nsr
))
4165 def unpublish_nsr(self
, xact
, nsr
):
4166 """ Unpublish an NSR """
4167 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4168 return (yield from self
._nsr
_pub
_hdlr
.delete(xact
, path
))
4171 def publish_vnfr(self
, xact
, vnfr
):
4172 """ Publish an VNFR """
4173 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4174 return (yield from self
._vnfr
_pub
_hdlr
.update(xact
, path
, vnfr
))
4177 def unpublish_vnfr(self
, xact
, vnfr
):
4178 """ Unpublish a VNFR """
4179 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4180 return (yield from self
._vnfr
_pub
_hdlr
.delete(xact
, path
))
4183 def publish_vlr(self
, xact
, vlr
):
4184 """ Publish a VLR """
4185 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4186 return (yield from self
._vlr
_pub
_hdlr
.update(xact
, path
, vlr
))
4189 def unpublish_vlr(self
, xact
, vlr
):
4190 """ Unpublish a VLR """
4191 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4192 return (yield from self
._vlr
_pub
_hdlr
.delete(xact
, path
))
4195 class ScalingRpcHandler(mano_dts
.DtsHandler
):
4196 """ The Network service Monitor DTS handler """
4197 SCALE_IN_INPUT_XPATH
= "I,/nsr:exec-scale-in"
4198 SCALE_IN_OUTPUT_XPATH
= "O,/nsr:exec-scale-in"
4200 SCALE_OUT_INPUT_XPATH
= "I,/nsr:exec-scale-out"
4201 SCALE_OUT_OUTPUT_XPATH
= "O,/nsr:exec-scale-out"
4203 ACTION
= Enum('ACTION', 'SCALE_IN SCALE_OUT')
4205 def __init__(self
, log
, dts
, loop
, callback
=None):
4206 super().__init
__(log
, dts
, loop
)
4207 self
.callback
= callback
4208 self
.last_instance_id
= defaultdict(int)
4214 def on_scale_in_prepare(xact_info
, action
, ks_path
, msg
):
4215 assert action
== rwdts
.QueryAction
.RPC
4219 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_IN
)
4221 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleIn
.from_dict({
4222 "instance_id": msg
.instance_id
})
4224 xact_info
.respond_xpath(
4225 rwdts
.XactRspCode
.ACK
,
4226 self
.__class
__.SCALE_IN_OUTPUT_XPATH
,
4229 except Exception as e
:
4230 self
.log
.exception(e
)
4231 xact_info
.respond_xpath(
4232 rwdts
.XactRspCode
.NACK
,
4233 self
.__class
__.SCALE_IN_OUTPUT_XPATH
)
4236 def on_scale_out_prepare(xact_info
, action
, ks_path
, msg
):
4237 assert action
== rwdts
.QueryAction
.RPC
4240 scaling_group
= msg
.scaling_group_name_ref
4241 if not msg
.instance_id
:
4242 last_instance_id
= self
.last_instance_id
[scale_group
]
4243 msg
.instance_id
= last_instance_id
+ 1
4244 self
.last_instance_id
[scale_group
] += 1
4247 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_OUT
)
4249 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleOut
.from_dict({
4250 "instance_id": msg
.instance_id
})
4252 xact_info
.respond_xpath(
4253 rwdts
.XactRspCode
.ACK
,
4254 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
,
4257 except Exception as e
:
4258 self
.log
.exception(e
)
4259 xact_info
.respond_xpath(
4260 rwdts
.XactRspCode
.NACK
,
4261 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
)
4263 scale_in_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4264 on_prepare
=on_scale_in_prepare
)
4265 scale_out_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4266 on_prepare
=on_scale_out_prepare
)
4268 with self
.dts
.group_create() as group
:
4270 xpath
=self
.__class
__.SCALE_IN_INPUT_XPATH
,
4271 handler
=scale_in_hdl
,
4272 flags
=rwdts
.Flag
.PUBLISHER
)
4274 xpath
=self
.__class
__.SCALE_OUT_INPUT_XPATH
,
4275 handler
=scale_out_hdl
,
4276 flags
=rwdts
.Flag
.PUBLISHER
)
4279 class NsmTasklet(rift
.tasklets
.Tasklet
):
4281 The network service manager tasklet
4283 def __init__(self
, *args
, **kwargs
):
4284 super(NsmTasklet
, self
).__init
__(*args
, **kwargs
)
4285 self
.rwlog
.set_category("rw-mano-log")
4286 self
.rwlog
.set_subcategory("nsm")
4291 self
._ro
_plugin
_selector
= None
4292 self
._vnffgmgr
= None
4294 self
._nsr
_handler
= None
4295 self
._vnfr
_pub
_handler
= None
4296 self
._vlr
_pub
_handler
= None
4297 self
._vnfd
_pub
_handler
= None
4298 self
._scale
_cfg
_handler
= None
4300 self
._records
_publisher
_proxy
= None
4303 """ The task start callback """
4304 super(NsmTasklet
, self
).start()
4305 self
.log
.info("Starting NsmTasklet")
4307 self
.log
.debug("Registering with dts")
4308 self
._dts
= rift
.tasklets
.DTS(self
.tasklet_info
,
4309 RwNsmYang
.get_schema(),
4311 self
.on_dts_state_change
)
4313 self
.log
.debug("Created DTS Api GI Object: %s", self
._dts
)
4319 print("Caught Exception in NSM stop:", sys
.exc_info()[0])
4322 def on_instance_started(self
):
4323 """ Task instance started callback """
4324 self
.log
.debug("Got instance started callback")
4328 """ Task init callback """
4329 self
.log
.debug("Got instance started callback")
4331 self
.log
.debug("creating config account handler")
4333 self
._nsr
_pub
_handler
= publisher
.NsrOpDataDtsHandler(self
._dts
, self
.log
, self
.loop
)
4334 yield from self
._nsr
_pub
_handler
.register()
4336 self
._vnfr
_pub
_handler
= publisher
.VnfrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4337 yield from self
._vnfr
_pub
_handler
.register()
4339 self
._vlr
_pub
_handler
= publisher
.VlrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4340 yield from self
._vlr
_pub
_handler
.register()
4342 manifest
= self
.tasklet_info
.get_pb_manifest()
4343 use_ssl
= manifest
.bootstrap_phase
.rwsecurity
.use_ssl
4344 ssl_cert
= manifest
.bootstrap_phase
.rwsecurity
.cert
4345 ssl_key
= manifest
.bootstrap_phase
.rwsecurity
.key
4347 self
._vnfd
_pub
_handler
= publisher
.VnfdPublisher(use_ssl
, ssl_cert
, ssl_key
, self
.loop
)
4349 self
._records
_publisher
_proxy
= NsmRecordsPublisherProxy(
4353 self
._nsr
_pub
_handler
,
4354 self
._vnfr
_pub
_handler
,
4355 self
._vlr
_pub
_handler
,
4358 # Register the NSM to receive the nsm plugin
4359 # when cloud account is configured
4360 self
._ro
_plugin
_selector
= cloud
.ROAccountPluginSelector(
4364 self
._records
_publisher
_proxy
,
4366 yield from self
._ro
_plugin
_selector
.register()
4368 self
._cloud
_account
_handler
= cloud
.CloudAccountConfigSubscriber(
4373 yield from self
._cloud
_account
_handler
.register()
4375 self
._vnffgmgr
= rwvnffgmgr
.VnffgMgr(self
._dts
, self
.log
, self
.log_hdl
, self
.loop
)
4376 yield from self
._vnffgmgr
.register()
4378 self
._nsm
= NsManager(
4382 self
._nsr
_pub
_handler
,
4383 self
._vnfr
_pub
_handler
,
4384 self
._vlr
_pub
_handler
,
4385 self
._ro
_plugin
_selector
,
4387 self
._vnfd
_pub
_handler
,
4388 self
._cloud
_account
_handler
4391 yield from self
._nsm
.register()
4395 """ Task run callback """
4399 def on_dts_state_change(self
, state
):
4400 """Take action according to current dts state to transition
4401 application into the corresponding application state
4404 state - current dts state
4407 rwdts
.State
.INIT
: rwdts
.State
.REGN_COMPLETE
,
4408 rwdts
.State
.CONFIG
: rwdts
.State
.RUN
,
4412 rwdts
.State
.INIT
: self
.init
,
4413 rwdts
.State
.RUN
: self
.run
,
4416 # Transition application to next state
4417 handler
= handlers
.get(state
, None)
4418 if handler
is not None:
4419 yield from handler()
4421 # Transition dts to next state
4422 next_state
= switch
.get(state
, None)
4423 if next_state
is not None:
4424 self
.log
.debug("Changing state to %s", next_state
)
4425 self
._dts
.handle
.set_state(next_state
)