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
:
1891 self
._log
.debug("Found vld %s in nsr id %s", vld
, self
.id)
1892 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1893 for cloud_account
,om_datacenter
in cloud_account_list
:
1894 vlr
= yield from self
._create
_vls
(vld
, cloud_account
,om_datacenter
)
1895 self
._vlrs
.append(vlr
)
1899 def create_vl_instance(self
, vld
):
1900 self
._log
.debug("Create VL for {}: {}".format(self
.id, vld
.as_dict()))
1901 # Check if the VL is already present
1903 for vl
in self
._vlrs
:
1904 if vl
.vld_msg
.id == vld
.id:
1905 self
._log
.debug("The VLD %s already in NSR %s as VLR %s with status %s",
1906 vld
.id, self
.id, vl
.id, vl
.state
)
1908 if vlr
.state
!= VlRecordState
.TERMINATED
:
1909 err_msg
= "VLR for VL %s in NSR %s already instantiated", \
1911 self
._log
.error(err_msg
)
1912 raise NsrVlUpdateError(err_msg
)
1916 cloud_account_list
= self
._extract
_cloud
_accounts
_for
_vl
(vld
)
1917 for account
,om_datacenter
in cloud_account_list
:
1918 vlr
= yield from self
._create
_vls
(vld
, account
,om_datacenter
)
1919 self
._vlrs
.append(vlr
)
1921 vlr
.state
= VlRecordState
.INSTANTIATION_PENDING
1922 yield from self
.update_state()
1925 yield from self
.nsm_plugin
.instantiate_vl(self
, vlr
)
1926 vlr
.state
= VlRecordState
.ACTIVE
1928 except Exception as e
:
1929 err_msg
= "Error instantiating VL for NSR {} and VLD {}: {}". \
1930 format(self
.id, vld
.id, e
)
1931 self
._log
.error(err_msg
)
1932 self
._log
.exception(e
)
1933 vlr
.state
= VlRecordState
.FAILED
1935 yield from self
.update_state()
1938 def delete_vl_instance(self
, vld
):
1939 for vlr
in self
._vlrs
:
1940 if vlr
.vld_msg
.id == vld
.id:
1941 self
._log
.debug("Found VLR %s for VLD %s in NSR %s",
1942 vlr
.id, vld
.id, self
.id)
1943 vlr
.state
= VlRecordState
.TERMINATE_PENDING
1944 yield from self
.update_state()
1947 yield from self
.nsm_plugin
.terminate_vl(vlr
)
1948 vlr
.state
= VlRecordState
.TERMINATED
1949 self
._vlrs
.remove(vlr
)
1951 except Exception as e
:
1952 err_msg
= "Error terminating VL for NSR {} and VLD {}: {}". \
1953 format(self
.id, vld
.id, e
)
1954 self
._log
.error(err_msg
)
1955 self
._log
.exception(e
)
1956 vlr
.state
= VlRecordState
.FAILED
1958 yield from self
.update_state()
1962 def create_vnfs(self
, config_xact
):
1964 This function creates VNFs for every VNF in the NSD
1965 associated with this NSR
1967 self
._log
.debug("Creating %u VNFs associated with this NS id %s",
1968 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
1970 for const_vnfd
in self
.nsd_msg
.constituent_vnfd
:
1971 if not const_vnfd
.start_by_default
:
1972 self
._log
.debug("start_by_default set to False in constituent VNF (%s). Skipping start.",
1973 const_vnfd
.member_vnf_index
)
1976 vnfd_msg
= self
._get
_vnfd
(const_vnfd
.vnfd_id_ref
, config_xact
)
1977 cloud_account_name
,om_datacenter_name
= self
._get
_vnfd
_cloud
_account
(const_vnfd
.member_vnf_index
)
1978 if cloud_account_name
is None:
1979 cloud_account_name
= self
.cloud_account_name
1980 yield from self
.create_vnf_record(vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
)
1983 def get_placement_groups(self
, vnfd_msg
, const_vnfd
):
1984 placement_groups
= []
1985 for group
in self
.nsd_msg
.placement_groups
:
1986 for member_vnfd
in group
.member_vnfd
:
1987 if (member_vnfd
.vnfd_id_ref
== vnfd_msg
.id) and \
1988 (member_vnfd
.member_vnf_index_ref
== const_vnfd
.member_vnf_index
):
1989 group_info
= self
.resolve_placement_group_cloud_construct(group
)
1990 if group_info
is None:
1991 self
._log
.error("Could not resolve cloud-construct for placement group: %s", group
.name
)
1992 ### raise PlacementGroupError("Could not resolve cloud-construct for placement group: {}".format(group.name))
1994 self
._log
.info("Successfully resolved cloud construct for placement group: %s for VNF: %s (Member Index: %s)",
1997 const_vnfd
.member_vnf_index
)
1998 placement_groups
.append(group_info
)
1999 return placement_groups
2002 def create_vnf_record(self
, vnfd_msg
, const_vnfd
, cloud_account_name
, om_datacenter_name
, group_name
=None, group_instance_id
=None):
2003 # Fetch the VNFD associated with this VNF
2004 placement_groups
= self
.get_placement_groups(vnfd_msg
, const_vnfd
)
2005 self
._log
.info("Cloud Account for VNF %d is %s",const_vnfd
.member_vnf_index
,cloud_account_name
)
2006 self
._log
.info("Launching VNF: %s (Member Index: %s) in NSD plancement Groups: %s",
2008 const_vnfd
.member_vnf_index
,
2009 [ group
.name
for group
in placement_groups
])
2010 vnfr
= yield from VirtualNetworkFunctionRecord
.create_record(self
._dts
,
2023 restart_mode
=self
.restart_mode
,
2025 if vnfr
.id in self
._vnfrs
:
2026 err
= "VNF with VNFR id %s already in vnf list" % (vnfr
.id,)
2027 raise NetworkServiceRecordError(err
)
2029 self
._vnfrs
[vnfr
.id] = vnfr
2030 self
._nsm
.vnfrs
[vnfr
.id] = vnfr
2032 yield from vnfr
.set_config_status(NsrYang
.ConfigStates
.INIT
)
2034 self
._log
.debug("Added VNFR %s to NSM VNFR list with id %s",
2040 def create_param_pools(self
):
2041 for param_pool
in self
.nsd_msg
.parameter_pool
:
2042 self
._log
.debug("Found parameter pool %s in nsr id %s", param_pool
, self
.id)
2044 start_value
= param_pool
.range.start_value
2045 end_value
= param_pool
.range.end_value
2046 if end_value
< start_value
:
2047 raise NetworkServiceRecordError(
2048 "Parameter pool %s has invalid range (start: {}, end: {})".format(
2049 start_value
, end_value
2053 self
._param
_pools
[param_pool
.name
] = config_value_pool
.ParameterValuePool(
2056 range(start_value
, end_value
)
2060 def fetch_vnfr(self
, vnfr_path
):
2061 """ Fetch VNFR record """
2063 self
._log
.debug("Fetching VNFR with key %s while instantiating %s",
2065 res_iter
= yield from self
._dts
.query_read(vnfr_path
, rwdts
.XactFlag
.MERGE
)
2067 for ent
in res_iter
:
2068 res
= yield from ent
2074 def instantiate_vnfs(self
, vnfrs
):
2076 This function instantiates VNFs for every VNF in this Network Service
2078 self
._log
.debug("Instantiating %u VNFs in NS %s", len(vnfrs
), self
.id)
2080 self
._log
.debug("Instantiating VNF: %s in NS %s", vnf
, self
.id)
2081 yield from self
.nsm_plugin
.instantiate_vnf(self
, vnf
)
2084 def instantiate_vnffgs(self
):
2086 This function instantiates VNFFGs for every VNFFG in this Network Service
2088 self
._log
.debug("Instantiating %u VNFFGs in NS %s",
2089 len(self
.nsd_msg
.vnffgd
), self
.id)
2090 for _
, vnfr
in self
.vnfrs
.items():
2091 while vnfr
.state
in [VnfRecordState
.INSTANTIATION_PENDING
, VnfRecordState
.INIT
]:
2092 self
._log
.debug("Received vnfr state for vnfr %s is %s; retrying",vnfr
.name
,vnfr
.state
)
2093 yield from asyncio
.sleep(2, loop
=self
._loop
)
2094 if vnfr
.state
== VnfRecordState
.ACTIVE
:
2095 self
._log
.debug("Received vnfr state for vnfr %s is %s ",vnfr
.name
,vnfr
.state
)
2098 self
._log
.debug("Received vnfr state for vnfr %s is %s; failing vnffg creation",vnfr
.name
,vnfr
.state
)
2099 self
._vnffgr
_state
= VnffgRecordState
.FAILED
2102 self
._log
.info("Waiting for 90 seconds for VMs to come up")
2103 yield from asyncio
.sleep(90, loop
=self
._loop
)
2104 self
._log
.info("Starting VNFFG orchestration")
2105 for vnffg
in self
._vnffgrs
.values():
2106 self
._log
.debug("Instantiating VNFFG: %s in NS %s", vnffg
, self
.id)
2107 yield from vnffg
.instantiate()
2110 def instantiate_scaling_instances(self
, config_xact
):
2111 """ Instantiate any default scaling instances in this Network Service """
2112 for group
in self
._scaling
_groups
.values():
2113 for i
in range(group
.min_instance_count
):
2114 self
._log
.debug("Instantiating %s default scaling instance %s", group
, i
)
2115 yield from self
.create_scale_group_instance(
2116 group
.name
, i
, config_xact
, is_default
=True
2119 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2120 if group_msg
.scaling_group_name_ref
!= group
.name
:
2123 for instance
in group_msg
.instance
:
2124 self
._log
.debug("Reloading %s scaling instance %s", group_msg
, instance
.id)
2125 yield from self
.create_scale_group_instance(
2126 group
.name
, instance
.id, config_xact
, is_default
=False
2129 def has_scaling_instances(self
):
2130 """ Return boolean indicating if the network service has default scaling groups """
2131 for group
in self
._scaling
_groups
.values():
2132 if group
.min_instance_count
> 0:
2135 for group_msg
in self
._nsr
_cfg
_msg
.scaling_group
:
2136 if len(group_msg
.instance
) > 0:
2143 """ This function publishes this NSR """
2144 self
._nsr
_msg
= self
.create_msg()
2146 self
._log
.debug("Publishing the NSR with xpath %s and nsr %s",
2150 if self
._debug
_running
:
2151 self
._log
.debug("Publishing NSR in RUNNING state!")
2154 with self
._dts
.transaction() as xact
:
2155 yield from self
._nsm
.nsr_handler
.update(xact
, self
.nsr_xpath
, self
._nsr
_msg
)
2156 if self
._op
_status
.state
== NetworkServiceRecordState
.RUNNING
:
2157 self
._debug
_running
= True
2160 def unpublish(self
, xact
):
2161 """ Unpublish this NSR object """
2162 self
._log
.debug("Unpublishing Network service id %s", self
.id)
2163 yield from self
._nsm
.nsr_handler
.delete(xact
, self
.nsr_xpath
)
2166 def nsr_xpath(self
):
2167 """ Returns the xpath associated with this NSR """
2169 "D,/nsr:ns-instance-opdata" +
2170 "/nsr:nsr[nsr:ns-instance-config-ref = '{}']"
2174 def xpath_from_nsr(nsr
):
2175 """ Returns the xpath associated with this NSR op data"""
2176 return (NetworkServiceRecord
.XPATH
+
2177 "[nsr:ns-instance-config-ref = '{}']").format(nsr
.id)
2180 def nsd_xpath(self
):
2181 """ Return NSD config xpath."""
2183 "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}']"
2184 ).format(self
.nsd_id
)
2187 def instantiate(self
, config_xact
):
2188 """"Instantiates a NetworkServiceRecord.
2190 This function instantiates a Network service
2191 which involves the following steps,
2193 * Instantiate every VL in NSD by sending create VLR request to DTS.
2194 * Instantiate every VNF in NSD by sending create VNF reuqest to DTS.
2195 * Publish the NSR details to DTS
2198 nsr: The NSR configuration request containing nsr-id and nsd
2199 config_xact: The configuration transaction which initiated the instatiation
2202 NetworkServiceRecordError if the NSR creation fails
2208 self
._log
.debug("Instantiating NS - %s xact - %s", self
, config_xact
)
2210 # Move the state to INIITALIZING
2211 self
.set_state(NetworkServiceRecordState
.INIT
)
2213 event_descr
= "Instantiation Request Received NSR Id:%s" % self
.id
2214 self
.record_event("instantiating", event_descr
)
2217 self
._nsd
= self
._nsr
_cfg
_msg
.nsd
2220 # Update ref count if nsd present in catalog
2221 self
._nsm
.get_nsd_ref(self
.nsd_id
)
2223 except NetworkServiceDescriptorError
:
2224 # This could be an NSD not in the nsd-catalog
2227 # Merge any config and initial config primitive values
2228 self
.config_store
.merge_nsd_config(self
.nsd_msg
)
2229 self
._log
.debug("Merged NSD: {}".format(self
.nsd_msg
.as_dict()))
2231 event_descr
= "Fetched NSD with descriptor id %s" % self
.nsd_id
2232 self
.record_event("nsd-fetched", event_descr
)
2234 if self
._nsd
is None:
2235 msg
= "Failed to fetch NSD with nsd-id [%s] for nsr-id %s"
2236 self
._log
.debug(msg
, self
.nsd_id
, self
.id)
2237 raise NetworkServiceRecordError(self
)
2239 self
._log
.debug("Got nsd result %s", self
._nsd
)
2241 # Substitute any input parameters
2242 self
.substitute_input_parameters(self
._nsd
, self
._nsr
_cfg
_msg
)
2245 yield from self
.create(config_xact
)
2247 # Publish the NSR to DTS
2248 yield from self
.publish()
2251 def do_instantiate():
2253 Instantiate network service
2255 self
._log
.debug("Instantiating VLs nsr id [%s] nsd id [%s]",
2256 self
.id, self
.nsd_id
)
2258 # instantiate the VLs
2259 event_descr
= ("Instantiating %s external VLs for NSR id %s" %
2260 (len(self
.nsd_msg
.vld
), self
.id))
2261 self
.record_event("begin-external-vls-instantiation", event_descr
)
2263 self
.set_state(NetworkServiceRecordState
.VL_INIT_PHASE
)
2265 yield from self
.instantiate_vls()
2267 # Publish the NSR to DTS
2268 yield from self
.publish()
2270 event_descr
= ("Finished instantiating %s external VLs for NSR id %s" %
2271 (len(self
.nsd_msg
.vld
), self
.id))
2272 self
.record_event("end-external-vls-instantiation", event_descr
)
2274 self
.set_state(NetworkServiceRecordState
.VNF_INIT_PHASE
)
2276 self
._log
.debug("Instantiating VNFs ...... nsr[%s], nsd[%s]",
2277 self
.id, self
.nsd_id
)
2279 # instantiate the VNFs
2280 event_descr
= ("Instantiating %s VNFS for NSR id %s" %
2281 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2283 self
.record_event("begin-vnf-instantiation", event_descr
)
2285 yield from self
.instantiate_vnfs(self
._vnfrs
.values())
2287 self
._log
.debug(" Finished instantiating %d VNFs for NSR id %s",
2288 len(self
.nsd_msg
.constituent_vnfd
), self
.id)
2290 event_descr
= ("Finished instantiating %s VNFs for NSR id %s" %
2291 (len(self
.nsd_msg
.constituent_vnfd
), self
.id))
2292 self
.record_event("end-vnf-instantiation", event_descr
)
2294 if len(self
.vnffgrs
) > 0:
2295 #self.set_state(NetworkServiceRecordState.VNFFG_INIT_PHASE)
2296 event_descr
= ("Instantiating %s VNFFGS for NSR id %s" %
2297 (len(self
.nsd_msg
.vnffgd
), self
.id))
2299 self
.record_event("begin-vnffg-instantiation", event_descr
)
2301 yield from self
.instantiate_vnffgs()
2303 event_descr
= ("Finished instantiating %s VNFFGDs for NSR id %s" %
2304 (len(self
.nsd_msg
.vnffgd
), self
.id))
2305 self
.record_event("end-vnffg-instantiation", event_descr
)
2307 if self
.has_scaling_instances():
2308 event_descr
= ("Instantiating %s Scaling Groups for NSR id %s" %
2309 (len(self
._scaling
_groups
), self
.id))
2311 self
.record_event("begin-scaling-group-instantiation", event_descr
)
2312 yield from self
.instantiate_scaling_instances(config_xact
)
2313 self
.record_event("end-scaling-group-instantiation", event_descr
)
2315 # Give the plugin a chance to deploy the network service now that all
2316 # virtual links and vnfs are instantiated
2317 yield from self
.nsm_plugin
.deploy(self
._nsr
_msg
)
2319 self
._log
.debug("Publishing NSR...... nsr[%s], nsd[%s]",
2320 self
.id, self
.nsd_id
)
2322 # Publish the NSR to DTS
2323 yield from self
.publish()
2325 self
._log
.debug("Published NSR...... nsr[%s], nsd[%s]",
2326 self
.id, self
.nsd_id
)
2328 def on_instantiate_done(fut
):
2329 # If the do_instantiate fails, then publish NSR with failed result
2330 if fut
.exception() is not None:
2331 self
._log
.error("NSR instantiation failed for NSR id %s: %s", self
.id, str(fut
.exception()))
2332 self
._loop
.create_task(self
.instantiation_failed(failed_reason
=str(fut
.exception())))
2334 instantiate_task
= self
._loop
.create_task(do_instantiate())
2335 instantiate_task
.add_done_callback(on_instantiate_done
)
2338 def set_config_status(self
, status
, status_details
=None):
2339 if self
.config_status
!= status
:
2340 self
._log
.debug("Updating NSR {} status for {} to {}".
2341 format(self
.name
, self
.config_status
, status
))
2342 self
._config
_status
= status
2343 self
._config
_status
_details
= status_details
2345 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2346 self
.record_event("config-failed", "NS configuration failed",
2347 evt_details
=self
._config
_status
_details
)
2349 yield from self
.publish()
2352 def is_active(self
):
2353 """ This NS is active """
2354 self
.set_state(NetworkServiceRecordState
.RUNNING
)
2358 # Publish the NSR to DTS
2359 self
._log
.debug("Network service %s is active ", self
.id)
2360 self
._is
_active
= True
2362 event_descr
= "NSR in running state for NSR id %s" % self
.id
2363 self
.record_event("ns-running", event_descr
)
2365 yield from self
.publish()
2368 def instantiation_failed(self
, failed_reason
=None):
2369 """ The NS instantiation failed"""
2370 self
._log
.error("Network service id:%s, name:%s instantiation failed",
2372 self
.set_state(NetworkServiceRecordState
.FAILED
)
2374 event_descr
= "Instantiation of NS %s failed" % self
.id
2375 self
.record_event("ns-failed", event_descr
, evt_details
=failed_reason
)
2377 # Publish the NSR to DTS
2378 yield from self
.publish()
2381 def terminate_vnfrs(self
, vnfrs
):
2382 """ Terminate VNFRS in this network service """
2383 self
._log
.debug("Terminating VNFs in network service %s", self
.id)
2385 yield from self
.nsm_plugin
.terminate_vnf(vnfr
)
2388 def terminate(self
):
2389 """ Terminate a NetworkServiceRecord."""
2390 def terminate_vnffgrs():
2391 """ Terminate VNFFGRS in this network service """
2392 self
._log
.debug("Terminating VNFFGRs in network service %s", self
.id)
2393 for vnffgr
in self
.vnffgrs
.values():
2394 yield from vnffgr
.terminate()
2396 def terminate_vlrs():
2397 """ Terminate VLRs in this netork service """
2398 self
._log
.debug("Terminating VLs in network service %s", self
.id)
2399 for vlr
in self
.vlrs
:
2400 yield from self
.nsm_plugin
.terminate_vl(vlr
)
2401 vlr
.state
= VlRecordState
.TERMINATED
2403 self
._log
.debug("Terminating network service id %s", self
.id)
2405 # Move the state to TERMINATE
2406 self
.set_state(NetworkServiceRecordState
.TERMINATE
)
2407 event_descr
= "Terminate being processed for NS Id:%s" % self
.id
2408 self
.record_event("terminate", event_descr
)
2410 # Move the state to VNF_TERMINATE_PHASE
2411 self
._log
.debug("Terminating VNFFGs in NS ID: %s", self
.id)
2412 self
.set_state(NetworkServiceRecordState
.VNFFG_TERMINATE_PHASE
)
2413 event_descr
= "Terminating VNFFGS in NS Id:%s" % self
.id
2414 self
.record_event("terminating-vnffgss", event_descr
)
2415 yield from terminate_vnffgrs()
2417 # Move the state to VNF_TERMINATE_PHASE
2418 self
.set_state(NetworkServiceRecordState
.VNF_TERMINATE_PHASE
)
2419 event_descr
= "Terminating VNFS in NS Id:%s" % self
.id
2420 self
.record_event("terminating-vnfs", event_descr
)
2421 yield from self
.terminate_vnfrs(self
.vnfrs
.values())
2423 # Move the state to VL_TERMINATE_PHASE
2424 self
.set_state(NetworkServiceRecordState
.VL_TERMINATE_PHASE
)
2425 event_descr
= "Terminating VLs in NS Id:%s" % self
.id
2426 self
.record_event("terminating-vls", event_descr
)
2427 yield from terminate_vlrs()
2429 yield from self
.nsm_plugin
.terminate_ns(self
)
2431 # Move the state to TERMINATED
2432 self
.set_state(NetworkServiceRecordState
.TERMINATED
)
2433 event_descr
= "Terminated NS Id:%s" % self
.id
2434 self
.record_event("terminated", event_descr
)
2437 """"Enable a NetworkServiceRecord."""
2441 """"Disable a NetworkServiceRecord."""
2444 def map_config_status(self
):
2445 self
._log
.debug("Config status for ns {} is {}".
2446 format(self
.name
, self
._config
_status
))
2447 if self
._config
_status
== NsrYang
.ConfigStates
.CONFIGURING
:
2448 return 'configuring'
2449 if self
._config
_status
== NsrYang
.ConfigStates
.FAILED
:
2453 def vl_phase_completed(self
):
2454 """ Are VLs created in this NS?"""
2455 return self
._vl
_phase
_completed
2457 def vnf_phase_completed(self
):
2458 """ Are VLs created in this NS?"""
2459 return self
._vnf
_phase
_completed
2461 def create_msg(self
):
2462 """ The network serice record as a message """
2463 nsr_dict
= {"ns_instance_config_ref": self
.id}
2464 nsr
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr
.from_dict(nsr_dict
)
2465 #nsr.cloud_account = self.cloud_account_name
2466 nsr
.sdn_account
= self
._sdn
_account
_name
2467 nsr
.name_ref
= self
.name
2468 nsr
.nsd_ref
= self
.nsd_id
2469 nsr
.nsd_name_ref
= self
.nsd_msg
.name
2470 nsr
.operational_events
= self
._op
_status
.msg
2471 nsr
.operational_status
= self
._op
_status
.yang_str()
2472 nsr
.config_status
= self
.map_config_status()
2473 nsr
.config_status_details
= self
._config
_status
_details
2474 nsr
.create_time
= self
._create
_time
2476 for cfg_prim
in self
.nsd_msg
.service_primitive
:
2477 cfg_prim
= NsrYang
.YangData_Nsr_NsInstanceOpdata_Nsr_ServicePrimitive
.from_dict(
2479 nsr
.service_primitive
.append(cfg_prim
)
2481 for init_cfg
in self
.nsd_msg
.initial_config_primitive
:
2482 prim
= NsrYang
.NsrInitialConfigPrimitive
.from_dict(
2484 nsr
.initial_config_primitive
.append(prim
)
2486 if self
.vl_phase_completed():
2487 for vlr
in self
.vlrs
:
2488 nsr
.vlr
.append(vlr
.create_nsr_vlr_msg(self
.vnfrs
.values()))
2490 if self
.vnf_phase_completed():
2491 for vnfr_id
in self
.vnfrs
:
2492 nsr
.constituent_vnfr_ref
.append(self
.vnfrs
[vnfr_id
].const_vnfr_msg
)
2493 for vnffgr
in self
.vnffgrs
.values():
2494 nsr
.vnffgr
.append(vnffgr
.fetch_vnffgr())
2495 for scaling_group
in self
._scaling
_groups
.values():
2496 nsr
.scaling_group_record
.append(scaling_group
.create_record_msg())
2500 def all_vnfs_active(self
):
2501 """ Are all VNFS in this NS active? """
2502 for _
, vnfr
in self
.vnfrs
.items():
2503 if vnfr
.active
is not True:
2508 def update_state(self
):
2509 """ Re-evaluate this NS's state """
2510 curr_state
= self
._op
_status
.state
2512 if curr_state
== NetworkServiceRecordState
.TERMINATED
:
2513 self
._log
.debug("NS (%s) in terminated state, not updating state", self
.id)
2516 new_state
= NetworkServiceRecordState
.RUNNING
2517 self
._log
.info("Received update_state for nsr: %s, curr-state: %s",
2518 self
.id, curr_state
)
2520 # Check all the VNFRs are present
2521 for _
, vnfr
in self
.vnfrs
.items():
2522 if vnfr
.state
in [VnfRecordState
.ACTIVE
, VnfRecordState
.TERMINATED
]:
2524 elif vnfr
.state
== VnfRecordState
.FAILED
:
2525 if vnfr
._prev
_state
!= vnfr
.state
:
2526 event_descr
= "Instantiation of VNF %s failed" % vnfr
.id
2527 event_error_details
= vnfr
.state_failed_reason
2528 self
.record_event("vnf-failed", event_descr
, evt_details
=event_error_details
)
2529 vnfr
.set_state(VnfRecordState
.FAILED
)
2531 self
._log
.info("VNF state did not change, curr=%s, prev=%s",
2532 vnfr
.state
, vnfr
._prev
_state
)
2533 new_state
= NetworkServiceRecordState
.FAILED
2536 self
._log
.info("VNF %s in NSR %s is still not active; current state is: %s",
2537 vnfr
.id, self
.id, vnfr
.state
)
2538 new_state
= curr_state
2540 # If new state is RUNNING; check all VLs
2541 if new_state
== NetworkServiceRecordState
.RUNNING
:
2542 for vl
in self
.vlrs
:
2544 if vl
.state
in [VlRecordState
.ACTIVE
, VlRecordState
.TERMINATED
]:
2546 elif vl
.state
== VlRecordState
.FAILED
:
2547 if vl
.prev_state
!= vl
.state
:
2548 event_descr
= "Instantiation of VL %s failed" % vl
.id
2549 event_error_details
= vl
.state_failed_reason
2550 self
.record_event("vl-failed", event_descr
, evt_details
=event_error_details
)
2551 vl
.prev_state
= vl
.state
2553 self
._log
.debug("VL %s already in failed state")
2555 if vl
.state
in [VlRecordState
.INSTANTIATION_PENDING
, VlRecordState
.INIT
]:
2556 new_state
= NetworkServiceRecordState
.VL_INSTANTIATE
2559 if vl
.state
in [VlRecordState
.TERMINATE_PENDING
]:
2560 new_state
= NetworkServiceRecordState
.VL_TERMINATE
2563 # If new state is RUNNING; check VNFFGRs are also active
2564 if new_state
== NetworkServiceRecordState
.RUNNING
:
2565 for _
, vnffgr
in self
.vnffgrs
.items():
2566 self
._log
.info("Checking vnffgr state for nsr %s is: %s",
2567 self
.id, vnffgr
.state
)
2568 if vnffgr
.state
== VnffgRecordState
.ACTIVE
:
2570 elif vnffgr
.state
== VnffgRecordState
.FAILED
:
2571 event_descr
= "Instantiation of VNFFGR %s failed" % vnffgr
.id
2572 self
.record_event("vnffg-failed", event_descr
)
2573 new_state
= NetworkServiceRecordState
.FAILED
2576 self
._log
.info("VNFFGR %s in NSR %s is still not active; current state is: %s",
2577 vnffgr
.id, self
.id, vnffgr
.state
)
2578 new_state
= curr_state
2580 # Update all the scaling group instance operational status to
2581 # reflect the state of all VNFR within that instance
2582 yield from self
._update
_scale
_group
_instances
_status
()
2584 for _
, group
in self
._scaling
_groups
.items():
2585 if group
.state
== scale_group
.ScaleGroupState
.SCALING_OUT
:
2586 new_state
= NetworkServiceRecordState
.SCALING_OUT
2588 elif group
.state
== scale_group
.ScaleGroupState
.SCALING_IN
:
2589 new_state
= NetworkServiceRecordState
.SCALING_IN
2592 if new_state
!= curr_state
:
2593 self
._log
.debug("Changing state of Network service %s from %s to %s",
2594 self
.id, curr_state
, new_state
)
2595 if new_state
== NetworkServiceRecordState
.RUNNING
:
2596 yield from self
.is_active()
2597 elif new_state
== NetworkServiceRecordState
.FAILED
:
2598 # If the NS is already active and we entered scaling_in, scaling_out,
2599 # do not mark the NS as failing if scaling operation failed.
2600 if curr_state
in [NetworkServiceRecordState
.SCALING_OUT
,
2601 NetworkServiceRecordState
.SCALING_IN
] and self
._is
_active
:
2602 new_state
= NetworkServiceRecordState
.RUNNING
2603 self
.set_state(new_state
)
2605 yield from self
.instantiation_failed()
2607 self
.set_state(new_state
)
2609 yield from self
.publish()
2612 class InputParameterSubstitution(object):
2614 This class is responsible for substituting input parameters into an NSD.
2617 def __init__(self
, log
):
2618 """Create an instance of InputParameterSubstitution
2621 log - a logger for this object to use
2626 def __call__(self
, nsd
, nsr_config
):
2627 """Substitutes input parameters from the NSR config into the NSD
2629 This call modifies the provided NSD with the input parameters that are
2630 contained in the NSR config.
2633 nsd - a GI NSD object
2634 nsr_config - a GI NSR config object
2637 if nsd
is None or nsr_config
is None:
2640 # Create a lookup of the xpath elements that this descriptor allows
2642 optional_input_parameters
= set()
2643 for input_parameter
in nsd
.input_parameter_xpath
:
2644 optional_input_parameters
.add(input_parameter
.xpath
)
2646 # Apply the input parameters to the descriptor
2647 if nsr_config
.input_parameter
:
2648 for param
in nsr_config
.input_parameter
:
2649 if param
.xpath
not in optional_input_parameters
:
2650 msg
= "tried to set an invalid input parameter ({})"
2651 self
.log
.error(msg
.format(param
.xpath
))
2655 "input-parameter:{} = {}".format(
2662 xpath
.setxattr(nsd
, param
.xpath
, param
.value
)
2664 except Exception as e
:
2665 self
.log
.exception(e
)
2668 class NetworkServiceDescriptor(object):
2670 Network service descriptor class
2673 def __init__(self
, dts
, log
, loop
, nsd
, nsm
):
2685 """ Returns nsd id """
2690 """ Returns name of nsd """
2691 return self
._nsd
.name
2694 def ref_count(self
):
2695 """ Returns reference count"""
2696 return self
._ref
_count
2699 """ Returns whether nsd is in use or not """
2700 return True if self
.ref_count
> 0 else False
2703 """ Take a reference on this object """
2704 self
._ref
_count
+= 1
2707 """ Release reference on this object """
2708 if self
.ref_count
< 1:
2709 msg
= ("Unref on a NSD object - nsd id %s, ref_count = %s" %
2710 (self
.id, self
.ref_count
))
2711 self
._log
.critical(msg
)
2712 raise NetworkServiceDescriptorError(msg
)
2713 self
._ref
_count
-= 1
2717 """ Return the message associated with this NetworkServiceDescriptor"""
2721 def path_for_id(nsd_id
):
2722 """ Return path for the passed nsd_id"""
2723 return "C,/nsd:nsd-catalog/nsd:nsd[nsd:id = '{}'".format(nsd_id
)
2726 """ Return the message associated with this NetworkServiceDescriptor"""
2727 return NetworkServiceDescriptor
.path_for_id(self
.id)
2729 def update(self
, nsd
):
2730 """ Update the NSD descriptor """
2734 class NsdDtsHandler(object):
2735 """ The network service descriptor DTS handler """
2736 XPATH
= "C,/nsd:nsd-catalog/nsd:nsd"
2738 def __init__(self
, dts
, log
, loop
, nsm
):
2748 """ Return registration handle """
2753 """ Register for Nsd create/update/delete/read requests from dts """
2755 def on_apply(dts
, acg
, xact
, action
, scratch
):
2756 """Apply the configuration"""
2757 is_recovery
= xact
.xact
is None and action
== rwdts
.AppconfAction
.INSTALL
2758 self
._log
.debug("Got nsd apply cfg (xact:%s) (action:%s)",
2760 # Create/Update an NSD record
2761 for cfg
in self
._regh
.get_xact_elements(xact
):
2762 # Only interested in those NSD cfgs whose ID was received in prepare callback
2763 if cfg
.id in scratch
.get('nsds', []) or is_recovery
:
2764 self
._nsm
.update_nsd(cfg
)
2766 scratch
.pop('nsds', None)
2768 return RwTypes
.RwStatus
.SUCCESS
2771 def delete_nsd_libs(nsd_id
):
2772 """ Remove any files uploaded with NSD and stored under $RIFT_ARTIFACTS/libs/<id> """
2774 rift_artifacts_dir
= os
.environ
['RIFT_ARTIFACTS']
2775 nsd_dir
= os
.path
.join(rift_artifacts_dir
, 'launchpad/libs', nsd_id
)
2777 if os
.path
.exists (nsd_dir
):
2778 shutil
.rmtree(nsd_dir
, ignore_errors
=True)
2779 except Exception as e
:
2780 self
._log
.error("Exception in cleaning up NSD libs {}: {}".
2782 self
._log
.excpetion(e
)
2785 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2786 """ Prepare callback from DTS for NSD config """
2788 self
._log
.info("Got nsd prepare - config received nsd id %s, msg %s",
2791 fref
= ProtobufC
.FieldReference
.alloc()
2792 fref
.goto_whole_message(msg
.to_pbcm())
2794 if fref
.is_field_deleted():
2795 # Delete an NSD record
2796 self
._log
.debug("Deleting NSD with id %s", msg
.id)
2797 if self
._nsm
.nsd_in_use(msg
.id):
2798 self
._log
.debug("Cannot delete NSD in use - %s", msg
.id)
2799 err
= "Cannot delete an NSD in use - %s" % msg
.id
2800 raise NetworkServiceDescriptorRefCountExists(err
)
2802 yield from delete_nsd_libs(msg
.id)
2803 self
._nsm
.delete_nsd(msg
.id)
2805 # Add this NSD to scratch to create/update in apply callback
2806 nsds
= scratch
.setdefault('nsds', [])
2808 # acg._scratch['nsds'].append(msg.id)
2810 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2813 "Registering for NSD config using xpath: %s",
2814 NsdDtsHandler
.XPATH
,
2817 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2818 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2819 # Need a list in scratch to store NSDs to create/update later
2820 # acg._scratch['nsds'] = list()
2821 self
._regh
= acg
.register(
2822 xpath
=NsdDtsHandler
.XPATH
,
2823 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
2824 on_prepare
=on_prepare
)
2827 class VnfdDtsHandler(object):
2828 """ DTS handler for VNFD config changes """
2829 XPATH
= "C,/vnfd:vnfd-catalog/vnfd:vnfd"
2831 def __init__(self
, dts
, log
, loop
, nsm
):
2840 """ DTS registration handle """
2845 """ Register for VNFD configuration"""
2848 def on_apply(dts
, acg
, xact
, action
, scratch
):
2849 """Apply the configuration"""
2850 self
._log
.debug("Got NSM VNFD apply (xact: %s) (action: %s)(scr: %s)",
2851 xact
, action
, scratch
)
2853 # Create/Update a VNFD record
2854 for cfg
in self
._regh
.get_xact_elements(xact
):
2855 # Only interested in those VNFD cfgs whose ID was received in prepare callback
2856 if cfg
.id in scratch
.get('vnfds', []):
2857 self
._nsm
.update_vnfd(cfg
)
2859 for cfg
in self
._regh
.elements
:
2860 if cfg
.id in scratch
.get('deleted_vnfds', []):
2861 yield from self
._nsm
.delete_vnfd(cfg
.id)
2863 scratch
.pop('vnfds', None)
2864 scratch
.pop('deleted_vnfds', None)
2867 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
2868 """ on prepare callback """
2869 self
._log
.debug("Got on prepare for VNFD (path: %s) (action: %s) (msg: %s)",
2870 ks_path
.to_xpath(RwNsmYang
.get_schema()), xact_info
.query_action
, msg
)
2872 fref
= ProtobufC
.FieldReference
.alloc()
2873 fref
.goto_whole_message(msg
.to_pbcm())
2875 # Handle deletes in prepare_callback, but adds/updates in apply_callback
2876 if fref
.is_field_deleted():
2877 self
._log
.debug("Adding msg to deleted field")
2878 deleted_vnfds
= scratch
.setdefault('deleted_vnfds', [])
2879 deleted_vnfds
.append(msg
.id)
2881 # Add this VNFD to scratch to create/update in apply callback
2882 vnfds
= scratch
.setdefault('vnfds', [])
2883 vnfds
.append(msg
.id)
2885 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
2888 "Registering for VNFD config using xpath: %s",
2889 VnfdDtsHandler
.XPATH
,
2891 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
2892 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
2893 # Need a list in scratch to store VNFDs to create/update later
2894 # acg._scratch['vnfds'] = list()
2895 # acg._scratch['deleted_vnfds'] = list()
2896 self
._regh
= acg
.register(
2897 xpath
=VnfdDtsHandler
.XPATH
,
2898 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY
,
2899 on_prepare
=on_prepare
)
2901 class NsrRpcDtsHandler(object):
2902 """ The network service instantiation RPC DTS handler """
2903 EXEC_NSR_CONF_XPATH
= "I,/nsr:start-network-service"
2904 EXEC_NSR_CONF_O_XPATH
= "O,/nsr:start-network-service"
2905 NETCONF_IP_ADDRESS
= "127.0.0.1"
2907 RESTCONF_PORT
= 8888
2908 NETCONF_USER
= "admin"
2909 NETCONF_PW
= "admin"
2910 REST_BASE_V2_URL
= 'https://{}:{}/v2/api/'.format("127.0.0.1",8888)
2912 def __init__(self
, dts
, log
, loop
, nsm
):
2919 self
._ns
_regh
= None
2921 self
._manager
= None
2922 self
._nsr
_config
_url
= NsrRpcDtsHandler
.REST_BASE_V2_URL
+ 'config/ns-instance-config'
2924 self
._model
= RwYang
.Model
.create_libncx()
2925 self
._model
.load_schema_ypbc(RwNsrYang
.get_schema())
2929 """ Return the NS manager instance """
2933 def wrap_netconf_config_xml(xml
):
2934 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
2938 def _connect(self
, timeout_secs
=240):
2940 start_time
= time
.time()
2941 while (time
.time() - start_time
) < timeout_secs
:
2944 self
._log
.debug("Attemping NsmTasklet netconf connection.")
2946 manager
= yield from ncclient
.asyncio_manager
.asyncio_connect(
2948 host
=NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
,
2949 port
=NsrRpcDtsHandler
.NETCONF_PORT
,
2950 username
=NsrRpcDtsHandler
.NETCONF_USER
,
2951 password
=NsrRpcDtsHandler
.NETCONF_PW
,
2953 look_for_keys
=False,
2954 hostkey_verify
=False,
2959 except ncclient
.transport
.errors
.SSHError
as e
:
2960 self
._log
.warning("Netconf connection to launchpad %s failed: %s",
2961 NsrRpcDtsHandler
.NETCONF_IP_ADDRESS
, str(e
))
2963 yield from asyncio
.sleep(5, loop
=self
._loop
)
2965 raise NsrInstantiationFailed("Failed to connect to Launchpad within %s seconds" %
2968 def _apply_ns_instance_config(self
,payload_dict
):
2969 #self._log.debug("At apply NS instance config with payload %s",payload_dict)
2970 req_hdr
= {'accept':'application/vnd.yang.data+json','content-type':'application/vnd.yang.data+json'}
2971 response
=requests
.post(self
._nsr
_config
_url
, headers
=req_hdr
, auth
=('admin', 'admin'),data
=payload_dict
,verify
=False)
2976 """ Register for NS monitoring read from dts """
2978 def on_ns_config_prepare(xact_info
, action
, ks_path
, msg
):
2979 """ prepare callback from dts start-network-service"""
2980 assert action
== rwdts
.QueryAction
.RPC
2982 rpc_op
= NsrYang
.YangOutput_Nsr_StartNetworkService
.from_dict({
2983 "nsr_id":str(uuid
.uuid4())
2986 if not ('name' in rpc_ip
and 'nsd_ref' in rpc_ip
and ('cloud_account' in rpc_ip
or 'om_datacenter' in rpc_ip
)):
2987 self
._log
.error("Mandatory parameters name or nsd_ref or cloud account not found in start-network-service {}".format(rpc_ip
))
2990 self
._log
.debug("start-network-service RPC input: {}".format(rpc_ip
))
2993 # Add used value to the pool
2994 self
._log
.debug("RPC output: {}".format(rpc_op
))
2996 nsd_copy
= self
.nsm
.get_nsd(rpc_ip
.nsd_ref
)
2998 #if not self._manager:
2999 # self._manager = yield from self._connect()
3001 self
._log
.debug("Configuring ns-instance-config with name %s nsd-ref: %s",
3002 rpc_ip
.name
, rpc_ip
.nsd_ref
)
3004 ns_instance_config_dict
= {"id":rpc_op
.nsr_id
, "admin_status":"ENABLED"}
3005 ns_instance_config_copy_dict
= {k
:v
for k
, v
in rpc_ip
.as_dict().items()
3006 if k
in RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr().fields
}
3007 ns_instance_config_dict
.update(ns_instance_config_copy_dict
)
3009 ns_instance_config
= RwNsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.from_dict(ns_instance_config_dict
)
3010 ns_instance_config
.nsd
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_Nsd()
3011 ns_instance_config
.nsd
.from_dict(nsd_copy
.msg
.as_dict())
3013 payload_dict
= ns_instance_config
.to_json(self
._model
)
3014 #xml = ns_instance_config.to_xml_v2(self._model)
3015 #netconf_xml = self.wrap_netconf_config_xml(xml)
3017 #self._log.debug("Sending configure ns-instance-config xml to %s: %s",
3018 # netconf_xml, NsrRpcDtsHandler.NETCONF_IP_ADDRESS)
3019 self
._log
.debug("Sending configure ns-instance-config json to %s: %s",
3020 self
._nsr
_config
_url
,ns_instance_config
)
3022 #response = yield from self._manager.edit_config(
3024 # config=netconf_xml,
3026 response
= yield from self
._loop
.run_in_executor(
3028 self
._apply
_ns
_instance
_config
,
3031 response
.raise_for_status()
3032 self
._log
.debug("Received edit config response: %s", response
.json())
3034 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
,
3035 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
,
3037 except Exception as e
:
3038 self
._log
.error("Exception processing the "
3039 "start-network-service: {}".format(e
))
3040 self
._log
.exception(e
)
3041 xact_info
.respond_xpath(rwdts
.XactRspCode
.NACK
,
3042 NsrRpcDtsHandler
.EXEC_NSR_CONF_O_XPATH
)
3045 hdl_ns
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_ns_config_prepare
,)
3047 with self
._dts
.group_create() as group
:
3048 self
._ns
_regh
= group
.register(xpath
=NsrRpcDtsHandler
.EXEC_NSR_CONF_XPATH
,
3050 flags
=rwdts
.Flag
.PUBLISHER
,
3054 class NsrDtsHandler(object):
3055 """ The network service DTS handler """
3056 NSR_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr"
3057 SCALE_INSTANCE_XPATH
= "C,/nsr:ns-instance-config/nsr:nsr/nsr:scaling-group/nsr:instance"
3058 KEY_PAIR_XPATH
= "C,/nsr:key-pair"
3060 def __init__(self
, dts
, log
, loop
, nsm
):
3066 self
._nsr
_regh
= None
3067 self
._scale
_regh
= None
3068 self
._key
_pair
_regh
= None
3072 """ Return the NS manager instance """
3077 """ Register for Nsr create/update/delete/read requests from dts """
3079 def nsr_id_from_keyspec(ks
):
3080 nsr_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr
.schema().keyspec_to_entry(ks
)
3081 nsr_id
= nsr_path_entry
.key00
.id
3084 def group_name_from_keyspec(ks
):
3085 group_path_entry
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
.schema().keyspec_to_entry(ks
)
3086 group_name
= group_path_entry
.key00
.scaling_group_name_ref
3089 def is_instance_in_reg_elements(nsr_id
, group_name
, instance_id
):
3090 """ Return boolean indicating if scaling group instance was already commited previously.
3092 By looking at the existing elements in this registration handle (elements not part
3093 of this current xact), we can tell if the instance was configured previously without
3094 keeping any application state.
3096 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3097 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3098 elem_group_name
= group_name_from_keyspec(keyspec
)
3100 if elem_nsr_id
!= nsr_id
or group_name
!= elem_group_name
:
3103 if instance_cfg
.id == instance_id
:
3108 def get_scale_group_instance_delta(nsr_id
, group_name
, xact
):
3109 delta
= {"added": [], "deleted": []}
3110 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3111 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3112 if elem_nsr_id
!= nsr_id
:
3115 elem_group_name
= group_name_from_keyspec(keyspec
)
3116 if elem_group_name
!= group_name
:
3119 delta
["added"].append(instance_cfg
.id)
3121 for instance_cfg
, keyspec
in self
._scale
_regh
.get_xact_elements(include_keyspec
=True):
3122 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3123 if elem_nsr_id
!= nsr_id
:
3126 elem_group_name
= group_name_from_keyspec(keyspec
)
3127 if elem_group_name
!= group_name
:
3130 if instance_cfg
.id in delta
["added"]:
3131 delta
["added"].remove(instance_cfg
.id)
3133 delta
["deleted"].append(instance_cfg
.id)
3138 def update_nsr_nsd(nsr_id
, xact
, scratch
):
3141 def get_nsr_vl_delta(nsr_id
, xact
, scratch
):
3142 delta
= {"added": [], "deleted": []}
3143 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(xact
, include_keyspec
=True):
3144 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3145 if elem_nsr_id
!= nsr_id
:
3148 if 'vld' in instance_cfg
.nsd
:
3149 for vld
in instance_cfg
.nsd
.vld
:
3150 delta
["added"].append(vld
)
3152 for instance_cfg
, keyspec
in self
._nsr
_regh
.get_xact_elements(include_keyspec
=True):
3153 self
._log
.debug("NSR update: %s", instance_cfg
)
3154 elem_nsr_id
= nsr_id_from_keyspec(keyspec
)
3155 if elem_nsr_id
!= nsr_id
:
3158 if 'vld' in instance_cfg
.nsd
:
3159 for vld
in instance_cfg
.nsd
.vld
:
3160 if vld
in delta
["added"]:
3161 delta
["added"].remove(vld
)
3163 delta
["deleted"].append(vld
)
3167 vl_delta
= yield from get_nsr_vl_delta(nsr_id
, xact
, scratch
)
3168 self
._log
.debug("Got NSR:%s VL instance delta: %s", nsr_id
, vl_delta
)
3170 for vld
in vl_delta
["added"]:
3171 yield from self
._nsm
.nsr_instantiate_vl(nsr_id
, vld
)
3173 for vld
in vl_delta
["deleted"]:
3174 yield from self
._nsm
.nsr_terminate_vl(nsr_id
, vld
)
3176 def get_add_delete_update_cfgs(dts_member_reg
, xact
, key_name
, scratch
):
3177 # Unfortunately, it is currently difficult to figure out what has exactly
3178 # changed in this xact without Pbdelta support (RIFT-4916)
3179 # As a workaround, we can fetch the pre and post xact elements and
3180 # perform a comparison to figure out adds/deletes/updates
3181 xact_cfgs
= list(dts_member_reg
.get_xact_elements(xact
))
3182 curr_cfgs
= list(dts_member_reg
.elements
)
3184 xact_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in xact_cfgs
}
3185 curr_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in curr_cfgs
}
3188 added_keys
= set(xact_key_map
) - set(curr_key_map
)
3189 added_cfgs
= [xact_key_map
[key
] for key
in added_keys
]
3192 deleted_keys
= set(curr_key_map
) - set(xact_key_map
)
3193 deleted_cfgs
= [curr_key_map
[key
] for key
in deleted_keys
]
3196 updated_keys
= set(curr_key_map
) & set(xact_key_map
)
3197 updated_cfgs
= [xact_key_map
[key
] for key
in updated_keys
3198 if xact_key_map
[key
] != curr_key_map
[key
]]
3200 return added_cfgs
, deleted_cfgs
, updated_cfgs
3202 def get_nsr_key_pairs(dts_member_reg
, xact
):
3204 for instance_cfg
, keyspec
in dts_member_reg
.get_xact_elements(xact
, include_keyspec
=True):
3205 self
._log
.debug("Key pair received is {} KS: {}".format(instance_cfg
, keyspec
))
3206 xpath
= keyspec
.to_xpath(RwNsrYang
.get_schema())
3207 key_pairs
[instance_cfg
.name
] = instance_cfg
3210 def on_apply(dts
, acg
, xact
, action
, scratch
):
3211 """Apply the configuration"""
3212 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3213 xact
, action
, scratch
)
3215 def handle_create_nsr(msg
, key_pairs
=None, restart_mode
=False):
3216 # Handle create nsr requests """
3217 # Do some validations
3218 if not msg
.has_field("nsd"):
3219 err
= "NSD not provided"
3220 self
._log
.error(err
)
3221 raise NetworkServiceRecordError(err
)
3223 self
._log
.debug("Creating NetworkServiceRecord %s from nsr config %s",
3224 msg
.id, msg
.as_dict())
3225 nsr
= self
.nsm
.create_nsr(msg
, key_pairs
=key_pairs
, restart_mode
=restart_mode
)
3228 def handle_delete_nsr(msg
):
3230 def delete_instantiation(ns_id
):
3231 """ Delete instantiation """
3232 with self
._dts
.transaction() as xact
:
3233 yield from self
._nsm
.terminate_ns(ns_id
, xact
)
3235 # Handle delete NSR requests
3236 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3237 # Terminate the NSR instance
3238 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3240 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3241 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3242 nsr
.record_event("terminate-rcvd", event_descr
)
3244 self
._loop
.create_task(delete_instantiation(msg
.id))
3247 def begin_instantiation(nsr
):
3248 # Begin instantiation
3249 self
._log
.info("Beginning NS instantiation: %s", nsr
.id)
3250 yield from self
._nsm
.instantiate_ns(nsr
.id, xact
)
3252 self
._log
.debug("Got nsr apply (xact: %s) (action: %s)(scr: %s)",
3253 xact
, action
, scratch
)
3255 if action
== rwdts
.AppconfAction
.INSTALL
and xact
.id is None:
3257 for element
in self
._key
_pair
_regh
.elements
:
3258 key_pairs
.append(element
)
3259 for element
in self
._nsr
_regh
.elements
:
3260 nsr
= handle_create_nsr(element
, key_pairs
, restart_mode
=True)
3261 self
._loop
.create_task(begin_instantiation(nsr
))
3264 (added_msgs
, deleted_msgs
, updated_msgs
) = get_add_delete_update_cfgs(self
._nsr
_regh
,
3268 self
._log
.debug("Added: %s, Deleted: %s, Updated: %s", added_msgs
,
3269 deleted_msgs
, updated_msgs
)
3271 for msg
in added_msgs
:
3272 if msg
.id not in self
._nsm
.nsrs
:
3273 self
._log
.info("Create NSR received in on_apply to instantiate NS:%s", msg
.id)
3274 key_pairs
= get_nsr_key_pairs(self
._key
_pair
_regh
, xact
)
3275 nsr
= handle_create_nsr(msg
,key_pairs
)
3276 self
._loop
.create_task(begin_instantiation(nsr
))
3278 for msg
in deleted_msgs
:
3279 self
._log
.info("Delete NSR received in on_apply to terminate NS:%s", msg
.id)
3281 handle_delete_nsr(msg
)
3283 self
._log
.exception("Failed to terminate NS:%s", msg
.id)
3285 for msg
in updated_msgs
:
3286 self
._log
.info("Update NSR received in on_apply: %s", msg
)
3288 self
._nsm
.nsr_update_cfg(msg
.id, msg
)
3291 self
._loop
.create_task(update_nsr_nsd(msg
.id, xact
, scratch
))
3293 for group
in msg
.scaling_group
:
3294 instance_delta
= get_scale_group_instance_delta(msg
.id, group
.scaling_group_name_ref
, xact
)
3295 self
._log
.debug("Got NSR:%s scale group instance delta: %s", msg
.id, instance_delta
)
3297 for instance_id
in instance_delta
["added"]:
3298 self
._nsm
.scale_nsr_out(msg
.id, group
.scaling_group_name_ref
, instance_id
, xact
)
3300 for instance_id
in instance_delta
["deleted"]:
3301 self
._nsm
.scale_nsr_in(msg
.id, group
.scaling_group_name_ref
, instance_id
)
3304 return RwTypes
.RwStatus
.SUCCESS
3307 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
3308 """ Prepare calllback from DTS for NSR """
3310 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3311 action
= xact_info
.query_action
3313 "Got Nsr prepare callback (xact: %s) (action: %s) (info: %s), %s:%s)",
3314 xact
, action
, xact_info
, xpath
, msg
3318 def delete_instantiation(ns_id
):
3319 """ Delete instantiation """
3320 yield from self
._nsm
.terminate_ns(ns_id
, None)
3322 def handle_delete_nsr():
3323 """ Handle delete NSR requests """
3324 self
._log
.info("Delete req for NSR Id: %s received", msg
.id)
3325 # Terminate the NSR instance
3326 nsr
= self
._nsm
.get_ns_by_nsr_id(msg
.id)
3328 nsr
.set_state(NetworkServiceRecordState
.TERMINATE_RCVD
)
3329 event_descr
= "Terminate rcvd for NS Id:%s" % msg
.id
3330 nsr
.record_event("terminate-rcvd", event_descr
)
3332 self
._loop
.create_task(delete_instantiation(msg
.id))
3334 fref
= ProtobufC
.FieldReference
.alloc()
3335 fref
.goto_whole_message(msg
.to_pbcm())
3337 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
, rwdts
.QueryAction
.DELETE
]:
3338 # if this is an NSR create
3339 if action
!= rwdts
.QueryAction
.DELETE
and msg
.id not in self
._nsm
.nsrs
:
3340 # Ensure the Cloud account/datacenter has been specified
3341 if not msg
.has_field("cloud_account") and not msg
.has_field("om_datacenter"):
3342 raise NsrInstantiationFailed("Cloud account or datacenter not specified in NSR")
3344 # Check if nsd is specified
3345 if not msg
.has_field("nsd"):
3346 raise NsrInstantiationFailed("NSD not specified in NSR")
3349 nsr
= self
._nsm
.nsrs
[msg
.id]
3351 if msg
.has_field("nsd"):
3352 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3353 raise NsrVlUpdateError("Unable to update VL when NSR not in running state")
3354 if 'vld' not in msg
.nsd
or len(msg
.nsd
.vld
) == 0:
3355 raise NsrVlUpdateError("NS config NSD should have atleast 1 VLD defined")
3357 if msg
.has_field("scaling_group"):
3358 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3359 raise ScalingOperationError("Unable to perform scaling action when NS is not in running state")
3361 if len(msg
.scaling_group
) > 1:
3362 raise ScalingOperationError("Only a single scaling group can be configured at a time")
3364 for group_msg
in msg
.scaling_group
:
3365 num_new_group_instances
= len(group_msg
.instance
)
3366 if num_new_group_instances
> 1:
3367 raise ScalingOperationError("Only a single scaling instance can be modified at a time")
3369 elif num_new_group_instances
== 1:
3370 scale_group
= nsr
.scaling_groups
[group_msg
.scaling_group_name_ref
]
3371 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
]:
3372 if len(scale_group
.instances
) == scale_group
.max_instance_count
:
3373 raise ScalingOperationError("Max instances for %s reached" % scale_group
)
3375 acg
.handle
.prepare_complete_ok(xact_info
.handle
)
3378 self
._log
.debug("Registering for NSR config using xpath: %s",
3379 NsrDtsHandler
.NSR_XPATH
)
3381 acg_hdl
= rift
.tasklets
.AppConfGroup
.Handler(on_apply
=on_apply
)
3382 with self
._dts
.appconf_group_create(handler
=acg_hdl
) as acg
:
3383 self
._nsr
_regh
= acg
.register(xpath
=NsrDtsHandler
.NSR_XPATH
,
3384 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
3385 on_prepare
=on_prepare
)
3387 self
._scale
_regh
= acg
.register(
3388 xpath
=NsrDtsHandler
.SCALE_INSTANCE_XPATH
,
3389 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY| rwdts
.Flag
.CACHE
,
3392 self
._key
_pair
_regh
= acg
.register(
3393 xpath
=NsrDtsHandler
.KEY_PAIR_XPATH
,
3394 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
3398 class NsrOpDataDtsHandler(object):
3399 """ The network service op data DTS handler """
3400 XPATH
= "D,/nsr:ns-instance-opdata/nsr:nsr"
3402 def __init__(self
, dts
, log
, loop
, nsm
):
3411 """ Return the registration handle"""
3416 """ Return the NS manager instance """
3421 """ Register for Nsr op data publisher registration"""
3422 self
._log
.debug("Registering Nsr op data path %s as publisher",
3423 NsrOpDataDtsHandler
.XPATH
)
3425 hdl
= rift
.tasklets
.DTS
.RegistrationHandler()
3426 handlers
= rift
.tasklets
.Group
.Handler()
3427 with self
._dts
.group_create(handler
=handlers
) as group
:
3428 self
._regh
= group
.register(xpath
=NsrOpDataDtsHandler
.XPATH
,
3430 flags
=rwdts
.Flag
.PUBLISHER | rwdts
.Flag
.NO_PREP_READ | rwdts
.Flag
.DATASTORE
)
3433 def create(self
, path
, msg
):
3435 Create an NS record in DTS with the path and message
3437 self
._log
.debug("Creating NSR %s:%s", path
, msg
)
3438 self
.regh
.create_element(path
, msg
)
3439 self
._log
.debug("Created NSR, %s:%s", path
, msg
)
3442 def update(self
, path
, msg
, flags
=rwdts
.XactFlag
.REPLACE
):
3444 Update an NS record in DTS with the path and message
3446 self
._log
.debug("Updating NSR, %s:%s regh = %s", path
, msg
, self
.regh
)
3447 self
.regh
.update_element(path
, msg
, flags
)
3448 self
._log
.debug("Updated NSR, %s:%s", path
, msg
)
3451 def delete(self
, path
):
3453 Update an NS record in DTS with the path and message
3455 self
._log
.debug("Deleting NSR path:%s", path
)
3456 self
.regh
.delete_element(path
)
3457 self
._log
.debug("Deleted NSR path:%s", path
)
3460 class VnfrDtsHandler(object):
3461 """ The virtual network service DTS handler """
3462 XPATH
= "D,/vnfr:vnfr-catalog/vnfr:vnfr"
3464 def __init__(self
, dts
, log
, loop
, nsm
):
3474 """ Return registration handle """
3479 """ Return the NS manager instance """
3484 """ Register for vnfr create/update/delete/ advises from dts """
3486 def on_commit(xact_info
):
3487 """ The transaction has been committed """
3488 self
._log
.debug("Got vnfr commit (xact_info: %s)", xact_info
)
3489 return rwdts
.MemberRspCode
.ACTION_OK
3492 def on_prepare(xact_info
, action
, ks_path
, msg
):
3493 """ prepare callback from dts """
3494 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3496 "Got vnfr on_prepare cb (xact_info: %s, action: %s): %s:%s",
3497 xact_info
, action
, ks_path
, msg
3500 schema
= VnfrYang
.YangData_Vnfr_VnfrCatalog_Vnfr
.schema()
3501 path_entry
= schema
.keyspec_to_entry(ks_path
)
3502 if path_entry
.key00
.id not in self
._nsm
._vnfrs
:
3503 self
._log
.error("%s request for non existent record path %s",
3505 xact_info
.respond_xpath(rwdts
.XactRspCode
.NA
, xpath
)
3509 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3510 if action
== rwdts
.QueryAction
.CREATE
or action
== rwdts
.QueryAction
.UPDATE
:
3511 yield from self
._nsm
.update_vnfr(msg
)
3512 elif action
== rwdts
.QueryAction
.DELETE
:
3513 self
._log
.debug("Deleting VNFR with id %s", path_entry
.key00
.id)
3514 self
._nsm
.delete_vnfr(path_entry
.key00
.id)
3516 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
, xpath
)
3518 self
._log
.debug("Registering for VNFR using xpath: %s",
3519 VnfrDtsHandler
.XPATH
,)
3521 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_commit
=on_commit
,
3522 on_prepare
=on_prepare
,)
3523 with self
._dts
.group_create() as group
:
3524 self
._regh
= group
.register(xpath
=VnfrDtsHandler
.XPATH
,
3526 flags
=(rwdts
.Flag
.SUBSCRIBER
),)
3529 class NsdRefCountDtsHandler(object):
3530 """ The NSD Ref Count DTS handler """
3531 XPATH
= "D,/nsr:ns-instance-opdata/rw-nsr:nsd-ref-count"
3533 def __init__(self
, dts
, log
, loop
, nsm
):
3543 """ Return registration handle """
3548 """ Return the NS manager instance """
3553 """ Register for NSD ref count read from dts """
3556 def on_prepare(xact_info
, action
, ks_path
, msg
):
3557 """ prepare callback from dts """
3558 xpath
= ks_path
.to_xpath(RwNsrYang
.get_schema())
3560 if action
== rwdts
.QueryAction
.READ
:
3561 schema
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount
.schema()
3562 path_entry
= schema
.keyspec_to_entry(ks_path
)
3563 nsd_list
= yield from self
._nsm
.get_nsd_refcount(path_entry
.key00
.nsd_id_ref
)
3564 for xpath
, msg
in nsd_list
:
3565 xact_info
.respond_xpath(rsp_code
=rwdts
.XactRspCode
.MORE
,
3568 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
3570 raise NetworkServiceRecordError("Not supported operation %s" % action
)
3572 hdl
= rift
.tasklets
.DTS
.RegistrationHandler(on_prepare
=on_prepare
,)
3573 with self
._dts
.group_create() as group
:
3574 self
._regh
= group
.register(xpath
=NsdRefCountDtsHandler
.XPATH
,
3576 flags
=rwdts
.Flag
.PUBLISHER
,)
3579 class NsManager(object):
3580 """ The Network Service Manager class"""
3581 def __init__(self
, dts
, log
, loop
,
3582 nsr_handler
, vnfr_handler
, vlr_handler
, ro_plugin_selector
,
3583 vnffgmgr
, vnfd_pub_handler
, cloud_account_handler
):
3587 self
._nsr
_handler
= nsr_handler
3588 self
._vnfr
_pub
_handler
= vnfr_handler
3589 self
._vlr
_pub
_handler
= vlr_handler
3590 self
._vnffgmgr
= vnffgmgr
3591 self
._vnfd
_pub
_handler
= vnfd_pub_handler
3592 self
._cloud
_account
_handler
= cloud_account_handler
3594 self
._ro
_plugin
_selector
= ro_plugin_selector
3595 self
._ncclient
= rift
.mano
.ncclient
.NcClient(
3607 self
.cfgmgr_obj
= conman
.ROConfigManager(log
, loop
, dts
, self
)
3609 # TODO: All these handlers should move to tasklet level.
3610 # Passing self is often an indication of bad design
3611 self
._nsd
_dts
_handler
= NsdDtsHandler(dts
, log
, loop
, self
)
3612 self
._vnfd
_dts
_handler
= VnfdDtsHandler(dts
, log
, loop
, self
)
3613 self
._dts
_handlers
= [self
._nsd
_dts
_handler
,
3614 VnfrDtsHandler(dts
, log
, loop
, self
),
3615 NsdRefCountDtsHandler(dts
, log
, loop
, self
),
3616 NsrDtsHandler(dts
, log
, loop
, self
),
3617 ScalingRpcHandler(log
, dts
, loop
, self
.scale_rpc_callback
),
3618 NsrRpcDtsHandler(dts
,log
,loop
,self
),
3619 self
._vnfd
_dts
_handler
,
3640 def nsr_handler(self
):
3641 """" NSR handler """
3642 return self
._nsr
_handler
3646 """" So Obj handler """
3651 """ NSRs in this NSM"""
3656 """ NSDs in this NSM"""
3661 """ VNFDs in this NSM"""
3666 """ VNFRs in this NSM"""
3670 def nsr_pub_handler(self
):
3671 """ NSR publication handler """
3672 return self
._nsr
_handler
3675 def vnfr_pub_handler(self
):
3676 """ VNFR publication handler """
3677 return self
._vnfr
_pub
_handler
3680 def vlr_pub_handler(self
):
3681 """ VLR publication handler """
3682 return self
._vlr
_pub
_handler
3685 def vnfd_pub_handler(self
):
3686 return self
._vnfd
_pub
_handler
3690 """ Register all static DTS handlers """
3691 for dts_handle
in self
._dts
_handlers
:
3692 yield from dts_handle
.register()
3695 def get_ns_by_nsr_id(self
, nsr_id
):
3696 """ get NSR by nsr id """
3697 if nsr_id
not in self
._nsrs
:
3698 raise NetworkServiceRecordError("NSR id %s not found" % nsr_id
)
3700 return self
._nsrs
[nsr_id
]
3702 def scale_nsr_out(self
, nsr_id
, scale_group_name
, instance_id
, config_xact
):
3703 self
.log
.debug("Scale out NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3708 nsr
= self
._nsrs
[nsr_id
]
3709 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3710 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3712 self
._loop
.create_task(nsr
.create_scale_group_instance(scale_group_name
, instance_id
, config_xact
))
3714 def scale_nsr_in(self
, nsr_id
, scale_group_name
, instance_id
):
3715 self
.log
.debug("Scale in NetworkServiceRecord (nsr_id: %s) (scaling group: %s) (instance_id: %s)",
3720 nsr
= self
._nsrs
[nsr_id
]
3721 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3722 raise ScalingOperationError("Cannot perform scaling operation if NSR is not in running state")
3724 self
._loop
.create_task(nsr
.delete_scale_group_instance(scale_group_name
, instance_id
))
3726 def scale_rpc_callback(self
, xact
, msg
, action
):
3727 """Callback handler for RPC calls
3729 xact : Transaction Handler
3731 action : Scaling Action
3733 ScalingGroupInstance
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup_Instance
3734 ScalingGroup
= NsrYang
.YangData_Nsr_NsInstanceConfig_Nsr_ScalingGroup
3736 xpath
= ('C,/nsr:ns-instance-config/nsr:nsr[nsr:id="{}"]').format(
3738 instance
= ScalingGroupInstance
.from_dict({"id": msg
.instance_id
})
3741 def get_nsr_scaling_group():
3742 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3744 for result
in results
:
3745 res
= yield from result
3746 nsr_config
= res
.result
3748 for scaling_group
in nsr_config
.scaling_group
:
3749 if scaling_group
.scaling_group_name_ref
== msg
.scaling_group_name_ref
:
3752 scaling_group
= nsr_config
.scaling_group
.add()
3753 scaling_group
.scaling_group_name_ref
= msg
.scaling_group_name_ref
3755 return (nsr_config
, scaling_group
)
3758 def update_config(nsr_config
):
3759 xml
= self
._ncclient
.convert_to_xml(RwNsrYang
, nsr_config
)
3760 xml
= '<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0">{}</config>'.format(xml
)
3761 yield from self
._ncclient
.connect()
3762 yield from self
._ncclient
.manager
.edit_config(target
="running", config
=xml
, default_operation
="replace")
3766 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3767 scaling_group
.instance
.append(instance
)
3768 yield from update_config(nsr_config
)
3772 nsr_config
, scaling_group
= yield from get_nsr_scaling_group()
3773 scaling_group
.instance
.remove(instance
)
3774 yield from update_config(nsr_config
)
3776 if action
== ScalingRpcHandler
.ACTION
.SCALE_OUT
:
3777 self
._loop
.create_task(scale_out())
3779 self
._loop
.create_task(scale_in())
3781 # Opdata based calls, disabled for now!
3782 # if action == ScalingRpcHandler.ACTION.SCALE_OUT:
3783 # self.scale_nsr_out(
3785 # msg.scaling_group_name_ref,
3789 # self.scale_nsr_in(
3791 # msg.scaling_group_name_ref,
3794 def nsr_update_cfg(self
, nsr_id
, msg
):
3795 nsr
= self
._nsrs
[nsr_id
]
3796 nsr
.nsr_cfg_msg
= msg
3798 def nsr_instantiate_vl(self
, nsr_id
, vld
):
3799 self
.log
.debug("NSR {} create VL {}".format(nsr_id
, vld
))
3800 nsr
= self
._nsrs
[nsr_id
]
3801 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3802 raise NsrVlUpdateError("Cannot perform VL instantiate if NSR is not in running state")
3804 # Not calling in a separate task as this is called from a separate task
3805 yield from nsr
.create_vl_instance(vld
)
3807 def nsr_terminate_vl(self
, nsr_id
, vld
):
3808 self
.log
.debug("NSR {} delete VL {}".format(nsr_id
, vld
.id))
3809 nsr
= self
._nsrs
[nsr_id
]
3810 if nsr
.state
!= NetworkServiceRecordState
.RUNNING
:
3811 raise NsrVlUpdateError("Cannot perform VL terminate if NSR is not in running state")
3813 # Not calling in a separate task as this is called from a separate task
3814 yield from nsr
.delete_vl_instance(vld
)
3816 def create_nsr(self
, nsr_msg
, key_pairs
=None,restart_mode
=False):
3817 """ Create an NSR instance """
3818 if nsr_msg
.id in self
._nsrs
:
3819 msg
= "NSR id %s already exists" % nsr_msg
.id
3820 self
._log
.error(msg
)
3821 raise NetworkServiceRecordError(msg
)
3823 self
._log
.info("Create NetworkServiceRecord nsr id %s from nsd_id %s",
3827 nsm_plugin
= self
._ro
_plugin
_selector
.ro_plugin
3828 sdn_account_name
= self
._cloud
_account
_handler
.get_cloud_account_sdn_name(nsr_msg
.cloud_account
)
3830 nsr
= NetworkServiceRecord(self
._dts
,
3838 restart_mode
=restart_mode
3840 self
._nsrs
[nsr_msg
.id] = nsr
3841 nsm_plugin
.create_nsr(nsr_msg
, nsr_msg
.nsd
, key_pairs
)
3845 def delete_nsr(self
, nsr_id
):
3847 Delete NSR with the passed nsr id
3849 del self
._nsrs
[nsr_id
]
3852 def instantiate_ns(self
, nsr_id
, config_xact
):
3853 """ Instantiate an NS instance """
3854 self
._log
.debug("Instantiating Network service id %s", nsr_id
)
3855 if nsr_id
not in self
._nsrs
:
3856 err
= "NSR id %s not found " % nsr_id
3857 self
._log
.error(err
)
3858 raise NetworkServiceRecordError(err
)
3860 nsr
= self
._nsrs
[nsr_id
]
3861 yield from nsr
.nsm_plugin
.instantiate_ns(nsr
, config_xact
)
3864 def update_vnfr(self
, vnfr
):
3865 """Create/Update an VNFR """
3867 vnfr_state
= self
._vnfrs
[vnfr
.id].state
3868 self
._log
.debug("Updating VNFR with state %s: vnfr %s", vnfr_state
, vnfr
)
3870 yield from self
._vnfrs
[vnfr
.id].update_state(vnfr
)
3871 nsr
= self
.find_nsr_for_vnfr(vnfr
.id)
3872 yield from nsr
.update_state()
3874 def find_nsr_for_vnfr(self
, vnfr_id
):
3875 """ Find the NSR which )has the passed vnfr id"""
3876 for nsr
in list(self
.nsrs
.values()):
3877 for vnfr
in list(nsr
.vnfrs
.values()):
3878 if vnfr
.id == vnfr_id
:
3882 def delete_vnfr(self
, vnfr_id
):
3883 """ Delete VNFR with the passed id"""
3884 del self
._vnfrs
[vnfr_id
]
3886 def get_nsd_ref(self
, nsd_id
):
3887 """ Get network service descriptor for the passed nsd_id
3889 nsd
= self
.get_nsd(nsd_id
)
3894 def get_nsr_config(self
, nsd_id
):
3895 xpath
= "C,/nsr:ns-instance-config"
3896 results
= yield from self
._dts
.query_read(xpath
, rwdts
.XactFlag
.MERGE
)
3898 for result
in results
:
3899 entry
= yield from result
3900 ns_instance_config
= entry
.result
3902 for nsr
in ns_instance_config
.nsr
:
3903 if nsr
.nsd
.id == nsd_id
:
3909 def nsd_unref_by_nsr_id(self
, nsr_id
):
3910 """ Unref the network service descriptor based on NSR id """
3911 self
._log
.debug("NSR Unref called for Nsr Id:%s", nsr_id
)
3912 if nsr_id
in self
._nsrs
:
3913 nsr
= self
._nsrs
[nsr_id
]
3916 nsd
= self
.get_nsd(nsr
.nsd_id
)
3917 self
._log
.debug("Releasing ref on NSD %s held by NSR %s - Curr %d",
3918 nsd
.id, nsr
.id, nsd
.ref_count
)
3920 except NetworkServiceDescriptorError
:
3921 # We store a copy of NSD in NSR and the NSD in nsd-catalog
3926 self
._log
.error("Cannot find NSR with id %s", nsr_id
)
3927 raise NetworkServiceDescriptorUnrefError("No NSR with id" % nsr_id
)
3930 def nsd_unref(self
, nsd_id
):
3931 """ Unref the network service descriptor associated with the id """
3932 nsd
= self
.get_nsd(nsd_id
)
3935 def get_nsd(self
, nsd_id
):
3936 """ Get network service descriptor for the passed nsd_id"""
3937 if nsd_id
not in self
._nsds
:
3938 self
._log
.error("Cannot find NSD id:%s", nsd_id
)
3939 raise NetworkServiceDescriptorError("Cannot find NSD id:%s", nsd_id
)
3941 return self
._nsds
[nsd_id
]
3943 def create_nsd(self
, nsd_msg
):
3944 """ Create a network service descriptor """
3945 self
._log
.debug("Create network service descriptor - %s", nsd_msg
)
3946 if nsd_msg
.id in self
._nsds
:
3947 self
._log
.error("Cannot create NSD %s -NSD ID already exists", nsd_msg
)
3948 raise NetworkServiceDescriptorError("NSD already exists-%s", nsd_msg
.id)
3950 nsd
= NetworkServiceDescriptor(
3957 self
._nsds
[nsd_msg
.id] = nsd
3961 def update_nsd(self
, nsd
):
3962 """ update the Network service descriptor """
3963 self
._log
.debug("Update network service descriptor - %s", nsd
)
3964 if nsd
.id not in self
._nsds
:
3965 self
._log
.debug("No NSD found - creating NSD id = %s", nsd
.id)
3966 self
.create_nsd(nsd
)
3968 self
._log
.debug("Updating NSD id = %s, nsd = %s", nsd
.id, nsd
)
3969 self
._nsds
[nsd
.id].update(nsd
)
3971 def delete_nsd(self
, nsd_id
):
3972 """ Delete the Network service descriptor with the passed id """
3973 self
._log
.debug("Deleting the network service descriptor - %s", nsd_id
)
3974 if nsd_id
not in self
._nsds
:
3975 self
._log
.debug("Delete NSD failed - cannot find nsd-id %s", nsd_id
)
3976 raise NetworkServiceDescriptorNotFound("Cannot find %s", nsd_id
)
3978 if nsd_id
not in self
._nsds
:
3979 self
._log
.debug("Cannot delete NSD id %s reference exists %s",
3981 self
._nsds
[nsd_id
].ref_count
)
3982 raise NetworkServiceDescriptorRefCountExists(
3983 "Cannot delete :%s, ref_count:%s",
3985 self
._nsds
[nsd_id
].ref_count
)
3987 del self
._nsds
[nsd_id
]
3989 def get_vnfd_config(self
, xact
):
3990 vnfd_dts_reg
= self
._vnfd
_dts
_handler
.regh
3991 for cfg
in vnfd_dts_reg
.get_xact_elements(xact
):
3992 if cfg
.id not in self
._vnfds
:
3993 self
.create_vnfd(cfg
)
3995 def get_vnfd(self
, vnfd_id
, xact
):
3996 """ Get virtual network function descriptor for the passed vnfd_id"""
3997 if vnfd_id
not in self
._vnfds
:
3998 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
3999 self
.get_vnfd_config(xact
)
4001 if vnfd_id
not in self
._vnfds
:
4002 self
._log
.error("Cannot find VNFD id:%s", vnfd_id
)
4003 raise VnfDescriptorError("Cannot find VNFD id:%s", vnfd_id
)
4005 return self
._vnfds
[vnfd_id
]
4007 def create_vnfd(self
, vnfd
):
4008 """ Create a virtual network function descriptor """
4009 self
._log
.debug("Create virtual network function descriptor - %s", vnfd
)
4010 if vnfd
.id in self
._vnfds
:
4011 self
._log
.error("Cannot create VNFD %s -VNFD ID already exists", vnfd
)
4012 raise VnfDescriptorError("VNFD already exists-%s", vnfd
.id)
4014 self
._vnfds
[vnfd
.id] = vnfd
4015 return self
._vnfds
[vnfd
.id]
4017 def update_vnfd(self
, vnfd
):
4018 """ Update the virtual network function descriptor """
4019 self
._log
.debug("Update virtual network function descriptor- %s", vnfd
)
4022 if vnfd
.id not in self
._vnfds
:
4023 self
._log
.debug("No VNFD found - creating VNFD id = %s", vnfd
.id)
4024 self
.create_vnfd(vnfd
)
4026 self
._log
.debug("Updating VNFD id = %s, vnfd = %s", vnfd
.id, vnfd
)
4027 self
._vnfds
[vnfd
.id] = vnfd
4030 def delete_vnfd(self
, vnfd_id
):
4031 """ Delete the virtual network function descriptor with the passed id """
4032 self
._log
.debug("Deleting the virtual network function descriptor - %s", vnfd_id
)
4033 if vnfd_id
not in self
._vnfds
:
4034 self
._log
.debug("Delete VNFD failed - cannot find vnfd-id %s", vnfd_id
)
4035 raise VnfDescriptorError("Cannot find %s", vnfd_id
)
4037 del self
._vnfds
[vnfd_id
]
4039 def nsd_in_use(self
, nsd_id
):
4040 """ Is the NSD with the passed id in use """
4041 self
._log
.debug("Is this NSD in use - msg:%s", nsd_id
)
4042 if nsd_id
in self
._nsds
:
4043 return self
._nsds
[nsd_id
].in_use()
4047 def publish_nsr(self
, xact
, path
, msg
):
4048 """ Publish a NSR """
4049 self
._log
.debug("Publish NSR with path %s, msg %s",
4051 yield from self
.nsr_handler
.update(xact
, path
, msg
)
4054 def unpublish_nsr(self
, xact
, path
):
4055 """ Un Publish an NSR """
4056 self
._log
.debug("Publishing delete NSR with path %s", path
)
4057 yield from self
.nsr_handler
.delete(path
, xact
)
4059 def vnfr_is_ready(self
, vnfr_id
):
4060 """ VNFR with the id is ready """
4061 self
._log
.debug("VNFR id %s ready", vnfr_id
)
4062 if vnfr_id
not in self
._vnfds
:
4063 err
= "Did not find VNFR ID with id %s" % vnfr_id
4064 self
._log
.critical("err")
4065 raise VirtualNetworkFunctionRecordError(err
)
4066 self
._vnfrs
[vnfr_id
].is_ready()
4069 def get_nsd_refcount(self
, nsd_id
):
4070 """ Get the nsd_list from this NSM"""
4072 def nsd_refcount_xpath(nsd_id
):
4073 """ xpath for ref count entry """
4074 return (NsdRefCountDtsHandler
.XPATH
+
4075 "[rw-nsr:nsd-id-ref = '{}']").format(nsd_id
)
4078 if nsd_id
is None or nsd_id
== "":
4079 for nsd
in self
._nsds
.values():
4080 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4081 nsd_msg
.nsd_id_ref
= nsd
.id
4082 nsd_msg
.instance_ref_count
= nsd
.ref_count
4083 nsd_list
.append((nsd_refcount_xpath(nsd
.id), nsd_msg
))
4084 elif nsd_id
in self
._nsds
:
4085 nsd_msg
= RwNsrYang
.YangData_Nsr_NsInstanceOpdata_NsdRefCount()
4086 nsd_msg
.nsd_id_ref
= self
._nsds
[nsd_id
].id
4087 nsd_msg
.instance_ref_count
= self
._nsds
[nsd_id
].ref_count
4088 nsd_list
.append((nsd_refcount_xpath(nsd_id
), nsd_msg
))
4093 def terminate_ns(self
, nsr_id
, xact
):
4095 Terminate network service for the given NSR Id
4098 # Terminate the instances/networks assocaited with this nw service
4099 self
._log
.debug("Terminating the network service %s", nsr_id
)
4100 yield from self
._nsrs
[nsr_id
].terminate()
4103 yield from self
.nsd_unref_by_nsr_id(nsr_id
)
4105 # Unpublish the NSR record
4106 self
._log
.debug("Unpublishing the network service %s", nsr_id
)
4107 yield from self
._nsrs
[nsr_id
].unpublish(xact
)
4109 # Finaly delete the NS instance from this NS Manager
4110 self
._log
.debug("Deletng the network service %s", nsr_id
)
4111 self
.delete_nsr(nsr_id
)
4114 class NsmRecordsPublisherProxy(object):
4115 """ This class provides a publisher interface that allows plugin objects
4116 to publish NSR/VNFR/VLR"""
4118 def __init__(self
, dts
, log
, loop
, nsr_pub_hdlr
, vnfr_pub_hdlr
, vlr_pub_hdlr
):
4122 self
._nsr
_pub
_hdlr
= nsr_pub_hdlr
4123 self
._vlr
_pub
_hdlr
= vlr_pub_hdlr
4124 self
._vnfr
_pub
_hdlr
= vnfr_pub_hdlr
4127 def publish_nsr(self
, xact
, nsr
):
4128 """ Publish an NSR """
4129 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4130 return (yield from self
._nsr
_pub
_hdlr
.update(xact
, path
, nsr
))
4133 def unpublish_nsr(self
, xact
, nsr
):
4134 """ Unpublish an NSR """
4135 path
= NetworkServiceRecord
.xpath_from_nsr(nsr
)
4136 return (yield from self
._nsr
_pub
_hdlr
.delete(xact
, path
))
4139 def publish_vnfr(self
, xact
, vnfr
):
4140 """ Publish an VNFR """
4141 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4142 return (yield from self
._vnfr
_pub
_hdlr
.update(xact
, path
, vnfr
))
4145 def unpublish_vnfr(self
, xact
, vnfr
):
4146 """ Unpublish a VNFR """
4147 path
= VirtualNetworkFunctionRecord
.vnfr_xpath(vnfr
)
4148 return (yield from self
._vnfr
_pub
_hdlr
.delete(xact
, path
))
4151 def publish_vlr(self
, xact
, vlr
):
4152 """ Publish a VLR """
4153 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4154 return (yield from self
._vlr
_pub
_hdlr
.update(xact
, path
, vlr
))
4157 def unpublish_vlr(self
, xact
, vlr
):
4158 """ Unpublish a VLR """
4159 path
= VirtualLinkRecord
.vlr_xpath(vlr
)
4160 return (yield from self
._vlr
_pub
_hdlr
.delete(xact
, path
))
4163 class ScalingRpcHandler(mano_dts
.DtsHandler
):
4164 """ The Network service Monitor DTS handler """
4165 SCALE_IN_INPUT_XPATH
= "I,/nsr:exec-scale-in"
4166 SCALE_IN_OUTPUT_XPATH
= "O,/nsr:exec-scale-in"
4168 SCALE_OUT_INPUT_XPATH
= "I,/nsr:exec-scale-out"
4169 SCALE_OUT_OUTPUT_XPATH
= "O,/nsr:exec-scale-out"
4171 ACTION
= Enum('ACTION', 'SCALE_IN SCALE_OUT')
4173 def __init__(self
, log
, dts
, loop
, callback
=None):
4174 super().__init
__(log
, dts
, loop
)
4175 self
.callback
= callback
4176 self
.last_instance_id
= defaultdict(int)
4182 def on_scale_in_prepare(xact_info
, action
, ks_path
, msg
):
4183 assert action
== rwdts
.QueryAction
.RPC
4187 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_IN
)
4189 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleIn
.from_dict({
4190 "instance_id": msg
.instance_id
})
4192 xact_info
.respond_xpath(
4193 rwdts
.XactRspCode
.ACK
,
4194 self
.__class
__.SCALE_IN_OUTPUT_XPATH
,
4197 except Exception as e
:
4198 self
.log
.exception(e
)
4199 xact_info
.respond_xpath(
4200 rwdts
.XactRspCode
.NACK
,
4201 self
.__class
__.SCALE_IN_OUTPUT_XPATH
)
4204 def on_scale_out_prepare(xact_info
, action
, ks_path
, msg
):
4205 assert action
== rwdts
.QueryAction
.RPC
4208 scaling_group
= msg
.scaling_group_name_ref
4209 if not msg
.instance_id
:
4210 last_instance_id
= self
.last_instance_id
[scale_group
]
4211 msg
.instance_id
= last_instance_id
+ 1
4212 self
.last_instance_id
[scale_group
] += 1
4215 self
.callback(xact_info
.xact
, msg
, self
.ACTION
.SCALE_OUT
)
4217 rpc_op
= NsrYang
.YangOutput_Nsr_ExecScaleOut
.from_dict({
4218 "instance_id": msg
.instance_id
})
4220 xact_info
.respond_xpath(
4221 rwdts
.XactRspCode
.ACK
,
4222 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
,
4225 except Exception as e
:
4226 self
.log
.exception(e
)
4227 xact_info
.respond_xpath(
4228 rwdts
.XactRspCode
.NACK
,
4229 self
.__class
__.SCALE_OUT_OUTPUT_XPATH
)
4231 scale_in_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4232 on_prepare
=on_scale_in_prepare
)
4233 scale_out_hdl
= rift
.tasklets
.DTS
.RegistrationHandler(
4234 on_prepare
=on_scale_out_prepare
)
4236 with self
.dts
.group_create() as group
:
4238 xpath
=self
.__class
__.SCALE_IN_INPUT_XPATH
,
4239 handler
=scale_in_hdl
,
4240 flags
=rwdts
.Flag
.PUBLISHER
)
4242 xpath
=self
.__class
__.SCALE_OUT_INPUT_XPATH
,
4243 handler
=scale_out_hdl
,
4244 flags
=rwdts
.Flag
.PUBLISHER
)
4247 class NsmTasklet(rift
.tasklets
.Tasklet
):
4249 The network service manager tasklet
4251 def __init__(self
, *args
, **kwargs
):
4252 super(NsmTasklet
, self
).__init
__(*args
, **kwargs
)
4253 self
.rwlog
.set_category("rw-mano-log")
4254 self
.rwlog
.set_subcategory("nsm")
4259 self
._ro
_plugin
_selector
= None
4260 self
._vnffgmgr
= None
4262 self
._nsr
_handler
= None
4263 self
._vnfr
_pub
_handler
= None
4264 self
._vlr
_pub
_handler
= None
4265 self
._vnfd
_pub
_handler
= None
4266 self
._scale
_cfg
_handler
= None
4268 self
._records
_publisher
_proxy
= None
4271 """ The task start callback """
4272 super(NsmTasklet
, self
).start()
4273 self
.log
.info("Starting NsmTasklet")
4275 self
.log
.debug("Registering with dts")
4276 self
._dts
= rift
.tasklets
.DTS(self
.tasklet_info
,
4277 RwNsmYang
.get_schema(),
4279 self
.on_dts_state_change
)
4281 self
.log
.debug("Created DTS Api GI Object: %s", self
._dts
)
4287 print("Caught Exception in NSM stop:", sys
.exc_info()[0])
4290 def on_instance_started(self
):
4291 """ Task instance started callback """
4292 self
.log
.debug("Got instance started callback")
4296 """ Task init callback """
4297 self
.log
.debug("Got instance started callback")
4299 self
.log
.debug("creating config account handler")
4301 self
._nsr
_pub
_handler
= publisher
.NsrOpDataDtsHandler(self
._dts
, self
.log
, self
.loop
)
4302 yield from self
._nsr
_pub
_handler
.register()
4304 self
._vnfr
_pub
_handler
= publisher
.VnfrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4305 yield from self
._vnfr
_pub
_handler
.register()
4307 self
._vlr
_pub
_handler
= publisher
.VlrPublisherDtsHandler(self
._dts
, self
.log
, self
.loop
)
4308 yield from self
._vlr
_pub
_handler
.register()
4310 manifest
= self
.tasklet_info
.get_pb_manifest()
4311 use_ssl
= manifest
.bootstrap_phase
.rwsecurity
.use_ssl
4312 ssl_cert
= manifest
.bootstrap_phase
.rwsecurity
.cert
4313 ssl_key
= manifest
.bootstrap_phase
.rwsecurity
.key
4315 self
._vnfd
_pub
_handler
= publisher
.VnfdPublisher(use_ssl
, ssl_cert
, ssl_key
, self
.loop
)
4317 self
._records
_publisher
_proxy
= NsmRecordsPublisherProxy(
4321 self
._nsr
_pub
_handler
,
4322 self
._vnfr
_pub
_handler
,
4323 self
._vlr
_pub
_handler
,
4326 # Register the NSM to receive the nsm plugin
4327 # when cloud account is configured
4328 self
._ro
_plugin
_selector
= cloud
.ROAccountPluginSelector(
4332 self
._records
_publisher
_proxy
,
4334 yield from self
._ro
_plugin
_selector
.register()
4336 self
._cloud
_account
_handler
= cloud
.CloudAccountConfigSubscriber(
4341 yield from self
._cloud
_account
_handler
.register()
4343 self
._vnffgmgr
= rwvnffgmgr
.VnffgMgr(self
._dts
, self
.log
, self
.log_hdl
, self
.loop
)
4344 yield from self
._vnffgmgr
.register()
4346 self
._nsm
= NsManager(
4350 self
._nsr
_pub
_handler
,
4351 self
._vnfr
_pub
_handler
,
4352 self
._vlr
_pub
_handler
,
4353 self
._ro
_plugin
_selector
,
4355 self
._vnfd
_pub
_handler
,
4356 self
._cloud
_account
_handler
4359 yield from self
._nsm
.register()
4363 """ Task run callback """
4367 def on_dts_state_change(self
, state
):
4368 """Take action according to current dts state to transition
4369 application into the corresponding application state
4372 state - current dts state
4375 rwdts
.State
.INIT
: rwdts
.State
.REGN_COMPLETE
,
4376 rwdts
.State
.CONFIG
: rwdts
.State
.RUN
,
4380 rwdts
.State
.INIT
: self
.init
,
4381 rwdts
.State
.RUN
: self
.run
,
4384 # Transition application to next state
4385 handler
= handlers
.get(state
, None)
4386 if handler
is not None:
4387 yield from handler()
4389 # Transition dts to next state
4390 next_state
= switch
.get(state
, None)
4391 if next_state
is not None:
4392 self
.log
.debug("Changing state to %s", next_state
)
4393 self
._dts
.handle
.set_state(next_state
)