2 # Copyright 2016 RIFT.IO Inc
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
20 import ncclient
.asyncio_manager
32 from collections
import deque
33 from collections
import defaultdict
37 gi
.require_version('RwYang', '1.0')
38 gi
.require_version('RwNsdYang', '1.0')
39 gi
.require_version('RwDts', '1.0')
40 gi
.require_version('RwNsmYang', '1.0')
41 gi
.require_version('RwNsrYang', '1.0')
42 gi
.require_version('RwTypes', '1.0')
43 gi
.require_version('RwVlrYang', '1.0')
44 gi
.require_version('RwVnfrYang', '1.0')
45 from gi
.repository
import (
61 import rift
.mano
.ncclient
62 import rift
.mano
.config_data
.config
63 import rift
.mano
.dts
as mano_dts
65 from . import rwnsm_conman
as conman
67 from . import publisher
69 from . import config_value_pool
70 from . import rwvnffgmgr
71 from . import scale_group
74 class NetworkServiceRecordState(Enum
):
75 """ Network Service Record State """
79 VNFFG_INIT_PHASE
= 104
85 VL_TERMINATE_PHASE
= 111
86 VNF_TERMINATE_PHASE
= 112
87 VNFFG_TERMINATE_PHASE
= 113
94 class NetworkServiceRecordError(Exception):
95 """ Network Service Record Error """
99 class NetworkServiceDescriptorError(Exception):
100 """ Network Service Descriptor Error """
104 class VirtualNetworkFunctionRecordError(Exception):
105 """ Virtual Network Function Record Error """
109 class NetworkServiceDescriptorNotFound(Exception):
110 """ Cannot find Network Service Descriptor"""
114 class NetworkServiceDescriptorRefCountExists(Exception):
115 """ Network Service Descriptor reference count exists """
119 class NetworkServiceDescriptorUnrefError(Exception):
120 """ Failed to unref a network service descriptor """
124 class NsrInstantiationFailed(Exception):
125 """ Failed to instantiate network service """
129 class VnfInstantiationFailed(Exception):
130 """ Failed to instantiate virtual network function"""
134 class VnffgInstantiationFailed(Exception):
135 """ Failed to instantiate virtual network function"""
139 class VnfDescriptorError(Exception):
140 """Failed to instantiate virtual network function"""
144 class ScalingOperationError(Exception):
148 class ScaleGroupMissingError(Exception):
152 class PlacementGroupError(Exception):
156 class NsrNsdUpdateError(Exception):
160 class NsrVlUpdateError(NsrNsdUpdateError
):
164 class VlRecordState(Enum
):
165 """ VL Record State """
167 INSTANTIATION_PENDING
= 102
169 TERMINATE_PENDING
= 104
174 class VnffgRecordState(Enum
):
175 """ VNFFG Record State """
177 INSTANTIATION_PENDING
= 102
179 TERMINATE_PENDING
= 104
184 class VnffgRecord(object):
185 """ Vnffg Records class"""
188 def __init__(self
, dts
, log
, loop
, vnffgmgr
, nsr
, nsr_name
, vnffgd_msg
, sdn_account_name
):
193 self
._vnffgmgr
= vnffgmgr
195 self
._nsr
_name
= nsr_name
196 self
._vnffgd
_msg
= vnffgd_msg
197 if sdn_account_name
is None:
198 self
._sdn
_account
_name
= ''
200 self
._sdn
_account
_name
= sdn_account_name
202 self
._vnffgr
_id
= str(uuid
.uuid4())
203 self
._vnffgr
_rsp
_id
= list()
204 self
._vnffgr
_state
= VnffgRecordState
.INIT
209 return self
._vnffgr
_id
213 """ state of this VNF """
214 return self
._vnffgr
_state
216 def fetch_vnffgr(self
):
218 Get VNFFGR message to be published
221 if self
._vnffgr
_state
== VnffgRecordState
.INIT
:
222 vnffgr_dict
= {"id": self
._vnffgr
_id
,
223 "nsd_id": self
._nsr
.nsd_id
,
224 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
225 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
226 "sdn_account": self
._sdn
_account
_name
,
227 "operational_status": 'init',
229 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
230 elif self
._vnffgr
_state
== VnffgRecordState
.TERMINATED
:
231 vnffgr_dict
= {"id": self
._vnffgr
_id
,
232 "nsd_id": self
._nsr
.nsd_id
,
233 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
234 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
235 "sdn_account": self
._sdn
_account
_name
,
236 "operational_status": 'terminated',
238 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
241 vnffgr
= self
._vnffgmgr
.fetch_vnffgr(self
._vnffgr
_id
)
243 self
._log
.exception("Fetching VNFFGR for VNFFG with id %s failed", self
._vnffgr
_id
)
244 self
._vnffgr
_state
= VnffgRecordState
.FAILED
245 vnffgr_dict
= {"id": self
._vnffgr
_id
,
246 "nsd_id": self
._nsr
.nsd_id
,
247 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
248 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
249 "sdn_account": self
._sdn
_account
_name
,
250 "operational_status": 'failed',
252 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
257 def vnffgr_create_msg(self
):
258 """ Virtual Link Record message for Creating VLR in VNS """
259 vnffgr_dict
= {"id": self
._vnffgr
_id
,
260 "nsd_id": self
._nsr
.nsd_id
,
261 "vnffgd_id_ref": self
._vnffgd
_msg
.id,
262 "vnffgd_name_ref": self
._vnffgd
_msg
.name
,
263 "sdn_account": self
._sdn
_account
_name
,
265 vnffgr
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vnffgr
.from_dict(vnffgr_dict
)
266 for rsp
in self
._vnffgd
_msg
.rsp
:
267 vnffgr_rsp
= vnffgr
.rsp
.add()
268 vnffgr_rsp
.id = str(uuid
.uuid4())
269 vnffgr_rsp
.name
= self
._nsr
.name
+ '.' + rsp
.name
270 self
._vnffgr
_rsp
_id
.append(vnffgr_rsp
.id)
271 vnffgr_rsp
.vnffgd_rsp_id_ref
= rsp
.id
272 vnffgr_rsp
.vnffgd_rsp_name_ref
= rsp
.name
273 for rsp_cp_ref
in rsp
.vnfd_connection_point_ref
:
274 vnfd
= [vnfr
.vnfd
for vnfr
in self
._nsr
.vnfrs
.values() if vnfr
.vnfd
.id == rsp_cp_ref
.vnfd_id_ref
]
275 self
._log
.debug("VNFD message during VNFFG instantiation is %s",vnfd
)
276 if len(vnfd
) > 0 and vnfd
[0].has_field('service_function_type'):
277 self
._log
.debug("Service Function Type for VNFD ID %s is %s",rsp_cp_ref
.vnfd_id_ref
, vnfd
[0].service_function_type
)
279 self
._log
.error("Service Function Type not available for VNFD ID %s; Skipping in chain",rsp_cp_ref
.vnfd_id_ref
)
282 vnfr_cp_ref
= vnffgr_rsp
.vnfr_connection_point_ref
.add()
283 vnfr_cp_ref
.member_vnf_index_ref
= rsp_cp_ref
.member_vnf_index_ref
284 vnfr_cp_ref
.hop_number
= rsp_cp_ref
.order
285 vnfr_cp_ref
.vnfd_id_ref
=rsp_cp_ref
.vnfd_id_ref
286 vnfr_cp_ref
.service_function_type
= vnfd
[0].service_function_type
287 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
288 if (nsr_vnfr
.vnfd
.id == vnfr_cp_ref
.vnfd_id_ref
and
289 nsr_vnfr
.member_vnf_index
== vnfr_cp_ref
.member_vnf_index_ref
):
290 vnfr_cp_ref
.vnfr_id_ref
= nsr_vnfr
.id
291 vnfr_cp_ref
.vnfr_name_ref
= nsr_vnfr
.name
292 vnfr_cp_ref
.vnfr_connection_point_ref
= rsp_cp_ref
.vnfd_connection_point_ref
294 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
295 self
._log
.debug(" Received VNFR is %s", vnfr
)
296 while vnfr
.operational_status
!= 'running':
297 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
298 if vnfr
.operational_status
== 'failed':
299 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
300 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
301 yield from asyncio
.sleep(2, loop
=self
._loop
)
302 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
303 self
._log
.debug("Received VNFR is %s", vnfr
)
305 vnfr_cp_ref
.connection_point_params
.mgmt_address
= vnfr
.mgmt_interface
.ip_address
306 for cp
in vnfr
.connection_point
:
307 if cp
.name
== vnfr_cp_ref
.vnfr_connection_point_ref
:
308 vnfr_cp_ref
.connection_point_params
.port_id
= cp
.connection_point_id
309 vnfr_cp_ref
.connection_point_params
.name
= self
._nsr
.name
+ '.' + cp
.name
310 for vdu
in vnfr
.vdur
:
311 for ext_intf
in vdu
.external_interface
:
312 if ext_intf
.name
== vnfr_cp_ref
.vnfr_connection_point_ref
:
313 vnfr_cp_ref
.connection_point_params
.vm_id
= vdu
.vim_id
314 self
._log
.debug("VIM ID for CP %s in VNFR %s is %s",cp
.name
,nsr_vnfr
.id,
315 vnfr_cp_ref
.connection_point_params
.vm_id
)
318 vnfr_cp_ref
.connection_point_params
.address
= cp
.ip_address
319 vnfr_cp_ref
.connection_point_params
.port
= VnffgRecord
.SFF_DP_PORT
321 for vnffgd_classifier
in self
._vnffgd
_msg
.classifier
:
322 _rsp
= [rsp
for rsp
in vnffgr
.rsp
if rsp
.vnffgd_rsp_id_ref
== vnffgd_classifier
.rsp_id_ref
]
324 rsp_id_ref
= _rsp
[0].id
325 rsp_name
= _rsp
[0].name
327 self
._log
.error("RSP with ID %s not found during classifier creation for classifier id %s",vnffgd_classifier
.rsp_id_ref
,vnffgd_classifier
.id)
329 vnffgr_classifier
= vnffgr
.classifier
.add()
330 vnffgr_classifier
.id = vnffgd_classifier
.id
331 vnffgr_classifier
.name
= self
._nsr
.name
+ '.' + vnffgd_classifier
.name
332 _rsp
[0].classifier_name
= vnffgr_classifier
.name
333 vnffgr_classifier
.rsp_id_ref
= rsp_id_ref
334 vnffgr_classifier
.rsp_name
= rsp_name
335 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
336 if (nsr_vnfr
.vnfd
.id == vnffgd_classifier
.vnfd_id_ref
and
337 nsr_vnfr
.member_vnf_index
== vnffgd_classifier
.member_vnf_index_ref
):
338 vnffgr_classifier
.vnfr_id_ref
= nsr_vnfr
.id
339 vnffgr_classifier
.vnfr_name_ref
= nsr_vnfr
.name
340 vnffgr_classifier
.vnfr_connection_point_ref
= vnffgd_classifier
.vnfd_connection_point_ref
342 if nsr_vnfr
.vnfd
.service_function_chain
== 'CLASSIFIER':
343 vnffgr_classifier
.sff_name
= nsr_vnfr
.name
345 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
346 self
._log
.debug(" Received VNFR is %s", vnfr
)
347 while vnfr
.operational_status
!= 'running':
348 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
349 if vnfr
.operational_status
== 'failed':
350 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
351 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
352 yield from asyncio
.sleep(2, loop
=self
._loop
)
353 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
354 self
._log
.debug("Received VNFR is %s", vnfr
)
356 for cp
in vnfr
.connection_point
:
357 if cp
.name
== vnffgr_classifier
.vnfr_connection_point_ref
:
358 vnffgr_classifier
.port_id
= cp
.connection_point_id
359 vnffgr_classifier
.ip_address
= cp
.ip_address
360 for vdu
in vnfr
.vdur
:
361 for ext_intf
in vdu
.external_interface
:
362 if ext_intf
.name
== vnffgr_classifier
.vnfr_connection_point_ref
:
363 vnffgr_classifier
.vm_id
= vdu
.vim_id
364 self
._log
.debug("VIM ID for CP %s in VNFR %s is %s",cp
.name
,nsr_vnfr
.id,
365 vnfr_cp_ref
.connection_point_params
.vm_id
)
368 self
._log
.info("VNFFGR msg to be sent is %s", vnffgr
)
372 def vnffgr_nsr_sff_list(self
):
373 """ SFF List for VNFR """
375 sf_list
= [nsr_vnfr
.name
for nsr_vnfr
in self
._nsr
.vnfrs
.values() if nsr_vnfr
.vnfd
.service_function_chain
== 'SF']
377 for nsr_vnfr
in self
._nsr
.vnfrs
.values():
378 if (nsr_vnfr
.vnfd
.service_function_chain
== 'CLASSIFIER' or nsr_vnfr
.vnfd
.service_function_chain
== 'SFF'):
379 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
380 self
._log
.debug(" Received VNFR is %s", vnfr
)
381 while vnfr
.operational_status
!= 'running':
382 self
._log
.info("Received vnf op status is %s; retrying",vnfr
.operational_status
)
383 if vnfr
.operational_status
== 'failed':
384 self
._log
.error("Fetching VNFR for %s failed", vnfr
.id)
385 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFR %s failure" % (self
.id, vnfr
.id))
386 yield from asyncio
.sleep(2, loop
=self
._loop
)
387 vnfr
= yield from self
._nsr
.fetch_vnfr(nsr_vnfr
.xpath
)
388 self
._log
.debug("Received VNFR is %s", vnfr
)
390 sff
= RwsdnYang
.VNFFGSff()
391 sff_list
[nsr_vnfr
.vnfd
.id] = sff
392 sff
.name
= nsr_vnfr
.name
393 sff
.function_type
= nsr_vnfr
.vnfd
.service_function_chain
395 sff
.mgmt_address
= vnfr
.mgmt_interface
.ip_address
396 sff
.mgmt_port
= VnffgRecord
.SFF_MGMT_PORT
397 for cp
in vnfr
.connection_point
:
398 sff_dp
= sff
.dp_endpoints
.add()
399 sff_dp
.name
= self
._nsr
.name
+ '.' + cp
.name
400 sff_dp
.address
= cp
.ip_address
401 sff_dp
.port
= VnffgRecord
.SFF_DP_PORT
402 if nsr_vnfr
.vnfd
.service_function_chain
== 'SFF':
403 for sf_name
in sf_list
:
404 _sf
= sff
.vnfr_list
.add()
405 _sf
.vnfr_name
= sf_name
410 def instantiate(self
):
411 """ Instantiate this VNFFG """
413 self
._log
.info("Instaniating VNFFGR with vnffgd %s",
417 vnffgr_request
= yield from self
.vnffgr_create_msg()
418 vnffg_sff_list
= yield from self
.vnffgr_nsr_sff_list()
421 vnffgr
= self
._vnffgmgr
.create_vnffgr(vnffgr_request
,self
._vnffgd
_msg
.classifier
,vnffg_sff_list
)
422 except Exception as e
:
423 self
._log
.exception("VNFFG instantiation failed: %s", str(e
))
424 self
._vnffgr
_state
= VnffgRecordState
.FAILED
425 raise NsrInstantiationFailed("Failed NS %s instantiation due to VNFFGR %s failure" % (self
.id, vnffgr_request
.id))
427 self
._vnffgr
_state
= VnffgRecordState
.INSTANTIATION_PENDING
429 self
._log
.info("Instantiated VNFFGR :%s", vnffgr
)
430 self
._vnffgr
_state
= VnffgRecordState
.ACTIVE
432 self
._log
.info("Invoking update_state to update NSR state for NSR ID: %s", self
._nsr
.id)
433 yield from self
._nsr
.update_state()
435 def vnffgr_in_vnffgrm(self
):
436 """ Is there a VNFR record in VNFM """
437 if (self
._vnffgr
_state
== VnffgRecordState
.ACTIVE
or
438 self
._vnffgr
_state
== VnffgRecordState
.INSTANTIATION_PENDING
or
439 self
._vnffgr
_state
== VnffgRecordState
.FAILED
):
446 """ Terminate this VNFFGR """
447 if not self
.vnffgr_in_vnffgrm():
448 self
._log
.error("Ignoring terminate request for id %s in state %s",
449 self
.id, self
._vnffgr
_state
)
452 self
._log
.info("Terminating VNFFGR id:%s", self
.id)
453 self
._vnffgr
_state
= VnffgRecordState
.TERMINATE_PENDING
455 self
._vnffgmgr
.terminate_vnffgr(self
._vnffgr
_id
)
457 self
._vnffgr
_state
= VnffgRecordState
.TERMINATED
458 self
._log
.debug("Terminated VNFFGR id:%s", self
.id)
461 class VirtualLinkRecord(object):
462 """ Virtual Link Records class"""
465 def create_record(dts
, log
, loop
, nsr_name
, vld_msg
, cloud_account_name
, om_datacenter
, ip_profile
, nsr_id
, restart_mode
=False):
466 """Creates a new VLR object based on the given data.
468 If restart mode is enabled, then we look for existing records in the
469 DTS and create a VLR records using the exiting data(ID)
474 vlr_obj
= VirtualLinkRecord(
487 res_iter
= yield from dts
.query_read(
488 "D,/vlr:vlr-catalog/vlr:vlr",
489 rwdts
.XactFlag
.MERGE
)
492 response
= yield from fut
493 vlr
= response
.result
495 # Check if the record is already present, if so use the ID of
496 # the existing record. Since the name of the record is uniquely
497 # formed we can use it as a search key!
498 if vlr
.name
== vlr_obj
.name
:
499 vlr_obj
.reset_id(vlr
.id)
504 def __init__(self
, dts
, log
, loop
, nsr_name
, vld_msg
, cloud_account_name
, om_datacenter
, ip_profile
, nsr_id
):
508 self
._nsr
_name
= nsr_name
509 self
._vld
_msg
= vld_msg
510 self
._cloud
_account
_name
= cloud_account_name
511 self
._om
_datacenter
_name
= om_datacenter
512 self
._assigned
_subnet
= None
513 self
._nsr
_id
= nsr_id
514 self
._ip
_profile
= ip_profile
515 self
._vlr
_id
= str(uuid
.uuid4())
516 self
._state
= VlRecordState
.INIT
517 self
._prev
_state
= None
521 """ path for this object """
522 return "D,/vlr:vlr-catalog/vlr:vlr[vlr:id = '{}']".format(self
._vlr
_id
)
531 """ Get NSR name for this VL """
536 """ Virtual Link Desciptor """
540 def assigned_subnet(self
):
541 """ Subnet assigned to this VL"""
542 return self
._assigned
_subnet
547 Get the name for this VLR.
548 VLR name is "nsr name:VLD name"
550 if self
.vld_msg
.vim_network_name
:
551 return self
.vld_msg
.vim_network_name
552 elif self
.vld_msg
.name
== "multisite":
553 # This is a temporary hack to identify manually provisioned inter-site network
554 return self
.vld_msg
.name
556 return self
._nsr
_name
+ "." + self
.vld_msg
.name
559 def cloud_account_name(self
):
560 """ Cloud account that this VLR should be created in """
561 return self
._cloud
_account
_name
564 def om_datacenter_name(self
):
565 """ Datacenter that this VLR should be created in """
566 return self
._om
_datacenter
_name
570 """ Get the VLR path from VLR """
571 return (VirtualLinkRecord
.XPATH
+ "[vlr:id = '{}']").format(vlr
.id)
579 def state(self
, value
):
580 """ VLR set state """
584 def prev_state(self
):
585 """ VLR previous state """
586 return self
._prev
_state
589 def prev_state(self
, value
):
590 """ VLR set previous state """
591 self
._prev
_state
= value
595 """ Virtual Link Record message for Creating VLR in VNS """
596 vld_fields
= ["short_name",
604 vld_copy_dict
= {k
: v
for k
, v
in self
.vld_msg
.as_dict().items()
607 vlr_dict
= {"id": self
._vlr
_id
,
608 "nsr_id_ref": self
._nsr
_id
,
609 "vld_ref": self
.vld_msg
.id,
611 "cloud_account": self
.cloud_account_name
,
612 "om_datacenter": self
.om_datacenter_name
,
615 if self
._ip
_profile
and self
._ip
_profile
.has_field('ip_profile_params'):
616 vlr_dict
['ip_profile_params' ] = self
._ip
_profile
.ip_profile_params
.as_dict()
618 vlr_dict
.update(vld_copy_dict
)
619 vlr
= RwVlrYang
.YangData_Vlr_VlrCatalog_Vlr
.from_dict(vlr_dict
)
622 def reset_id(self
, vlr_id
):
623 self
._vlr
_id
= vlr_id
625 def create_nsr_vlr_msg(self
, vnfrs
):
626 """ The VLR message"""
627 nsr_vlr
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_Vlr()
628 nsr_vlr
.vlr_ref
= self
._vlr
_id
629 nsr_vlr
.assigned_subnet
= self
.assigned_subnet
630 nsr_vlr
.cloud_account
= self
.cloud_account_name
631 nsr_vlr
.om_datacenter
= self
.om_datacenter_name
633 for conn
in self
.vld_msg
.vnfd_connection_point_ref
:
635 if (vnfr
.vnfd
.id == conn
.vnfd_id_ref
and
636 vnfr
.member_vnf_index
== conn
.member_vnf_index_ref
and
637 self
.cloud_account_name
== vnfr
.cloud_account_name
and
638 self
.om_datacenter_name
== vnfr
.om_datacenter_name
):
639 cp_entry
= nsr_vlr
.vnfr_connection_point_ref
.add()
640 cp_entry
.vnfr_id
= vnfr
.id
641 cp_entry
.connection_point
= conn
.vnfd_connection_point_ref
646 def instantiate(self
):
647 """ Instantiate this VL """
649 self
._log
.debug("Instaniating VLR key %s, vld %s",
650 self
.xpath
, self
._vld
_msg
)
652 self
._state
= VlRecordState
.INSTANTIATION_PENDING
653 self
._log
.debug("Executing VL create path:%s msg:%s",
654 self
.xpath
, self
.vlr_msg
)
656 with self
._dts
.transaction(flags
=0) as xact
:
657 block
= xact
.block_create()
658 block
.add_query_create(self
.xpath
, self
.vlr_msg
)
659 self
._log
.debug("Executing VL create path:%s msg:%s",
660 self
.xpath
, self
.vlr_msg
)
661 res_iter
= yield from block
.execute(now
=True)
667 self
._state
= VlRecordState
.FAILED
668 raise NsrInstantiationFailed("Failed NS %s instantiation due to empty response" % self
.id)
670 if vlr
.operational_status
== 'failed':
671 self
._log
.debug("NS Id:%s VL creation failed for vlr id %s", self
.id, vlr
.id)
672 self
._state
= VlRecordState
.FAILED
673 raise NsrInstantiationFailed("Failed VL %s instantiation (%s)" % (vlr
.id, vlr
.operational_status_details
))
675 self
._log
.info("Instantiated VL with xpath %s and vlr:%s",
677 self
._state
= VlRecordState
.ACTIVE
678 self
._assigned
_subnet
= vlr
.assigned_subnet
680 def vlr_in_vns(self
):
681 """ Is there a VLR record in VNS """
682 if (self
._state
== VlRecordState
.ACTIVE
or
683 self
._state
== VlRecordState
.INSTANTIATION_PENDING
or
684 self
._state
== VlRecordState
.TERMINATE_PENDING
or
685 self
._state
== VlRecordState
.FAILED
):
692 """ Terminate this VL """
693 if not self
.vlr_in_vns():
694 self
._log
.debug("Ignoring terminate request for id %s in state %s",
695 self
.id, self
._state
)
698 self
._log
.debug("Terminating VL id:%s", self
.id)
699 self
._state
= VlRecordState
.TERMINATE_PENDING
701 with self
._dts
.transaction(flags
=0) as xact
:
702 block
= xact
.block_create()
703 block
.add_query_delete(self
.xpath
)
704 yield from block
.execute(flags
=0, now
=True)
706 self
._state
= VlRecordState
.TERMINATED
707 self
._log
.debug("Terminated VL id:%s", self
.id)
710 class VnfRecordState(Enum
):
711 """ Vnf Record State """
713 INSTANTIATION_PENDING
= 102
715 TERMINATE_PENDING
= 104
720 class VirtualNetworkFunctionRecord(object):
721 """ Virtual Network Function Record class"""
722 XPATH
= "D,/vnfr:vnfr-catalog/vnfr:vnfr"
726 def create_record(dts
, log
, loop
, vnfd
, const_vnfd_msg
, nsd_id
, nsr_name
,
727 cloud_account_name
, om_datacenter_name
, nsr_id
, group_name
, group_instance_id
,
728 placement_groups
, restart_mode
=False):
729 """Creates a new VNFR object based on the given data.
731 If restart mode is enabled, then we look for existing records in the
732 DTS and create a VNFR records using the exiting data(ID)
735 VirtualNetworkFunctionRecord
737 vnfr_obj
= VirtualNetworkFunctionRecord(
751 restart_mode
=restart_mode
)
754 res_iter
= yield from dts
.query_read(
755 "D,/vnfr:vnfr-catalog/vnfr:vnfr",
756 rwdts
.XactFlag
.MERGE
)
759 response
= yield from fut
760 vnfr
= response
.result
762 if vnfr
.name
== vnfr_obj
.name
:
763 vnfr_obj
.reset_id(vnfr
.id)
780 group_instance_id
=None,
781 placement_groups
= [],
782 restart_mode
= False):
787 self
._const
_vnfd
_msg
= const_vnfd_msg
788 self
._nsd
_id
= nsd_id
789 self
._nsr
_name
= nsr_name
790 self
._nsr
_id
= nsr_id
791 self
._cloud
_account
_name
= cloud_account_name
792 self
._om
_datacenter
_name
= om_datacenter_name
793 self
._group
_name
= group_name
794 self
._group
_instance
_id
= group_instance_id
795 self
._placement
_groups
= placement_groups
796 self
._config
_status
= NsrYang
.ConfigStates
.INIT
798 self
._prev
_state
= VnfRecordState
.INIT
799 self
._state
= VnfRecordState
.INIT
800 self
._state
_failed
_reason
= None
802 self
.config_store
= rift
.mano
.config_data
.config
.ConfigStore(self
._log
)
805 self
._vnfr
_id
= str(uuid
.uuid4())
807 self
._vnfr
_msg
= self
.create_vnfr_msg()
808 self
._log
.debug("Set VNFR {} config type to {}".
809 format(self
.name
, self
.config_type
))
810 self
.restart_mode
= restart_mode
813 if group_name
is None and group_instance_id
is not None:
814 raise ValueError("Group instance id must not be provided with an empty group name")
824 return "D,/vnfr:vnfr-catalog/vnfr:vnfr[vnfr:id = '{}']".format(self
.id)
829 return self
._vnfr
_msg
832 def const_vnfr_msg(self
):
834 return RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_ConstituentVnfrRef(vnfr_id
=self
.id,cloud_account
=self
.cloud_account_name
,om_datacenter
=self
._om
_datacenter
_name
)
842 def cloud_account_name(self
):
843 """ Cloud account that this VNF should be created in """
844 return self
._cloud
_account
_name
847 def om_datacenter_name(self
):
848 """ Datacenter that this VNF should be created in """
849 return self
._om
_datacenter
_name
854 """ Is this VNF actve """
855 return True if self
._state
== VnfRecordState
.ACTIVE
else False
859 """ state of this VNF """
863 def state_failed_reason(self
):
864 """ Error message in case this VNF is in failed state """
865 return self
._state
_failed
_reason
868 def member_vnf_index(self
):
869 """ Member VNF index """
870 return self
._const
_vnfd
_msg
.member_vnf_index
875 return self
._nsr
_name
879 """ Name of this VNFR """
880 if self
._name
is not None:
883 name_tags
= [self
._nsr
_name
]
885 if self
._group
_name
is not None:
886 name_tags
.append(self
._group
_name
)
888 if self
._group
_instance
_id
is not None:
889 name_tags
.append(str(self
._group
_instance
_id
))
891 name_tags
.extend([self
.vnfd
.name
, str(self
.member_vnf_index
)])
893 self
._name
= "__".join(name_tags
)
898 def vnfr_xpath(vnfr
):
899 """ Get the VNFR path from VNFR """
900 return (VirtualNetworkFunctionRecord
.XPATH
+ "[vnfr:id = '{}']").format(vnfr
.id)
903 def config_type(self
):
904 cfg_types
= ['netconf', 'juju', 'script']
905 for method
in cfg_types
:
906 if self
._vnfd
.vnf_configuration
.has_field(method
):
911 def config_status(self
):
912 """Return the config status as YANG ENUM string"""
913 self
._log
.debug("Map VNFR {} config status {} ({})".
914 format(self
.name
, self
._config
_status
, self
.config_type
))
915 if self
.config_type
== 'none':
916 return 'config_not_needed'
917 elif self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURED
:
919 elif self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
924 def set_state(self
, state
):
925 """ set the state of this object """
926 self
._prev
_state
= self
._state
929 def reset_id(self
, vnfr_id
):
930 self
._vnfr
_id
= vnfr_id
931 self
._vnfr
_msg
= self
.create_vnfr_msg()
934 self
.config_store
.merge_vnfd_config(
937 self
.member_vnf_index
,
940 def create_vnfr_msg(self
):
941 """ VNFR message for this VNFR """
949 vnfd_copy_dict
= {k
: v
for k
, v
in self
._vnfd
.as_dict().items() if k
in vnfd_fields
}
952 "nsr_id_ref": self
._nsr
_id
,
953 "vnfd_ref": self
.vnfd
.id,
955 "cloud_account": self
._cloud
_account
_name
,
956 "om_datacenter": self
._om
_datacenter
_name
,
957 "config_status": self
.config_status
959 vnfr_dict
.update(vnfd_copy_dict
)
961 vnfr
= RwVnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr
.from_dict(vnfr_dict
)
962 vnfr
.member_vnf_index_ref
= self
.member_vnf_index
963 vnfr
.vnf_configuration
.from_dict(self
._vnfd
.vnf_configuration
.as_dict())
965 if self
._vnfd
.mgmt_interface
.has_field("port"):
966 vnfr
.mgmt_interface
.port
= self
._vnfd
.mgmt_interface
.port
968 for group_info
in self
._placement
_groups
:
969 group
= vnfr
.placement_groups_info
.add()
970 group
.from_dict(group_info
.as_dict())
972 # UI expects the monitoring param field to exist
973 vnfr
.monitoring_param
= []
975 self
._log
.debug("Get vnfr_msg for VNFR {} : {}".format(self
.name
, vnfr
))
979 def update_vnfm(self
):
980 self
._log
.debug("Send an update to VNFM for VNFR {} with {}".
981 format(self
.name
, self
.vnfr_msg
))
982 yield from self
._dts
.query_update(
984 rwdts
.XactFlag
.TRACE
,
988 def get_config_status(self
):
989 """Return the config status as YANG ENUM"""
990 return self
._config
_status
993 def set_config_status(self
, status
):
995 def status_to_string(status
):
997 NsrYang
.ConfigStates
.INIT
: 'init',
998 NsrYang
.ConfigStates
.CONFIGURING
: 'configuring',
999 NsrYang
.ConfigStates
.CONFIG_NOT_NEEDED
: 'config_not_needed',
1000 NsrYang
.ConfigStates
.CONFIGURED
: 'configured',
1001 NsrYang
.ConfigStates
.FAILED
: 'failed',
1004 return status_dc
[status
]
1006 self
._log
.debug("Update VNFR {} from {} ({}) to {}".
1007 format(self
.name
, self
._config
_status
,
1008 self
.config_type
, status
))
1009 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURED
:
1010 self
._log
.error("Updating already configured VNFR {}".
1014 if self
._config
_status
!= status
:
1016 self
._config
_status
= status
1017 # I don't think this is used. Original implementor can check.
1018 # Caused Exception, so corrected it by status_to_string
1019 # But not sure whats the use of this variable?
1020 self
.vnfr_msg
.config_status
= status_to_string(status
)
1021 except Exception as e
:
1022 self
._log
.error("Exception=%s", str(e
))
1025 self
._log
.debug("Updated VNFR {} status to {}".format(self
.name
, status
))
1027 if self
._config
_status
!= NsrYang
.ConfigStates
.INIT
:
1029 # Publish only after VNFM has the VNFR created
1030 yield from self
.update_vnfm()
1031 except Exception as e
:
1032 self
._log
.error("Exception updating VNFM with new status {} of VNFR {}: {}".
1033 format(status
, self
.name
, e
))
1034 self
._log
.exception(e
)
1036 def is_configured(self
):
1037 if self
.config_type
== 'none':
1040 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURED
:
1046 def instantiate(self
, nsr
):
1047 """ Instantiate this VNFR"""
1049 self
._log
.debug("Instaniating VNFR key %s, vnfd %s",
1050 self
.xpath
, self
._vnfd
)
1052 self
._log
.debug("Create VNF with xpath %s and vnfr %s",
1053 self
.xpath
, self
.vnfr_msg
)
1055 self
.set_state(VnfRecordState
.INSTANTIATION_PENDING
)
1057 def find_vlr_for_cp(conn
):
1058 """ Find VLR for the given connection point """
1059 for vlr
in nsr
.vlrs
:
1060 for vnfd_cp
in vlr
.vld_msg
.vnfd_connection_point_ref
:
1061 if (vnfd_cp
.vnfd_id_ref
== self
._vnfd
.id and
1062 vnfd_cp
.vnfd_connection_point_ref
== conn
.name
and
1063 vnfd_cp
.member_vnf_index_ref
== self
.member_vnf_index
and
1064 vlr
.cloud_account_name
== self
.cloud_account_name
):
1065 self
._log
.debug("Found VLR for cp_name:%s and vnf-index:%d",
1066 conn
.name
, self
.member_vnf_index
)
1070 # For every connection point in the VNFD fill in the identifier
1071 for conn_p
in self
._vnfd
.connection_point
:
1072 cpr
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr_ConnectionPoint()
1073 cpr
.name
= conn_p
.name
1074 cpr
.type_yang
= conn_p
.type_yang
1075 vlr_ref
= find_vlr_for_cp(conn_p
)
1077 msg
= "Failed to find VLR for cp = %s" % conn_p
.name
1078 self
._log
.debug("%s", msg
)
1079 # raise VirtualNetworkFunctionRecordError(msg)
1082 cpr
.vlr_ref
= vlr_ref
.id
1083 self
.vnfr_msg
.connection_point
.append(cpr
)
1084 self
._log
.debug("Connection point [%s] added, vnf id=%s vnfd id=%s",
1085 cpr
, self
.vnfr_msg
.id, self
.vnfr_msg
.vnfd_ref
)
1087 if not self
.restart_mode
:
1088 yield from self
._dts
.query_create(self
.xpath
,
1092 yield from self
._dts
.query_update(self
.xpath
,
1096 self
._log
.info("Created VNF with xpath %s and vnfr %s",
1097 self
.xpath
, self
.vnfr_msg
)
1099 self
._log
.info("Instantiated VNFR with xpath %s and vnfd %s, vnfr %s",
1100 self
.xpath
, self
._vnfd
, self
.vnfr_msg
)
1103 def update_state(self
, vnfr_msg
):
1104 """ Update this VNFR"""
1105 if vnfr_msg
.operational_status
== "running":
1106 if self
.vnfr_msg
.operational_status
!= "running":
1107 yield from self
.is_active()
1108 elif vnfr_msg
.operational_status
== "failed":
1109 yield from self
.instantiation_failed(failed_reason
=vnfr_msg
.operational_status_details
)
1112 def is_active(self
):
1113 """ This VNFR is active """
1114 self
._log
.debug("VNFR %s is active", self
._vnfr
_id
)
1115 self
.set_state(VnfRecordState
.ACTIVE
)
1118 def instantiation_failed(self
, failed_reason
=None):
1119 """ This VNFR instantiation failed"""
1120 self
._log
.error("VNFR %s instantiation failed", self
._vnfr
_id
)
1121 self
.set_state(VnfRecordState
.FAILED
)
1122 self
._state
_failed
_reason
= failed_reason
1124 def vnfr_in_vnfm(self
):
1125 """ Is there a VNFR record in VNFM """
1126 if (self
._state
== VnfRecordState
.ACTIVE
or
1127 self
._state
== VnfRecordState
.INSTANTIATION_PENDING
or
1128 self
._state
== VnfRecordState
.FAILED
):
1134 def terminate(self
):
1135 """ Terminate this VNF """
1136 if not self
.vnfr_in_vnfm():
1137 self
._log
.debug("Ignoring terminate request for id %s in state %s",
1138 self
.id, self
._state
)
1141 self
._log
.debug("Terminating VNF id:%s", self
.id)
1142 self
.set_state(VnfRecordState
.TERMINATE_PENDING
)
1143 with self
._dts
.transaction(flags
=0) as xact
:
1144 block
= xact
.block_create()
1145 block
.add_query_delete(self
.xpath
)
1146 yield from block
.execute(flags
=0)
1147 self
.set_state(VnfRecordState
.TERMINATED
)
1148 self
._log
.debug("Terminated VNF id:%s", self
.id)
1151 class NetworkServiceStatus(object):
1152 """ A class representing the Network service's status """
1153 MAX_EVENTS_RECORDED
= 10
1154 """ Network service Status class"""
1155 def __init__(self
, dts
, log
, loop
):
1160 self
._state
= NetworkServiceRecordState
.INIT
1161 self
._events
= deque([])
1164 def create_notification(self
, evt
, evt_desc
, evt_details
):
1165 xp
= "N,/rw-nsr:nsm-notification"
1166 notif
= RwNsrYang
.YangNotif_RwNsr_NsmNotification()
1168 notif
.description
= evt_desc
1169 notif
.details
= evt_details
if evt_details
is not None else None
1171 yield from self
._dts
.query_create(xp
, rwdts
.XactFlag
.ADVISE
, notif
)
1172 self
._log
.info("Notification called by creating dts query: %s", notif
)
1174 def record_event(self
, evt
, evt_desc
, evt_details
):
1175 """ Record an event """
1176 self
._log
.debug("Recording event - evt %s, evt_descr %s len = %s",
1177 evt
, evt_desc
, len(self
._events
))
1178 if len(self
._events
) >= NetworkServiceStatus
.MAX_EVENTS_RECORDED
:
1179 self
._events
.popleft()
1180 self
._events
.append((int(time
.time()), evt
, evt_desc
,
1181 evt_details
if evt_details
is not None else None))
1183 self
._loop
.create_task(self
.create_notification(evt
,evt_desc
,evt_details
))
1185 def set_state(self
, state
):
1186 """ set the state of this status object """
1190 """ Return the state as a yang enum string """
1191 state_to_str_map
= {"INIT": "init",
1192 "VL_INIT_PHASE": "vl_init_phase",
1193 "VNF_INIT_PHASE": "vnf_init_phase",
1194 "VNFFG_INIT_PHASE": "vnffg_init_phase",
1195 "SCALING_GROUP_INIT_PHASE": "scaling_group_init_phase",
1196 "RUNNING": "running",
1197 "SCALING_OUT": "scaling_out",
1198 "SCALING_IN": "scaling_in",
1199 "TERMINATE_RCVD": "terminate_rcvd",
1200 "TERMINATE": "terminate",
1201 "VL_TERMINATE_PHASE": "vl_terminate_phase",
1202 "VNF_TERMINATE_PHASE": "vnf_terminate_phase",
1203 "VNFFG_TERMINATE_PHASE": "vnffg_terminate_phase",
1204 "TERMINATED": "terminated",
1206 "VL_INSTANTIATE": "vl_instantiate",
1207 "VL_TERMINATE": "vl_terminate",
1209 return state_to_str_map
[self
._state
.name
]
1213 """ State of this status object """
1218 """ Network Service Record as a message"""
1221 for entry
in self
._events
:
1222 event
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_OperationalEvents()
1225 event
.timestamp
, event
.event
, event
.description
, event
.details
= entry
1226 event_list
.append(event
)
1230 class NetworkServiceRecord(object):
1231 """ Network service record """
1232 XPATH
= "D,/nsr:ns-instance-opdata/nsr:nsr"
1234 def __init__(self
, dts
, log
, loop
, nsm
, nsm_plugin
, nsr_cfg_msg
, sdn_account_name
, key_pairs
, restart_mode
=False):
1239 self
._nsr
_cfg
_msg
= nsr_cfg_msg
1240 self
._nsm
_plugin
= nsm_plugin
1241 self
._sdn
_account
_name
= sdn_account_name
1244 self
._nsr
_msg
= None
1245 self
._nsr
_regh
= None
1246 self
._key
_pairs
= key_pairs
1251 self
._param
_pools
= {}
1252 self
._scaling
_groups
= {}
1253 self
._create
_time
= int(time
.time())
1254 self
._op
_status
= NetworkServiceStatus(dts
, log
, loop
)
1255 self
._config
_status
= NsrYang
.ConfigStates
.CONFIGURING
1256 self
._config
_status
_details
= None
1258 self
.restart_mode
= restart_mode
1259 self
.config_store
= rift
.mano
.config_data
.config
.ConfigStore(self
._log
)
1260 self
._debug
_running
= False
1261 self
._is
_active
= False
1262 self
._vl
_phase
_completed
= False
1263 self
._vnf
_phase
_completed
= False
1266 # Initalise the state to init
1267 # The NSR moves through the following transitions
1268 # 1. INIT -> VLS_READY once all the VLs in the NSD are created
1269 # 2. VLS_READY - VNFS_READY when all the VNFs in the NSD are created
1270 # 3. VNFS_READY - READY when the NSR is published
1272 self
.set_state(NetworkServiceRecordState
.INIT
)
1274 self
.substitute_input_parameters
= InputParameterSubstitution(self
._log
)
1277 def nsm_plugin(self
):
1279 return self
._nsm
_plugin
1281 def set_state(self
, state
):
1282 """ Set state for this NSR"""
1283 self
._log
.debug("Setting state to %s", state
)
1284 # We are in init phase and is moving to the next state
1285 # The new state could be a FAILED state or VNF_INIIT_PHASE
1286 if self
.state
== NetworkServiceRecordState
.VL_INIT_PHASE
:
1287 self
._vl
_phase
_completed
= True
1289 if self
.state
== NetworkServiceRecordState
.VNF_INIT_PHASE
:
1290 self
._vnf
_phase
_completed
= True
1292 self
._op
_status
.set_state(state
)
1296 """ Get id for this NSR"""
1297 return self
._nsr
_cfg
_msg
.id
1301 """ Name of this network service record """
1302 return self
._nsr
_cfg
_msg
.name
1305 def cloud_account_name(self
):
1306 return self
._nsr
_cfg
_msg
.cloud_account
1309 def om_datacenter_name(self
):
1310 if self
._nsr
_cfg
_msg
.has_field('om_datacenter'):
1311 return self
._nsr
_cfg
_msg
.om_datacenter
1316 """State of this NetworkServiceRecord"""
1317 return self
._op
_status
.state
1321 """ Is this NSR active ?"""
1322 return True if self
._op
_status
.state
== NetworkServiceRecordState
.RUNNING
else False
1326 """ VLRs associated with this NSR"""
1331 """ VNFRs associated with this NSR"""
1336 """ VNFFGRs associated with this NSR"""
1337 return self
._vnffgrs
1340 def scaling_groups(self
):
1341 """ Scaling groups associated with this NSR """
1342 return self
._scaling
_groups
1345 def param_pools(self
):
1346 """ Parameter value pools associated with this NSR"""
1347 return self
._param
_pools
1350 def nsr_cfg_msg(self
):
1351 return self
._nsr
_cfg
_msg
1354 def nsr_cfg_msg(self
, msg
):
1355 self
._nsr
_cfg
_msg
= msg
1359 """ NSD Protobuf for this NSR """
1360 if self
._nsd
is not None:
1362 self
._nsd
= self
._nsr
_cfg
_msg
.nsd
1367 """ NSD ID for this NSR """
1368 return self
.nsd_msg
.id
1372 ''' Get a new job id for config primitive'''
1377 def config_status(self
):
1378 """ Config status for NSR """
1379 return self
._config
_status
1381 def resolve_placement_group_cloud_construct(self
, input_group
):
1383 Returns the cloud specific construct for placement group
1385 copy_dict
= ['name', 'requirement', 'strategy']
1387 for group_info
in self
._nsr
_cfg
_msg
.nsd_placement_group_maps
:
1388 if group_info
.placement_group_ref
== input_group
.name
:
1389 group
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr_PlacementGroupsInfo()
1390 group_dict
= {k
:v
for k
,v
in
1391 group_info
.as_dict().items() if k
!= 'placement_group_ref'}
1392 for param
in copy_dict
:
1393 group_dict
.update({param
: getattr(input_group
, param
)})
1394 group
.from_dict(group_dict
)
1400 return "NSR(name={}, nsd_id={}, cloud_account={})".format(
1401 self
.name
, self
.nsd_id
, self
.cloud_account_name
1404 def _get_vnfd(self
, vnfd_id
, config_xact
):
1405 """ Fetch vnfd msg for the passed vnfd id """
1406 return self
._nsm
.get_vnfd(vnfd_id
, config_xact
)
1408 def _get_vnfd_cloud_account(self
, vnfd_member_index
):
1409 """ Fetch Cloud Account for the passed vnfd id """
1410 if self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1411 vim_accounts
= [(vnf
.cloud_account
,vnf
.om_datacenter
) for vnf
in self
._nsr
_cfg
_msg
.vnf_cloud_account_map \
1412 if vnfd_member_index
== vnf
.member_vnf_index_ref
]
1413 if vim_accounts
and vim_accounts
[0]:
1414 return vim_accounts
[0]
1415 return (self
.cloud_account_name
,self
.om_datacenter_name
)
1417 def _get_constituent_vnfd_msg(self
, vnf_index
):
1418 for const_vnfd
in self
.nsd_msg
.constituent_vnfd
:
1419 if const_vnfd
.member_vnf_index
== vnf_index
:
1422 raise ValueError("Constituent VNF index %s not found" % vnf_index
)
1424 def record_event(self
, evt
, evt_desc
, evt_details
=None, state
=None):
1425 """ Record an event """
1426 self
._op
_status
.record_event(evt
, evt_desc
, evt_details
)
1427 if state
is not None:
1428 self
.set_state(state
)
1430 def scaling_trigger_str(self
, trigger
):
1431 SCALING_TRIGGER_STRS
= {
1432 NsdYang
.ScalingTrigger
.PRE_SCALE_IN
: 'pre-scale-in',
1433 NsdYang
.ScalingTrigger
.POST_SCALE_IN
: 'post-scale-in',
1434 NsdYang
.ScalingTrigger
.PRE_SCALE_OUT
: 'pre-scale-out',
1435 NsdYang
.ScalingTrigger
.POST_SCALE_OUT
: 'post-scale-out',
1438 return SCALING_TRIGGER_STRS
[trigger
]
1439 except Exception as e
:
1440 self
._log
.error("Scaling trigger mapping error for {} : {}".
1442 self
._log
.exception(e
)
1443 return "Unknown trigger"
1446 def instantiate_vls(self
):
1448 This function instantiates VLs for every VL in this Network Service
1450 self
._log
.debug("Instantiating %d VLs in NSD id %s", len(self
._vlrs
),
1452 for vlr
in self
._vlrs
:
1453 yield from self
.nsm_plugin
.instantiate_vl(self
, vlr
)
1454 vlr
.state
= VlRecordState
.ACTIVE
1457 def create(self
, config_xact
):
1458 """ Create this network service"""
1459 # Create virtual links for all the external vnf
1460 # connection points in this NS
1461 yield from self
.create_vls()
1463 # Create VNFs in this network service
1464 yield from self
.create_vnfs(config_xact
)
1466 # Create VNFFG for network service
1467 self
.create_vnffgs()
1469 # Create Scaling Groups for each scaling group in NSD
1470 self
.create_scaling_groups()
1472 # Create Parameter Pools
1473 self
.create_param_pools()
1476 def apply_scale_group_config_script(self
, script
, group
, scale_instance
, trigger
, vnfrs
=None):
1477 """ Apply config based on script for scale group """
1480 def add_vnfrs_data(vnfrs_list
):
1481 """ Add as a dict each of the VNFRs data """
1483 for vnfr
in vnfrs_list
:
1484 self
._log
.debug("Add VNFR {} data".format(vnfr
))
1486 vnfr_data
['name'] = vnfr
.name
1487 if trigger
in [NsdYang
.ScalingTrigger
.PRE_SCALE_IN
, NsdYang
.ScalingTrigger
.POST_SCALE_OUT
]:
1488 # Get VNF management and other IPs, etc
1489 opdata
= yield from self
.fetch_vnfr(vnfr
.xpath
)
1490 self
._log
.debug("VNFR {} op data: {}".format(vnfr
.name
, opdata
))
1492 vnfr_data
['rw_mgmt_ip'] = opdata
.mgmt_interface
.ip_address
1493 vnfr_data
['rw_mgmt_port'] = opdata
.mgmt_interface
.port
1494 except Exception as e
:
1495 self
._log
.error("Unable to get management IP for vnfr {}:{}".
1496 format(vnfr
.name
, e
))
1499 vnfr_data
['connection_points'] = []
1500 for cp
in opdata
.connection_point
:
1502 con_pt
['name'] = cp
.name
1503 con_pt
['ip_address'] = cp
.ip_address
1504 vnfr_data
['connection_points'].append(con_pt
)
1505 except Exception as e
:
1506 self
._log
.error("Exception getting connections points for VNFR {}: {}".
1507 format(vnfr
.name
, e
))
1509 vnfrs_data
.append(vnfr_data
)
1510 self
._log
.debug("VNFRs data: {}".format(vnfrs_data
))
1514 def add_nsr_data(nsr
):
1516 nsr_data
['name'] = nsr
.name
1519 if script
is None or len(script
) == 0:
1520 self
._log
.error("Script not provided for scale group config: {}".format(group
.name
))
1523 if script
[0] == '/':
1526 path
= os
.path
.join(os
.environ
['RIFT_INSTALL'], "usr/bin", script
)
1527 if not os
.path
.exists(path
):
1528 self
._log
.error("Config faled for scale group {}: Script does not exist at {}".
1529 format(group
.name
, path
))
1532 # Build a YAML file with all parameters for the script to execute
1533 # The data consists of 5 sections
1535 # 2. Scale group config
1536 # 3. VNFRs in the scale group
1537 # 4. VNFRs outside scale group
1540 data
['trigger'] = group
.trigger_map(trigger
)
1541 data
['config'] = group
.group_msg
.as_dict()
1544 data
["vnfrs_in_group"] = yield from add_vnfrs_data(vnfrs
)
1546 data
["vnfrs_in_group"] = yield from add_vnfrs_data(scale_instance
.vnfrs
)
1548 data
["vnfrs_others"] = yield from add_vnfrs_data(self
.vnfrs
.values())
1549 data
["nsr"] = add_nsr_data(self
)
1552 with tempfile
.NamedTemporaryFile(delete
=False) as tmp_file
:
1553 tmp_file
.write(yaml
.dump(data
, default_flow_style
=True)
1556 self
._log
.debug("Creating a temp file: {} with input data: {}".
1557 format(tmp_file
.name
, data
))
1559 cmd
= "{} {}".format(path
, tmp_file
.name
)
1560 self
._log
.debug("Running the CMD: {}".format(cmd
))
1561 proc
= yield from asyncio
.create_subprocess_shell(cmd
, loop
=self
._loop
)
1562 rc
= yield from proc
.wait()
1564 self
._log
.error("The script {} for scale group {} config returned: {}".
1565 format(script
, group
.name
, rc
))
1573 def apply_scaling_group_config(self
, trigger
, group
, scale_instance
, vnfrs
=None):
1574 """ Apply the config for the scaling group based on trigger """
1575 if group
is None or scale_instance
is None:
1579 def update_config_status(success
=True, err_msg
=None):
1580 self
._log
.debug("Update %s config status to %r : %s",
1581 scale_instance
, success
, err_msg
)
1582 if (scale_instance
.config_status
== "failed"):
1583 # Do not update the config status if it is already in failed state
1586 if scale_instance
.config_status
== "configured":
1587 # Update only to failed state an already configured scale instance
1589 scale_instance
.config_status
= "failed"
1590 scale_instance
.config_err_msg
= err_msg
1591 yield from self
.update_state()
1593 # We are in configuring state
1594 # Only after post scale out mark instance as configured
1595 if trigger
== NsdYang
.ScalingTrigger
.POST_SCALE_OUT
:
1597 scale_instance
.config_status
= "configured"
1599 scale_instance
.config_status
= "failed"
1600 scale_instance
.config_err_msg
= err_msg
1601 yield from self
.update_state()
1603 config
= group
.trigger_config(trigger
)
1607 self
._log
.debug("Scaling group {} config: {}".format(group
.name
, config
))
1608 if config
.has_field("ns_config_primitive_name_ref"):
1609 config_name
= config
.ns_config_primitive_name_ref
1610 nsd_msg
= self
.nsd_msg
1611 config_primitive
= None
1612 for ns_cfg_prim
in nsd_msg
.service_primitive
:
1613 if ns_cfg_prim
.name
== config_name
:
1614 config_primitive
= ns_cfg_prim
1617 if config_primitive
is None:
1618 raise ValueError("Could not find ns_cfg_prim %s in nsr %s" % (config_name
, self
.name
))
1620 self
._log
.debug("Scaling group {} config primitive: {}".format(group
.name
, config_primitive
))
1621 if config_primitive
.has_field("user_defined_script"):
1622 rc
= yield from self
.apply_scale_group_config_script(config_primitive
.user_defined_script
,
1623 group
, scale_instance
, trigger
, vnfrs
)
1626 err_msg
= "Failed config for trigger {} using config script '{}'". \
1627 format(self
.scaling_trigger_str(trigger
),
1628 config_primitive
.user_defined_script
)
1629 yield from update_config_status(success
=rc
, err_msg
=err_msg
)
1632 err_msg
= "Failed config for trigger {} as config script is not specified". \
1633 format(self
.scaling_trigger_str(trigger
))
1634 yield from update_config_status(success
=False, err_msg
=err_msg
)
1635 raise NotImplementedError("Only script based config support for scale group for now: {}".
1638 err_msg
= "Failed config for trigger {} as config primitive is not specified".\
1639 format(self
.scaling_trigger_str(trigger
))
1640 yield from update_config_status(success
=False, err_msg
=err_msg
)
1641 self
._log
.error("Config primitive not specified for config action in scale group %s" %
1645 def create_scaling_groups(self
):
1646 """ This function creates a NSScalingGroup for every scaling
1647 group defined in he NSD"""
1649 for scaling_group_msg
in self
.nsd_msg
.scaling_group_descriptor
:
1650 self
._log
.debug("Found scaling_group %s in nsr id %s",
1651 scaling_group_msg
.name
, self
.id)
1653 group_record
= scale_group
.ScalingGroup(
1658 self
._scaling
_groups
[group_record
.name
] = group_record
1661 def create_scale_group_instance(self
, group_name
, index
, config_xact
, is_default
=False):
1662 group
= self
._scaling
_groups
[group_name
]
1663 scale_instance
= group
.create_instance(index
, is_default
)
1667 self
._log
.debug("Creating %u VNFs associated with NS id %s scaling group %s",
1668 len(self
.nsd_msg
.constituent_vnfd
), self
.id, self
)
1671 for vnf_index
, count
in group
.vnf_index_count_map
.items():
1672 const_vnfd_msg
= self
._get
_constituent
_vnfd
_msg
(vnf_index
)
1673 vnfd_msg
= self
._get
_vnfd
(const_vnfd_msg
.vnfd_id_ref
, config_xact
)
1675 cloud_account_name
, om_datacenter_name
= self
._get
_vnfd
_cloud
_account
(const_vnfd_msg
.member_vnf_index
)
1676 if cloud_account_name
is None:
1677 cloud_account_name
= self
.cloud_account_name
1678 for _
in range(count
):
1679 vnfr
= yield from self
.create_vnf_record(vnfd_msg
, const_vnfd_msg
, cloud_account_name
, om_datacenter_name
, group_name
, index
)
1680 scale_instance
.add_vnfr(vnfr
)
1686 def instantiate_instance():
1687 self
._log
.debug("Creating %s VNFRS", scale_instance
)
1688 vnfrs
= yield from create_vnfs()
1689 yield from self
.publish()
1691 self
._log
.debug("Instantiating %s VNFRS for %s", len(vnfrs
), scale_instance
)
1692 scale_instance
.operational_status
= "vnf_init_phase"
1693 yield from self
.update_state()
1696 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.PRE_SCALE_OUT
,
1697 group
, scale_instance
, vnfrs
)
1699 self
._log
.error("Pre scale out config for scale group {} ({}) failed".
1700 format(group
.name
, index
))
1701 scale_instance
.operational_status
= "failed"
1703 yield from self
.instantiate_vnfs(vnfrs
)
1705 except Exception as e
:
1706 self
._log
.exception("Failed to begin instantiatiation of vnfs for scale group {}: {}".
1707 format(group
.name
, e
))
1708 self
._log
.exception(e
)
1709 scale_instance
.operational_status
= "failed"
1711 yield from self
.update_state()
1713 yield from instantiate_instance()
1716 def delete_scale_group_instance(self
, group_name
, index
):
1717 group
= self
._scaling
_groups
[group_name
]
1718 scale_instance
= group
.get_instance(index
)
1719 if scale_instance
.is_default
:
1720 raise ScalingOperationError("Cannot terminate a default scaling group instance")
1722 scale_instance
.operational_status
= "terminate"
1723 yield from self
.update_state()
1726 def terminate_instance():
1727 self
._log
.debug("Terminating %s VNFRS" % scale_instance
)
1728 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.PRE_SCALE_IN
,
1729 group
, scale_instance
)
1731 self
._log
.error("Pre scale in config for scale group {} ({}) failed".
1732 format(group
.name
, index
))
1734 # Going ahead with terminate, even if there is an error in pre-scale-in config
1735 # as this could be result of scale out failure and we need to cleanup this group
1736 yield from self
.terminate_vnfrs(scale_instance
.vnfrs
)
1737 group
.delete_instance(index
)
1739 scale_instance
.operational_status
= "vnf_terminate_phase"
1740 yield from self
.update_state()
1742 yield from terminate_instance()
1745 def _update_scale_group_instances_status(self
):
1747 def post_scale_out_task(group
, instance
):
1748 # Apply post scale out config once all VNFRs are active
1749 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.POST_SCALE_OUT
,
1751 instance
.operational_status
= "running"
1753 self
._log
.debug("Scale out for group {} and instance {} succeeded".
1754 format(group
.name
, instance
.instance_id
))
1756 self
._log
.error("Post scale out config for scale group {} ({}) failed".
1757 format(group
.name
, instance
.instance_id
))
1759 yield from self
.update_state()
1761 group_instances
= {group
: group
.instances
for group
in self
._scaling
_groups
.values()}
1762 for group
, instances
in group_instances
.items():
1763 self
._log
.debug("Updating %s instance status", group
)
1764 for instance
in instances
:
1765 instance_vnf_state_list
= [vnfr
.state
for vnfr
in instance
.vnfrs
]
1766 self
._log
.debug("Got vnfr instance states: %s", instance_vnf_state_list
)
1767 if instance
.operational_status
== "vnf_init_phase":
1768 if all([state
== VnfRecordState
.ACTIVE
for state
in instance_vnf_state_list
]):
1769 instance
.operational_status
= "running"
1771 # Create a task for post scale out to allow us to sleep before attempting
1772 # to configure newly created VM's
1773 self
._loop
.create_task(post_scale_out_task(group
, instance
))
1775 elif any([state
== VnfRecordState
.FAILED
for state
in instance_vnf_state_list
]):
1776 self
._log
.debug("Scale out for group {} and instance {} failed".
1777 format(group
.name
, instance
.instance_id
))
1778 instance
.operational_status
= "failed"
1780 elif instance
.operational_status
== "vnf_terminate_phase":
1781 if all([state
== VnfRecordState
.TERMINATED
for state
in instance_vnf_state_list
]):
1782 instance
.operational_status
= "terminated"
1783 rc
= yield from self
.apply_scaling_group_config(NsdYang
.ScalingTrigger
.POST_SCALE_IN
,
1786 self
._log
.debug("Scale in for group {} and instance {} succeeded".
1787 format(group
.name
, instance
.instance_id
))
1789 self
._log
.error("Post scale in config for scale group {} ({}) failed".
1790 format(group
.name
, instance
.instance_id
))
1792 def create_vnffgs(self
):
1793 """ This function creates VNFFGs for every VNFFG in the NSD
1794 associated with this NSR"""
1796 for vnffgd
in self
.nsd_msg
.vnffgd
:
1797 self
._log
.debug("Found vnffgd %s in nsr id %s", vnffgd
, self
.id)
1798 vnffgr
= VnffgRecord(self
._dts
,
1801 self
._nsm
._vnffgmgr
,
1805 self
._sdn
_account
_name
1807 self
._vnffgrs
[vnffgr
.id] = vnffgr
1809 def resolve_vld_ip_profile(self
, nsd_msg
, vld
):
1810 self
._log
.debug("Receieved ip profile ref is %s",vld
.ip_profile_ref
)
1811 if not vld
.has_field('ip_profile_ref'):
1813 profile
= [profile
for profile
in nsd_msg
.ip_profiles
if profile
.name
== vld
.ip_profile_ref
]
1814 return profile
[0] if profile
else None
1817 def _create_vls(self
, vld
, cloud_account
,om_datacenter
):
1818 """Create a VLR in the cloud account specified using the given VLD
1822 cloud_account : Cloud account name
1827 vlr
= yield from VirtualLinkRecord
.create_record(
1835 self
.resolve_vld_ip_profile(self
.nsd_msg
, vld
),
1837 restart_mode
=self
.restart_mode
)
1841 def _extract_cloud_accounts_for_vl(self
, vld
):
1843 Extracts the list of cloud accounts from the NS Config obj
1846 1. Cloud accounts based connection point (vnf_cloud_account_map)
1848 vld : VLD yang object
1853 cloud_account_list
= []
1855 if self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1856 # Handle case where cloud_account is None
1858 for vnf
in self
._nsr
_cfg
_msg
.vnf_cloud_account_map
:
1859 if vnf
.cloud_account
is not None or vnf
.om_datacenter
is not None:
1860 vnf_cloud_map
[vnf
.member_vnf_index_ref
] = (vnf
.cloud_account
,vnf
.om_datacenter
)
1862 for vnfc
in vld
.vnfd_connection_point_ref
:
1863 cloud_account
= vnf_cloud_map
.get(
1864 vnfc
.member_vnf_index_ref
,
1865 (self
.cloud_account_name
,self
.om_datacenter_name
))
1867 cloud_account_list
.append(cloud_account
)
1869 if self
._nsr
_cfg
_msg
.vl_cloud_account_map
:
1870 for vld_map
in self
._nsr
_cfg
_msg
.vl_cloud_account_map
:
1871 if vld_map
.vld_id_ref
== vld
.id:
1872 for cloud_account
in vld_map
.cloud_accounts
:
1873 cloud_account_list
.extend((cloud_account
,None))
1874 for om_datacenter
in vld_map
.om_datacenters
:
1875 cloud_account_list
.extend((None,om_datacenter
))
1877 # If no config has been provided then fall-back to the default
1879 if not cloud_account_list
:
1880 cloud_account_list
= [(self
.cloud_account_name
,self
.om_datacenter_name
)]
1882 self
._log
.debug("VL {} cloud accounts: {}".
1883 format(vld
.name
, cloud_account_list
))
1884 return set(cloud_account_list
)
1887 def create_vls(self
):
1888 """ This function creates VLs for every VLD in the NSD
1889 associated with this NSR"""
1890 for vld
in self
.nsd_msg
.vld
:
1892 self
._log
.debug("Found vld %s in nsr id %s", vld
, self
.id)
1893 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1894 for cloud_account
,om_datacenter
in cloud_account_list
:
1895 vlr
= yield from self
._create
_vls
(vld
, cloud_account
,om_datacenter
)
1896 self
._vlrs
.append(vlr
)
1900 def create_vl_instance(self
, vld
):
1901 self
._log
.debug("Create VL for {}: {}".format(self
.id, vld
.as_dict()))
1902 # Check if the VL is already present
1904 for vl
in self
._vlrs
:
1905 if vl
.vld_msg
.id == vld
.id:
1906 self
._log
.debug("The VLD %s already in NSR %s as VLR %s with status %s",
1907 vld
.id, self
.id, vl
.id, vl
.state
)
1909 if vlr
.state
!= VlRecordState
.TERMINATED
:
1910 err_msg
= "VLR for VL %s in NSR %s already instantiated", \
1912 self
._log
.error(err_msg
)
1913 raise NsrVlUpdateError(err_msg
)
1917 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1918 for account
,om_datacenter
in cloud_account_list
:
1919 vlr
= yield from self
._create
_vls
(vld
, account
,om_datacenter
)
1920 self
._vlrs
.append(vlr
)
1922 vlr
.state
= VlRecordState
.INSTANTIATION_PENDING
1923 yield from self
.update_state()
1926 yield from self
.nsm_plugin
.instantiate_vl(self
, vlr
)
1927 vlr
.state
= VlRecordState
.ACTIVE
1929 except Exception as e
:
1930 err_msg
= "Error instantiating VL for NSR {} and VLD {}: {}". \
1931 format(self
.id, vld
.id, e
)
1932 self
._log
.error(err_msg
)
1933 self
._log
.exception(e
)
1934 vlr
.state
= VlRecordState
.FAILED
1936 yield from self
.update_state()
1939 def delete_vl_instance(self
, vld
):
1940 for vlr
in self
._vlrs
:
1941 if vlr
.vld_msg
.id == vld
.id:
1942 self
._log
.debug("Found VLR %s for VLD %s in NSR %s",
1943 vlr
.id, vld
.id, self
.id)
1944 vlr
.state
= VlRecordState
.TERMINATE_PENDING
1945 yield from self
.update_state()
1948 yield from self
.nsm_plugin
.terminate_vl(vlr
)
1949 vlr
.state
= VlRecordState
.TERMINATED
1950 self
._vlrs
.remove(vlr
)
1952 except Exception as e
:
1953 err_msg
= "Error terminating VL for NSR {} and VLD {}: {}". \
1954 format(self
.id, vld
.id, e
)
1955 self
._log
.error(err_msg
)
1956 self
._log
.exception(e
)
1957 vlr
.state
= VlRecordState
.FAILED
1959 yield from self
.update_state()
1963 def create_vnfs(self
, config_xact
):
1965 This function creates VNFs for every VNF in the NSD
1966 associated with this NSR
1968 self
._log
.debug("Creating %u VNFs associated with this NS id %s",
1969 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
1971 for const_vnfd
in self
.nsd_msg
.constituent_vnfd
:
1972 if not const_vnfd
.start_by_default
:
1973 self
._log
.debug("start_by_default set to False in constituent VNF (%s). Skipping start.",
1974 const_vnfd
.member_vnf_index
)
1977 vnfd_msg
= self
._get
_vnfd
(const_vnfd
.vnfd_id_ref
, config_xact
)
1978 cloud_account_name
,om_datacenter_name
= self
._get
_vnfd
_cloud
_account
(const_vnfd
.member_vnf_index
)
1979 if cloud_account_name
is None:
1980 cloud_account_name
= self
.cloud_account_name
1981 yield from self
.create_vnf_record(vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
)
1984 def get_placement_groups(self
, vnfd_msg
, const_vnfd
):
1985 placement_groups
= []
1986 for group
in self
.nsd_msg
.placement_groups
:
1987 for member_vnfd
in group
.member_vnfd
:
1988 if (member_vnfd
.vnfd_id_ref
== vnfd_msg
.id) and \
1989 (member_vnfd
.member_vnf_index_ref
== const_vnfd
.member_vnf_index
):
1990 group_info
= self
.resolve_placement_group_cloud_construct(group
)
1991 if group_info
is None:
1992 self
._log
.error("Could not resolve cloud-construct for placement group: %s", group
.name
)
1993 ### raise PlacementGroupError("Could not resolve cloud-construct for placement group: {}".format(group.name))
1995 self
._log
.info("Successfully resolved cloud construct for placement group: %s for VNF: %s (Member Index: %s)",
1998 const_vnfd
.member_vnf_index
)
1999 placement_groups
.append(group_info
)
2000 return placement_groups
2003 def create_vnf_record(self
, vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
, group_name
=None, group_instance_id
=None):
2004 # Fetch the VNFD associated with this VNF
2005 placement_groups
= self
.get_placement_groups(vnfd_msg
, const_vnfd
)
2006 self
._log
.info("Cloud Account for VNF %d is %s",const_vnfd
.member_vnf_index
,cloud_account_name
)
2007 self
._log
.info("Launching VNF: %s (Member Index: %s) in NSD plancement Groups: %s",
2009 const_vnfd
.member_vnf_index
,
2010 [ group
.name
for group
in placement_groups
])
2011 vnfr
= yield from VirtualNetworkFunctionRecord
.create_record(self
._dts
,
2024 restart_mode
=self
.restart_mode
,
2026 if vnfr
.id in self
._vnfrs
:
2027 err
= "VNF with VNFR id %s already in vnf list" % (vnfr
.id,)
2028 raise NetworkServiceRecordError(err
)
2030 self
._vnfrs
[vnfr
.id] = vnfr
2031 self
._nsm
.vnfrs
[vnfr
.id] = vnfr
2033 yield from vnfr
.set_config_status(NsrYang
.ConfigStates
.INIT
)
2035 self
._log
.debug("Added VNFR %s to NSM VNFR list with id %s",
2041 def create_param_pools(self
):
2042 for param_pool
in self
.nsd_msg
.parameter_pool
:
2043 self
._log
.debug("Found parameter pool %s in nsr id %s", param_pool
, self
.id)
2045 start_value
= param_pool
.range.start_value
2046 end_value
= param_pool
.range.end_value
2047 if end_value
< start_value
:
2048 raise NetworkServiceRecordError(
2049 "Parameter pool %s has invalid range (start: {}, end: {})".format(
2050 start_value
, end_value
2054 self
._param
_pools
[param_pool
.name
] = config_value_pool
.ParameterValuePool(
2057 range(start_value
, end_value
)
2061 def fetch_vnfr(self
, vnfr_path
):
2062 """ Fetch VNFR record """
2064 self
._log
.debug("Fetching VNFR with key %s while instantiating %s",
2066 res_iter
= yield from self
._dts
.query_read(vnfr_path
, rwdts
.XactFlag
.MERGE
)
2068 for ent
in res_iter
:
2069 res
= yield from ent
2075 def instantiate_vnfs(self
, vnfrs
):
2077 This function instantiates VNFs for every VNF in this Network Service
2079 self
._log
.debug("Instantiating %u VNFs in NS %s", len(vnfrs
), self
.id)
2081 self
._log
.debug("Instantiating VNF: %s in NS %s", vnf
, self
.id)
2082 yield from self
.nsm_plugin
.instantiate_vnf(self
, vnf
)
2085 def instantiate_vnffgs(self
):
2087 This function instantiates VNFFGs for every VNFFG in this Network Service
2089 self
._log
.debug("Instantiating %u VNFFGs in NS %s",
2090 len(self
.nsd_msg
.vnffgd
), self
.id)
2091 for _
, vnfr
in self
.vnfrs
.items():
2092 while vnfr
.state
in [VnfRecordState
.INSTANTIATION_PENDING
, VnfRecordState
.INIT
]:
2093 self
._log
.debug("Received vnfr state for vnfr %s is %s; retrying",vnfr
.name
,vnfr
.state
)
2094 yield from asyncio
.sleep(2, loop
=self
._loop
)
2095 if vnfr
.state
== VnfRecordState
.ACTIVE
:
2096 self
._log
.debug("Received vnfr state for vnfr %s is %s ",vnfr
.name
,vnfr
.state
)
2099 self
._log
.debug("Received vnfr state for vnfr %s is %s; failing vnffg creation",vnfr
.name
,vnfr
.state
)
2100 self
._vnffgr
_state
= VnffgRecordState
.FAILED
2103 self
._log
.info("Waiting for 90 seconds for VMs to come up")
2104 yield from asyncio
.sleep(90, loop
=self
._loop
)
2105 self
._log
.info("Starting VNFFG orchestration")
2106 for vnffg
in self
._vnffgrs
.values():
2107 self
._log
.debug("Instantiating VNFFG: %s in NS %s", vnffg
, self
.id)
2108 yield from vnffg
.instantiate()
2111 def instantiate_scaling_instances(self
, config_xact
):
2112 """ Instantiate any default scaling instances in this Network Service """
2113 for group
in self
._scaling
_groups
.values():
2114 for i
in range(group
.min_instance_count
):
2115 self
._log
.debug("Instantiating %s default scaling instance %s", group
, i
)
2116 yield from self
.create_scale_group_instance(
2117 group
.name
, i
, config_xact
, is_default
=True
2120 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2121 if group_msg
.scaling_group_name_ref
!= group
.name
:
2124 for instance
in group_msg
.instance
:
2125 self
._log
.debug("Reloading %s scaling instance %s", group_msg
, instance
.id)
2126 yield from self
.create_scale_group_instance(
2127 group
.name
, instance
.id, config_xact
, is_default
=False
2130 def has_scaling_instances(self
):
2131 """ Return boolean indicating if the network service has default scaling groups """
2132 for group
in self
._scaling
_groups
.values():
2133 if group
.min_instance_count
> 0:
2136 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2137 if len(group_msg
.instance
) > 0:
2144 """ This function publishes this NSR """
2145 self
._nsr
_msg
= self
.create_msg()
2147 self
._log
.debug("Publishing the NSR with xpath %s and nsr %s",
2151 if self
._debug
_running
:
2152 self
._log
.debug("Publishing NSR in RUNNING state!")
2155 with self
._dts
.transaction() as xact
:
2156 yield from self
._nsm
.nsr_handler
.update(xact
, self
.nsr_xpath
, self
._nsr
_msg
)
2157 if self
._op
_status
.state
== NetworkServiceRecordState
.RUNNING
:
2158 self
._debug
_running
= True
2161 def unpublish(self
, xact
):
2162 """ Unpublish this NSR object """
2163 self
._log
.debug("Unpublishing Network service id %s", self
.id)
2164 yield from self
._nsm
.nsr_handler
.delete(xact
, self
.nsr_xpath
)
2167 def nsr_xpath(self
):
2168 """ Returns the xpath associated with this NSR """
2170 "D,/nsr:ns-instance-opdata" +
2171 "/nsr:nsr[nsr:ns-instance-config-ref = '{}']"
2175 def xpath_from_nsr(nsr
):
2176 """ Returns the xpath associated with this NSR op data"""
2177 return (NetworkServiceRecord
.XPATH
+
2178 "[nsr:ns-instance-config-ref = '{}']").format(nsr
.id)
2181 def nsd_xpath(self
):
2182 """ Return NSD config xpath."""
2184 "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}']"
2185 ).format(self
.nsd_id
)
2188 def instantiate(self
, config_xact
):
2189 """"Instantiates a NetworkServiceRecord.
2191 This function instantiates a Network service
2192 which involves the following steps,
2194 * Instantiate every VL in NSD by sending create VLR request to DTS.
2195 * Instantiate every VNF in NSD by sending create VNF reuqest to DTS.
2196 * Publish the NSR details to DTS
2199 nsr: The NSR configuration request containing nsr-id and nsd
2200 config_xact: The configuration transaction which initiated the instatiation
2203 NetworkServiceRecordError if the NSR creation fails
2209 self
._log
.debug("Instantiating NS - %s xact - %s", self
, config_xact
)
2211 # Move the state to INIITALIZING
2212 self
.set_state(NetworkServiceRecordState
.INIT
)
2214 event_descr
= "Instantiation Request Received NSR Id:%s" % self
.id
2215 self
.record_event("instantiating", event_descr
)
2218 self
._nsd
= self
._nsr
_cfg
_msg
.nsd
2221 # Update ref count if nsd present in catalog
2222 self
._nsm
.get_nsd_ref(self
.nsd_id
)
2224 except NetworkServiceDescriptorError
:
2225 # This could be an NSD not in the nsd-catalog
2228 # Merge any config and initial config primitive values
2229 self
.config_store
.merge_nsd_config(self
.nsd_msg
)
2230 self
._log
.debug("Merged NSD: {}".format(self
.nsd_msg
.as_dict()))
2232 event_descr
= "Fetched NSD with descriptor id %s" % self
.nsd_id
2233 self
.record_event("nsd-fetched", event_descr
)
2235 if self
._nsd
is None:
2236 msg
= "Failed to fetch NSD with nsd-id [%s] for nsr-id %s"
2237 self
._log
.debug(msg
, self
.nsd_id
, self
.id)
2238 raise NetworkServiceRecordError(self
)
2240 self
._log
.debug("Got nsd result %s", self
._nsd
)
2242 # Substitute any input parameters
2243 self
.substitute_input_parameters(self
._nsd
, self
._nsr
_cfg
_msg
)
2246 yield from self
.create(config_xact
)
2248 # Publish the NSR to DTS
2249 yield from self
.publish()
2252 def do_instantiate():
2254 Instantiate network service
2256 self
._log
.debug("Instantiating VLs nsr id [%s] nsd id [%s]",
2257 self
.id, self
.nsd_id
)
2259 # instantiate the VLs
2260 event_descr
= ("Instantiating %s external VLs for NSR id %s" %
2261 (len(self
.nsd_msg
.vld
), self
.id))
2262 self
.record_event("begin-external-vls-instantiation", event_descr
)
2264 self
.set_state(NetworkServiceRecordState
.VL_INIT_PHASE
)
2266 yield from self
.instantiate_vls()
2268 # Publish the NSR to DTS
2269 yield from self
.publish()
2271 event_descr
= ("Finished instantiating %s external VLs for NSR id %s" %
2272 (len(self
.nsd_msg
.vld
), self
.id))
2273 self
.record_event("end-external-vls-instantiation", event_descr
)
2275 self
.set_state(NetworkServiceRecordState
.VNF_INIT_PHASE
)
2277 self
._log
.debug("Instantiating VNFs ...... nsr[%s], nsd[%s]",
2278 self
.id, self
.nsd_id
)
2280 # instantiate the VNFs
2281 event_descr
= ("Instantiating %s VNFS for NSR id %s" %
2282 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2284 self
.record_event("begin-vnf-instantiation", event_descr
)
2286 yield from self
.instantiate_vnfs(self
._vnfrs
.values())
2288 self
._log
.debug(" Finished instantiating %d VNFs for NSR id %s",
2289 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
2291 event_descr
= ("Finished instantiating %s VNFs for NSR id %s" %
2292 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2293 self
.record_event("end-vnf-instantiation", event_descr
)
2295 if len(self
.vnffgrs
) > 0:
2296 #self.set_state(NetworkServiceRecordState.VNFFG_INIT_PHASE)
2297 event_descr
= ("Instantiating %s VNFFGS for NSR id %s" %
2298 (len(self
.nsd_msg
.vnffgd
), self
.id))
2300 self
.record_event("begin-vnffg-instantiation", event_descr
)
2302 yield from self
.instantiate_vnffgs()
2304 event_descr
= ("Finished instantiating %s VNFFGDs for NSR id %s" %
2305 (len(self
.nsd_msg
.vnffgd
), self
.id))
2306 self
.record_event("end-vnffg-instantiation", event_descr
)
2308 if self
.has_scaling_instances():
2309 event_descr
= ("Instantiating %s Scaling Groups for NSR id %s" %
2310 (len(self
._scaling
_groups
), self
.id))
2312 self
.record_event("begin-scaling-group-instantiation", event_descr
)
2313 yield from self
.instantiate_scaling_instances(config_xact
)
2314 self
.record_event("end-scaling-group-instantiation", event_descr
)
2316 # Give the plugin a chance to deploy the network service now that all
2317 # virtual links and vnfs are instantiated
2318 yield from self
.nsm_plugin
.deploy(self
._nsr
_msg
)
2320 self
._log
.debug("Publishing NSR...... nsr[%s], nsd[%s]",
2321 self
.id, self
.nsd_id
)
2323 # Publish the NSR to DTS
2324 yield from self
.publish()
2326 self
._log
.debug("Published NSR...... nsr[%s], nsd[%s]",
2327 self
.id, self
.nsd_id
)
2329 def on_instantiate_done(fut
):
2330 # If the do_instantiate fails, then publish NSR with failed result
2331 if fut
.exception() is not None:
2332 self
._log
.error("NSR instantiation failed for NSR id %s: %s", self
.id, str(fut
.exception()))
2333 self
._loop
.create_task(self
.instantiation_failed(failed_reason
=str(fut
.exception())))
2335 instantiate_task
= self
._loop
.create_task(do_instantiate())
2336 instantiate_task
.add_done_callback(on_instantiate_done
)
2339 def set_config_status(self
, status
, status_details
=None):
2340 if self
.config_status
!= status
:
2341 self
._log
.debug("Updating NSR {} status for {} to {}".
2342 format(self
.name
, self
.config_status
, status
))
2343 self
._config
_status
= status
2344 self
._config
_status
_details
= status_details
2346 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2347 self
.record_event("config-failed", "NS configuration failed",
2348 evt_details
=self
._config
_status
_details
)
2350 yield from self
.publish()
2353 def is_active(self
):
2354 """ This NS is active """
2355 self
.set_state(NetworkServiceRecordState
.RUNNING
)
2359 # Publish the NSR to DTS
2360 self
._log
.debug("Network service %s is active ", self
.id)
2361 self
._is
_active
= True
2363 event_descr
= "NSR in running state for NSR id %s" % self
.id
2364 self
.record_event("ns-running", event_descr
)
2366 yield from self
.publish()
2369 def instantiation_failed(self
, failed_reason
=None):
2370 """ The NS instantiation failed"""
2371 self
._log
.error("Network service id:%s, name:%s instantiation failed",
2373 self
.set_state(NetworkServiceRecordState
.FAILED
)
2375 event_descr
= "Instantiation of NS %s failed" % self
.id
2376 self
.record_event("ns-failed", event_descr
, evt_details
=failed_reason
)
2378 # Publish the NSR to DTS
2379 yield from self
.publish()
2382 def terminate_vnfrs(self
, vnfrs
):
2383 """ Terminate VNFRS in this network service """
2384 self
._log
.debug("Terminating VNFs in network service %s", self
.id)
2386 yield from self
.nsm_plugin
.terminate_vnf(vnfr
)
2389 def terminate(self
):
2390 """ Terminate a NetworkServiceRecord."""
2391 def terminate_vnffgrs():
2392 """ Terminate VNFFGRS in this network service """
2393 self
._log
.debug("Terminating VNFFGRs in network service %s", self
.id)
2394 for vnffgr
in self
.vnffgrs
.values():
2395 yield from vnffgr
.terminate()
2397 def terminate_vlrs():
2398 """ Terminate VLRs in this netork service """
2399 self
._log
.debug("Terminating VLs in network service %s", self
.id)
2400 for vlr
in self
.vlrs
:
2401 yield from self
.nsm_plugin
.terminate_vl(vlr
)
2402 vlr
.state
= VlRecordState
.TERMINATED
2404 self
._log
.debug("Terminating network service id %s", self
.id)
2406 # Move the state to TERMINATE
2407 self
.set_state(NetworkServiceRecordState
.TERMINATE
)
2408 event_descr
= "Terminate being processed for NS Id:%s" % self
.id
2409 self
.record_event("terminate", event_descr
)
2411 # Move the state to VNF_TERMINATE_PHASE
2412 self
._log
.debug("Terminating VNFFGs in NS ID: %s", self
.id)
2413 self
.set_state(NetworkServiceRecordState
.VNFFG_TERMINATE_PHASE
)
2414 event_descr
= "Terminating VNFFGS in NS Id:%s" % self
.id
2415 self
.record_event("terminating-vnffgss", event_descr
)
2416 yield from terminate_vnffgrs()
2418 # Move the state to VNF_TERMINATE_PHASE
2419 self
.set_state(NetworkServiceRecordState
.VNF_TERMINATE_PHASE
)
2420 event_descr
= "Terminating VNFS in NS Id:%s" % self
.id
2421 self
.record_event("terminating-vnfs", event_descr
)
2422 yield from self
.terminate_vnfrs(self
.vnfrs
.values())
2424 # Move the state to VL_TERMINATE_PHASE
2425 self
.set_state(NetworkServiceRecordState
.VL_TERMINATE_PHASE
)
2426 event_descr
= "Terminating VLs in NS Id:%s" % self
.id
2427 self
.record_event("terminating-vls", event_descr
)
2428 yield from terminate_vlrs()
2430 yield from self
.nsm_plugin
.terminate_ns(self
)
2432 # Move the state to TERMINATED
2433 self
.set_state(NetworkServiceRecordState
.TERMINATED
)
2434 event_descr
= "Terminated NS Id:%s" % self
.id
2435 self
.record_event("terminated", event_descr
)
2438 """"Enable a NetworkServiceRecord."""
2442 """"Disable a NetworkServiceRecord."""
2445 def map_config_status(self
):
2446 self
._log
.debug("Config status for ns {} is {}".
2447 format(self
.name
, self
._config
_status
))
2448 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURING
:
2449 return 'configuring'
2450 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2454 def vl_phase_completed(self
):
2455 """ Are VLs created in this NS?"""
2456 return self
._vl
_phase
_completed
2458 def vnf_phase_completed(self
):
2459 """ Are VLs created in this NS?"""
2460 return self
._vnf
_phase
_completed
2462 def create_msg(self
):
2463 """ The network serice record as a message """
2464 nsr_dict
= {"ns_instance_config_ref": self
.id}
2465 nsr
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr
.from_dict(nsr_dict
)
2466 #nsr.cloud_account = self.cloud_account_name
2467 nsr
.sdn_account
= self
._sdn
_account
_name
2468 nsr
.name_ref
= self
.name
2469 nsr
.nsd_ref
= self
.nsd_id
2470 nsr
.nsd_name_ref
= self
.nsd_msg
.name
2471 nsr
.operational_events
= self
._op
_status
.msg
2472 nsr
.operational_status
= self
._op
_status
.yang_str()
2473 nsr
.config_status
= self
.map_config_status()
2474 nsr
.config_status_details
= self
._config
_status
_details
2475 nsr
.create_time
= self
._create
_time
2477 for cfg_prim
in self
.nsd_msg
.service_primitive
:
2478 cfg_prim
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_ServicePrimitive
.from_dict(
2480 nsr
.service_primitive
.append(cfg_prim
)
2482 for init_cfg
in self
.nsd_msg
.initial_config_primitive
:
2483 prim
= NsrYang
.NsrInitialConfigPrimitive
.from_dict(
2485 nsr
.initial_config_primitive
.append(prim
)
2487 if self
.vl_phase_completed():
2488 for vlr
in self
.vlrs
:
2489 nsr
.vlr
.append(vlr
.create_nsr_vlr_msg(self
.vnfrs
.values()))
2491 if self
.vnf_phase_completed():
2492 for vnfr_id
in self
.vnfrs
:
2493 nsr
.constituent_vnfr_ref
.append(self
.vnfrs
[vnfr_id
].const_vnfr_msg
)
2494 for vnffgr
in self
.vnffgrs
.values():
2495 nsr
.vnffgr
.append(vnffgr
.fetch_vnffgr())
2496 for scaling_group
in self
._scaling
_groups
.values():
2497 nsr
.scaling_group_record
.append(scaling_group
.create_record_msg())
2501 def all_vnfs_active(self
):
2502 """ Are all VNFS in this NS active? """
2503 for _
, vnfr
in self
.vnfrs
.items():
2504 if vnfr
.active
is not True:
2509 def update_state(self
):
2510 """ Re-evaluate this NS's state """
2511 curr_state
= self
._op
_status
.state
2513 if curr_state
== NetworkServiceRecordState
.TERMINATED
:
2514 self
._log
.debug("NS (%s) in terminated state, not updating state", self
.id)
2517 new_state
= NetworkServiceRecordState
.RUNNING
2518 self
._log
.info("Received update_state for nsr: %s, curr-state: %s",
2519 self
.id, curr_state
)
2521 # Check all the VNFRs are present
2522 for _
, vnfr
in self
.vnfrs
.items():
2523 if vnfr
.state
in [VnfRecordState
.ACTIVE
, VnfRecordState
.TERMINATED
]:
2525 elif vnfr
.state
== VnfRecordState
.FAILED
:
2526 if vnfr
._prev
_state
!= vnfr
.state
:
2527 event_descr
= "Instantiation of VNF %s failed" % vnfr
.id
2528 event_error_details
= vnfr
.state_failed_reason
2529 self
.record_event("vnf-failed", event_descr
, evt_details
=event_error_details
)
2530 vnfr
.set_state(VnfRecordState
.FAILED
)
2532 self
._log
.info("VNF state did not change, curr=%s, prev=%s",
2533 vnfr
.state
, vnfr
._prev
_state
)
2534 new_state
= NetworkServiceRecordState
.FAILED
2537 self
._log
.info("VNF %s in NSR %s is still not active; current state is: %s",
2538 vnfr
.id, self
.id, vnfr
.state
)
2539 new_state
= curr_state
2541 # If new state is RUNNING; check all VLs
2542 if new_state
== NetworkServiceRecordState
.RUNNING
:
2543 for vl
in self
.vlrs
:
2545 if vl
.state
in [VlRecordState
.ACTIVE
, VlRecordState
.TERMINATED
]:
2547 elif vl
.state
== VlRecordState
.FAILED
:
2548 if vl
.prev_state
!= vl
.state
:
2549 event_descr
= "Instantiation of VL %s failed" % vl
.id
2550 event_error_details
= vl
.state_failed_reason
2551 self
.record_event("vl-failed", event_descr
, evt_details
=event_error_details
)
2552 vl
.prev_state
= vl
.state
2554 self
._log
.debug("VL %s already in failed state")
2556 if vl
.state
in [VlRecordState
.INSTANTIATION_PENDING
, VlRecordState
.INIT
]:
2557 new_state
= NetworkServiceRecordState
.VL_INSTANTIATE
2560 if vl
.state
in [VlRecordState
.TERMINATE_PENDING
]:
2561 new_state
= NetworkServiceRecordState
.VL_TERMINATE
2564 # If new state is RUNNING; check VNFFGRs are also active
2565 if new_state
== NetworkServiceRecordState
.RUNNING
:
2566 for _
, vnffgr
in self
.vnffgrs
.items():
2567 self
._log
.info("Checking vnffgr state for nsr %s is: %s",
2568 self
.id, vnffgr
.state
)
2569 if vnffgr
.state
== VnffgRecordState
.ACTIVE
:
2571 elif vnffgr
.state
== VnffgRecordState
.FAILED
:
2572 event_descr
= "Instantiation of VNFFGR %s failed" % vnffgr
.id
2573 self
.record_event("vnffg-failed", event_descr
)
2574 new_state
= NetworkServiceRecordState
.FAILED
2577 self
._log
.info("VNFFGR %s in NSR %s is still not active; current state is: %s",
2578 vnffgr
.id, self
.id, vnffgr
.state
)
2579 new_state
= curr_state
2581 # Update all the scaling group instance operational status to
2582 # reflect the state of all VNFR within that instance
2583 yield from self
._update
_scale
_group
_instances
_status
()
2585 for _
, group
in self
._scaling
_groups
.items():
2586 if group
.state
== scale_group
.ScaleGroupState
.SCALING_OUT
:
2587 new_state
= NetworkServiceRecordState
.SCALING_OUT
2589 elif group
.state
== scale_group
.ScaleGroupState
.SCALING_IN
:
2590 new_state
= NetworkServiceRecordState
.SCALING_IN
2593 if new_state
!= curr_state
:
2594 self
._log
.debug("Changing state of Network service %s from %s to %s",
2595 self
.id, curr_state
, new_state
)
2596 if new_state
== NetworkServiceRecordState
.RUNNING
:
2597 yield from self
.is_active()
2598 elif new_state
== NetworkServiceRecordState
.FAILED
:
2599 # If the NS is already active and we entered scaling_in, scaling_out,
2600 # do not mark the NS as failing if scaling operation failed.
2601 if curr_state
in [NetworkServiceRecordState
.SCALING_OUT
,
2602 NetworkServiceRecordState
.SCALING_IN
] and self
._is
_active
:
2603 new_state
= NetworkServiceRecordState
.RUNNING
2604 self
.set_state(new_state
)
2606 yield from self
.instantiation_failed()
2608 self
.set_state(new_state
)
2610 yield from self
.publish()
2613 class InputParameterSubstitution(object):
2615 This class is responsible for substituting input parameters into an NSD.
2618 def __init__(self
, log
):
2619 """Create an instance of InputParameterSubstitution
2622 log - a logger for this object to use
2627 def __call__(self
, nsd
, nsr_config
):
2628 """Substitutes input parameters from the NSR config into the NSD
2630 This call modifies the provided NSD with the input parameters that are
2631 contained in the NSR config.
2634 nsd - a GI NSD object
2635 nsr_config - a GI NSR config object
2638 if nsd
is None or nsr_config
is None:
2641 # Create a lookup of the xpath elements that this descriptor allows
2643 optional_input_parameters
= set()
2644 for input_parameter
in nsd
.input_parameter_xpath
:
2645 optional_input_parameters
.add(input_parameter
.xpath
)
2647 # Apply the input parameters to the descriptor
2648 if nsr_config
.input_parameter
:
2649 for param
in nsr_config
.input_parameter
:
2650 if param
.xpath
not in optional_input_parameters
:
2651 msg
= "tried to set an invalid input parameter ({})"
2652 self
.log
.error(msg
.format(param
.xpath
))
2656 "input-parameter:{} = {}".format(
2663 xpath
.setxattr(nsd
, param
.xpath
, param
.value
)
2665 except Exception as e
:
2666 self
.log
.exception(e
)
2669 class NetworkServiceDescriptor(object):
2671 Network service descriptor class
2674 def __init__(self
, dts
, log
, loop
, nsd
, nsm
):
2686 """ Returns nsd id """
2691 """ Returns name of nsd """
2692 return self
._nsd
.name
2695 def ref_count(self
):
2696 """ Returns reference count"""
2697 return self
._ref
_count
2700 """ Returns whether nsd is in use or not """
2701 return True if self
.ref_count
> 0 else False
2704 """ Take a reference on this object """
2705 self
._ref
_count
+= 1
2708 """ Release reference on this object """
2709 if self
.ref_count
< 1:
2710 msg
= ("Unref on a NSD object - nsd id %s, ref_count = %s" %
2711 (self
.id, self
.ref_count
))
2712 self
._log
.critical(msg
)
2713 raise NetworkServiceDescriptorError(msg
)
2714 self
._ref
_count
-= 1
2718 """ Return the message associated with this NetworkServiceDescriptor"""
2722 def path_for_id(nsd_id
):
2723 """ Return path for the passed nsd_id"""
2724 return "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}'".format(nsd_id
)
2727 """ Return the message associated with this NetworkServiceDescriptor"""
2728 return NetworkServiceDescriptor
.path_for_id(self
.id)
2730 def update(self
, nsd
):
2731 """ Update the NSD descriptor """
2735 class NsdDtsHandler(object):
2736 """ The network service descriptor DTS handler """
2737 XPATH
= "C,/nsd:nsd-catalog/nsd:nsd"
2739 def __init__(self
, dts
, log
, loop
, nsm
):
2749 """ Return registration handle """
2754 """ Register for Nsd create/update/delete/read requests from dts """
2756 def on_apply(dts
, acg
, xact
, action
, scratch
):
2757 """Apply the configuration"""
2758 is_recovery
= xact
.xact
is None and action
== rwdts
.AppconfAction
.INSTALL
2759 self
._log
.debug("Got nsd apply cfg (xact:%s) (action:%s)",
2761 # Create/Update an NSD record
2762 for cfg
in self
._regh
.get_xact_elements(xact
):
2763 # Only interested in those NSD cfgs whose ID was received in prepare callback
2764 if cfg
.id in scratch
.get('nsds', []) or is_recovery
:
2765 self
._nsm
.update_nsd(cfg
)
2767 scratch
.pop('nsds', None)
2769 return RwTypes
.RwStatus
.SUCCESS
2772 def delete_nsd_libs(nsd_id
):
2773 """ Remove any files uploaded with NSD and stored under $RIFT_ARTIFACTS/libs/<id> """
2775 rift_artifacts_dir
= os
.environ
['RIFT_ARTIFACTS']
2776 nsd_dir
= os
.path
.join(rift_artifacts_dir
, 'launchpad/libs', nsd_id
)
2778 if os
.path
.exists (nsd_dir
):
2779 shutil
.rmtree(nsd_dir
, ignore_errors
=True)
2780 except Exception as e
:
2781 self
._log
.error("Exception in cleaning up NSD libs {}: {}".
2783 self
._log
.excpetion(e
)
2786 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2787 """ Prepare callback from DTS for NSD config """
2789 self
._log
.info("Got nsd prepare - config received nsd id %s, msg %s",
2792 fref
= ProtobufC
.FieldReference
.alloc()
2793 fref
.goto_whole_message(msg
.to_pbcm())
2795 if fref
.is_field_deleted():
2796 # Delete an NSD record
2797 self
._log
.debug("Deleting NSD with id %s", msg
.id)
2798 if self
._nsm
.nsd_in_use(msg
.id):
2799 self
._log
.debug("Cannot delete NSD in use - %s", msg
.id)
2800 err
= "Cannot delete an NSD in use - %s" % msg
.id
2801 raise NetworkServiceDescriptorRefCountExists(err
)
2803 yield from delete_nsd_libs(msg
.id)
2804 self
._nsm
.delete_nsd(msg
.id)
2806 # Add this NSD to scratch to create/update in apply callback
2807 nsds
= scratch
.setdefault('nsds', [])
2809 # acg._scratch['nsds'].append(msg.id)
2811 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2814 "Registering for NSD config using xpath: %s",
2815 NsdDtsHandler
.XPATH
,
2818 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2819 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2820 # Need a list in scratch to store NSDs to create/update later
2821 # acg._scratch['nsds'] = list()
2822 self
._regh
= acg
.register(
2823 xpath
=NsdDtsHandler
.XPATH
,
2824 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
2825 on_prepare
=on_prepare
)
2828 class VnfdDtsHandler(object):
2829 """ DTS handler for VNFD config changes """
2830 XPATH
= "C,/vnfd:vnfd-catalog/vnfd:vnfd"
2832 def __init__(self
, dts
, log
, loop
, nsm
):
2841 """ DTS registration handle """
2846 """ Register for VNFD configuration"""
2849 def on_apply(dts
, acg
, xact
, action
, scratch
):
2850 """Apply the configuration"""
2851 self
._log
.debug("Got NSM VNFD apply (xact: %s) (action: %s)(scr: %s)",
2852 xact
, action
, scratch
)
2854 # Create/Update a VNFD record
2855 for cfg
in self
._regh
.get_xact_elements(xact
):
2856 # Only interested in those VNFD cfgs whose ID was received in prepare callback
2857 if cfg
.id in scratch
.get('vnfds', []):
2858 self
._nsm
.update_vnfd(cfg
)
2860 for cfg
in self
._regh
.elements
:
2861 if cfg
.id in scratch
.get('deleted_vnfds', []):
2862 yield from self
._nsm
.delete_vnfd(cfg
.id)
2864 scratch
.pop('vnfds', None)
2865 scratch
.pop('deleted_vnfds', None)
2868 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2869 """ on prepare callback """
2870 self
._log
.debug("Got on prepare for VNFD (path: %s) (action: %s) (msg: %s)",
2871 ks_path
.to_xpath(RwNsmYang
.get_schema()), xact_info
.query_action
, msg
)
2873 fref
= ProtobufC
.FieldReference
.alloc()
2874 fref
.goto_whole_message(msg
.to_pbcm())
2876 # Handle deletes in prepare_callback, but adds/updates in apply_callback
2877 if fref
.is_field_deleted():
2878 self
._log
.debug("Adding msg to deleted field")
2879 deleted_vnfds
= scratch
.setdefault('deleted_vnfds', [])
2880 deleted_vnfds
.append(msg
.id)
2882 # Add this VNFD to scratch to create/update in apply callback
2883 vnfds
= scratch
.setdefault('vnfds', [])
2884 vnfds
.append(msg
.id)
2886 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2889 "Registering for VNFD config using xpath: %s",
2890 VnfdDtsHandler
.XPATH
,
2892 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2893 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2894 # Need a list in scratch to store VNFDs to create/update later
2895 # acg._scratch['vnfds'] = list()
2896 # acg._scratch['deleted_vnfds'] = list()
2897 self
._regh
= acg
.register(
2898 xpath
=VnfdDtsHandler
.XPATH
,
2899 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY
,
2900 on_prepare
=on_prepare
)
2902 class NsrRpcDtsHandler(object):
2903 """ The network service instantiation RPC DTS handler """
2904 EXEC_NSR_CONF_XPATH
= "I,/nsr:start-network-service"
2905 EXEC_NSR_CONF_O_XPATH
= "O,/nsr:start-network-service"
2906 NETCONF_IP_ADDRESS
= "127.0.0.1"
2908 RESTCONF_PORT
= 8888
2909 NETCONF_USER
= "admin"
2910 NETCONF_PW
= "admin"
2911 REST_BASE_V2_URL
= 'https://{}:{}/v2/api/'.format("127.0.0.1",8888)
2913 def __init__(self
, dts
, log
, loop
, nsm
):
2920 self
._ns
_regh
= None
2922 self
._manager
= None
2923 self
._nsr
_config
_url
= NsrRpcDtsHandler
.REST_BASE_V2_URL
+ 'config/ns-instance-config'
2925 self
._model
= RwYang
.Model
.create_libncx()
2926 self
._model
.load_schema_ypbc(RwNsrYang
.get_schema())
2930 """ Return the NS manager instance """
2934 def wrap_netconf_config_xml(xml
):
2935 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
2939 def _connect(self
, timeout_secs
=240):
2941 start_time
= time
.time()
2942 while (time
.time() - start_time
) < timeout_secs
:
2945 self
._log
.debug("Attemping NsmTasklet netconf connection.")
2947 manager
= yield from ncclient
.asyncio_manager
.asyncio_connect(
2949 host
=NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
,
2950 port
=NsrRpcDtsHandler
.NETCONF_PORT
,
2951 username
=NsrRpcDtsHandler
.NETCONF_USER
,
2952 password
=NsrRpcDtsHandler
.NETCONF_PW
,
2954 look_for_keys
=False,
2955 hostkey_verify
=False,
2960 except ncclient
.transport
.errors
.SSHError
as e
:
2961 self
._log
.warning("Netconf connection to launchpad %s failed: %s",
2962 NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
, str(e
))
2964 yield from asyncio
.sleep(5, loop
=self
._loop
)
2966 raise NsrInstantiationFailed("Failed to connect to Launchpad within %s seconds" %
2969 def _apply_ns_instance_config(self
,payload_dict
):
2970 #self._log.debug("At apply NS instance config with payload %s",payload_dict)
2971 req_hdr
= {'accept':'application/vnd.yang.data+json','content-type':'application/vnd.yang.data+json'}
2972 response
=requests
.post(self
._nsr
_config
_url
, headers
=req_hdr
, auth
=('admin', 'admin'),data
=payload_dict
,verify
=False)
2977 """ Register for NS monitoring read from dts """
2979 def on_ns_config_prepare(xact_info
, action
, ks_path
, msg
):
2980 """ prepare callback from dts start-network-service"""
2981 assert action
== rwdts
.QueryAction
.RPC
2983 rpc_op
= NsrYang
.YangOutput_Nsr_StartNetworkService
.from_dict({
2984 "nsr_id":str(uuid
.uuid4())
2987 if not ('name' in rpc_ip
and 'nsd_ref' in rpc_ip
and ('cloud_account' in rpc_ip
or 'om_datacenter' in rpc_ip
)):
2988 self
._log
.error("Mandatory parameters name or nsd_ref or cloud account not found in start-network-service {}".format(rpc_ip
))
2991 self
._log
.debug("start-network-service RPC input: {}".format(rpc_ip
))
2994 # Add used value to the pool
2995 self
._log
.debug("RPC output: {}".format(rpc_op
))
2997 nsd_copy
= self
.nsm
.get_nsd(rpc_ip
.nsd_ref
)
2999 #if not self._manager:
3000 # self._manager = yield from self._connect()
3002 self
._log
.debug("Configuring ns-instance-config with name %s nsd-ref: %s",
3003 rpc_ip
.name
, rpc_ip
.nsd_ref
)
3005 ns_instance_config_dict
= {"id":rpc_op
.nsr_id
, "admin_status":"ENABLED"}
3006 ns_instance_config_copy_dict
= {k
:v
for k
, v
in rpc_ip
.as_dict().items()
3007 if k
in RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr().fields
}
3008 ns_instance_config_dict
.update(ns_instance_config_copy_dict
)
3010 ns_instance_config
= RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.from_dict(ns_instance_config_dict
)
3011 ns_instance_config
.nsd
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_Nsd()
3012 ns_instance_config
.nsd
.from_dict(nsd_copy
.msg
.as_dict())
3014 payload_dict
= ns_instance_config
.to_json(self
._model
)
3015 #xml = ns_instance_config.to_xml_v2(self._model)
3016 #netconf_xml = self.wrap_netconf_config_xml(xml)
3018 #self._log.debug("Sending configure ns-instance-config xml to %s: %s",
3019 # netconf_xml, NsrRpcDtsHandler.NETCONF_IP_ADDRESS)
3020 self
._log
.debug("Sending configure ns-instance-config json to %s: %s",
3021 self
._nsr
_config
_url
,ns_instance_config
)
3023 #response = yield from self._manager.edit_config(
3025 # config=netconf_xml,
3027 response
= yield from self
._loop
.run_in_executor(
3029 self
._apply
_ns
_instance
_config
,
3032 response
.raise_for_status()
3033 self
._log
.debug("Received edit config response: %s", response
.json())
3035 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
,
3036 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
,
3038 except Exception as e
:
3039 self
._log
.error("Exception processing the "
3040 "start-network-service: {}".format(e
))
3041 self
._log
.exception(e
)
3042 xact_info
.respond_xpath(rwdts
.XactRspCode
.NACK
,
3043 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
)
3046 hdl_ns
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_ns_config_prepare
,)
3048 with self
._dts
.group_create() as group
:
3049 self
._ns
_regh
= group
.register(xpath
=NsrRpcDtsHandler
.EXEC_NSR_CONF_XPATH
,
3051 flags
=rwdts
.Flag
.PUBLISHER
,
3055 class NsrDtsHandler(object):
3056 """ The network service DTS handler """
3057 NSR_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr"
3058 SCALE_INSTANCE_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group/nsr:instance"
3059 KEY_PAIR_XPATH
= "C,/nsr:key-pair"
3061 def __init__(self
, dts
, log
, loop
, nsm
):
3067 self
._nsr
_regh
= None
3068 self
._scale
_regh
= None
3069 self
._key
_pair
_regh
= None
3073 """ Return the NS manager instance """
3078 """ Register for Nsr create/update/delete/read requests from dts """
3080 def nsr_id_from_keyspec(ks
):
3081 nsr_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.schema().keyspec_to_entry(ks
)
3082 nsr_id
= nsr_path_entry
.key00
.id
3085 def group_name_from_keyspec(ks
):
3086 group_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
.schema().keyspec_to_entry(ks
)
3087 group_name
= group_path_entry
.key00
.scaling_group_name_ref
3090 def is_instance_in_reg_elements(nsr_id
, group_name
, instance_id
):
3091 """ Return boolean indicating if scaling group instance was already commited previously.
3093 By looking at the existing elements in this registration handle (elements not part
3094 of this current xact), we can tell if the instance was configured previously without
3095 keeping any application state.
3097 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3098 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3099 elem_group_name
= group_name_from_keyspec(keyspec
)
3101 if elem_nsr_id
!= nsr_id
or group_name
!= elem_group_name
:
3104 if instance_cfg
.id == instance_id
:
3109 def get_scale_group_instance_delta(nsr_id
, group_name
, xact
):
3110 delta
= {"added": [], "deleted": []}
3111 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3112 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3113 if elem_nsr_id
!= nsr_id
:
3116 elem_group_name
= group_name_from_keyspec(keyspec
)
3117 if elem_group_name
!= group_name
:
3120 delta
["added"].append(instance_cfg
.id)
3122 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(include_keyspec
=True):
3123 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3124 if elem_nsr_id
!= nsr_id
:
3127 elem_group_name
= group_name_from_keyspec(keyspec
)
3128 if elem_group_name
!= group_name
:
3131 if instance_cfg
.id in delta
["added"]:
3132 delta
["added"].remove(instance_cfg
.id)
3134 delta
["deleted"].append(instance_cfg
.id)
3139 def update_nsr_nsd(nsr_id
, xact
, scratch
):
3142 def get_nsr_vl_delta(nsr_id
, xact
, scratch
):
3143 delta
= {"added": [], "deleted": []}
3144 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3145 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3146 if elem_nsr_id
!= nsr_id
:
3149 if 'vld' in instance_cfg
.nsd
:
3150 for vld
in instance_cfg
.nsd
.vld
:
3151 delta
["added"].append(vld
)
3153 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3154 self
._log
.debug("NSR update: %s", instance_cfg
)
3155 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3156 if elem_nsr_id
!= nsr_id
:
3159 if 'vld' in instance_cfg
.nsd
:
3160 for vld
in instance_cfg
.nsd
.vld
:
3161 if vld
in delta
["added"]:
3162 delta
["added"].remove(vld
)
3164 delta
["deleted"].append(vld
)
3168 vl_delta
= yield from get_nsr_vl_delta(nsr_id
, xact
, scratch
)
3169 self
._log
.debug("Got NSR:%s VL instance delta: %s", nsr_id
, vl_delta
)
3171 for vld
in vl_delta
["added"]:
3172 yield from self
._nsm
.nsr_instantiate_vl(nsr_id
, vld
)
3174 for vld
in vl_delta
["deleted"]:
3175 yield from self
._nsm
.nsr_terminate_vl(nsr_id
, vld
)
3177 def get_add_delete_update_cfgs(dts_member_reg
, xact
, key_name
, scratch
):
3178 # Unfortunately, it is currently difficult to figure out what has exactly
3179 # changed in this xact without Pbdelta support (RIFT-4916)
3180 # As a workaround, we can fetch the pre and post xact elements and
3181 # perform a comparison to figure out adds/deletes/updates
3182 xact_cfgs
= list(dts_member_reg
.get_xact_elements(xact
))
3183 curr_cfgs
= list(dts_member_reg
.elements
)
3185 xact_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in xact_cfgs
}
3186 curr_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in curr_cfgs
}
3189 added_keys
= set(xact_key_map
) - set(curr_key_map
)
3190 added_cfgs
= [xact_key_map
[key
] for key
in added_keys
]
3193 deleted_keys
= set(curr_key_map
) - set(xact_key_map
)
3194 deleted_cfgs
= [curr_key_map
[key
] for key
in deleted_keys
]
3197 updated_keys
= set(curr_key_map
) & set(xact_key_map
)
3198 updated_cfgs
= [xact_key_map
[key
] for key
in updated_keys
3199 if xact_key_map
[key
] != curr_key_map
[key
]]
3201 return added_cfgs
, deleted_cfgs
, updated_cfgs
3203 def get_nsr_key_pairs(dts_member_reg
, xact
):
3205 for instance_cfg
, keyspec
in dts_member_reg
.get_xact_elements(xact
, include_keyspec
=True):
3206 self
._log
.debug("Key pair received is {} KS: {}".format(instance_cfg
, keyspec
))
3207 xpath
= keyspec
.to_xpath(RwNsrYang
.get_schema())
3208 key_pairs
[instance_cfg
.name
] = instance_cfg
3211 def on_apply(dts
, acg
, xact
, action
, scratch
):
3212 """Apply the configuration"""
3213 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3214 xact
, action
, scratch
)
3216 def handle_create_nsr(msg
, key_pairs
=None, restart_mode
=False):
3217 # Handle create nsr requests """
3218 # Do some validations
3219 if not msg
.has_field("nsd"):
3220 err
= "NSD not provided"
3221 self
._log
.error(err
)
3222 raise NetworkServiceRecordError(err
)
3224 self
._log
.debug("Creating NetworkServiceRecord %s from nsr config %s",
3225 msg
.id, msg
.as_dict())
3226 nsr
= self
.nsm
.create_nsr(msg
, key_pairs
=key_pairs
, restart_mode
=restart_mode
)
3229 def handle_delete_nsr(msg
):
3231 def delete_instantiation(ns_id
):
3232 """ Delete instantiation """
3233 with self
._dts
.transaction() as xact
:
3234 yield from self
._nsm
.terminate_ns(ns_id
, xact
)
3236 # Handle delete NSR requests
3237 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3238 # Terminate the NSR instance
3239 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3241 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3242 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3243 nsr
.record_event("terminate-rcvd", event_descr
)
3245 self
._loop
.create_task(delete_instantiation(msg
.id))
3248 def begin_instantiation(nsr
):
3249 # Begin instantiation
3250 self
._log
.info("Beginning NS instantiation: %s", nsr
.id)
3251 yield from self
._nsm
.instantiate_ns(nsr
.id, xact
)
3253 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3254 xact
, action
, scratch
)
3256 if action
== rwdts
.AppconfAction
.INSTALL
and xact
.id is None:
3258 for element
in self
._key
_pair
_regh
.elements
:
3259 key_pairs
.append(element
)
3260 for element
in self
._nsr
_regh
.elements
:
3261 nsr
= handle_create_nsr(element
, key_pairs
, restart_mode
=True)
3262 self
._loop
.create_task(begin_instantiation(nsr
))
3265 (added_msgs
, deleted_msgs
, updated_msgs
) = get_add_delete_update_cfgs(self
._nsr
_regh
,
3269 self
._log
.debug("Added: %s, Deleted: %s, Updated: %s", added_msgs
,
3270 deleted_msgs
, updated_msgs
)
3272 for msg
in added_msgs
:
3273 if msg
.id not in self
._nsm
.nsrs
:
3274 self
._log
.info("Create NSR received in on_apply to instantiate NS:%s", msg
.id)
3275 key_pairs
= get_nsr_key_pairs(self
._key
_pair
_regh
, xact
)
3276 nsr
= handle_create_nsr(msg
,key_pairs
)
3277 self
._loop
.create_task(begin_instantiation(nsr
))
3279 for msg
in deleted_msgs
:
3280 self
._log
.info("Delete NSR received in on_apply to terminate NS:%s", msg
.id)
3282 handle_delete_nsr(msg
)
3284 self
._log
.exception("Failed to terminate NS:%s", msg
.id)
3286 for msg
in updated_msgs
:
3287 self
._log
.info("Update NSR received in on_apply: %s", msg
)
3289 self
._nsm
.nsr_update_cfg(msg
.id, msg
)
3292 self
._loop
.create_task(update_nsr_nsd(msg
.id, xact
, scratch
))
3294 for group
in msg
.scaling_group
:
3295 instance_delta
= get_scale_group_instance_delta(msg
.id, group
.scaling_group_name_ref
, xact
)
3296 self
._log
.debug("Got NSR:%s scale group instance delta: %s", msg
.id, instance_delta
)
3298 for instance_id
in instance_delta
["added"]:
3299 self
._nsm
.scale_nsr_out(msg
.id, group
.scaling_group_name_ref
, instance_id
, xact
)
3301 for instance_id
in instance_delta
["deleted"]:
3302 self
._nsm
.scale_nsr_in(msg
.id, group
.scaling_group_name_ref
, instance_id
)
3305 return RwTypes
.RwStatus
.SUCCESS
3308 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
3309 """ Prepare calllback from DTS for NSR """
3311 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3312 action
= xact_info
.query_action
3314 "Got Nsr prepare callback (xact: %s) (action: %s) (info: %s), %s:%s)",
3315 xact
, action
, xact_info
, xpath
, msg
3319 def delete_instantiation(ns_id
):
3320 """ Delete instantiation """
3321 yield from self
._nsm
.terminate_ns(ns_id
, None)
3323 def handle_delete_nsr():
3324 """ Handle delete NSR requests """
3325 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3326 # Terminate the NSR instance
3327 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3329 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3330 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3331 nsr
.record_event("terminate-rcvd", event_descr
)
3333 self
._loop
.create_task(delete_instantiation(msg
.id))
3335 fref
= ProtobufC
.FieldReference
.alloc()
3336 fref
.goto_whole_message(msg
.to_pbcm())
3338 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
, rwdts
.QueryAction
.DELETE
]:
3339 # if this is an NSR create
3340 if action
!= rwdts
.QueryAction
.DELETE
and msg
.id not in self
._nsm
.nsrs
:
3341 # Ensure the Cloud account/datacenter has been specified
3342 if not msg
.has_field("cloud_account") and not msg
.has_field("om_datacenter"):
3343 raise NsrInstantiationFailed("Cloud account or datacenter not specified in NSR")
3345 # Check if nsd is specified
3346 if not msg
.has_field("nsd"):
3347 raise NsrInstantiationFailed("NSD not specified in NSR")
3350 nsr
= self
._nsm
.nsrs
[msg
.id]
3352 if msg
.has_field("nsd"):
3353 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3354 raise NsrVlUpdateError("Unable to update VL when NSR not in running state")
3355 if 'vld' not in msg
.nsd
or len(msg
.nsd
.vld
) == 0:
3356 raise NsrVlUpdateError("NS config NSD should have atleast 1 VLD defined")
3358 if msg
.has_field("scaling_group"):
3359 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3360 raise ScalingOperationError("Unable to perform scaling action when NS is not in running state")
3362 if len(msg
.scaling_group
) > 1:
3363 raise ScalingOperationError("Only a single scaling group can be configured at a time")
3365 for group_msg
in msg
.scaling_group
:
3366 num_new_group_instances
= len(group_msg
.instance
)
3367 if num_new_group_instances
> 1:
3368 raise ScalingOperationError("Only a single scaling instance can be modified at a time")
3370 elif num_new_group_instances
== 1:
3371 scale_group
= nsr
.scaling_groups
[group_msg
.scaling_group_name_ref
]
3372 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
]:
3373 if len(scale_group
.instances
) == scale_group
.max_instance_count
:
3374 raise ScalingOperationError("Max instances for %s reached" % scale_group
)
3376 acg
.handle
.prepare_complete_ok(xact_info
.handle
)
3379 self
._log
.debug("Registering for NSR config using xpath: %s",
3380 NsrDtsHandler
.NSR_XPATH
)
3382 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
3383 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
3384 self
._nsr
_regh
= acg
.register(xpath
=NsrDtsHandler
.NSR_XPATH
,
3385 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
3386 on_prepare
=on_prepare
)
3388 self
._scale
_regh
= acg
.register(
3389 xpath
=NsrDtsHandler
.SCALE_INSTANCE_XPATH
,
3390 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY| rwdts
.Flag
.CACHE
,
3393 self
._key
_pair
_regh
= acg
.register(
3394 xpath
=NsrDtsHandler
.KEY_PAIR_XPATH
,
3395 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
3399 class NsrOpDataDtsHandler(object):
3400 """ The network service op data DTS handler """
3401 XPATH
= "D,/nsr:ns-instance-opdata/nsr:nsr"
3403 def __init__(self
, dts
, log
, loop
, nsm
):
3412 """ Return the registration handle"""
3417 """ Return the NS manager instance """
3422 """ Register for Nsr op data publisher registration"""
3423 self
._log
.debug("Registering Nsr op data path %s as publisher",
3424 NsrOpDataDtsHandler
.XPATH
)
3426 hdl
= rift
.tasklets
.DTS
.RegistrationHandler()
3427 handlers
= rift
.tasklets
.Group
.Handler()
3428 with self
._dts
.group_create(handler
=handlers
) as group
:
3429 self
._regh
= group
.register(xpath
=NsrOpDataDtsHandler
.XPATH
,
3431 flags
=rwdts
.Flag
.PUBLISHER | rwdts
.Flag
.NO_PREP_READ | rwdts
.Flag
.DATASTORE
)
3434 def create(self
, path
, msg
):
3436 Create an NS record in DTS with the path and message
3438 self
._log
.debug("Creating NSR %s:%s", path
, msg
)
3439 self
.regh
.create_element(path
, msg
)
3440 self
._log
.debug("Created NSR, %s:%s", path
, msg
)
3443 def update(self
, path
, msg
, flags
=rwdts
.XactFlag
.REPLACE
):
3445 Update an NS record in DTS with the path and message
3447 self
._log
.debug("Updating NSR, %s:%s regh = %s", path
, msg
, self
.regh
)
3448 self
.regh
.update_element(path
, msg
, flags
)
3449 self
._log
.debug("Updated NSR, %s:%s", path
, msg
)
3452 def delete(self
, path
):
3454 Update an NS record in DTS with the path and message
3456 self
._log
.debug("Deleting NSR path:%s", path
)
3457 self
.regh
.delete_element(path
)
3458 self
._log
.debug("Deleted NSR path:%s", path
)
3461 class VnfrDtsHandler(object):
3462 """ The virtual network service DTS handler """
3463 XPATH
= "D,/vnfr:vnfr-catalog/vnfr:vnfr"
3465 def __init__(self
, dts
, log
, loop
, nsm
):
3475 """ Return registration handle """
3480 """ Return the NS manager instance """
3485 """ Register for vnfr create/update/delete/ advises from dts """
3487 def on_commit(xact_info
):
3488 """ The transaction has been committed """
3489 self
._log
.debug("Got vnfr commit (xact_info: %s)", xact_info
)
3490 return rwdts
.MemberRspCode
.ACTION_OK
3493 def on_prepare(xact_info
, action
, ks_path
, msg
):
3494 """ prepare callback from dts """
3495 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3497 "Got vnfr on_prepare cb (xact_info: %s, action: %s): %s:%s",
3498 xact_info
, action
, ks_path
, msg
3501 schema
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr
.schema()
3502 path_entry
= schema
.keyspec_to_entry(ks_path
)
3503 if path_entry
.key00
.id not in self
._nsm
._vnfrs
:
3504 self
._log
.error("%s request for non existent record path %s",
3506 xact_info
.respond_xpath(rwdts
.XactRspCode
.NA
, xpath
)
3510 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3511 if action
== rwdts
.QueryAction
.CREATE
or action
== rwdts
.QueryAction
.UPDATE
:
3512 yield from self
._nsm
.update_vnfr(msg
)
3513 elif action
== rwdts
.QueryAction
.DELETE
:
3514 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3515 self
._nsm
.delete_vnfr(path_entry
.key00
.id)
3517 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
, xpath
)
3519 self
._log
.debug("Registering for VNFR using xpath: %s",
3520 VnfrDtsHandler
.XPATH
,)
3522 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_commit
=on_commit
,
3523 on_prepare
=on_prepare
,)
3524 with self
._dts
.group_create() as group
:
3525 self
._regh
= group
.register(xpath
=VnfrDtsHandler
.XPATH
,
3527 flags
=(rwdts
.Flag
.SUBSCRIBER
),)
3530 class NsdRefCountDtsHandler(object):
3531 """ The NSD Ref Count DTS handler """
3532 XPATH
= "D,/nsr:ns-instance-opdata/rw-nsr:nsd-ref-count"
3534 def __init__(self
, dts
, log
, loop
, nsm
):
3544 """ Return registration handle """
3549 """ Return the NS manager instance """
3554 """ Register for NSD ref count read from dts """
3557 def on_prepare(xact_info
, action
, ks_path
, msg
):
3558 """ prepare callback from dts """
3559 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3561 if action
== rwdts
.QueryAction
.READ
:
3562 schema
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount
.schema()
3563 path_entry
= schema
.keyspec_to_entry(ks_path
)
3564 nsd_list
= yield from self
._nsm
.get_nsd_refcount(path_entry
.key00
.nsd_id_ref
)
3565 for xpath
, msg
in nsd_list
:
3566 xact_info
.respond_xpath(rsp_code
=rwdts
.XactRspCode
.MORE
,
3569 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
3571 raise NetworkServiceRecordError("Not supported operation %s" % action
)
3573 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_prepare
,)
3574 with self
._dts
.group_create() as group
:
3575 self
._regh
= group
.register(xpath
=NsdRefCountDtsHandler
.XPATH
,
3577 flags
=rwdts
.Flag
.PUBLISHER
,)
3580 class NsManager(object):
3581 """ The Network Service Manager class"""
3582 def __init__(self
, dts
, log
, loop
,
3583 nsr_handler
, vnfr_handler
, vlr_handler
, ro_plugin_selector
,
3584 vnffgmgr
, vnfd_pub_handler
, cloud_account_handler
):
3588 self
._nsr
_handler
= nsr_handler
3589 self
._vnfr
_pub
_handler
= vnfr_handler
3590 self
._vlr
_pub
_handler
= vlr_handler
3591 self
._vnffgmgr
= vnffgmgr
3592 self
._vnfd
_pub
_handler
= vnfd_pub_handler
3593 self
._cloud
_account
_handler
= cloud_account_handler
3595 self
._ro
_plugin
_selector
= ro_plugin_selector
3596 self
._ncclient
= rift
.mano
.ncclient
.NcClient(
3608 self
.cfgmgr_obj
= conman
.ROConfigManager(log
, loop
, dts
, self
)
3610 # TODO: All these handlers should move to tasklet level.
3611 # Passing self is often an indication of bad design
3612 self
._nsd
_dts
_handler
= NsdDtsHandler(dts
, log
, loop
, self
)
3613 self
._vnfd
_dts
_handler
= VnfdDtsHandler(dts
, log
, loop
, self
)
3614 self
._dts
_handlers
= [self
._nsd
_dts
_handler
,
3615 VnfrDtsHandler(dts
, log
, loop
, self
),
3616 NsdRefCountDtsHandler(dts
, log
, loop
, self
),
3617 NsrDtsHandler(dts
, log
, loop
, self
),
3618 ScalingRpcHandler(log
, dts
, loop
, self
.scale_rpc_callback
),
3619 NsrRpcDtsHandler(dts
,log
,loop
,self
),
3620 self
._vnfd
_dts
_handler
,
3641 def nsr_handler(self
):
3642 """" NSR handler """
3643 return self
._nsr
_handler
3647 """" So Obj handler """
3652 """ NSRs in this NSM"""
3657 """ NSDs in this NSM"""
3662 """ VNFDs in this NSM"""
3667 """ VNFRs in this NSM"""
3671 def nsr_pub_handler(self
):
3672 """ NSR publication handler """
3673 return self
._nsr
_handler
3676 def vnfr_pub_handler(self
):
3677 """ VNFR publication handler """
3678 return self
._vnfr
_pub
_handler
3681 def vlr_pub_handler(self
):
3682 """ VLR publication handler """
3683 return self
._vlr
_pub
_handler
3686 def vnfd_pub_handler(self
):
3687 return self
._vnfd
_pub
_handler
3691 """ Register all static DTS handlers """
3692 for dts_handle
in self
._dts
_handlers
:
3693 yield from dts_handle
.register()
3696 def get_ns_by_nsr_id(self
, nsr_id
):
3697 """ get NSR by nsr id """
3698 if nsr_id
not in self
._nsrs
:
3699 raise NetworkServiceRecordError("NSR id %s not found" % nsr_id
)
3701 return self
._nsrs
[nsr_id
]
3703 def scale_nsr_out(self
, nsr_id
, scale_group_name
, instance_id
, config_xact
):
3704 self
.log
.debug("Scale out NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3709 nsr
= self
._nsrs
[nsr_id
]
3710 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3711 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3713 self
._loop
.create_task(nsr
.create_scale_group_instance(scale_group_name
, instance_id
, config_xact
))
3715 def scale_nsr_in(self
, nsr_id
, scale_group_name
, instance_id
):
3716 self
.log
.debug("Scale in NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3721 nsr
= self
._nsrs
[nsr_id
]
3722 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3723 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3725 self
._loop
.create_task(nsr
.delete_scale_group_instance(scale_group_name
, instance_id
))
3727 def scale_rpc_callback(self
, xact
, msg
, action
):
3728 """Callback handler for RPC calls
3730 xact : Transaction Handler
3732 action : Scaling Action
3734 ScalingGroupInstance
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup_Instance
3735 ScalingGroup
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
3737 xpath
= ('C,/nsr:ns-instance-config/nsr:nsr[nsr:id="{}"]').format(
3739 instance
= ScalingGroupInstance
.from_dict({"id": msg
.instance_id
})
3742 def get_nsr_scaling_group():
3743 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3745 for result
in results
:
3746 res
= yield from result
3747 nsr_config
= res
.result
3749 for scaling_group
in nsr_config
.scaling_group
:
3750 if scaling_group
.scaling_group_name_ref
== msg
.scaling_group_name_ref
:
3753 scaling_group
= nsr_config
.scaling_group
.add()
3754 scaling_group
.scaling_group_name_ref
= msg
.scaling_group_name_ref
3756 return (nsr_config
, scaling_group
)
3759 def update_config(nsr_config
):
3760 xml
= self
._ncclient
.convert_to_xml(RwNsrYang
, nsr_config
)
3761 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
3762 yield from self
._ncclient
.connect()
3763 yield from self
._ncclient
.manager
.edit_config(target
="running", config
=xml
, default_operation
="replace")
3767 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3768 scaling_group
.instance
.append(instance
)
3769 yield from update_config(nsr_config
)
3773 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3774 scaling_group
.instance
.remove(instance
)
3775 yield from update_config(nsr_config
)
3777 if action
== ScalingRpcHandler
.ACTION
.SCALE_OUT
:
3778 self
._loop
.create_task(scale_out())
3780 self
._loop
.create_task(scale_in())
3782 # Opdata based calls, disabled for now!
3783 # if action == ScalingRpcHandler.ACTION.SCALE_OUT:
3784 # self.scale_nsr_out(
3786 # msg.scaling_group_name_ref,
3790 # self.scale_nsr_in(
3792 # msg.scaling_group_name_ref,
3795 def nsr_update_cfg(self
, nsr_id
, msg
):
3796 nsr
= self
._nsrs
[nsr_id
]
3797 nsr
.nsr_cfg_msg
= msg
3799 def nsr_instantiate_vl(self
, nsr_id
, vld
):
3800 self
.log
.debug("NSR {} create VL {}".format(nsr_id
, vld
))
3801 nsr
= self
._nsrs
[nsr_id
]
3802 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3803 raise NsrVlUpdateError("Cannot perform VL instantiate if NSR is not in running state")
3805 # Not calling in a separate task as this is called from a separate task
3806 yield from nsr
.create_vl_instance(vld
)
3808 def nsr_terminate_vl(self
, nsr_id
, vld
):
3809 self
.log
.debug("NSR {} delete VL {}".format(nsr_id
, vld
.id))
3810 nsr
= self
._nsrs
[nsr_id
]
3811 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3812 raise NsrVlUpdateError("Cannot perform VL terminate if NSR is not in running state")
3814 # Not calling in a separate task as this is called from a separate task
3815 yield from nsr
.delete_vl_instance(vld
)
3817 def create_nsr(self
, nsr_msg
, key_pairs
=None,restart_mode
=False):
3818 """ Create an NSR instance """
3819 if nsr_msg
.id in self
._nsrs
:
3820 msg
= "NSR id %s already exists" % nsr_msg
.id
3821 self
._log
.error(msg
)
3822 raise NetworkServiceRecordError(msg
)
3824 self
._log
.info("Create NetworkServiceRecord nsr id %s from nsd_id %s",
3828 nsm_plugin
= self
._ro
_plugin
_selector
.ro_plugin
3829 sdn_account_name
= self
._cloud
_account
_handler
.get_cloud_account_sdn_name(nsr_msg
.cloud_account
)
3831 nsr
= NetworkServiceRecord(self
._dts
,
3839 restart_mode
=restart_mode
3841 self
._nsrs
[nsr_msg
.id] = nsr
3842 nsm_plugin
.create_nsr(nsr_msg
, nsr_msg
.nsd
, key_pairs
)
3846 def delete_nsr(self
, nsr_id
):
3848 Delete NSR with the passed nsr id
3850 del self
._nsrs
[nsr_id
]
3853 def instantiate_ns(self
, nsr_id
, config_xact
):
3854 """ Instantiate an NS instance """
3855 self
._log
.debug("Instantiating Network service id %s", nsr_id
)
3856 if nsr_id
not in self
._nsrs
:
3857 err
= "NSR id %s not found " % nsr_id
3858 self
._log
.error(err
)
3859 raise NetworkServiceRecordError(err
)
3861 nsr
= self
._nsrs
[nsr_id
]
3862 yield from nsr
.nsm_plugin
.instantiate_ns(nsr
, config_xact
)
3865 def update_vnfr(self
, vnfr
):
3866 """Create/Update an VNFR """
3868 vnfr_state
= self
._vnfrs
[vnfr
.id].state
3869 self
._log
.debug("Updating VNFR with state %s: vnfr %s", vnfr_state
, vnfr
)
3871 yield from self
._vnfrs
[vnfr
.id].update_state(vnfr
)
3872 nsr
= self
.find_nsr_for_vnfr(vnfr
.id)
3873 yield from nsr
.update_state()
3875 def find_nsr_for_vnfr(self
, vnfr_id
):
3876 """ Find the NSR which )has the passed vnfr id"""
3877 for nsr
in list(self
.nsrs
.values()):
3878 for vnfr
in list(nsr
.vnfrs
.values()):
3879 if vnfr
.id == vnfr_id
:
3883 def delete_vnfr(self
, vnfr_id
):
3884 """ Delete VNFR with the passed id"""
3885 del self
._vnfrs
[vnfr_id
]
3887 def get_nsd_ref(self
, nsd_id
):
3888 """ Get network service descriptor for the passed nsd_id
3890 nsd
= self
.get_nsd(nsd_id
)
3895 def get_nsr_config(self
, nsd_id
):
3896 xpath
= "C,/nsr:ns-instance-config"
3897 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3899 for result
in results
:
3900 entry
= yield from result
3901 ns_instance_config
= entry
.result
3903 for nsr
in ns_instance_config
.nsr
:
3904 if nsr
.nsd
.id == nsd_id
:
3910 def nsd_unref_by_nsr_id(self
, nsr_id
):
3911 """ Unref the network service descriptor based on NSR id """
3912 self
._log
.debug("NSR Unref called for Nsr Id:%s", nsr_id
)
3913 if nsr_id
in self
._nsrs
:
3914 nsr
= self
._nsrs
[nsr_id
]
3917 nsd
= self
.get_nsd(nsr
.nsd_id
)
3918 self
._log
.debug("Releasing ref on NSD %s held by NSR %s - Curr %d",
3919 nsd
.id, nsr
.id, nsd
.ref_count
)
3921 except NetworkServiceDescriptorError
:
3922 # We store a copy of NSD in NSR and the NSD in nsd-catalog
3927 self
._log
.error("Cannot find NSR with id %s", nsr_id
)
3928 raise NetworkServiceDescriptorUnrefError("No NSR with id" % nsr_id
)
3931 def nsd_unref(self
, nsd_id
):
3932 """ Unref the network service descriptor associated with the id """
3933 nsd
= self
.get_nsd(nsd_id
)
3936 def get_nsd(self
, nsd_id
):
3937 """ Get network service descriptor for the passed nsd_id"""
3938 if nsd_id
not in self
._nsds
:
3939 self
._log
.error("Cannot find NSD id:%s", nsd_id
)
3940 raise NetworkServiceDescriptorError("Cannot find NSD id:%s", nsd_id
)
3942 return self
._nsds
[nsd_id
]
3944 def create_nsd(self
, nsd_msg
):
3945 """ Create a network service descriptor """
3946 self
._log
.debug("Create network service descriptor - %s", nsd_msg
)
3947 if nsd_msg
.id in self
._nsds
:
3948 self
._log
.error("Cannot create NSD %s -NSD ID already exists", nsd_msg
)
3949 raise NetworkServiceDescriptorError("NSD already exists-%s", nsd_msg
.id)
3951 nsd
= NetworkServiceDescriptor(
3958 self
._nsds
[nsd_msg
.id] = nsd
3962 def update_nsd(self
, nsd
):
3963 """ update the Network service descriptor """
3964 self
._log
.debug("Update network service descriptor - %s", nsd
)
3965 if nsd
.id not in self
._nsds
:
3966 self
._log
.debug("No NSD found - creating NSD id = %s", nsd
.id)
3967 self
.create_nsd(nsd
)
3969 self
._log
.debug("Updating NSD id = %s, nsd = %s", nsd
.id, nsd
)
3970 self
._nsds
[nsd
.id].update(nsd
)
3972 def delete_nsd(self
, nsd_id
):
3973 """ Delete the Network service descriptor with the passed id """
3974 self
._log
.debug("Deleting the network service descriptor - %s", nsd_id
)
3975 if nsd_id
not in self
._nsds
:
3976 self
._log
.debug("Delete NSD failed - cannot find nsd-id %s", nsd_id
)
3977 raise NetworkServiceDescriptorNotFound("Cannot find %s", nsd_id
)
3979 if nsd_id
not in self
._nsds
:
3980 self
._log
.debug("Cannot delete NSD id %s reference exists %s",
3982 self
._nsds
[nsd_id
].ref_count
)
3983 raise NetworkServiceDescriptorRefCountExists(
3984 "Cannot delete :%s, ref_count:%s",
3986 self
._nsds
[nsd_id
].ref_count
)
3988 del self
._nsds
[nsd_id
]
3990 def get_vnfd_config(self
, xact
):
3991 vnfd_dts_reg
= self
._vnfd
_dts
_handler
.regh
3992 for cfg
in vnfd_dts_reg
.get_xact_elements(xact
):
3993 if cfg
.id not in self
._vnfds
:
3994 self
.create_vnfd(cfg
)
3996 def get_vnfd(self
, vnfd_id
, xact
):
3997 """ Get virtual network function descriptor for the passed vnfd_id"""
3998 if vnfd_id
not in self
._vnfds
:
3999 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
4000 self
.get_vnfd_config(xact
)
4002 if vnfd_id
not in self
._vnfds
:
4003 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
4004 raise VnfDescriptorError("Cannot find VNFD id:%s", vnfd_id
)
4006 return self
._vnfds
[vnfd_id
]
4008 def create_vnfd(self
, vnfd
):
4009 """ Create a virtual network function descriptor """
4010 self
._log
.debug("Create virtual network function descriptor - %s", vnfd
)
4011 if vnfd
.id in self
._vnfds
:
4012 self
._log
.error("Cannot create VNFD %s -VNFD ID already exists", vnfd
)
4013 raise VnfDescriptorError("VNFD already exists-%s", vnfd
.id)
4015 self
._vnfds
[vnfd
.id] = vnfd
4016 return self
._vnfds
[vnfd
.id]
4018 def update_vnfd(self
, vnfd
):
4019 """ Update the virtual network function descriptor """
4020 self
._log
.debug("Update virtual network function descriptor- %s", vnfd
)
4023 if vnfd
.id not in self
._vnfds
:
4024 self
._log
.debug("No VNFD found - creating VNFD id = %s", vnfd
.id)
4025 self
.create_vnfd(vnfd
)
4027 self
._log
.debug("Updating VNFD id = %s, vnfd = %s", vnfd
.id, vnfd
)
4028 self
._vnfds
[vnfd
.id] = vnfd
4031 def delete_vnfd(self
, vnfd_id
):
4032 """ Delete the virtual network function descriptor with the passed id """
4033 self
._log
.debug("Deleting the virtual network function descriptor - %s", vnfd_id
)
4034 if vnfd_id
not in self
._vnfds
:
4035 self
._log
.debug("Delete VNFD failed - cannot find vnfd-id %s", vnfd_id
)
4036 raise VnfDescriptorError("Cannot find %s", vnfd_id
)
4038 del self
._vnfds
[vnfd_id
]
4040 def nsd_in_use(self
, nsd_id
):
4041 """ Is the NSD with the passed id in use """
4042 self
._log
.debug("Is this NSD in use - msg:%s", nsd_id
)
4043 if nsd_id
in self
._nsds
:
4044 return self
._nsds
[nsd_id
].in_use()
4048 def publish_nsr(self
, xact
, path
, msg
):
4049 """ Publish a NSR """
4050 self
._log
.debug("Publish NSR with path %s, msg %s",
4052 yield from self
.nsr_handler
.update(xact
, path
, msg
)
4055 def unpublish_nsr(self
, xact
, path
):
4056 """ Un Publish an NSR """
4057 self
._log
.debug("Publishing delete NSR with path %s", path
)
4058 yield from self
.nsr_handler
.delete(path
, xact
)
4060 def vnfr_is_ready(self
, vnfr_id
):
4061 """ VNFR with the id is ready """
4062 self
._log
.debug("VNFR id %s ready", vnfr_id
)
4063 if vnfr_id
not in self
._vnfds
:
4064 err
= "Did not find VNFR ID with id %s" % vnfr_id
4065 self
._log
.critical("err")
4066 raise VirtualNetworkFunctionRecordError(err
)
4067 self
._vnfrs
[vnfr_id
].is_ready()
4070 def get_nsd_refcount(self
, nsd_id
):
4071 """ Get the nsd_list from this NSM"""
4073 def nsd_refcount_xpath(nsd_id
):
4074 """ xpath for ref count entry """
4075 return (NsdRefCountDtsHandler
.XPATH
+
4076 "[rw-nsr:nsd-id-ref = '{}']").format(nsd_id
)
4079 if nsd_id
is None or nsd_id
== "":
4080 for nsd
in self
._nsds
.values():
4081 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4082 nsd_msg
.nsd_id_ref
= nsd
.id
4083 nsd_msg
.instance_ref_count
= nsd
.ref_count
4084 nsd_list
.append((nsd_refcount_xpath(nsd
.id), nsd_msg
))
4085 elif nsd_id
in self
._nsds
:
4086 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4087 nsd_msg
.nsd_id_ref
= self
._nsds
[nsd_id
].id
4088 nsd_msg
.instance_ref_count
= self
._nsds
[nsd_id
].ref_count
4089 nsd_list
.append((nsd_refcount_xpath(nsd_id
), nsd_msg
))
4094 def terminate_ns(self
, nsr_id
, xact
):
4096 Terminate network service for the given NSR Id
4099 # Terminate the instances/networks assocaited with this nw service
4100 self
._log
.debug("Terminating the network service %s", nsr_id
)
4101 yield from self
._nsrs
[nsr_id
].terminate()
4104 yield from self
.nsd_unref_by_nsr_id(nsr_id
)
4106 # Unpublish the NSR record
4107 self
._log
.debug("Unpublishing the network service %s", nsr_id
)
4108 yield from self
._nsrs
[nsr_id
].unpublish(xact
)
4110 # Finaly delete the NS instance from this NS Manager
4111 self
._log
.debug("Deletng the network service %s", nsr_id
)
4112 self
.delete_nsr(nsr_id
)
4115 class NsmRecordsPublisherProxy(object):
4116 """ This class provides a publisher interface that allows plugin objects
4117 to publish NSR/VNFR/VLR"""
4119 def __init__(self
, dts
, log
, loop
, nsr_pub_hdlr
, vnfr_pub_hdlr
, vlr_pub_hdlr
):
4123 self
._nsr
_pub
_hdlr
= nsr_pub_hdlr
4124 self
._vlr
_pub
_hdlr
= vlr_pub_hdlr
4125 self
._vnfr
_pub
_hdlr
= vnfr_pub_hdlr
4128 def publish_nsr(self
, xact
, nsr
):
4129 """ Publish an NSR """
4130 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4131 return (yield from self
._nsr
_pub
_hdlr
.update(xact
, path
, nsr
))
4134 def unpublish_nsr(self
, xact
, nsr
):
4135 """ Unpublish an NSR """
4136 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4137 return (yield from self
._nsr
_pub
_hdlr
.delete(xact
, path
))
4140 def publish_vnfr(self
, xact
, vnfr
):
4141 """ Publish an VNFR """
4142 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4143 return (yield from self
._vnfr
_pub
_hdlr
.update(xact
, path
, vnfr
))
4146 def unpublish_vnfr(self
, xact
, vnfr
):
4147 """ Unpublish a VNFR """
4148 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4149 return (yield from self
._vnfr
_pub
_hdlr
.delete(xact
, path
))
4152 def publish_vlr(self
, xact
, vlr
):
4153 """ Publish a VLR """
4154 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4155 return (yield from self
._vlr
_pub
_hdlr
.update(xact
, path
, vlr
))
4158 def unpublish_vlr(self
, xact
, vlr
):
4159 """ Unpublish a VLR """
4160 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4161 return (yield from self
._vlr
_pub
_hdlr
.delete(xact
, path
))
4164 class ScalingRpcHandler(mano_dts
.DtsHandler
):
4165 """ The Network service Monitor DTS handler """
4166 SCALE_IN_INPUT_XPATH
= "I,/nsr:exec-scale-in"
4167 SCALE_IN_OUTPUT_XPATH
= "O,/nsr:exec-scale-in"
4169 SCALE_OUT_INPUT_XPATH
= "I,/nsr:exec-scale-out"
4170 SCALE_OUT_OUTPUT_XPATH
= "O,/nsr:exec-scale-out"
4172 ACTION
= Enum('ACTION', 'SCALE_IN SCALE_OUT')
4174 def __init__(self
, log
, dts
, loop
, callback
=None):
4175 super().__init
__(log
, dts
, loop
)
4176 self
.callback
= callback
4177 self
.last_instance_id
= defaultdict(int)
4183 def on_scale_in_prepare(xact_info
, action
, ks_path
, msg
):
4184 assert action
== rwdts
.QueryAction
.RPC
4188 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_IN
)
4190 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleIn
.from_dict({
4191 "instance_id": msg
.instance_id
})
4193 xact_info
.respond_xpath(
4194 rwdts
.XactRspCode
.ACK
,
4195 self
.__class
__.SCALE_IN_OUTPUT_XPATH
,
4198 except Exception as e
:
4199 self
.log
.exception(e
)
4200 xact_info
.respond_xpath(
4201 rwdts
.XactRspCode
.NACK
,
4202 self
.__class
__.SCALE_IN_OUTPUT_XPATH
)
4205 def on_scale_out_prepare(xact_info
, action
, ks_path
, msg
):
4206 assert action
== rwdts
.QueryAction
.RPC
4209 scaling_group
= msg
.scaling_group_name_ref
4210 if not msg
.instance_id
:
4211 last_instance_id
= self
.last_instance_id
[scale_group
]
4212 msg
.instance_id
= last_instance_id
+ 1
4213 self
.last_instance_id
[scale_group
] += 1
4216 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_OUT
)
4218 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleOut
.from_dict({
4219 "instance_id": msg
.instance_id
})
4221 xact_info
.respond_xpath(
4222 rwdts
.XactRspCode
.ACK
,
4223 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
,
4226 except Exception as e
:
4227 self
.log
.exception(e
)
4228 xact_info
.respond_xpath(
4229 rwdts
.XactRspCode
.NACK
,
4230 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
)
4232 scale_in_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4233 on_prepare
=on_scale_in_prepare
)
4234 scale_out_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4235 on_prepare
=on_scale_out_prepare
)
4237 with self
.dts
.group_create() as group
:
4239 xpath
=self
.__class
__.SCALE_IN_INPUT_XPATH
,
4240 handler
=scale_in_hdl
,
4241 flags
=rwdts
.Flag
.PUBLISHER
)
4243 xpath
=self
.__class
__.SCALE_OUT_INPUT_XPATH
,
4244 handler
=scale_out_hdl
,
4245 flags
=rwdts
.Flag
.PUBLISHER
)
4248 class NsmTasklet(rift
.tasklets
.Tasklet
):
4250 The network service manager tasklet
4252 def __init__(self
, *args
, **kwargs
):
4253 super(NsmTasklet
, self
).__init
__(*args
, **kwargs
)
4254 self
.rwlog
.set_category("rw-mano-log")
4255 self
.rwlog
.set_subcategory("nsm")
4260 self
._ro
_plugin
_selector
= None
4261 self
._vnffgmgr
= None
4263 self
._nsr
_handler
= None
4264 self
._vnfr
_pub
_handler
= None
4265 self
._vlr
_pub
_handler
= None
4266 self
._vnfd
_pub
_handler
= None
4267 self
._scale
_cfg
_handler
= None
4269 self
._records
_publisher
_proxy
= None
4272 """ The task start callback """
4273 super(NsmTasklet
, self
).start()
4274 self
.log
.info("Starting NsmTasklet")
4276 self
.log
.debug("Registering with dts")
4277 self
._dts
= rift
.tasklets
.DTS(self
.tasklet_info
,
4278 RwNsmYang
.get_schema(),
4280 self
.on_dts_state_change
)
4282 self
.log
.debug("Created DTS Api GI Object: %s", self
._dts
)
4288 print("Caught Exception in NSM stop:", sys
.exc_info()[0])
4291 def on_instance_started(self
):
4292 """ Task instance started callback """
4293 self
.log
.debug("Got instance started callback")
4297 """ Task init callback """
4298 self
.log
.debug("Got instance started callback")
4300 self
.log
.debug("creating config account handler")
4302 self
._nsr
_pub
_handler
= publisher
.NsrOpDataDtsHandler(self
._dts
, self
.log
, self
.loop
)
4303 yield from self
._nsr
_pub
_handler
.register()
4305 self
._vnfr
_pub
_handler
= publisher
.VnfrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4306 yield from self
._vnfr
_pub
_handler
.register()
4308 self
._vlr
_pub
_handler
= publisher
.VlrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4309 yield from self
._vlr
_pub
_handler
.register()
4311 manifest
= self
.tasklet_info
.get_pb_manifest()
4312 use_ssl
= manifest
.bootstrap_phase
.rwsecurity
.use_ssl
4313 ssl_cert
= manifest
.bootstrap_phase
.rwsecurity
.cert
4314 ssl_key
= manifest
.bootstrap_phase
.rwsecurity
.key
4316 self
._vnfd
_pub
_handler
= publisher
.VnfdPublisher(use_ssl
, ssl_cert
, ssl_key
, self
.loop
)
4318 self
._records
_publisher
_proxy
= NsmRecordsPublisherProxy(
4322 self
._nsr
_pub
_handler
,
4323 self
._vnfr
_pub
_handler
,
4324 self
._vlr
_pub
_handler
,
4327 # Register the NSM to receive the nsm plugin
4328 # when cloud account is configured
4329 self
._ro
_plugin
_selector
= cloud
.ROAccountPluginSelector(
4333 self
._records
_publisher
_proxy
,
4335 yield from self
._ro
_plugin
_selector
.register()
4337 self
._cloud
_account
_handler
= cloud
.CloudAccountConfigSubscriber(
4342 yield from self
._cloud
_account
_handler
.register()
4344 self
._vnffgmgr
= rwvnffgmgr
.VnffgMgr(self
._dts
, self
.log
, self
.log_hdl
, self
.loop
)
4345 yield from self
._vnffgmgr
.register()
4347 self
._nsm
= NsManager(
4351 self
._nsr
_pub
_handler
,
4352 self
._vnfr
_pub
_handler
,
4353 self
._vlr
_pub
_handler
,
4354 self
._ro
_plugin
_selector
,
4356 self
._vnfd
_pub
_handler
,
4357 self
._cloud
_account
_handler
4360 yield from self
._nsm
.register()
4364 """ Task run callback """
4368 def on_dts_state_change(self
, state
):
4369 """Take action according to current dts state to transition
4370 application into the corresponding application state
4373 state - current dts state
4376 rwdts
.State
.INIT
: rwdts
.State
.REGN_COMPLETE
,
4377 rwdts
.State
.CONFIG
: rwdts
.State
.RUN
,
4381 rwdts
.State
.INIT
: self
.init
,
4382 rwdts
.State
.RUN
: self
.run
,
4385 # Transition application to next state
4386 handler
= handlers
.get(state
, None)
4387 if handler
is not None:
4388 yield from handler()
4390 # Transition dts to next state
4391 next_state
= switch
.get(state
, None)
4392 if next_state
is not None:
4393 self
.log
.debug("Changing state to %s", next_state
)
4394 self
._dts
.handle
.set_state(next_state
)