diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index 31e2ae0bc..de21788a1 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -7,6 +7,20 @@ content_type: in: header required: true type: string +fetch_content_type: + description: | + The fetched VNF Package will be returned with Content-Type set + as `application/zip` in the response header. + in: header + required: true + type: string +range: + description: | + The byte range of VNF Package to be downloaded is specified in the Range + header. + in: header + required: false + type: string # variables in path alias_path: diff --git a/api-ref/source/v1/status.yaml b/api-ref/source/v1/status.yaml index fa186b9c9..6341d0626 100644 --- a/api-ref/source/v1/status.yaml +++ b/api-ref/source/v1/status.yaml @@ -15,6 +15,10 @@ 204: default: | The server has fulfilled the request by deleting the resource. +206: + default: | + Partial Content, The server has fulfilled the partial GET request for the + resource. 300: default: | There are multiple choices for resources. The request has to be more @@ -56,6 +60,13 @@ This operation conflicted with another operation on this resource. duplcate_zone: | There is already a zone with this name. +416: + default: | + Requested Range Not Satisfiable, A server SHOULD return a response with + this status code if a request included a Range request-header field, + and none of the range-specifier values in this field overlap the current + extent of the selected resource, and the request did not include an + If-Range request-header field. 500: default: | Something went wrong inside the service. This should not happen usually. diff --git a/api-ref/source/v1/vnf_packages.inc b/api-ref/source/v1/vnf_packages.inc index 5ba5e6dec..691ad8167 100644 --- a/api-ref/source/v1/vnf_packages.inc +++ b/api-ref/source/v1/vnf_packages.inc @@ -361,3 +361,50 @@ Response .. rest_parameters:: parameters.yaml - Content-Type: content_type + +Fetch an on-boarded VNF package with HTTP_RANGE +================================================ + +.. rest_method:: GET /vnfpkgm/v1/vnf_packages/{vnf_package_id}/package_content + +Fetch an on-boarded VNF package with HTTP_RANGE. + +The GET method fetches the content of a VNF package identified by +the VNF package identifier allocated by the NFVO. + +The 'HTTP_RANGE' header is inspected for a valid value. +If it is present and valid, then the package content within +the range is fetched. If not present the entire content is +fetched. + +Response Codes +-------------- + +.. rest_status_code:: success status.yaml + + - 200 + - 206 + +.. rest_status_code:: error status.yaml + + - 403 + - 404 + - 409 + - 416 + - 500 + +Request Parameters +------------------ + +.. rest_parameters:: parameters.yaml + + - vnf_package_id: vnf_package_id_path + - Accept: fetch_content_type + - Range: range + +Response +-------- + +.. rest_parameters:: parameters.yaml + + - Content-Type: fetch_content_type diff --git a/tacker/api/vnfpkgm/v1/controller.py b/tacker/api/vnfpkgm/v1/controller.py index 51d2cb004..afec2fc34 100644 --- a/tacker/api/vnfpkgm/v1/controller.py +++ b/tacker/api/vnfpkgm/v1/controller.py @@ -171,6 +171,123 @@ class VnfPkgmController(wsgi.Controller): # Delete vnf_package self.rpc_api.delete_vnf_package(context, vnf_package) + @wsgi.response(http_client.ACCEPTED) + @wsgi.expected_errors((http_client.FORBIDDEN, http_client.NOT_FOUND, + http_client.CONFLICT, + http_client.REQUESTED_RANGE_NOT_SATISFIABLE)) + def fetch_vnf_package_content(self, request, id): + context = request.environ['tacker.context'] + context.can(vnf_package_policies.VNFPKGM % 'fetch_package_content') + + vnf_package = self._get_vnf_package(id, request) + + if vnf_package.onboarding_state != \ + fields.PackageOnboardingStateType.ONBOARDED: + msg = _("VNF Package %(id)s onboarding state " + "is not %(onboarding)s") + raise webob.exc.HTTPConflict(explanation=msg % {"id": id, + "onboarding": fields.PackageOnboardingStateType.ONBOARDED}) + + if vnf_package.size == 0: + + try: + zip_file_size = glance_store.get_csar_size(id, + vnf_package.location_glance_store) + vnf_package.size = zip_file_size + vnf_package.save() + except exceptions.VnfPackageLocationInvalid: + msg = _("Vnf package not present at location") + raise webob.exc.HTTPNotFound(explanation=msg) + + else: + zip_file_size = vnf_package.size + + range_val = self._get_range_from_request(request, zip_file_size) + + return self._download( + request.response, range_val, id, vnf_package.location_glance_store, + zip_file_size) + + def _download(self, response, range_val, uuid, location, zip_file_size): + offset, chunk_size = 0, None + if range_val: + if isinstance(range_val, webob.byterange.Range): + response_end = zip_file_size - 1 + # NOTE(sameert): webob parsing is zero-indexed. + # i.e.,to download first 5 bytes of a 10 byte image, + # request should be "bytes=0-4" and the response would be + # "bytes 0-4/10". + # Range if validated, will never have 'start' object as None. + if range_val.start >= 0: + offset = range_val.start + else: + # NOTE(sameert): Negative start values needs to be + # processed to allow suffix-length for Range request + # like "bytes=-2" as per rfc7233. + if abs(range_val.start) < zip_file_size: + offset = zip_file_size + range_val.start + + if range_val.end is not None and range_val.end < zip_file_size: + chunk_size = range_val.end - offset + response_end = range_val.end - 1 + else: + chunk_size = zip_file_size - offset + + response.status_int = 206 + + response.headers['Content-Type'] = 'application/zip' + + response.app_iter = self._get_csar_zip_data(uuid, + location, offset, chunk_size) + # NOTE(sameert): In case of a full zip download, when + # chunk_size was none, reset it to zip.size to set the + # response header's Content-Length. + if chunk_size is not None: + response.headers['Content-Range'] = 'bytes %s-%s/%s'\ + % (offset, + response_end, + zip_file_size) + else: + chunk_size = zip_file_size + response.headers['Content-Length'] = six.text_type(chunk_size) + return response + + def _get_csar_zip_data(self, uuid, location, offset=0, chunk_size=None): + try: + resp, size = glance_store.load_csar_iter( + uuid, location, offset=offset, chunk_size=chunk_size) + except exceptions.VnfPackageLocationInvalid: + msg = _("Vnf package not present at location") + raise webob.exc.HTTPServerError(explanation=msg) + return resp + + def _get_range_from_request(self, request, zip_file_size): + range_str = request._headers.environ.get('HTTP_RANGE') + if range_str is not None: + # NOTE(sameert): We do not support multi range requests. + if ',' in range_str: + msg = _("Requests with multiple ranges are not supported in " + "Tacker. You may make multiple single-range requests " + "instead.") + raise webob.exc.HTTPBadRequest(explanation=msg) + + range_ = webob.byterange.Range.parse(range_str) + if range_ is None: + range_err_msg = _("The byte range passed in the 'Range' header" + "did not match any available byte range in the VNF package" + "file") + raise webob.exc.HTTPRequestRangeNotSatisfiable( + explanation=range_err_msg) + # NOTE(sameert): Ensure that a range like bytes=4- for an zip + # size of 3 is invalidated as per rfc7233. + if range_.start >= zip_file_size: + msg = _("Invalid start position in Range header. " + "Start position MUST be in the inclusive range" + "[0, %s].") % (zip_file_size - 1) + raise webob.exc.HTTPRequestRangeNotSatisfiable( + explanation=msg) + return range_ + @wsgi.response(http_client.ACCEPTED) @wsgi.expected_errors((http_client.FORBIDDEN, http_client.NOT_FOUND, http_client.CONFLICT)) @@ -207,7 +324,7 @@ class VnfPkgmController(wsgi.Controller): vnf_package.algorithm = CONF.vnf_package.hashing_algorithm vnf_package.hash = multihash vnf_package.location_glance_store = location - + vnf_package.size = size vnf_package.save() # process vnf_package diff --git a/tacker/api/vnfpkgm/v1/router.py b/tacker/api/vnfpkgm/v1/router.py index c9af7036d..362453607 100644 --- a/tacker/api/vnfpkgm/v1/router.py +++ b/tacker/api/vnfpkgm/v1/router.py @@ -64,7 +64,8 @@ class VnfpkgmAPIRouter(wsgi.Router): methods, controller, default_resource) # Allowed methods on /vnf_packages/{id}/package_content resource - methods = {"PUT": "upload_vnf_package_content"} + methods = {"PUT": "upload_vnf_package_content", + "GET": "fetch_vnf_package_content"} self._setup_route(mapper, "/vnf_packages/{id}/package_content", methods, controller, default_resource) diff --git a/tacker/common/exceptions.py b/tacker/common/exceptions.py index 60d6f750d..d8c4fb9a2 100644 --- a/tacker/common/exceptions.py +++ b/tacker/common/exceptions.py @@ -286,6 +286,10 @@ class VNFPackageURLInvalid(Invalid): message = _("Failed to open URL %(url)s") +class VnfPackageLocationInvalid(Invalid): + message = _("Failed to find location: %(location)") + + class InvalidZipFile(Invalid): message = _("Invalid zip file : %(path)s") @@ -299,6 +303,10 @@ class FailedToGetVnfdData(Invalid): message = _("Failed to get csar zip file from glance store: %(error)s") +class FailedToGetVnfPackageDetails(Invalid): + message = _("Failed to get vnf package details: %(error)s") + + class InvalidCSAR(Invalid): message = _("Invalid csar: %(error)s") diff --git a/tacker/conductor/conductor_server.py b/tacker/conductor/conductor_server.py index 1f5ba3a47..393edf93e 100644 --- a/tacker/conductor/conductor_server.py +++ b/tacker/conductor/conductor_server.py @@ -265,7 +265,6 @@ class Conductor(manager.Manager): def upload_vnf_package_from_uri(self, context, vnf_package, address_information, user_name=None, password=None): - body = {"address_information": address_information} (location, size, checksum, multihash, loc_meta) = glance_store.store_csar(context, vnf_package.id, body) @@ -276,7 +275,7 @@ class Conductor(manager.Manager): vnf_package.algorithm = CONF.vnf_package.hashing_algorithm vnf_package.hash = multihash vnf_package.location_glance_store = location - + vnf_package.size = size vnf_package.save() zip_path = glance_store.load_csar(vnf_package.id, location) diff --git a/tacker/db/db_sqlalchemy/models.py b/tacker/db/db_sqlalchemy/models.py index 8ce60dee9..58c027dbe 100644 --- a/tacker/db/db_sqlalchemy/models.py +++ b/tacker/db/db_sqlalchemy/models.py @@ -141,6 +141,7 @@ class VnfPackage(model_base.BASE, models.SoftDeleteMixin, algorithm = sa.Column(sa.String(64), nullable=True) hash = sa.Column(sa.String(128), nullable=True) location_glance_store = sa.Column(sa.Text(), nullable=True) + size = sa.Column(sa.BigInteger, nullable=False, default=0) _metadata = orm.relationship( VnfPackageUserData, diff --git a/tacker/db/migration/alembic_migrations/versions/HEAD b/tacker/db/migration/alembic_migrations/versions/HEAD index 3ad606433..737ff8573 100644 --- a/tacker/db/migration/alembic_migrations/versions/HEAD +++ b/tacker/db/migration/alembic_migrations/versions/HEAD @@ -1 +1 @@ -985e28392890 +d2e39e01d540 diff --git a/tacker/db/migration/alembic_migrations/versions/d2e39e01d540_add_size_to_vnfpackage.py b/tacker/db/migration/alembic_migrations/versions/d2e39e01d540_add_size_to_vnfpackage.py new file mode 100644 index 000000000..833a10808 --- /dev/null +++ b/tacker/db/migration/alembic_migrations/versions/d2e39e01d540_add_size_to_vnfpackage.py @@ -0,0 +1,37 @@ +# Copyright 2019 OpenStack Foundation +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# + +"""add size column to vnf_packages table + +Revision ID: d2e39e01d540 +Revises: 985e28392890 +Create Date: 2019-11-27 13:30:23.599865 + +""" + +from alembic import op +import sqlalchemy as sa + +# revision identifiers, used by Alembic. +revision = 'd2e39e01d540' +down_revision = '985e28392890' + + +# Added 'size' column to an existing table. Server_default bit will make +# existing rows 0 for that column +def upgrade(active_plugins=None, options=None): + op.add_column('vnf_packages', sa.Column('size', sa.BigInteger, + nullable=False, + server_default='0')) diff --git a/tacker/glance_store/store.py b/tacker/glance_store/store.py index 1753aac3a..59a0283d4 100644 --- a/tacker/glance_store/store.py +++ b/tacker/glance_store/store.py @@ -54,7 +54,6 @@ def get_csar_data_iter(body): def store_csar(context, package_uuid, body): data_iter = get_csar_data_iter(body) - try: # store CSAR file in glance_store (location, size, checksum, multihash, @@ -91,16 +90,21 @@ def delete_csar(context, package_uuid, location): {"uuid": package_uuid}) +def get_csar_size(package_uuid, location): + + try: + return glance_store.backend.get_size_from_backend(location) + except Exception: + LOG.exception("Failed to get csar data from glance store %(location)s" + "for package %(uuid)s", {"location": location, "uuid": package_uuid}) + raise exceptions.VnfPackageLocationInvalid(location=location) + + def load_csar(package_uuid, location): zip_path = os.path.join(CONF.vnf_package.vnf_package_csar_path, package_uuid + ".zip") - - try: - resp, size = glance_store.backend.get_from_backend(location) - except Exception: - LOG.info("Failed to get csar data from glance store %(location)s for " - "package %(uuid)s", - {"location": location, "uuid": package_uuid}) + resp, size = _get_csar_chunks( + package_uuid, location, offset=0, chunk_size=None) try: temp_data = open(zip_path, 'wb') @@ -115,3 +119,21 @@ def load_csar(package_uuid, location): 'error': encodeutils.exception_to_unicode(exp)}) return zip_path + + +def load_csar_iter(package_uuid, location, offset=0, chunk_size=None): + resp, size = _get_csar_chunks( + package_uuid, location, offset=offset, chunk_size=chunk_size) + return resp, size + + +def _get_csar_chunks(package_uuid, location, offset, chunk_size): + try: + resp, size = glance_store.backend.get_from_backend(location, + offset=offset, + chunk_size=chunk_size) + return resp, size + except Exception: + LOG.exception("Failed to get csar data from glance store %(location)s" + "for package %(uuid)s", {"location": location, "uuid": package_uuid}) + raise exceptions.VnfPackageLocationInvalid(location=location) diff --git a/tacker/objects/vnf_package.py b/tacker/objects/vnf_package.py index f3b8f22ab..55cde9099 100644 --- a/tacker/objects/vnf_package.py +++ b/tacker/objects/vnf_package.py @@ -18,6 +18,7 @@ from oslo_serialization import jsonutils as json from oslo_utils import excutils from oslo_utils import timeutils from oslo_utils import uuidutils +from oslo_utils import versionutils from oslo_versionedobjects import base as ovoo_base from sqlalchemy.orm import joinedload from sqlalchemy.sql import func @@ -305,8 +306,8 @@ class VnfPackage(base.TackerObject, base.TackerPersistentObject, COMPLEX_ATTRIBUTES.extend( vnf_software_image.VnfSoftwareImage.COMPLEX_ATTRIBUTES) - # Version 1.0: Initial version - VERSION = '1.0' + # Version 1.1: Added 'size' to persist size of VnfPackage. + VERSION = '1.1' fields = { 'id': fields.UUIDField(nullable=False), @@ -323,8 +324,19 @@ class VnfPackage(base.TackerObject, base.TackerPersistentObject, 'vnf_deployment_flavours': fields.ObjectField( 'VnfDeploymentFlavoursList', nullable=True), 'vnfd': fields.ObjectField('VnfPackageVnfd', nullable=True), + 'size': fields.IntegerField(nullable=False, default=0), } + def __init__(self, context=None, **kwargs): + super(VnfPackage, self).__init__(context, **kwargs) + self.obj_set_defaults() + + def obj_make_compatible(self, primitive, target_version): + super(VnfPackage, self).obj_make_compatible(primitive, target_version) + target_version = versionutils.convert_version_to_tuple(target_version) + if target_version < (1, 1) and 'size' in primitive: + del primitive['size'] + @staticmethod def _from_db_object(context, vnf_package, db_vnf_package, expected_attrs=None): diff --git a/tacker/policies/vnf_package.py b/tacker/policies/vnf_package.py index 4ebef2ce5..320d11dac 100644 --- a/tacker/policies/vnf_package.py +++ b/tacker/policies/vnf_package.py @@ -62,6 +62,17 @@ rules = [ 'path': '/vnf_packages/{vnf_package_id}' } ]), + policy.DocumentedRuleDefault( + name=VNFPKGM % 'fetch_package_content', + check_str=base.RULE_ADMIN_OR_OWNER, + description="fetch the contents of an on-boarded VNF Package", + operations=[ + { + 'method': 'GET', + 'path': '/vnf_packages/{vnf_package_id}/' + 'package_content' + } + ]), policy.DocumentedRuleDefault( name=VNFPKGM % 'upload_package_content', check_str=base.RULE_ADMIN_OR_OWNER, diff --git a/tacker/tests/etc/samples/etsi/nfv/sample_vnfpkg_no_meta_single_vnfd/Files/images/cirros-0.4.0-x86_64-disk.img b/tacker/tests/etc/samples/etsi/nfv/sample_vnfpkg_no_meta_single_vnfd/Files/images/cirros-0.4.0-x86_64-disk.img new file mode 100644 index 000000000..5d45e57c0 --- /dev/null +++ b/tacker/tests/etc/samples/etsi/nfv/sample_vnfpkg_no_meta_single_vnfd/Files/images/cirros-0.4.0-x86_64-disk.img @@ -0,0 +1 @@ +#### THIS IS A DUMMY FILE TO SAVE FILE SIZE ##### diff --git a/tacker/tests/etc/samples/etsi/nfv/sample_vnfpkg_no_meta_single_vnfd/vnfd_helloworld_single.yaml b/tacker/tests/etc/samples/etsi/nfv/sample_vnfpkg_no_meta_single_vnfd/vnfd_helloworld_single.yaml new file mode 100644 index 000000000..03d40823b --- /dev/null +++ b/tacker/tests/etc/samples/etsi/nfv/sample_vnfpkg_no_meta_single_vnfd/vnfd_helloworld_single.yaml @@ -0,0 +1,1266 @@ +tosca_definitions_version: tosca_simple_yaml_1_2 + +description: Sample VNFD in sigle file by NTT NS lab. + +metadata: + template_author: Hiroyuki JO + template_version: 1.0 + template_name: Sample VNFD + +node_types: + # datatype definitions + tosca.datatypes.nfv.ConnectivityType: + derived_from: tosca.datatypes.Root + description: describes additional connectivity information of a virtualLink + properties: + layer_protocols: + type: list + description: Identifies the protocol a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire).The top layer protocol of the virtualLink protocol stack shall always be provided. The lower layer protocols may be included when there are specific requirements on these layers. + required: true + entry_schema: + type: string + constraints: + - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] + flow_pattern: + type: string + description: Identifies the flow pattern of the connectivity + required: false + constraints: + - valid_values: [ line, tree, mesh ] + + tosca.datatypes.nfv.L3ProtocolData: + derived_from: tosca.datatypes.Root + description: describes L3 protocol data for a given virtual link used in a specific VNF deployment flavour. + properties: + name: + type: string + description: Identifies the network name associated with this L3 protocol. + required: false + ip_version: + type: string + description: Specifies IP version of this L3 protocol.The value of the ip_version property shall be consistent with the value of the layer_protocol in the connectivity_type property of the virtual link node. + required: true + constraints: + - valid_values: [ ipv4, ipv6 ] + cidr: + type: string + description: Specifies the CIDR (Classless Inter-Domain Routing) of this L3 protocol. The value may be overridden at run-time. + required: true + ip_allocation_pools: + type: list + description: Specifies the allocation pools with start and end IP addresses for this L3 protocol. The value may be overridden at run-time. + required: false + entry_schema: + type: tosca.datatypes.nfv.IpAllocationPool + gateway_ip: + type: string + description: Specifies the gateway IP address for this L3 protocol. The value may be overridden at run-time. + required: false + dhcp_enabled: + type: boolean + description: Indicates whether DHCP (Dynamic Host Configuration Protocol) is enabled or disabled for this L3 protocol. The value may be overridden at run-time. + required: false + ipv6_address_mode: + type: string + description: Specifies IPv6 address mode. May be present when the value of the ipVersion attribute is "ipv6" and shall be absent otherwise. The value may be overridden at run-time. + required: false + constraints: + - valid_values: [ slaac, dhcpv6-stateful, dhcpv6-stateless ] + + tosca.datatypes.nfv.LinkBitrateRequirements: + derived_from: tosca.datatypes.Root + description: describes the requirements in terms of bitrate for a virtual link + properties: + root: + type: integer # in bits per second + description: Specifies the throughput requirement in bits per second of the link (e.g. bitrate of E-Line, root bitrate of E-Tree, aggregate capacity of E-LAN). + required: true + constraints: + - greater_or_equal: 0 + leaf: + type: integer # in bits per second + description: Specifies the throughput requirement in bits per second of leaf connections to the link when applicable to the connectivity type (e.g. for E-Tree and E LAN branches). + required: false + constraints: + - greater_or_equal: 0 + + tosca.datatypes.nfv.VirtualLinkProtocolData: + derived_from: tosca.datatypes.Root + description: describes one protocol layer and associated protocol data for a given virtual link used in a specific VNF deployment flavour + properties: + associated_layer_protocol: + type: string + description: Identifies one of the protocols a virtualLink gives access to (ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire) as specified by the connectivity_type property. + required: true + constraints: + - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] + l2_protocol_data: + type: tosca.datatypes.nfv.L2ProtocolData + description: Specifies the L2 protocol data for a virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L2 protocol and shall be absent otherwise. + required: false + l3_protocol_data: + type: tosca.datatypes.nfv.L3ProtocolData + description: Specifies the L3 protocol data for this virtual link. Shall be present when the associatedLayerProtocol attribute indicates a L3 protocol and shall be absent otherwise. + required: false + + tosca.datatypes.nfv.VlProfile: + derived_from: tosca.datatypes.Root + description: Describes additional instantiation data for a given VL used in a specific VNF deployment flavour. + properties: + max_bitrate_requirements: + type: tosca.datatypes.nfv.LinkBitrateRequirements + description: Specifies the maximum bitrate requirements for a VL instantiated according to this profile. + required: true + min_bitrate_requirements: + type: tosca.datatypes.nfv.LinkBitrateRequirements + description: Specifies the minimum bitrate requirements for a VL instantiated according to this profile. + required: true + qos: + type: tosca.datatypes.nfv.Qos + description: Specifies the QoS requirements of a VL instantiated according to this profile. + required: false + virtual_link_protocol_data: + type: list + description: Specifies the protocol data for a virtual link. + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualLinkProtocolData + + tosca.datatypes.nfv.VirtualLinkMonitoringParameter: + derived_from: tosca.datatypes.Root + description: Represents information on virtualised resource related performance metrics applicable to the VNF. + properties: + name: + type: string + description: Human readable name of the monitoring parameter + required: true + performance_metric: + type: string + description: Identifies a performance metric derived from those defined in ETSI GS NFV-IFA 027.The packetOutgoingVirtualLink and packetIncomingVirtualLink metrics shall be obtained by aggregation the PacketOutgoing and PacketIncoming measurements defined in clause 7.1 of GS NFV-IFA 027 of all virtual link ports attached to the virtual link to which the metrics apply. + required: true + constraints: + - valid_values: [ packet_outgoing_virtual_link, packet_incoming_virtual_link ] + collection_period: + type: scalar-unit.time + description: Describes the periodicity at which to collect the performance information. + required: false + constraints: + - greater_than: 0 s + + tosca.datatypes.nfv.ChecksumData: + derived_from: tosca.datatypes.Root + description: Describes information about the result of performing a checksum operation over some arbitrary data + properties: + algorithm: + type: string + description: Describes the algorithm used to obtain the checksum value + required: true + constraints: + - valid_values: [sha-224, sha-256, sha-384, sha-512 ] + hash: + type: string + description: Contains the result of applying the algorithm indicated by the algorithm property to the data to which this ChecksumData refers + required: true + + tosca.datatypes.nfv.LogicalNodeData: + derived_from: tosca.datatypes.Root + description: Describes compute, memory and I/O requirements associated with a particular VDU. + properties: + logical_node_requirements: + type: map + description: The logical node-level compute, memory and I/O requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific deployment requirements, including the number of CPU cores on this logical node, a memory configuration specific to a logical node or a requirement related to the association of an I/O device with the logical node. + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.VirtualMemory: + derived_from: tosca.datatypes.Root + description: supports the specification of requirements related to virtual memory of a virtual compute resource + properties: + virtual_mem_size: + type: scalar-unit.size + description: Amount of virtual memory. + required: true + virtual_mem_oversubscription_policy: + type: string + description: The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. + required: false + vdu_mem_requirements: + type: map + description: The hardware platform specific VDU memory requirements. A map of strings that contains a set of key-value pairs that describes hardware platform specific VDU memory requirements. + required: false + entry_schema: + type: string + numa_enabled: + type: boolean + description: It specifies the memory allocation to be cognisant of the relevant process/core allocation. + required: false + default: false + + tosca.datatypes.nfv.VirtualCpuPinning: + derived_from: tosca.datatypes.Root + description: Supports the specification of requirements related to the virtual CPU pinning configuration of a virtual compute resource + properties: + virtual_cpu_pinning_policy: + type: string + description: 'Indicates the policy for CPU pinning. The policy can take values of "static" or "dynamic". In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). In case of "static" the allocation is requested to be according to the virtual_cpu_pinning_rule.' + required: false + constraints: + - valid_values: [ static, dynamic ] + virtual_cpu_pinning_rule: + type: list + description: Provides the list of rules for allocating virtual CPU cores to logical CPU cores/threads + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.VirtualCpu: + derived_from: tosca.datatypes.Root + description: Supports the specification of requirements related to virtual CPU(s) of a virtual compute resource + properties: + cpu_architecture: + type: string + description: CPU architecture type. Examples are x86, ARM + required: false + num_virtual_cpu: + type: integer + description: Number of virtual CPUs + required: true + constraints: + - greater_than: 0 + virtual_cpu_clock: + type: scalar-unit.frequency + description: Minimum virtual CPU clock rate + required: false + virtual_cpu_oversubscription_policy: + type: string + description: CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. + required: false + vdu_cpu_requirements: + type: map + description: The hardware platform specific VDU CPU requirements. A map of strings that contains a set of key-value pairs describing VDU CPU specific hardware platform requirements. + required: false + entry_schema: + type: string + virtual_cpu_pinning: + type: tosca.datatypes.nfv.VirtualCpuPinning + description: The virtual CPU pinning configuration for the virtualised compute resource. + required: false + + tosca.datatypes.nfv.VirtualBlockStorageData: + derived_from: tosca.datatypes.Root + description: VirtualBlockStorageData describes block storage requirements associated with compute resources in a particular VDU, either as a local disk or as virtual attached storage + properties: + size_of_storage: + type: scalar-unit.size + description: Size of virtualised storage resource + required: true + constraints: + - greater_or_equal: 0 B + vdu_storage_requirements: + type: map + description: The hardware platform specific storage requirements. A map of strings that contains a set of key-value pairs that represents the hardware platform specific storage deployment requirements. + required: false + entry_schema: + type: string + rdma_enabled: + type: boolean + description: Indicates if the storage support RDMA + required: false + default: false + + tosca.datatypes.nfv.VnfcMonitoringParameter: + derived_from: tosca.datatypes.Root + description: Represents information on virtualised resource related performance metrics applicable to the VNF. + properties: + name: + type: string + description: Human readable name of the monitoring parameter + required: true + performance_metric: + type: string + description: Identifies the performance metric, according to ETSI GS NFV-IFA 027. + required: true + constraints: + - valid_values: [ v_cpu_usage_mean_vnf, v_cpu_usage_peak_vnf, v_memory_usage_mean_vnf, v_memory_usage_peak_vnf, v_disk_usage_mean_vnf, v_disk_usage_peak_vnf, byte_incoming_vnf_int_cp, byte_outgoing_vnf_int_cp, packet_incoming_vnf_int_cp, packet_outgoing_vnf_int_cp ] + collection_period: + type: scalar-unit.time + description: Describes the periodicity at which to collect the performance information. + required: false + constraints: + - greater_than: 0 s + + tosca.datatypes.nfv.VduProfile: + derived_from: tosca.datatypes.Root + description: describes additional instantiation data for a given Vdu.Compute used in a specific deployment flavour. + properties: + min_number_of_instances: + type: integer + description: Minimum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour. + required: true + constraints: + - greater_or_equal: 0 + max_number_of_instances: + type: integer + description: Maximum number of instances of the VNFC based on this Vdu.Compute that is permitted to exist for a particular VNF deployment flavour. + required: true + constraints: + - greater_or_equal: 0 + + tosca.datatypes.nfv.SwImageData: + derived_from: tosca.datatypes.Root + description: describes information related to a software image artifact + properties: # in SOL001 v0.8.0: "properties or metadata:" + name: + type: string + description: Name of this software image + required: true + version: + type: string + description: Version of this software image + required: true + checksum: + type: tosca.datatypes.nfv.ChecksumData + description: Checksum of the software image file + required: true + container_format: + type: string + description: The container format describes the container file format in which software image is provided + required: true + constraints: + - valid_values: [ aki, ami, ari, bare, docker, ova, ovf ] + disk_format: + type: string + description: The disk format of a software image is the format of the underlying disk image + required: true + constraints: + - valid_values: [ aki, ami, ari, iso, qcow2, raw, vdi, vhd, vhdx, vmdk ] + min_disk: + type: scalar-unit.size # Number + description: The minimal disk size requirement for this software image + required: true + constraints: + - greater_or_equal: 0 B + min_ram: + type: scalar-unit.size # Number + description: The minimal RAM requirement for this software image + required: false + constraints: + - greater_or_equal: 0 B + size: + type: scalar-unit.size # Number + description: The size of this software image + required: true + operating_system: + type: string + description: Identifies the operating system used in the software image + required: false + supported_virtualisation_environments: + type: list + description: Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image + required: false + entry_schema: + type: string + + tosca.datatypes.nfv.ScalingAspect: + derived_from: tosca.datatypes.Root + properties: + name: + type: string + required: true + description: + type: string + required: true + max_scale_level: + type: integer # positiveInteger + required: true + constraints: + - greater_or_equal: 0 + step_deltas: + type: list + required: false + entry_schema: + type: string # Identifier + + tosca.datatypes.nfv.VduLevel: + derived_from: tosca.datatypes.Root + description: Indicates for a given Vdu.Compute in a given level the number of instances to deploy + properties: + number_of_instances: + type: integer + description: Number of instances of VNFC based on this VDU to deploy for this level. + required: true + constraints: + - greater_or_equal: 0 + + tosca.datatypes.nfv.InstantiationLevel: + derived_from: tosca.datatypes.Root + description: Describes the scale level for each aspect that corresponds to a given level of resources to be instantiated within a deployment flavour in term of the number VNFC instances + properties: + description: + type: string + description: Human readable description of the level + required: true + scale_info: + type: map # key: aspectId + description: Represents for each aspect the scale level that corresponds to this instantiation level. scale_info shall be present if the VNF supports scaling. + required: false + entry_schema: + type: tosca.datatypes.nfv.ScaleInfo + + # capability type definitions + tosca.capabilities.nfv.VirtualLinkable: + derived_from: tosca.capabilities.Node + description: A node type that includes the VirtualLinkable capability indicates that it can be pointed by tosca.relationships.nfv.VirtualLinksTo relationship type + + tosca.capabilities.nfv.VirtualCompute: + derived_from: tosca.capabilities.Node + description: Describes the capabilities related to virtual compute resources + properties: + logical_node: + type: map + description: Describes the Logical Node requirements + required: false + entry_schema: + type: tosca.datatypes.nfv.LogicalNodeData + requested_additional_capabilities: + type: map + description: Describes additional capability for a particular VDU + required: false + entry_schema: + type: tosca.datatypes.nfv.RequestedAdditionalCapability + compute_requirements: + type: map + required: false + entry_schema: + type: string + virtual_memory: + type: tosca.datatypes.nfv.VirtualMemory + description: Describes virtual memory of the virtualized compute + required: true + virtual_cpu: + type: tosca.datatypes.nfv.VirtualCpu + description: Describes virtual CPU(s) of the virtualized compute + required: true + virtual_local_storage: + type: list + description: A list of virtual system disks created and destroyed as part of the VM lifecycle + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualBlockStorageData + description: virtual system disk definition + + tosca.capabilities.nfv.VirtualBindable: + derived_from: tosca.capabilities.Node + description: Indicates that the node that includes it can be pointed by a tosca.relationships.nfv.VirtualBindsTo relationship type which is used to model the VduHasCpd association + + tosca.capabilities.nfv.VirtualStorage: + derived_from: tosca.capabilities.Root + description: Describes the attachment capabilities related to Vdu.Storage + + # relationship type definitions + tosca.relationships.nfv.AttachesTo: + derived_from: tosca.relationships.Root + description: Represents an association relationship between the Vdu.Compute and one of the node types, Vdu.VirtualBlockStorage, Vdu.VirtualObjectStorage or Vdu.VirtualFileStorage + valid_target_types: [ tosca.capabilities.nfv.VirtualStorage ] + + tosca.relationships.nfv.VirtualLinksTo: + derived_from: tosca.relationships.DependsOn + description: Represents an association relationship between the VduCp and VnfVirtualLink node types + valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable ] + + tosca.relationships.nfv.VirtualBindsTo: + derived_from: tosca.relationships.DependsOn + description: Represents an association relationship between Vdu.Compute and VduCp node types + valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ] + + # node type definitions + tosca.nodes.nfv.VnfVirtualLink: + derived_from: tosca.nodes.Root + description: Describes the information about an internal VNF VL + properties: + connectivity_type: + type: tosca.datatypes.nfv.ConnectivityType + description: Specifies the protocol exposed by the VL and the flow pattern supported by the VL + required: true + description: + type: string + description: Provides human-readable information on the purpose of the VL + required: false + test_access: + type: list + description: Test access facilities available on the VL + required: false + entry_schema: + type: string + constraints: + - valid_values: [ passive_monitoring, active_loopback ] + vl_profile: + type: tosca.datatypes.nfv.VlProfile + description: Defines additional data for the VL + required: true + monitoring_parameters: + type: list + description: Describes monitoring parameters applicable to the VL + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualLinkMonitoringParameter + capabilities: + virtual_linkable: + type: tosca.capabilities.nfv.VirtualLinkable + + tosca.nodes.nfv.Vdu.Compute: + derived_from: tosca.nodes.Root + description: Describes the virtual compute part of a VDU which is a construct supporting the description of the deployment and operational behavior of a VNFC + properties: + name: + type: string + description: Human readable name of the VDU + required: true + description: + type: string + description: Human readable description of the VDU + required: true + boot_order: + type: list # explicit index (boot index) not necessary, contrary to IFA011 + description: References a node template name from which a valid boot device is created + required: false + entry_schema: + type: string + nfvi_constraints: + type: list + description: Describes constraints on the NFVI for the VNFC instance(s) created from this VDU + required: false + entry_schema: + type: string + monitoring_parameters: + type: list + description: Describes monitoring parameters applicable to a VNFC instantiated from this VDU + required: false + entry_schema: + type: tosca.datatypes.nfv.VnfcMonitoringParameter + #configurable_properties: + #type: tosca.datatypes.nfv.VnfcConfigurableProperties + #required: false + # derived types are expected to introduce + # configurable_properties with its type derived from + # tosca.datatypes.nfv.VnfcConfigurableProperties + vdu_profile: + type: tosca.datatypes.nfv.VduProfile + description: Defines additional instantiation data for the VDU.Compute node + required: true + sw_image_data: + type: tosca.datatypes.nfv.SwImageData + description: Defines information related to a SwImage artifact used by this Vdu.Compute node + required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise + boot_data: + type: string + description: Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. + required: false + capabilities: + virtual_compute: + type: tosca.capabilities.nfv.VirtualCompute + occurrences: [ 1, 1 ] + virtual_binding: + type: tosca.capabilities.nfv.VirtualBindable + occurrences: [ 1, UNBOUNDED ] + requirements: + - virtual_storage: + capability: tosca.capabilities.nfv.VirtualStorage + relationship: tosca.relationships.nfv.AttachesTo + occurrences: [ 0, UNBOUNDED ] + + tosca.nodes.nfv.Cp: + derived_from: tosca.nodes.Root + description: Provides information regarding the purpose of the connection point + properties: + layer_protocols: + type: list + description: Identifies which protocol the connection point uses for connectivity purposes + required: true + entry_schema: + type: string + constraints: + - valid_values: [ ethernet, mpls, odu2, ipv4, ipv6, pseudo-wire ] + role: #Name in ETSI NFV IFA011 v0.7.3: cpRole + type: string + description: Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS + required: false + constraints: + - valid_values: [ root, leaf ] + description: + type: string + description: Provides human-readable information on the purpose of the connection point + required: false + protocol: + type: list + description: Provides information on the addresses to be assigned to the connection point(s) instantiated from this Connection Point Descriptor + required: false + entry_schema: + type: tosca.datatypes.nfv.CpProtocolData + trunk_mode: + type: boolean + description: Provides information about whether the CP instantiated from this Cp is in Trunk mode (802.1Q or other), When operating in "trunk mode", the Cp is capable of carrying traffic for several VLANs. Absence of this property implies that trunkMode is not configured for the Cp i.e. It is equivalent to boolean value "false". + required: false + + tosca.nodes.nfv.VduCp: + derived_from: tosca.nodes.nfv.Cp + description: describes network connectivity between a VNFC instance based on this VDU and an internal VL + properties: + bitrate_requirement: + type: integer # in bits per second + description: Bitrate requirement in bit per second on this connection point + required: false + constraints: + - greater_or_equal: 0 + virtual_network_interface_requirements: + type: list + description: Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD + required: false + entry_schema: + type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements + order: + type: integer + description: The order of the NIC on the compute instance (e.g.eth2) + required: false + constraints: + - greater_or_equal: 0 + vnic_type: + type: string + description: Describes the type of the virtual network interface realizing the CPs instantiated from this CPD + required: false + constraints: + - valid_values: [ normal, virtio, direct-physical ] + requirements: + - virtual_link: + capability: tosca.capabilities.nfv.VirtualLinkable + relationship: tosca.relationships.nfv.VirtualLinksTo + - virtual_binding: + capability: tosca.capabilities.nfv.VirtualBindable + relationship: tosca.relationships.nfv.VirtualBindsTo + node: tosca.nodes.nfv.Vdu.Compute + + tosca.nodes.nfv.Vdu.VirtualBlockStorage: + derived_from: tosca.nodes.Root + description: This node type describes the specifications of requirements related to virtual block storage resources + properties: + virtual_block_storage_data: + type: tosca.datatypes.nfv.VirtualBlockStorageData + description: Describes the block storage characteristics. + required: true + sw_image_data: + type: tosca.datatypes.nfv.SwImageData + description: Defines information related to a SwImage artifact used by this Vdu.Compute node. + required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise + capabilities: + virtual_storage: + type: tosca.capabilities.nfv.VirtualStorage + description: Defines the capabilities of virtual_storage. + + tosca.nodes.nfv.VNF: + derived_from: tosca.nodes.Root + description: The generic abstract type from which all VNF specific abstract node types shall be derived to form, together with other node types, the TOSCA service template(s) representing the VNFD + properties: + descriptor_id: # instead of vnfd_id + type: string # GUID + description: Globally unique identifier of the VNFD + required: true + descriptor_version: # instead of vnfd_version + type: string + description: Identifies the version of the VNFD + required: true + provider: # instead of vnf_provider + type: string + description: Provider of the VNF and of the VNFD + required: true + product_name: # instead of vnf_product_name + type: string + description: Human readable name for the VNF Product + required: true + software_version: # instead of vnf_software_version + type: string + description: Software version of the VNF + required: true + product_info_name: # instead of vnf_product_info_name + type: string + description: Human readable name for the VNF Product + required: false + product_info_description: # instead of vnf_product_info_description + type: string + description: Human readable description of the VNF Product + required: false + vnfm_info: + type: list + required: true + description: Identifies VNFM(s) compatible with the VNF + entry_schema: + type: string + constraints: + - pattern: (^etsivnfm:v[0-9]?[0-9]\.[0-9]?[0-9]\.[0-9]?[0-9]$)|(^[0-9]+:[a-zA-Z0-9.-]+$) + localization_languages: + type: list + description: Information about localization languages of the VNF + required: false + entry_schema: + type: string #IETF RFC 5646 string + default_localization_language: + type: string #IETF RFC 5646 string + description: Default localization language that is instantiated if no information about selected localization language is available + required: false + #configurable_properties: + #type: tosca.datatypes.nfv.VnfConfigurableProperties + #description: Describes the configurable properties of the VNF + #required: false + # derived types are expected to introduce configurable_properties + # with its type derived from + # tosca.datatypes.nfv.VnfConfigurableProperties + #modifiable_attributes: + #type: tosca.datatypes.nfv.VnfInfoModifiableAttributes + #description: Describes the modifiable attributes of the VNF + #required: false + # derived types are expected to introduce modifiable_attributes + # with its type derived from + # tosca.datatypes.nfv.VnfInfoModifiableAttributes + lcm_operations_configuration: + type: tosca.datatypes.nfv.VnfLcmOperationsConfiguration + description: Describes the configuration parameters for the VNF LCM operations + required: false + monitoring_parameters: + type: list + entry_schema: + type: tosca.datatypes.nfv.VnfMonitoringParameter + description: Describes monitoring parameters applicable to the VNF. + required: false + flavour_id: + type: string + description: Identifier of the Deployment Flavour within the VNFD + required: true + flavour_description: + type: string + description: Human readable description of the DF + required: true + vnf_profile: + type: tosca.datatypes.nfv.VnfProfile + description: Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF + required: false + requirements: + - virtual_link: + capability: tosca.capabilities.nfv.VirtualLinkable + relationship: tosca.relationships.nfv.VirtualLinksTo + occurrences: [ 0, 1 ] + # Additional requirements shall be defined in the VNF specific node type (deriving from tosca.nodes.nfv.VNF) corresponding to NS virtual links that need to connect to VnfExtCps + interfaces: + Vnflcm: + type: tosca.interfaces.nfv.Vnflcm + + ntt.nslab.VNF: + derived_from: tosca.nodes.nfv.VNF + properties: + descriptor_id: + type: string + constraints: [ valid_values: [ b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 ] ] + default: b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 + descriptor_version: + type: string + constraints: [ valid_values: [ '1.0' ] ] + default: '1.0' + provider: + type: string + constraints: [ valid_values: [ 'NTT NS lab' ] ] + default: 'NTT NS lab' + product_name: + type: string + constraints: [ valid_values: [ 'Sample VNF' ] ] + default: 'Sample VNF' + software_version: + type: string + constraints: [ valid_values: [ '1.0' ] ] + default: '1.0' + vnfm_info: + type: list + entry_schema: + type: string + constraints: [ valid_values: [ Tacker ] ] + default: [ Tacker ] + flavour_id: + type: string + constraints: [ valid_values: [ simple ] ] + default: simple + flavour_description: + type: string + default: "" + requirements: + - virtual_link_external: + capability: tosca.capabilities.nfv.VirtualLinkable + - virtual_link_internal: + capability: tosca.capabilities.nfv.VirtualLinkable + interfaces: + Vnflcm: + type: tosca.interfaces.nfv.Vnflcm + + # policy type definition + tosca.policies.nfv.ScalingAspects: + derived_from: tosca.policies.Root + description: The ScalingAspects type is a policy type representing the scaling aspects used for horizontal scaling as defined in ETSI GS NFV-IFA 011 [1]. + properties: + aspects: + type: map # key: aspectId + description: Describe maximum scale level for total number of scaling steps that can be applied to a particular aspect + required: true + entry_schema: + type: tosca.datatypes.nfv.ScalingAspect + constraints: + - min_length: 1 + + tosca.policies.nfv.VduInitialDelta: + derived_from: tosca.policies.Root + description: The VduInitialDelta type is a policy type representing the Vdu.Compute detail of an initial delta used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1]. + properties: + initial_delta: + type: tosca.datatypes.nfv.VduLevel + description: Represents the initial minimum size of the VNF. + required: true + targets: [ tosca.nodes.nfv.Vdu.Compute ] + + tosca.policies.nfv.VduScalingAspectDeltas: + derived_from: tosca.policies.Root + description: The VduScalingAspectDeltas type is a policy type representing the Vdu.Compute detail of an aspect deltas used for horizontal scaling, as defined in ETSI GS NFV-IFA 011 [1]. + properties: + aspect: + type: string + description: Represents the scaling aspect to which this policy applies + required: true + deltas: + type: map # key: scalingDeltaId + description: Describes the Vdu.Compute scaling deltas to be applied for every scaling steps of a particular aspect. + required: true + entry_schema: + type: tosca.datatypes.nfv.VduLevel + constraints: + - min_length: 1 + targets: [ tosca.nodes.nfv.Vdu.Compute ] + + tosca.policies.nfv.InstantiationLevels: + derived_from: tosca.policies.Root + description: The InstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour and including default instantiation level in term of the number of VNFC instances to be created as defined in ETSI GS NFV-IFA 011 [1]. + properties: + levels: + type: map # key: levelId + description: Describes the various levels of resources that can be used to instantiate the VNF using this flavour. + required: true + entry_schema: + type: tosca.datatypes.nfv.InstantiationLevel + constraints: + - min_length: 1 + default_level: + type: string # levelId + description: The default instantiation level for this flavour. + required: false # required if multiple entries in levels + + tosca.policies.nfv.VduInstantiationLevels: + derived_from: tosca.policies.Root + description: The VduInstantiationLevels type is a policy type representing all the instantiation levels of resources to be instantiated within a deployment flavour in term of the number of VNFC instances to be created from each vdu.Compute. as defined in ETSI GS NFV-IFA 011 [1] + properties: + levels: + type: map # key: levelId + description: Describes the Vdu.Compute levels of resources that can be used to instantiate the VNF using this flavour + required: true + entry_schema: + type: tosca.datatypes.nfv.VduLevel + constraints: + - min_length: 1 + targets: [ tosca.nodes.nfv.Vdu.Compute ] + + tosca.policies.nfv.VirtualLinkInstantiationLevels: + derived_from: tosca.policies.Root + description: The VirtualLinkInstantiationLevels type is a policy type representing all the instantiation levels of virtual link resources to be instantiated within a deployment flavour as defined in ETSI GS NFV-IFA 011 [1]. + properties: + levels: + type: map # key: levelId + description: Describes the virtual link levels of resources that can be used to instantiate the VNF using this flavour. + required: true + entry_schema: + type: tosca.datatypes.nfv.VirtualLinkBitrateLevel + constraints: + - min_length: 1 + targets: [ tosca.nodes.nfv.VnfVirtualLink ] + + # interface type definitions + tosca.interfaces.nfv.Vnflcm: + derived_from: tosca.interfaces.Root + description: This interface encompasses a set of TOSCA operations corresponding to the VNF LCM operations defined in ETSI GS NFV-IFA 007 as well as to preamble and postamble procedures to the execution of the VNF LCM operations. + instantiate: + description: Invoked upon receipt of an Instantiate VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + instantiate_start: + description: Invoked before instantiate + instantiate_end: + description: Invoked after instantiate + terminate: + description: Invoked upon receipt Terminate VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + terminate_start: + description: Invoked before terminate + terminate_end: + description: Invoked after terminate + modify_information: + description: Invoked upon receipt of a Modify VNF Information request + modify_information_start: + description: Invoked before modify_information + modify_information_end: + description: Invoked after modify_information + change_flavour: + description: Invoked upon receipt of a Change VNF Flavour request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + change_flavour_start: + description: Invoked before change_flavour + change_flavour_end: + description: Invoked after change_flavour + change_external_connectivity: + description: Invoked upon receipt of a Change External VNF Connectivity request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + change_external_connectivity_start: + description: Invoked before change_external_connectivity + change_external_connectivity_end: + description: Invoked after change_external_connectivity + operate: + description: Invoked upon receipt of an Operate VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + operate_start: + description: Invoked before operate + operate_end: + description: Invoked after operate + heal: + description: Invoked upon receipt of a Heal VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + heal_start: + description: Invoked before heal + heal_end: + description: Invoked after heal + scale: + description: Invoked upon receipt of a Scale VNF request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + scale_start: + description: Invoked before scale + scale_end: + description: Invoked after scale + scale_to_level: + description: Invoked upon receipt of a Scale VNF to Level request + # inputs: + # additional_parameters: + # type: tosca.datatypes.nfv.VnfOperationAdditionalParameters + # required: false + # derived types are expected to introduce additional_parameters with + # its type derived from + # tosca.datatypes.nfv.VnfOperationAdditionalParameters + scale_to_level_start: + description: Invoked before scale_to_level + scale_to_level_end: + description: Invoked after scale_to_level + +topology_template: + inputs: + selected_flavour: + type: string + default: { get_input: selected_flavour } + description: VNF deployment flavour selected by the consumer. It is provided in the API + + substitution_mappings: + node_type: ntt.nslab.VNF + properties: + flavour_id: simple + requirements: + virtual_link_external: [ CP1, virtual_link ] + + node_templates: + VNF: + type: ntt.nslab.VNF + properties: + flavour_id: { get_input: selected_flavour } + descriptor_id: b1bb0ce7-ebca-4fa7-95ed-4840d70a1177 + provider: NTT NS lab + product_name: Sample VNF + software_version: '1.0' + descriptor_version: '1.0' + vnfm_info: + - Tacker + flavour_description: A simple flavour + requirements: + #- virtual_link_external # mapped in lower-level templates + #- virtual_link_internal # mapped in lower-level templates + # get_input function would be used by a TOSCA orchestrator at run time to access the selected flavour id. If the deployment is not done by a TOSCA orchestrator above function may not be needed + interfaces: + Vnflcm: + # supporting only 'instantiate', 'terminate', 'modify' + # not supporting LCM script, supporting only default LCM + instantiate: [] + instantiate_start: [] + instantiate_end: [] + terminate: [] + terminate_start: [] + terminate_end: [] + modify_information: [] + modify_information_start: [] + modify_information_end: [] + # change_flavour: [] + # change_flavour_start: [] + # change_flavour_end: [] + # change_external_connectivity: [] + # change_external_connectivity_start: [] + # change_external_connectivity_end: [] + # operate: [] + # operate_start: [] + # operate_end: [] + # heal: [] + # heal_start: [] + # heal_end: [] + # scale: [] + # scale_start: [] + # scale_end: [] + # scale_to_level: [] + # scale_to_level_start: [] + # scale_to_level_end: [] + + VDU1: + type: tosca.nodes.nfv.Vdu.Compute + properties: + name: VDU1 + description: VDU1 compute node + vdu_profile: + min_number_of_instances: 1 + max_number_of_instances: 1 + sw_image_data: + name: Software of VDU1 + version: '0.4.0' + checksum: + algorithm: sha-256 + hash: b9c3036539fd7a5f87a1bf38eb05fdde8b556a1a7e664dbeda90ed3cd74b4f9d + container_format: bare + disk_format: qcow2 + min_disk: 1 GiB + size: 1 GiB + + artifacts: + sw_image: + type: tosca.artifacts.nfv.SwImage + file: Files/images/cirros-0.4.0-x86_64-disk.img + + capabilities: + virtual_compute: + properties: + virtual_memory: + virtual_mem_size: 512 MiB + virtual_cpu: + num_virtual_cpu: 1 + virtual_local_storage: + - size_of_storage: 1 GiB + + VDU2: + type: tosca.nodes.nfv.Vdu.Compute + properties: + name: VDU2 + description: VDU2 compute node + vdu_profile: + min_number_of_instances: 1 + max_number_of_instances: 3 + + capabilities: + virtual_compute: + properties: + virtual_memory: + virtual_mem_size: 512 MiB + virtual_cpu: + num_virtual_cpu: 1 + virtual_local_storage: + - size_of_storage: 1 GiB + requirements: + - virtual_storage: VirtualStorage + + VirtualStorage: + type: tosca.nodes.nfv.Vdu.VirtualBlockStorage + properties: + virtual_block_storage_data: + size_of_storage: 30 GiB + rdma_enabled: true + sw_image_data: + name: VrtualStorage + version: '0.4.0' + checksum: + algorithm: sha-256 + hash: b9c3036539fd7a5f87a1bf38eb05fdde8b556a1a7e664dbeda90ed3cd74b4f9d + container_format: bare + disk_format: qcow2 + min_disk: 2 GiB + min_ram: 8192 MiB + size: 2 GiB + artifacts: + sw_image: + type: tosca.artifacts.nfv.SwImage + file: Files/images/cirros-0.4.0-x86_64-disk.img + + CP1: + type: tosca.nodes.nfv.VduCp + properties: + layer_protocols: [ ipv4 ] + order: 0 + vnic_type: direct-physical + requirements: + - virtual_binding: VDU1 + #- virtual_link: # the target node is determined in the NSD + + CP2: + type: tosca.nodes.nfv.VduCp + properties: + layer_protocols: [ ipv4 ] + order: 1 + requirements: + - virtual_binding: VDU1 + - virtual_link: internalVL2 + + CP3: + type: tosca.nodes.nfv.VduCp + properties: + layer_protocols: [ ipv4 ] + order: 2 + requirements: + - virtual_binding: VDU2 + - virtual_link: internalVL2 + + internalVL2: + type: tosca.nodes.nfv.VnfVirtualLink + properties: + connectivity_type: + layer_protocols: [ ipv4 ] + description: Internal Virtual link in the VNF + vl_profile: + max_bitrate_requirements: + root: 1048576 + leaf: 1048576 + min_bitrate_requirements: + root: 1048576 + leaf: 1048576 + virtual_link_protocol_data: + - associated_layer_protocol: ipv4 + l3_protocol_data: + ip_version: ipv4 + cidr: 11.11.0.0/24 + + policies: + - scaling_aspects: + type: tosca.policies.nfv.ScalingAspects + properties: + aspects: + worker_instance: + name: worker_instance_aspect + description: worker_instance scaling aspect + max_scale_level: 2 + step_deltas: + - delta_1 + + - VDU2_initial_delta: + type: tosca.policies.nfv.VduInitialDelta + properties: + initial_delta: + number_of_instances: 1 + targets: [ VDU2 ] + + - VDU2_scaling_aspect_deltas: + type: tosca.policies.nfv.VduScalingAspectDeltas + properties: + aspect: worker_instance + deltas: + delta_1: + number_of_instances: 1 + targets: [ VDU2 ] + + - instantiation_levels: + type: tosca.policies.nfv.InstantiationLevels + properties: + levels: + instantiation_level_1: + description: Smallest size + scale_info: + worker_instance: + scale_level: 0 + instantiation_level_2: + description: Largest size + scale_info: + worker_instance: + scale_level: 2 + default_level: instantiation_level_1 + + - VDU1_instantiation_levels: + type: tosca.policies.nfv.VduInstantiationLevels + properties: + levels: + instantiation_level_1: + number_of_instances: 1 + instantiation_level_2: + number_of_instances: 1 + targets: [ VDU1 ] + + - VDU2_instantiation_levels: + type: tosca.policies.nfv.VduInstantiationLevels + properties: + levels: + instantiation_level_1: + number_of_instances: 1 + instantiation_level_2: + number_of_instances: 3 + targets: [ VDU2 ] + + - internalVL2_instantiation_levels: + type: tosca.policies.nfv.VirtualLinkInstantiationLevels + properties: + levels: + instantiation_level_1: + bitrate_requirements: + root: 1048576 + leaf: 1048576 + instantiation_level_2: + bitrate_requirements: + root: 1048576 + leaf: 1048576 + targets: [ internalVL2 ] diff --git a/tacker/tests/functional/vnfpkgm/test_vnf_package.py b/tacker/tests/functional/vnfpkgm/test_vnf_package.py index 4775b8158..84be61d34 100644 --- a/tacker/tests/functional/vnfpkgm/test_vnf_package.py +++ b/tacker/tests/functional/vnfpkgm/test_vnf_package.py @@ -289,30 +289,9 @@ class VnfPackageTest(base.BaseTackerTest): expected_result = [package1] self.assertEqual(expected_result, body) - def _create_and_onboard_vnf_package(self, file_name=None): - body = jsonutils.dumps({"userDefinedData": {"foo": "bar"}}) - vnf_package = self._create_vnf_package(body) - if file_name is None: - file_name = "sample_vnf_package_csar.zip" - file_path = os.path.abspath(os.path.join(os.path.dirname(__file__), - '../../etc/samples/' + file_name)) - with open(file_path, 'rb') as file_object: - resp, resp_body = self.http_client.do_request( - '{base_path}/{id}/package_content'.format( - id=vnf_package['id'], - base_path=self.base_url), - "PUT", body=file_object, content_type='application/zip') - self.assertEqual(202, resp.status_code) - self._wait_for_onboard(vnf_package['id']) - - return vnf_package['id'] - def test_get_vnfd_from_onboarded_vnf_package_for_content_type_zip(self): - vnf_package_id = self._create_and_onboard_vnf_package() - self.addCleanup(self._delete_vnf_package, vnf_package_id) - self.addCleanup(self._disable_operational_state, vnf_package_id) resp, resp_body = self.http_client.do_request( - '{base_path}/{id}/vnfd'.format(id=vnf_package_id, + '{base_path}/{id}/vnfd'.format(id=self.package_id1, base_path=self.base_url), "GET", content_type='application/zip') self.assertEqual(200, resp.status_code) @@ -344,9 +323,9 @@ class VnfPackageTest(base.BaseTackerTest): def test_get_vnfd_from_onboarded_vnf_package_for_content_type_text( self, accept_header): # Uploading vnf package with single yaml file csar. - single_yaml_csar = "sample_vnfpkg_no_meta_single_vnfd.zip" - vnf_package_id = self._create_and_onboard_vnf_package( - single_yaml_csar) + single_yaml_csar_dir = "sample_vnfpkg_no_meta_single_vnfd" + vnf_package_id = self._create_and_upload_vnf( + single_yaml_csar_dir) self.addCleanup(self._delete_vnf_package, vnf_package_id) self.addCleanup(self._disable_operational_state, vnf_package_id) resp, resp_body = self.http_client.do_request( @@ -356,3 +335,62 @@ class VnfPackageTest(base.BaseTackerTest): self.assertEqual(200, resp.status_code) self.assertEqual('text/plain', resp.headers['Content-Type']) self.assertIsNotNone(resp.text) + + def test_fetch_vnf_package_content_partial_download_using_range(self): + """Test partial download using 'Range' requests for csar zip""" + # test for success on satisfiable Range request. + range_ = 'bytes=3-8' + headers = {'Range': range_} + response = self.http_client.do_request( + '{base_path}/{id}/package_content'.format( + id=self.package_id1, base_path=self.base_url), + "GET", body={}, headers=headers) + self.assertEqual(206, response[0].status_code) + self.assertEqual( + '\x04\x14\x00\x00\x00\x00', response[0].content.decode( + 'utf-8', 'ignore')) + self.assertEqual('6', response[0].headers['Content-Length']) + + def test_fetch_vnf_package_content_full_download(self): + """Test full download for csar zip""" + response = self.http_client.do_request( + '{base_path}/{id}/package_content'.format( + id=self.package_id1, base_path=self.base_url), + "GET", body={}, headers={}) + self.assertEqual(200, response[0].status_code) + self.assertEqual('12802866', response[0].headers['Content-Length']) + + def test_fetch_vnf_package_content_combined_download(self): + """Combine two partial downloads using 'Range' requests for csar zip""" + + zip_file_path = tempfile.NamedTemporaryFile(delete=True) + zipf = zipfile.ZipFile(zip_file_path, 'w', zipfile.ZIP_STORED) + + # Partial download 1 + range_ = 'bytes=0-10' + headers = {'Range': range_} + response_1 = self.http_client.do_request( + '{base_path}/{id}/package_content'.format( + id=self.package_id1, base_path=self.base_url), + "GET", body={}, headers=headers) + size_1 = int(response_1[0].headers['Content-Length']) + data = response_1[0].content + file_path = self._get_csar_dir_path("data.txt") + zipf.writestr(file_path, data) + + # Partial download 2 + range_ = 'bytes=11-12802866' + headers = {'Range': range_} + response_2 = self.http_client.do_request( + '{base_path}/{id}/package_content'.format( + id=self.package_id1, base_path=self.base_url), + "GET", body={}, headers=headers) + + data = response_2[0].content + zipf.writestr(file_path, data) + zipf.close() + size_2 = int(response_2[0].headers['Content-Length']) + total_size = size_1 + size_2 + self.assertEqual(True, zipfile.is_zipfile(zip_file_path)) + self.assertEqual(12802866, total_size) + zip_file_path.close() diff --git a/tacker/tests/unit/common/test_store.py b/tacker/tests/unit/common/test_store.py new file mode 100644 index 000000000..7feab0273 --- /dev/null +++ b/tacker/tests/unit/common/test_store.py @@ -0,0 +1,39 @@ +# Copyright (c) 2019 NTT DATA. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import os +import testtools + +from tacker.common import exceptions +from tacker import context +from tacker.glance_store import store +from tacker.tests import constants + + +class TestStore(testtools.TestCase): + + def setUp(self): + super(TestStore, self).setUp() + self.context = context.get_admin_context() + self.base_path = os.path.dirname(os.path.abspath(__file__)) + + def test_get_csar_size_invalid_path(self): + self.assertRaises( + exceptions.VnfPackageLocationInvalid, store.get_csar_size, + constants.UUID, 'Invalid/path') + + def test_load_csar_iter_invalid_path(self): + self.assertRaises( + exceptions.VnfPackageLocationInvalid, store.load_csar_iter, + constants.UUID, 'Invalid/path') diff --git a/tacker/tests/unit/conductor/test_conductor_server.py b/tacker/tests/unit/conductor/test_conductor_server.py index 3486e619c..758679fc1 100644 --- a/tacker/tests/unit/conductor/test_conductor_server.py +++ b/tacker/tests/unit/conductor/test_conductor_server.py @@ -108,7 +108,7 @@ class TestConductor(SqlTestCase): mock_load_csar_data.return_value = (mock.ANY, mock.ANY) mock_load_csar.return_value = '/var/lib/tacker/5f5d99c6-844a' \ '-4c31-9e6d-ab21b87dcfff.zip' - mock_store.return_value = 'location', 'size', 'checksum',\ + mock_store.return_value = 'location', 0, 'checksum',\ 'multihash', 'loc_meta' self.conductor.upload_vnf_package_from_uri(self.context, self.vnf_package, diff --git a/tacker/tests/unit/objects/fakes.py b/tacker/tests/unit/objects/fakes.py index 9b960bca3..c3189192e 100644 --- a/tacker/tests/unit/objects/fakes.py +++ b/tacker/tests/unit/objects/fakes.py @@ -30,7 +30,8 @@ vnf_package_data = {'algorithm': None, 'hash': None, 'user_data': {'abc': 'xyz'}, 'created_at': datetime.datetime( 2019, 8, 8, 0, 0, 0, tzinfo=iso8601.UTC), - 'deleted': False + 'deleted': False, + 'size': 0 } software_image = { diff --git a/tacker/tests/unit/objects/test_vnf_package.py b/tacker/tests/unit/objects/test_vnf_package.py index 0bbc4c71f..91af07137 100644 --- a/tacker/tests/unit/objects/test_vnf_package.py +++ b/tacker/tests/unit/objects/test_vnf_package.py @@ -46,6 +46,7 @@ class TestVnfPackage(SqlTestCase): self.assertEqual('CREATED', vnfpkgm.onboarding_state) self.assertEqual('NOT_IN_USE', vnfpkgm.usage_state) self.assertEqual('DISABLED', vnfpkgm.operational_state) + self.assertEqual(0, vnfpkgm.size) def test_create_without_user_define_data(self): vnf_pack = fakes.vnf_package_data @@ -177,3 +178,11 @@ class TestVnfPackage(SqlTestCase): vnfpkgm_list = objects.VnfPackagesList.get_by_filters( self.context, filters=filters) self.assertEqual(1, len(vnfpkgm_list)) + + def test_obj_make_compatible(self): + data = {'id': self.vnf_package.id} + vnf_package_obj = objects.VnfPackage(context=self.context, **data) + fake_vnf_package_obj = objects.VnfPackage(context=self.context, **data) + obj_primitive = fake_vnf_package_obj.obj_to_primitive('1.0') + obj = vnf_package_obj.obj_from_primitive(obj_primitive) + self.assertIn('size', obj.fields) diff --git a/tacker/tests/unit/vnfpkgm/test_controller.py b/tacker/tests/unit/vnfpkgm/test_controller.py index 0a2cd2c16..d0bc5cb66 100644 --- a/tacker/tests/unit/vnfpkgm/test_controller.py +++ b/tacker/tests/unit/vnfpkgm/test_controller.py @@ -526,7 +526,7 @@ class TestController(base.TestCase): vnf_package_obj = objects.VnfPackage(**vnf_package_dict) mock_vnf_by_id.return_value = vnf_package_obj mock_vnf_pack_save.return_value = vnf_package_obj - mock_glance_store.return_value = 'location', 'size', 'checksum',\ + mock_glance_store.return_value = 'location', 0, 'checksum',\ 'multihash', 'loc_meta' req = fake_request.HTTPRequest.blank( '/vnf_packages/%s/package_content' @@ -919,3 +919,27 @@ class TestController(base.TestCase): self.controller.get_vnf_package_vnfd, req, constants.UUID) self.assertEqual(http_client.INTERNAL_SERVER_ERROR, resp.status_code) + + def test_fetch_vnf_package_content_valid_range(self): + request = fake_request.HTTPRequest.blank( + '/vnf_packages/%s/package_content/') + request.headers["Range"] = 'bytes=10-99' + range_ = self.controller._get_range_from_request(request, 120) + self.assertEqual(10, range_.start) + self.assertEqual(100, range_.end) # non-inclusive + + def test_fetch_vnf_package_content_invalid_range(self): + request = fake_request.HTTPRequest.blank( + '/vnf_packages/%s/package_content/') + request.headers["Range"] = 'bytes=150-' + self.assertRaises(exc.HTTPRequestRangeNotSatisfiable, + self.controller._get_range_from_request, + request, 120) + + def test_fetch_vnf_package_content_invalid_multiple_range(self): + request = fake_request.HTTPRequest.blank( + '/vnf_packages/%s/package_content/') + request.headers["Range"] = 'bytes=10-20,21-30' + self.assertRaises(exc.HTTPBadRequest, + self.controller._get_range_from_request, request, + 120)