4 # Copyright 2016 RIFT.IO Inc
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
29 gi
.require_version('RwYang', '1.0')
30 gi
.require_version('RwVnfdYang', '1.0')
31 gi
.require_version('RwNsdYang', '1.0')
33 from gi
.repository
import (
39 import rift
.package
.store
40 import rift
.package
.cloud_init
42 logger
= logging
.getLogger("rift2openmano.py")
45 class VNFNotFoundError(Exception):
49 class RiftNSD(object):
50 model
= RwYang
.Model
.create_libncx()
51 model
.load_module('nsd')
52 model
.load_module('rw-nsd')
54 def __init__(self
, descriptor
):
55 self
._nsd
= descriptor
70 return [c
.vnfd_id_ref
for c
in self
._nsd
.constituent_vnfd
]
73 def constituent_vnfds(self
):
74 return self
._nsd
.constituent_vnfd
82 return self
._nsd
.connection_point
85 def description(self
):
86 return self
._nsd
.description
89 def from_xml_file_hdl(cls
, hdl
):
91 descriptor
= RwNsdYang
.YangData_Nsd_NsdCatalog_Nsd()
92 descriptor
.from_xml_v2(RiftNSD
.model
, hdl
.read())
93 return cls(descriptor
)
96 def from_yaml_file_hdl(cls
, hdl
):
98 descriptor
= RwNsdYang
.YangData_Nsd_NsdCatalog_Nsd()
99 descriptor
.from_yaml(RiftNSD
.model
, hdl
.read())
100 return cls(descriptor
)
103 def from_dict(cls
, nsd_dict
):
104 descriptor
= RwNsdYang
.YangData_Nsd_NsdCatalog_Nsd
.from_dict(nsd_dict
)
105 return cls(descriptor
)
108 class RiftVNFD(object):
109 model
= RwYang
.Model
.create_libncx()
110 model
.load_module('vnfd')
111 model
.load_module('rw-vnfd')
113 def __init__(self
, descriptor
):
114 self
._vnfd
= descriptor
117 return str(self
._vnfd
)
125 return self
._vnfd
.name
128 def description(self
):
129 return self
._vnfd
.description
133 return self
._vnfd
.connection_point
137 return self
._vnfd
.vdu
140 def internal_vlds(self
):
141 return self
._vnfd
.internal_vld
144 def from_xml_file_hdl(cls
, hdl
):
146 descriptor
= RwVnfdYang
.YangData_Vnfd_VnfdCatalog_Vnfd()
147 descriptor
.from_xml_v2(RiftVNFD
.model
, hdl
.read())
148 return cls(descriptor
)
151 def from_yaml_file_hdl(cls
, hdl
):
153 descriptor
= RwVnfdYang
.YangData_Vnfd_VnfdCatalog_Vnfd()
154 descriptor
.from_yaml(RiftVNFD
.model
, hdl
.read())
155 return cls(descriptor
)
158 def from_dict(cls
, vnfd_dict
):
159 descriptor
= RwVnfdYang
.YangData_Vnfd_VnfdCatalog_Vnfd
.from_dict(vnfd_dict
)
160 return cls(descriptor
)
163 def is_writable_directory(dir_path
):
164 """ Returns True if dir_path is writable, False otherwise
167 dir_path - A directory path
169 if not os
.path
.exists(dir_path
):
170 raise ValueError("Directory does not exist: %s", dir_path
)
173 testfile
= tempfile
.TemporaryFile(dir=dir_path
)
181 def create_vnfd_from_files(vnfd_file_hdls
):
182 """ Create a list of RiftVNFD instances from xml/yaml file handles
185 vnfd_file_hdls - Rift VNFD XML/YAML file handles
188 A list of RiftVNFD instances
191 for vnfd_file_hdl
in vnfd_file_hdls
:
192 if vnfd_file_hdl
.name
.endswith("yaml") or vnfd_file_hdl
.name
.endswith("yaml"):
193 vnfd
= RiftVNFD
.from_yaml_file_hdl(vnfd_file_hdl
)
195 vnfd
= RiftVNFD
.from_xml_file_hdl(vnfd_file_hdl
)
196 vnfd_dict
[vnfd
.id] = vnfd
201 def create_nsd_from_file(nsd_file_hdl
):
202 """ Create a list of RiftNSD instances from yaml/xml file handles
205 nsd_file_hdls - Rift NSD XML/yaml file handles
208 A list of RiftNSD instances
210 if nsd_file_hdl
.name
.endswith("yaml") or nsd_file_hdl
.name
.endswith("yaml"):
211 nsd
= RiftNSD
.from_yaml_file_hdl(nsd_file_hdl
)
213 nsd
= RiftNSD
.from_xml_file_hdl(nsd_file_hdl
)
218 return collections
.defaultdict(dict)
220 def convert_vnfd_name(vnfd_name
, member_idx
):
221 return vnfd_name
+ "__" + str(member_idx
)
224 def rift2openmano_nsd(rift_nsd
, rift_vnfds
, openmano_vnfd_ids
):
225 for vnfd_id
in rift_nsd
.vnfd_ids
:
226 if vnfd_id
not in rift_vnfds
:
227 raise VNFNotFoundError("VNF id %s not provided" % vnfd_id
)
230 openmano
["name"] = rift_nsd
.name
231 openmano
["description"] = rift_nsd
.description
233 openmano
["topology"] = topology
235 topology
["nodes"] = {}
236 for vnfd
in rift_nsd
.constituent_vnfds
:
237 vnfd_id
= vnfd
.vnfd_id_ref
238 rift_vnfd
= rift_vnfds
[vnfd_id
]
239 member_idx
= vnfd
.member_vnf_index
240 openmano_vnfd_id
= openmano_vnfd_ids
.get(vnfd_id
,None)
242 topology
["nodes"][rift_vnfd
.name
+ "__" + str(member_idx
)] = {
244 "vnf_id": openmano_vnfd_id
247 topology
["nodes"][rift_vnfd
.name
+ "__" + str(member_idx
)] = {
249 "VNF model": rift_vnfd
.name
252 for vld
in rift_nsd
.vlds
:
253 # Openmano has both bridge_net and dataplane_net models for network types
254 # For now, since we are using openmano in developer mode lets just hardcode
255 # to bridge_net since it won't matter anyways.
256 # topology["nodes"][vld.name] = {"type": "network", "model": "bridge_net"}
259 topology
["connections"] = {}
260 for vld
in rift_nsd
.vlds
:
262 # Create a connections entry for each external VLD
263 topology
["connections"][vld
.name
] = {}
264 topology
["connections"][vld
.name
]["nodes"] = []
266 #if vld.vim_network_name:
268 if vld
.name
not in topology
["nodes"]:
269 topology
["nodes"][vld
.name
] = {
270 "type": "external_network",
274 # Add the external network to the list of connection points
275 topology
["connections"][vld
.name
]["nodes"].append(
278 elif vld
.provider_network
.has_field("physical_network"):
279 # Add the external datacenter network to the topology
280 # node list if it isn't already added
281 ext_net_name
= vld
.provider_network
.physical_network
282 ext_net_name_with_seg
= ext_net_name
283 if vld
.provider_network
.has_field("segmentation_id"):
284 ext_net_name_with_seg
+= ":{}".format(vld
.provider_network
.segmentation_id
)
286 if ext_net_name
not in topology
["nodes"]:
287 topology
["nodes"][ext_net_name
] = {
288 "type": "external_network",
289 "model": ext_net_name_with_seg
,
292 # Add the external network to the list of connection points
293 topology
["connections"][vld
.name
]["nodes"].append(
298 for vnfd_cp
in vld
.vnfd_connection_point_ref
:
300 # Get the RIFT VNF for this external VLD connection point
301 vnfd
= rift_vnfds
[vnfd_cp
.vnfd_id_ref
]
303 # For each VNF in this connection, use the same interface name
304 topology
["connections"][vld
.name
]["type"] = "link"
305 # Vnf ref is the vnf name with the member_vnf_idx appended
306 member_idx
= vnfd_cp
.member_vnf_index_ref
307 vnf_ref
= vnfd
.name
+ "__" + str(member_idx
)
308 topology
["connections"][vld
.name
]["nodes"].append(
310 vnf_ref
: vnfd_cp
.vnfd_connection_point_ref
316 def cloud_init(rift_vnfd_id
, vdu
):
317 """ Populate cloud_init with script from
318 either the inline contents or from the file provided
320 vnfd_package_store
= rift
.package
.store
.VnfdPackageFilesystemStore(logger
)
322 cloud_init_msg
= None
323 if vdu
.cloud_init
is not None:
324 logger
.debug("cloud_init script provided inline %s", vdu
.cloud_init
)
325 cloud_init_msg
= vdu
.cloud_init
326 elif vdu
.cloud_init_file
is not None:
327 # Get cloud-init script contents from the file provided in the cloud_init_file param
328 logger
.debug("cloud_init script provided in file %s", vdu
.cloud_init_file
)
329 filename
= vdu
.cloud_init_file
330 vnfd_package_store
.refresh()
331 stored_package
= vnfd_package_store
.get_package(rift_vnfd_id
)
332 cloud_init_extractor
= rift
.package
.cloud_init
.PackageCloudInitExtractor(logger
)
334 cloud_init_msg
= cloud_init_extractor
.read_script(stored_package
, filename
)
335 except rift
.package
.cloud_init
.CloudInitExtractionError
as e
:
338 logger
.debug("VDU translation: cloud-init script not provided")
341 logger
.debug("Current cloud init msg is {}".format(cloud_init_msg
))
342 return cloud_init_msg
344 def config_file_init(rift_vnfd_id
, vdu
, cfg_file
):
345 """ Populate config file init with file provided
347 vnfd_package_store
= rift
.package
.store
.VnfdPackageFilesystemStore(logger
)
349 # Get script contents from the file provided in the cloud_init directory
350 logger
.debug("config file script provided in file {}".format(cfg_file
))
352 vnfd_package_store
.refresh()
353 stored_package
= vnfd_package_store
.get_package(rift_vnfd_id
)
354 cloud_init_extractor
= rift
.package
.cloud_init
.PackageCloudInitExtractor(logger
)
356 cfg_file_msg
= cloud_init_extractor
.read_script(stored_package
, filename
)
357 except rift
.package
.cloud_init
.CloudInitExtractionError
as e
:
360 logger
.debug("Current config file msg is {}".format(cfg_file_msg
))
363 def rift2openmano_vnfd(rift_vnfd
, rift_nsd
):
364 openmano_vnf
= {"vnf":{}}
365 vnf
= openmano_vnf
["vnf"]
367 vnf
["name"] = rift_vnfd
.name
368 vnf
["description"] = rift_vnfd
.description
370 vnf
["external-connections"] = []
372 def find_vdu_and_ext_if_by_cp_ref(cp_ref_name
):
373 for vdu
in rift_vnfd
.vdus
:
374 for ext_if
in vdu
.external_interface
:
375 if ext_if
.vnfd_connection_point_ref
== cp_ref_name
:
378 raise ValueError("External connection point reference %s not found" % cp_ref_name
)
380 def find_vdu_and_int_if_by_cp_ref(cp_ref_id
):
381 for vdu
in rift_vnfd
.vdus
:
382 for int_if
in vdu
.internal_interface
:
383 if int_if
.vdu_internal_connection_point_ref
== cp_ref_id
:
386 raise ValueError("Internal connection point reference %s not found" % cp_ref_id
)
388 def rift2openmano_if_type(ext_if
):
390 cp_ref_name
= ext_if
.vnfd_connection_point_ref
391 for vld
in rift_nsd
.vlds
:
393 # if it is an explicit mgmt_network then check if the given
394 # cp_ref is a part of it
395 if not vld
.mgmt_network
:
398 for vld_cp
in vld
.vnfd_connection_point_ref
:
399 if vld_cp
.vnfd_connection_point_ref
== cp_ref_name
:
403 rift_type
= ext_if
.virtual_interface
.type_yang
404 # Retaining it for backward compatibility!
405 if rift_type
== "OM_MGMT":
407 elif rift_type
== "VIRTIO" or rift_type
== "E1000":
412 def rift2openmano_vif(rift_type
):
413 if rift_type
== "VIRTIO":
415 elif rift_type
== "E1000":
418 raise ValueError("VDU Virtual Interface type {} not supported".format(rift_type
))
420 # Add all external connections
421 for cp
in rift_vnfd
.cps
:
422 # Find the VDU and and external interface for this connection point
423 vdu
, ext_if
= find_vdu_and_ext_if_by_cp_ref(cp
.name
)
426 "type": rift2openmano_if_type(ext_if
),
428 "local_iface_name": ext_if
.name
,
429 "description": "%s iface on VDU %s" % (ext_if
.name
, vdu
.name
),
432 vnf
["external-connections"].append(connection
)
434 # Add all internal networks
435 for vld
in rift_vnfd
.internal_vlds
:
438 "description": vld
.description
,
443 # Add the specific VDU connection points
444 for int_cp
in vld
.internal_connection_point
:
445 vdu
, int_if
= find_vdu_and_int_if_by_cp_ref(int_cp
.id_ref
)
446 connection
["elements"].append({
448 "local_iface_name": int_if
.name
,
450 if "internal-connections" not in vnf
:
451 vnf
["internal-connections"] = []
453 vnf
["internal-connections"].append(connection
)
457 for vdu
in rift_vnfd
.vdus
:
460 "description": vdu
.name
,
464 if vdu
.vm_flavor
.has_field("storage_gb") and vdu
.vm_flavor
.storage_gb
:
465 vnfc
["disk"] = vdu
.vm_flavor
.storage_gb
467 if vdu
.has_field("image"):
468 if os
.path
.isabs(vdu
.image
):
469 vnfc
["VNFC image"] = vdu
.image
471 vnfc
["image name"] = vdu
.image
472 if vdu
.has_field("image_checksum"):
473 vnfc
["image checksum"] = vdu
.image_checksum
475 dedicated_int
= False
476 for intf
in list(vdu
.internal_interface
) + list(vdu
.external_interface
):
477 if intf
.virtual_interface
.type_yang
in ["SR_IOV", "PCI_PASSTHROUGH"]:
479 if vdu
.guest_epa
.has_field("numa_node_policy") or dedicated_int
:
481 "memory": max(int(vdu
.vm_flavor
.memory_mb
/1024), 1),
484 numa_node_policy
= vdu
.guest_epa
.numa_node_policy
485 if numa_node_policy
.has_field("node"):
486 numa_node
= numa_node_policy
.node
[0]
488 if numa_node
.has_field("paired_threads"):
489 if numa_node
.paired_threads
.has_field("num_paired_threads"):
490 vnfc
["numas"][0]["paired-threads"] = numa_node
.paired_threads
.num_paired_threads
491 if len(numa_node
.paired_threads
.paired_thread_ids
) > 0:
492 vnfc
["numas"][0]["paired-threads-id"] = []
493 for pair
in numa_node
.paired_threads
.paired_thread_ids
:
494 vnfc
["numas"][0]["paired-threads-id"].append(
495 [pair
.thread_a
, pair
.thread_b
]
499 if vdu
.vm_flavor
.has_field("vcpu_count"):
500 vnfc
["numas"][0]["cores"] = max(vdu
.vm_flavor
.vcpu_count
, 1)
502 if vdu
.vm_flavor
.has_field("vcpu_count") and vdu
.vm_flavor
.vcpu_count
:
503 vnfc
["vcpus"] = vdu
.vm_flavor
.vcpu_count
505 if vdu
.vm_flavor
.has_field("memory_mb") and vdu
.vm_flavor
.memory_mb
:
506 vnfc
["ram"] = vdu
.vm_flavor
.memory_mb
509 if vdu
.has_field("hypervisor_epa"):
510 vnfc
["hypervisor"] = {}
511 if vdu
.hypervisor_epa
.has_field("type"):
512 if vdu
.hypervisor_epa
.type_yang
== "REQUIRE_KVM":
513 vnfc
["hypervisor"]["type"] = "QEMU-kvm"
515 if vdu
.hypervisor_epa
.has_field("version"):
516 vnfc
["hypervisor"]["version"] = vdu
.hypervisor_epa
.version
518 if vdu
.has_field("host_epa"):
519 vnfc
["processor"] = {}
520 if vdu
.host_epa
.has_field("om_cpu_model_string"):
521 vnfc
["processor"]["model"] = vdu
.host_epa
.om_cpu_model_string
522 if vdu
.host_epa
.has_field("om_cpu_feature"):
523 vnfc
["processor"]["features"] = []
524 for feature
in vdu
.host_epa
.om_cpu_feature
:
525 vnfc
["processor"]["features"].append(feature
.feature
)
527 if vdu
.has_field("volumes"):
529 # Sort volumes as device-list is implictly ordered by Openmano
530 newvollist
= sorted(vdu
.volumes
, key
=lambda k
: k
.name
)
531 for iter_num
, volume
in enumerate(newvollist
):
533 # Convert the first volume to vnfc.image
534 if os
.path
.isabs(volume
.image
):
535 vnfc
["VNFC image"] = volume
.image
537 vnfc
["image name"] = volume
.image
538 if volume
.has_field("image_checksum"):
539 vnfc
["image checksum"] = volume
.image_checksum
541 # Add Openmano devices
543 device
["type"] = volume
.device_type
544 device
["image name"] = volume
.image
545 if volume
.has_field("image_checksum"):
546 device
["image checksum"] = volume
.image_checksum
547 vnfc
["devices"].append(device
)
549 vnfc_boot_data_init
= False
550 if vdu
.has_field("cloud_init") or vdu
.has_field("cloud_init_file"):
551 vnfc
['boot-data'] = dict()
552 vnfc_boot_data_init
= True
553 vnfc
['boot-data']['user-data'] = cloud_init(rift_vnfd
.id, vdu
)
555 if vdu
.has_field("supplemental_boot_data"):
556 if vdu
.supplemental_boot_data
.has_field('boot_data_drive'):
557 if vdu
.supplemental_boot_data
.boot_data_drive
is True:
558 if vnfc_boot_data_init
is False:
559 vnfc
['boot-data'] = dict()
560 vnfc_boot_data_init
= True
561 vnfc
['boot-data']['boot-data-drive'] = vdu
.supplemental_boot_data
.boot_data_drive
563 if vdu
.supplemental_boot_data
.has_field('config_file'):
564 om_cfgfile_list
= list()
565 for custom_config_file
in vdu
.supplemental_boot_data
.config_file
:
566 cfg_source
= config_file_init(rift_vnfd
.id, vdu
, custom_config_file
.source
)
567 om_cfgfile_list
.append({"dest":custom_config_file
.dest
, "content": cfg_source
})
568 vnfc
['boot-data']['config-files'] = om_cfgfile_list
571 vnf
["VNFC"].append(vnfc
)
573 for int_if
in list(vdu
.internal_interface
) + list(vdu
.external_interface
):
577 if int_if
.virtual_interface
.has_field("vpci"):
578 intf
["vpci"] = int_if
.virtual_interface
.vpci
580 if int_if
.virtual_interface
.type_yang
in ["VIRTIO", "E1000"]:
581 intf
["model"] = rift2openmano_vif(int_if
.virtual_interface
.type_yang
)
582 vnfc
["bridge-ifaces"].append(intf
)
584 elif int_if
.virtual_interface
.type_yang
in ["OM_MGMT"]:
585 vnfc
["bridge-ifaces"].append(intf
)
587 elif int_if
.virtual_interface
.type_yang
== "SR_IOV":
588 intf
["bandwidth"] = "10 Gbps"
589 intf
["dedicated"] = "no"
590 vnfc
["numas"][0]["interfaces"].append(intf
)
592 elif int_if
.virtual_interface
.type_yang
== "PCI_PASSTHROUGH":
593 intf
["bandwidth"] = "10 Gbps"
594 intf
["dedicated"] = "yes"
595 if "interfaces" not in vnfc
["numas"][0]:
596 vnfc
["numas"][0]["interfaces"] = []
597 vnfc
["numas"][0]["interfaces"].append(intf
)
599 raise ValueError("Interface type %s not supported" % int_if
.virtual_interface
)
601 if int_if
.virtual_interface
.has_field("bandwidth"):
602 if int_if
.virtual_interface
.bandwidth
!= 0:
603 bps
= int_if
.virtual_interface
.bandwidth
605 # Calculate the bits per second conversion
606 for x
in [('M', 1000000), ('G', 1000000000)]:
608 intf
["bandwidth"] = "{} {}bps".format(math
.ceil(bps
/x
[1]), x
[0])
610 # Sort bridge-ifaces-list TODO sort others
611 newlist
= sorted(vnfc
["bridge-ifaces"], key
=lambda k
: k
['name'])
612 vnfc
["bridge-ifaces"] = newlist
617 def parse_args(argv
=sys
.argv
[1:]):
618 """ Parse the command line arguments
621 arv - The list of arguments to parse
624 Argparse Namespace instance
626 parser
= argparse
.ArgumentParser()
630 help="Directory to output converted descriptors. Default is stdout",
634 '-n', '--nsd-file-hdl',
636 type=argparse
.FileType('r'),
637 help="Rift NSD Descriptor File",
641 '-v', '--vnfd-file-hdls',
644 type=argparse
.FileType('r'),
645 help="Rift VNFD Descriptor File",
648 args
= parser
.parse_args(argv
)
650 if not os
.path
.exists(args
.outdir
):
651 os
.makedirs(args
.outdir
)
653 if not is_writable_directory(args
.outdir
):
654 logging
.error("Directory %s is not writable", args
.outdir
)
660 def write_yaml_to_file(name
, outdir
, desc_dict
):
661 file_name
= "%s.yaml" % name
662 yaml_str
= yaml
.dump(desc_dict
)
664 sys
.stdout
.write(yaml_str
)
667 file_path
= os
.path
.join(outdir
, file_name
)
668 dir_path
= os
.path
.dirname(file_path
)
669 if not os
.path
.exists(dir_path
):
670 os
.makedirs(dir_path
)
672 with
open(file_path
, "w") as hdl
:
675 logger
.info("Wrote descriptor to %s", file_path
)
678 def main(argv
=sys
.argv
[1:]):
679 args
= parse_args(argv
)
682 openmano_vnfr_ids
= dict()
684 if args
.vnfd_file_hdls
is not None:
685 vnf_dict
= create_vnfd_from_files(args
.vnfd_file_hdls
)
687 for vnfd
in vnf_dict
:
688 openmano_vnfr_ids
[vnfd
] = vnfd
690 if args
.nsd_file_hdl
is not None:
691 nsd
= create_nsd_from_file(args
.nsd_file_hdl
)
693 openmano_nsd
= rift2openmano_nsd(nsd
, vnf_dict
, openmano_vnfr_ids
)
695 write_yaml_to_file(openmano_nsd
["name"], args
.outdir
, openmano_nsd
)
697 for vnf
in vnf_dict
.values():
698 openmano_vnf
= rift2openmano_vnfd(vnf
, nsd
)
699 write_yaml_to_file(openmano_vnf
["vnf"]["name"], args
.outdir
, openmano_vnf
)
702 if __name__
== "__main__":
703 logging
.basicConfig(level
=logging
.WARNING
)