Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Package Management Diagram

The following diagram depicts ONAP ETSI Package Management.

Table of Contents

Requirements & Use Cases

...

  • Onboard ETSI SOL004 compliant VNF packages 
    • Support for onboarding ETSI v2v3.73.1 SOL004 CSAR Packages (Link to ETSI SOL004 v2v3.73.1 )
    • Support for onboarding ETSI v2v3.73.1 SOL001 VNF Descriptor (Link to ETSI SOL001 v2v3.73.1)
    • Support for mapping of ETSI v2v3.73.1 SOL001 VNF Descriptor into SDC AID Data Model
    • Support for using an ETSI v2v3.73.1 VNF in an ONAP Service
  • Onboard ETSI SOL007 compliant Network Service Descriptor packages (stretch goal for Guilin)packages 
    • Support for Cataloging and Preserving the original SOL007 package
    • Support for mapping of ETSI v2v3.73.1 SOL001 Network Service Descriptor in the SOL007 package into SDC AID Data Model
    • Support for deploying a service that contains an ETSI SOL001 v2v3.73.1 compliant Network Service using VF-C as the NFVO
    • Support for deploying a service that contains an ETSI SOL001 v2v3.73.1 compliant Network Service using an external NFVO
  • Design ETSI SOL007 compliant Network Service Descriptor packages
    • Support for deploying a service that contains an ETSI SOL001 v2v3.73.1 compliant Network Service using VF-C as the NFVO
    • Support for deploying a service that contains an ETSI SOL001 v2v3.73.1 compliant Network Service using an external NFVO
  • Support for Nested/Hierarchical ETSI SOL001 v2v3.73.1 Network Service Descriptor (not for Guilin)
  • Design Service templates, leveraging NSDs
    • Support Service templates including NSDs

Feature Descriptions

Feature

Description

SDC ETSI Package Management
  • SOL004 VNF/PNF Package includes SOL001 VNFD/PNFD with the original vendor package will be onboarded into SDC and  distributed from SDC to SVNFM/External NFVO.
  • SOL007 NS Package includes SOL001 NSD with the original vendor package will be onboarded into SDC and distributed from SDC to SVNFM/External NFVO.
  • SDC supports design of ETSI SOL007 compliant NSD packages and distribute them to SVNFM/External NFVO
  • SDC supports Nested/Hierarchical ETSI SOL001
v2
  • v3.
7
  • 3.1 NSD onboarding and distribution to ONAP runtime components.
ETSI Package Security

If the vendor package includes signature and certificate, ONAP supports the package security.

  • SOL004 VNF/PNF Package security is supported by the package signature and certificate
  • SOL007 NS Package security is supported by the package signature and certificate
  • SDC will store the vendor package with signature and certificate in a zip format in the ETSI_PACKAGE directory
  • ETSI Catalog Manager stores the vendor package zip files from the ETSI_PACKAGE directory
  • SVNFM/NFVO extracts the vendor package zip/CSAR files with package validation
ETSI Package Validation
  • VNF SDK will support SOL004 VNF package pre-onboarding for validation - optional
  • VNF SDK will support SOL007 NS package pre-onboarding for validation
- optional

Epic and User Story

  • - optional

Epic and User Story

Epic

User Story

Description

Honolulu Plan?

JIRA

Epic

User Story

Description

Guilin Plan?

JIRA

MaintenanceSupport the substitution_mappings in the VNFD.

Currently, the substitution_mappings is not supported by SDC. Lack of this support blocks SOL004 VNF package management and ETSI Catalog Manager:

  • Prior to Frankfurt, as a workaround, the operator creates a dummy VNF without the substitution_mappings or node_types in the MainServiceTemplate.yaml and added a real VNF package with the substitution_mappings and user-define nodes in its Artifacts>DEPLOYMENT>OTHER directory.
  • It is to trick the current SDC onboarding issues because SDC does not check the OTHER directory.
  • In the Frankfurt/Dublin release, SDC was enhanced to support the vendor VNF package in the ETSI_PACKAGE directory.
  • In the Guilin release, the ONBOARDED_PACKAGE directory is changed to the ETSI_PACKAGE.
  • Since SDC Frankfurt/Dublin, we don't have to use the secondary VNF package unnecessary, but we still needs to follow an old way because of lack of substitution_mappings and user-defined node_types.
  • When SDC supports the subscription_mappings user-defined node types, the vendor VNF package does not have to add another VNF package in the Artifacts>DEPLOYMENT>OTHER directory, and the ETSI Catalog Manager will support the VNF package in the ETSI_PACKAGE directory.
    • ETSI Catalog Manager will depend on this SDC support.

Support of the substitution_mappings and user-defined node_types will remove the issues and support ETSI package management and others.

Support of the user-defined node types is handled by another task. This task needs to handle the substitution_mappings only.

For the testing,  use the vgw6.csar

For the Frankfurt release workaround, we added the following to the MainServiceTemplate.yaml, so the ETSI Catalog Manager can retrieve the descriptor_id from the metadata, instead of from the node_type. Once the substitution_mapping is supported by SDC, we don't have to use the descriptor_id in the metadata section.

  • descriptor_id: b1bb0ce7-2222-4fa7-95ed-4840d70a1177
Yes JiraserverONAP JIRAserverId425b2b0a-557c-3c0c-b515-579789cceedbkeySDC-2957

Onboard and Design ETSI SOL004 compliant VNF packages


Executive Summary - Enable a vendor provided ETSI SOL004 compliant VNF package including an ETSI SOL001 VNF Descriptor to  be onboarded into ONAP for composition into an ONAP Service

Business Impact - Enables operators and service providers to use same ETSI compliant VNF packages with ONAP and existing NFVO. Industry compatibility.

Business Markets - All operators that are currently using ETSI packages to deploy VNFs

Funding/Financial Impacts - Reduction in operations expense from using industry standard VNF packaging.  Reduction in capital expense from vendors using a single packaging methodology.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 

No

Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2610


Support for onboarding ETSI

v2

v3.

7

3.1 SOL001 VNF Descriptor (Link to ETSI SOL001

v2

v3.

7

3.1)

Support for onboarding ETSI

v2

v3.

7

3.1 SOL001 VNF Descriptor (Link to ETSI SOL001

v2

v3.

7

3.1)

  • Support SDC AID DM VF descriptor (see the 

79200568
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2611



Support for mapping of ETSI

v2

v3.

7

3.1 SOL001 VNF Descriptor into SDC AID Data Model

Support for mapping of ETSI

v2

v3.

7

3.1 SOL001 VNF Descriptor into SDC AID Data Model

VNF Mapping:

  • Define a new data type based on the org.openecomp.resource.abstract.nodes.VF with ETSI SOL001 VNF data type attributes.

    • Make the org.openecomp.resource.abstract.nodes.ETSI.VNF a superset of both tosca.nodes.nfv.VNF and org.openecomp.resource.abstract.node.VF
    • During VNF onboarding, SDC copies SOL001 VNF attribute contents to the corresponding attributes in the org.openecomp.resource.abstract.nodes.ETSI.VNF
      • In Guilin, SO NFVO, VFC and SVNFM get those SOL001 VNF attributes from the descriptor, not from AAI. So, AAI schema changes are not expected in Guilin.
    • SOL001 VNF attributes in SDC AID DM VNF will be visible to SDC UI, so SDC UI can change the attributes.
      • But the onboarded vendor ETSI package will note be changed by the SDC UI users in Guilin.
      • Since SO NFVO, VFC and SVNFM use only the original ETSI package, those changes will not be used in Guilin;
      • For the Honolulu release, it is under consideration
        • to sync up between those modified SOL001 VNF attributes and the vendor ETSI Package attributes 
        • to reflect those modified SOL001 VNF attributes in the orchestration
    • ONAP specific attributes that are inherited from the org.openecomp.resource.abstract.nodes.VF will be filled up by SDC (design time)
      • Those attribute contents will not be mapped back into the SOL001 VNF (reverse mapping). For that case, only the SOL001 VNF corresponding attributes will be copied

VDU Mapping:

  • Make the org.openecomp.resource.abstract.nodes.ETSI.VFC a superset of both tosca.nodes.nfv.Vdu and org.openecomp.resource.abstract.nodes.VFC
  • Note: the org.openecomp.resource.abstract.nodes.VFC represents design-time VFC, not VFC instances
  • During VNF onboarding, SDC copies SOL001 VDU attribute contents to the corresponding attributes in the org.openecomp.resource.abstract.nodes.ETSI.VFC
    • In Guilin, SO NFVO, VFC and SVNFM get those SOL001 VDU attributes from the descriptor, not from AAI. So, AAI schema changes are not expected in Guilin.
  • SOL001 VDU attributes in SDC AID DM VNF will be visible to SDC UI, so SDC UI can change the attributes.
    • But the onboarded vendor ETSI package will note be changed by the SDC UI users in Guilin.
    • Since SO NFVO, VFC and SVNFM use only the original ETSI package, those changes will not be used in Guilin;
    • For the Honolulu release, it is under consideration
      • to sync up between those modified SOL001 VDU attributes and the vendor ETSI Package attributes 
      • to reflect those modified SOL001 VDU / VFC attributes in the orchestration

VF-Module Mapping:

  • SDC deduces the VF-Module from the SOL001 VNFD Policies>scaling_aspects>properties>aspects
  • Additional VF-Module attributes are deduced as the following table
  • SOL003 Adapter may need to transform the VF-Module back to the SOL001 VNFD policies for the scaling and healing requests from VNFM(s) – not part of Guilin
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2617


Support for editing ETSI
v2
v3.
7
3.1 SOL001 VNF Descriptor
  • Support for editing ETSI
v2
  • v3.
7
  • 3.1 SOL001 VNF Descriptor
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2881


Support for using an ETSI

v2

v3.

7

3.1 VNF in an ONAP Service

  • Support for using an ETSI
v2
  • v3.
7
  • 3.1 VNF in an ONAP Service

TBD

Onboard ETSI SOL007 compliant Network Service Descriptor packages


Executive Summary - Onboard an ETSI SOL007

v2

v3.

7

3.1 compliant (Link to ETSI SOL007

v2

v3.

7

3.1)  Network Service Descriptor package including an ETSI version

2

3.

7

3.1 SOL001 Network Service Descriptor (NSD) to  be onboarded into ONAP for composition into an ONAP Service or deployment using an ETSI compliant NFVO.

  • Support for Cataloging and Preserving the original SOL007 package

  • Support for mapping of ETSI

v2
  • v3.

7
  • 3.1 SOL001 Network Service Descriptor in the SOL007 package into SDC AID Data Model

  • Support for deploying a service that contains an ETSI SOL001

v2
  • v3.

7
  • 3.1 compliant Network Service using VF-C as the NFVO

  • Support for deploying a service that contains an ETSI SOL001

v2
  • v3.

7
  • 3.1 compliant Network Service using an external NFVO

Business Impact - Enables operators and service providers to use vendor provided and internally designed Network Service Descriptors with ONAP and existing NFVO. Industry compatibility.

Business Markets - All operators and service providers that are developing ETSI compatible Network Services

Funding/Financial Impacts - Reduction in operations expense from using industry standard NSD packaging.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 

No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2801


Support onboarding for Cataloging and Preserving the original SOL007 package

Support onboarding for Cataloging and Preserving the original SOL007 package (Link to ETSI SOL001

v2

v3.

7

3.1)

No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2806






Design ETSI SOL007 compliant Network Service Descriptor & packages


Executive Summary - Design, catalog and distribute  an ETSI SOL007

v2

v3.

7

3.1 compliant (Link to ETSI SOL007

v2

v3.

7

3.1)  Network Service Descriptor package including an ETSI version

2

3.

7

3.1 SOL001 Network Service Descriptor (NSD) for deployment using an ETSI compliant NFVO.

  • Support for deploying a service that contains an ETSI SOL001

v2
  • v3.

7
  • 3.1 compliant Network Service using VF-C as the NFVO

  • Support for deploying a service that contains an ETSI SOL001

v2
  • v3.

7
  • 3.1 compliant Network Service using an external NFVO

Business Impact - Enables operators and service providers to use vendor provided and internally designed Network Service Descriptors with ONAP and existing NFVO. Industry compatibility.

Business Markets - All operators and service providers that are developing ETSI compatible Network Services

Funding/Financial Impacts - Reduction in operations expense from using industry standard NSD packaging.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 

Yes

(enhancements)

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2802

Note: there is a PoC for this. Soon, the PoC design could be shared as initial input for discussions


Design ETSI SOL001 NSD and generate an ETSI SOL001
v2
v3.
7
3.1 compliant Network Service Descriptor & package

Design ETSI SOL001 NSD and generate ETSI SOL007 compliant Network Service package

  • Create NS and compose NS with its sub components, such as VNFs, VLs, VNF-FG and dependencies between VNFs, etc. - final support scope will be defined
  • Support for mapping of ETSI SOL001 Network Service Descriptor in the SOL007 package into SDC AID Data Model
    • use SOL001 NSD as SDC AID DM
  • Generate SOL007 NS package

Yes

(enhancement)

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2808


Support for mapping of ETSI
v2
v3.
7
3.1 SOL001 Network Service Descriptor in the SOL007 package into SDC AID Data Model

Support for mapping of ETSI SOL001 Network Service Descriptor in the SOL007 package into SDC AID Data Model

  • use SOL001 NSD as SDC AID DM
  • support only ETSI NS and NsVirtualLink only

Yes

(enhancement)

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2618


Support design of Service templates, leveraging NSDsSupport design of Service templates, leveraging NSDs
No

Yes


Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2882


Change the ONBOARDED_PACKAGE directory to ETSI_PACKAGE directoryChange the ONBOARDED_PACKAGE directory to ETSI_PACKAGE directory

Yes

(enhancement)

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-3244

Support for Nested/Hierarchical ETSI SOL001
v2
v3.
7
3.1 Network Service Descriptor

Executive Summary Onboard an ETSI SOL007

v2

v3.

7

3.1 compliant (Link to ETSI SOL007

v2

v3.

7

3.1)  Network Service Descriptor package including an ETSI version

2

3.

7

3.1 SOL001 Network Service Descriptor (NSD) that includes references to other Network Service Descriptors for composition into an ONAP Service or deployment using an ETSI compliant NFVO.

Business Impact - Enables operators and service providers to use vendor provided and internally designed Network Service Descriptors with ONAP and existing NFVO. Industry compatibility.

Business Markets - All operators and service providers that are developing ETSI compatible Network Services especially for 5G Slicing where each Slice Subnet is associated with a Network Service 

Funding/Financial Impacts - Reduction in operations expense from using industry standard NSD packaging.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 

No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2803


Support for onboarding of the SOL007
v2
v3.
7
3.1 compliant NSD package including SOL001 NSD that includes references to other NSDs for composition into ONAP ServiceSupport for onboarding of the SOL007
v2
v3.
7
3.1 compliant NSD package including SOL001 NSD that includes references to other NSDs for composition into ONAP Service
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2811

Onboard ETSI SOL004 compliant PNF packages

Executive Summary - Enable a vendor provided ETSI SOL004 compliant PNF package including an ETSI SOL001 PNF Descriptor to  be onboarded into ONAP for composition into an ONAP Service

Business Impact - Enables operators and service providers to use same ETSI compliant PNF packages with ONAP and existing NFVO. Industry compatibility.

Business Markets - All operators that are currently using ETSI packages to deploy PNFs

Funding/Financial Impacts - Reduction in operations expense from using industry standard PNF packaging.  Reduction in capital expense from vendors using a single packaging methodology.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 

No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2805


SDC supports onboarding of the SOL004 PNF package includes SOL001 PNFD

  • PNFD onboarding is done and its regression testing will be done
  • SOL004 PNF package onboarding is done in Dublin but support
v2
  • v3.
7
  • 3.1
  • Update onboarding procedure for
v2
  • v3.
7
  • 3.1
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2837



Support for mapping of ETSI

v2

v3.

7

3.1 SOL001 PNF Descriptor into SDC AID Data Model


SOL001 PNFD
2
3.
7
3.1 Mapping to SDC AID DM
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2836

Support additional package artifact Indicators for ETSI packages and Non-ETSI packages

SDC supports additional package artifact types to split ETSI packages from other non-ETSI TOSCA packages

  • SDC (notification) generates additional artifact types
  • SDC client filters on the additional artifact types
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2813


SDC Notification supports additional package artifact types to split ETSI package from other non-ETSI TOSCA packages

SDC (Notification) supports additional package artifact types to split ETSI package from other non-ETSI TOSCA packages

  • for SOL004 and SOL007 packages, artifact type = ONBOARDED_ETSI_PACKAGE
  • for non-ETSI TOSCA package, artifact type = ONBOARDED_ONAP_PACKAGE
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2814


SDC client supports additional filtering on the artifact types for distinguishing between ETSI packages and Non-ETSI packages

SDC client supports additional filtering on the artifact types for distinguishing between ETSI packages and Non-ETSI packages

  • for SOL004 and SOL007 packages, filtering for artifact type = ONBOARDED_ETSI_PACKAGE
  • for non-ETSI TOSCA package, filtering for artifact type = ONBOARDED_ONAP_PACKAGE
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2815

Support ETSI Package Security and validation
  • ONAP supports vendor ETSI Package Security and validation

    • If the vendor package includes signature and certificate, ONAP supports the package security
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2613


  • SOL004 VNF/PNF Package security will be supported by SDC, based on the package signature and certificate
  • ONAP SDC supports the package security
Done

  • SOL007 NS Package security will be supported by SDC, based on the package signature and certificate
  • ONAP SDC supports the package security
No
Yes

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-2614

Support of ETSI Package Validation
VNF SDK will support ETSI package validation for VNF and NSTBD

VNF SDK will support ETSI VNF package pre-onboarding for validationVNF SDK will support ETSI VNF package pre-onboarding for validationTBD

VNF SDK will support ETSI NS package pre-onboarding for validationVNF SDK will support ETSI NS package pre-onboarding for validationTBD

ETSI Package Management Architecture

...

  1. At onboarding, SDC checks the file extension and performs the following procedures
    1. If the file is .zip, SDC unzips
      1. If it has .cert & .cms, it is a package with security and security validation will be performed.
      2. If it does not include .cert & .cms, it is an existing Heat template onboarding, and SDC follows the Heat template onboarding procedure
  2. If the file is .csar, it is a package without security.
  3. Next, SDC will check the TOSCA.meta file.
  4. If it contains SOL004v2.x.1 keywords, the package will be handled as SOL004v2.x.1. In the Guilin release, v2v3.73.1 will be supported.
  5. Otherwise, it will be handled as existing TOSCA (non-SOL004) package onboarding which will not have the ETSI_PACKAGE artifact.

...

  • SDC takes the vendor provided package and adds some files or changes files and meta data according to SDC procedure.
  • SDC NS/VNF/PNF Onboarding Procedure and Original Vendor VNF/PNF Package Handling
    • SDC onboarding enhancement was made to the SDC Dublin to support SOL004 PNF/VNF onboarding with .zip and .csar file extensions. We continue to support the current onboarding mechanism with some enhancements.
    • SOL007 NS onboarding (stretch goal for Guilin) will follow the same procedure; i.e., storing the vendor SOL007 NS package into the “ETSI_PACKAGE” directory.
    • SOL007 NS design will allow users to build SOL007 NS package including SOL001 NSD from scratch
    • SDC VSP and Resource csar files have the “ETSI_PACKAGE” directory, which will contain the original vendor VNF/NS/PNF package.
      • The “ONBOARDED_PACKAGE” directory name will be changed to “ETSI_PACKAGE” as a common ETSI directory name. This change is necessary to support design of SOL007 package
      • ONAP-ETSI Catalog Manager will be extracted the ETSI packages from the “ETSI_PACKAGE” directory.
      • The VNFM and external NFVO use the original vendor VNF/NS/PNF packages through ETSI Catalog Manager.
  • SDC provides mapping from ETSI SOL001 NSD/VNFD/PNFD (PNF in the future) to SDC AID DM
    • See the subsequent slides for mapping.
  • Note: ETSI 23.73.1 handling will be discussed separately.

...

The following summarizes the mapping between two models:

SOL001 Data ModelSDC AID DMCommentsRelease
N/Aorg.openecomp.resource.abstracts.nodes.servicerepresents OSS Service models
tosca.nodes.nfv.NStosca.nodes.nfv.NSNS; use of SOL001 as SDC AID DM NSGuilin
tosca.nodes.nfv.NsVirtualLinktosca.nodes.nfv.NsVirtualLinkNS VirtualLink; use of SOL001 as SDC AID DM VLGuilin
tosca.nodes.nfv.Vnforg.openecomp.resource.abstract.nodes.ETSI.VNFVNFPlan for Honolulu
tosca.nodes.nfv.vduorg.openecomp.resource.abstract.nodes.ETSI.VFCVDU and SDC VFCPlan for Honolulu
tosca.nodes.nfv.VirtualLinkorg.openecomp.resources.vlVNF VLPlan for Honolulu
tosca.nodes.nfv.VduCporg.openecomp.resources.cpVDU CPPlan for Honolulu
N/Aorg.openecomp.resource.allottedResourceallotted resource; could not find any from SOL001
tosca.nodes.nfv.Pnforg.openecomp.resource.abstract.nodes.ETSI.PNFPNFPlan for Honolulu (PNF support is under discussion for Honolulu


Current SDC Resource Models

SDC: nfv-types
SDC: heat-types
ETSI NFV IESDC Descriptor / SOL001TOSCA TypeDerived fromSDC DescriptorTOSCA TypeDerived from
NSDnodes.yml / SOL001tosca.nodes.nfv.NStosca.nodes.RootGeneric_Service.yml(question)

org.openecomp.resource.abstract.nodes.service

(use it for both E2E (OSS Service) and NS)

tosca.nodes.Root
NSD.ymlorg.openecomp.resource.vfc.NSDtosca.nodes.RootN/A

SapDSOL001tosca.nodes.nfv.Saptosca.nodes.Root


NsVirtualLinkDescSOL001

tosca.nodes.nfv.NsVirtualLink

(there is tosca.nodes.nfv.VnfVirtualLink)

tosca.nodes.Rootvl.ymlorg.openecomp.resource.vl.VLtosca.nodes.network.Network



extVl.ymlorg.openecomp.resource.vl.extVLtosca.nodes.Root



internalVl.ymlorg.openecomp.resource.vl.internalVLtosca.nodes.network.Network
extZteVL.ymltosca.nodes.nfv.ext.zte.VLtosca.nodes.Root


Pnfd
tosca.nodes.nfv.PNFtosca.nodes.RootGeneric_PNF.ymlorg.openecomp.resource.abstract.nodes.PNFtosca.nodes.Root
VnfdVNF.ymltosca.nodes.nfv.VNFtosca.nodes.RootGeneric_VF.ymlorg.openecomp.resource.abstract.nodes.VFtosca.nodes.Root
Vnffgd
tosca.groups.nfv.VNFFGtosca.groups.RootforwardingPath.yml(?)org.openecomp.nodes.ForwardingPathtosca.nodes.Root







NSD Mapping to SDC AID DM

...

  • ONAP previous analysis
    • The SDC NSD node type, org.openecom.resource.vfc.NSD, is modeled as a component of a VF to represent an allotted resource. But, it is not derived from the org.openecomp.resource.vfc.AllottedResource, either. 
    • The SDC NSD might be designed for Volte use case support, and used by the VFC.
    • It is recommended to deprecate the current SDC NSD node type, and to replace with SOL001 tosca.nodes.nfv.NS node type.
  • Solutions
    • SDC generates SOL001 tosca.nodes.nfv.NS node type
    • SDC takes SOL001 NSD with tosca.nodes.nfv.NS node type as is, without mapping; i.e., no mapping is necessary
    • ONAP SO NFVO uses the SOL001 NSD
    • VFC needs to use the SOL001 NSD
    • There could be some impact on VID and ONAP SO Catalog DB for the SOL001 NSD - to be analyzed.
  • Guilin Decisions
    • SDC generates SOL001 tosca.nodes.nfv.NSD node type, and uses it as SDC AID DM.
SOL001 NS


SOL001 NS (tosca.nodes.nfv.NS) - Chosen


SDC NSD

org.openecomp.resource.vfc.NSD

namerequiredtype
namerequiredtype
descriptor_idyesstring
nsd_idtruestring
designeryesstring
nsd_designertruestring
versionyesstring
nsd_versiontruestring
nameyesstring
nsd_nametruestring
invariant_idyesstring
providing_service_uuidtruestring
flavor_idyesstring
providing_service_invariant_uuidtruestring
ns_profilenotosca.datatypes.nfv.NsProfile
providing_service_nametruestring

<tosca.datatypes.nfv.NsProfile>

...

Current VNF Modeling in ETSI and SDC

SOL001 VNF (tosca.nodes.nfv.VNF)
  • from SOL001
v2
  • v3.
7
  • 3.1

SDC AID DM VNF (org.openecomp.resource.abstract.nodes.VF)
  • from SDC Generic_VF.yml

org.openecomp.resource.vf.vcpeInfrastructureGwDemoApp (derived from org.openecomp.resource.abstract.nodes.VF)
namerequiredtype
namerequiredtype
namerequiredtype
descriptor_idyesstring
nf_function
string
nf_function
string
descriptor_versionyesstring
nf_role
string
nf_role
string
provideryesstring
nf_type
string
nf_type
string
product_nameyesstring
nf_naming_code
string
nf_name_code
string
software_versionyesstring
nf_naming
org.openecomp.datatyhpes.Naming
nf_naming
org.openecomp.datatyhpes.Naming
product_info_nameno string
availability_zone_max_count
integer
availablity_zone_max_count
integer
vnfm_infoyeslist of string
min_instances
integer
min_instances
integer
localization_languagesnolist of string
max_instances
integer
max_instances
integer
default_localization_languageno string
multi_stage_design
boolean
multi_stage_design
boolean
configurable_propertiesnotosca.datatypes.nfv.VnfconfigurableProperties
sdnc_model_name
string
vf_module_idno
modifiable_attributesnotosca.datatypes.nfv.VnfInfoModifiableAttributes
sdnc_artifact_name
string
vcpe_image_nameno
lcm_operations_configuraionnotosca.datatypes.nfv.VnfLcmOperationsConfiguration
skip_post_instantiation_configuration

boolean (default true)

  • constraints : true, false

public_net_idno
monitoring_parametersnolist of tosca.dataypes.nfv.VnfMonitoringParameter
controller_actor

string (default: SO-REF-DATA)

  • constraints: SO-REF-DATA, CDS, SDNC, APPC

vgw_name_0no
flavour_idyesstring




nexus_artifact_repono
flavour_descriptionyesstring




mux_ip_addrno
vnf_profilenotosca.datatyhpes.nfv.VnfProfile




vnf_idno








cpe_public_net_cidrno








vg_vgmux_tunnel_vnino








nf_namingno








multi_stage_designno
<tosca.datatypes.nfv.VnfProfile>






nf_naming_codeno
instantiation_levelnostring




vgw_private_ip_0no
min_number_of_instancesyesinteger




vgw_private_ip_1no
max_number_of_instancesyesinteger




vgw_private_ip_2no








pub_keyno








install_script_versionno








onap_private_net_cidrno








cpe_public_net_idno








mux_gw_private_net_idno








dcae_collector_ipno








dcae_collector_portno








onap_private_net_idno








cloud_envno

Solutions:

There are two options. For now, we chose the option A. The option B is under discussion.

...

  • Make the org.openecomp.resource.abstract.nodes.ETSI.VNF a superset of both tosca.nodes.nfv.VNF and org.openecomp.resource.abstract.node.VF
  • During VNF onboarding, SDC copies SOL001 VNF attribute contents to the corresponding attributes in the org.openecomp.resource.abstract.nodes.ETSI.VNF
    • In Guilin, SO NFVO, VFC and SVNFM get those SOL001 VNF attributes from the descriptor, not from AAI. So, AAI schema changes are not expected in Guilin.
  • SOL001 VNF attributes in SDC AID DM VNF will be visible to SDC UI, so SDC UI can change the attributes.
    • But the onboarded vendor ETSI package will note be changed by the SDC UI users in Guilin.
    • Since SO NFVO, VFC and SVNFM use only the original ETSI package, those changes will not be used in Guilin;
    • For the Honolulu release, it is under consideration
      • to sync up between those modified SOL001 VNF attributes and the vendor ETSI Package attributes 
      • to reflect those modified SOL001 VNF attributes in the orchestration
  • ONAP specific attributes that are inherited from the org.openecomp.resource.abstract.nodes.VF will be filled up by SDC (design time)
    • Those attribute contents will not be mapped back into the SOL001 VNF (reverse mapping). For that case, only the SOL001 VNF corresponding attributes will be copied


SOL001 VNF (tosca.nodes.nfv.VNF)

Mapping

New SDC AID DM VNF (org.openecomp.resource.abstract.nodes.ETSI.VNF)

derived from org.openecomp.resource.abstract.nodes.VF

namerequiredtype
namerequiredtype
<SOL001 tosca.nodes.nfv.VNF attributes >


<SOL001 tosca.nodes.nfv.VNF attributes >

descriptor_idyesstring<-->descriptor_idyesstring
descriptor_versionyesstring<-->descriptor_versionyesstring
provideryesstring<-->provideryesstring
product_nameyesstring<-->product_nameyesstring
software_versionyesstring<-->software_versionyesstring
product_info_nameno string<-->product_info_nameno string
vnfm_infoyeslist of string<-->vnfm_infoyeslist of string
localization_languagesnolist of string<-->localization_languagesnolist of string
default_localization_languageno string<-->default_localization_languageno string
configurable_propertiesnotosca.datatypes.nfv.VnfconfigurableProperties<-->configurable_propertiesnotosca.datatypes.nfv.VnfconfigurableProperties
modifiable_attributesnotosca.datatypes.nfv.VnfInfoModifiableAttributes<-->modifiable_attributesnotosca.datatypes.nfv.VnfInfoModifiableAttributes
lcm_operations_configurationnotosca.datatypes.nfv.VnfLcmOperationsConfiguration<-->lcm_operations_configurationnotosca.datatypes.nfv.VnfLcmOperationsConfiguration
monitoring_parametersnolist of tosca.datatypes.nfv.VnfMonitoringParameter<-->monitoring_parametersnolist of tosca.datatypes.nfv.VnfMonitoringParameter
flavour_idyesstring<-->flavour_idyesstring
flavour_descriptionyesstring<-->flavour_descriptionyesstring
vnf_profilenotosca.datatypes.nfv.VnfProfile<-->vnf_profilenotosca.datatypes.nfv.VnfProfile




<SDC AID DM VF attributes that are inherited from org.openecomp.resource.abstract.nodes.VF>

<the followings are being considered>


nf_functionnostring
requirementsYes

nf_rolenostring
interfacesyestosca.interfaces.nfv.VnfLcm
nf_typenostring




nf_naming_codenostring




nf_namingnoorg.openecomp.datatypes.Naming




availability_zone_max_countnointeger




min_instancesnointeger




max_instancesnointeger




multi_stage_designnoboolean




sdnc_model_namenostring




sdnc_artifact_namenostring




skip_post_instantiation_configurationno

boolean (default true)

  • constraints: true, false




controller_actorno

string (default: SO-REF-DATA)

  • constraints: SO-REF-DATA, CDS, SDNC, APPC








Option B:

Define a new data type based on the tosca.nodes.nfv.VNF with SDC AID DM VNF data type attributes.

  • SDC AID DM VNF data type attributes will be handled as the 'additionalAttributes', which is a map of key, value pairs.
  • Those attribute contents will not be mapped back into the SOL001 VNF (reverse mapping). For that case, only the SOL001 VNF corresponding attributes will be copied.

a new data type org.openecomp.resource.abstract.nodes.ETSI.VNF that is inherited from SOL001 VNF (tosca.nodes.nfv.VNF)

namerequiredtype
<SOL001 tosca.nodes.nfv.VNF attributes >

descriptor_idyesstring
descriptor_versionyesstring
provideryesstring
product_nameyesstring
software_versionyesstring
product_info_nameno string
vnfm_infoyeslist of string
localization_languagesnolist of string
default_localization_languageno string
configurable_propertiesnotosca.datatypes.nfv.VnfconfigurableProperties
modifiable_attributesnotosca.datatypes.nfv.VnfInfoModifiableAttributes
lcm_operations_configuraionnotosca.datatypes.nfv.VnfLcmOperationsConfiguration
monitoring_parametersnolist of tosca.dataypes.nfv.VnfMonitoringParameter
flavour_idyesstring
flavour_descriptionyesstring
vnf_profilenotosca.datatyhpes.nfv.VnfProfile
additionalAttriubtes (or nonManoAttributes)nomap of key, value pair


SOL001 VDU mapping to/from VNF SDC AID DM VFC

...

  • no 1:1 mapping
  • note: the SDC AID DM VFC represents design-time VFC (like VDU), not VFC instances in runtime
SOL001 VDU

SDC AID DM VFC (org.openecomp.resource.abstract.nodes.VFC)

NameRequiredTypeNameRequiredType
nameyesstringnfc_function
string
descriptionyesstringhigh_availabilitynostring
boot_ordernobooleanvm_image_name
string
nfvi_constraintsnomap of stringvm_flavor_nameyesstring
monitoring_parametersnolist of tosca.datatypes.nfv.VnfcMonitoringParameternfc_naming_codenostring
configurable_propertiesnomap of tosca.datatypes.nfv.VnfcConfigurablePropertiesvm_type_tagnostring
boot_datanotosca.datatypes.nfv.BootDatanfc_naming

org.openecomp.datatypes.Naming

  • ONAP_generated_naming: yes: boolean
  • naming_policy: no: string
  • instance_name: no: string
vdu_profileyestosca.datatypes.nfv.VduProfilemin_instancesnointeger
sw_image_datanotosca.datatypes.nfv.SwImageData








Solutions for VDU and VFC mapping

...

New SDC AID DM VFC type (org.openecomp.resource.abstract.nodes.ETSI.VFC)

SOL001 VDU

Mapping

org.openecomp.resource.abstract.nodes.ETSI.VFC

(derived from org.openecomp.resource.abstract.nodes.VFC)



NameRequiredType<-->NameRequiredType
nameyesstring<-->nameyesstring
descriptionyesstring<-->descriptionyesstring
boot_ordernoboolean<-->boot_ordernoboolean
nfvi_constraintsnomap of string<-->nfvi_constraintsnomap of string
monitoring_parametersnolist of tosca.datatypes.nfv.VnfcMonitoringParameter<-->monitoring_parametersnolist of tosca.datatypes.nfv.VnfcMonitoringParameter
configurable_propertiesnomap of tosca.datatypes.nfv.VnfcConfigurableProperties<-->configurable_propertiesnomap of tosca.datatypes.nfv.VnfcConfigurableProperties
boot_datanotosca.datatypes.nfv.BootData<-->boot_datanotosca.datatypes.nfv.BootData
vdu_profileyestosca.datatypes.nfv.VduProfile<-->vdu_profileyestosca.datatypes.nfv.VduProfile
sw_image_datanotosca.datatypes.nfv.SwImageData<-->sw_image_datanotosca.datatypes.nfv.SwImageData




<SDC AID DM VFC attributes that are inherited from the org.openecomp.resource.abstract.nodes.VFC>





nfc_functionnostring




high_availabilitynostring




vm_image_namenostring




vm_flavor_namenostring




nfc_naming_codenostring




vm_type_tagnostring




nfc_namingno

org.openecomp.datatypes.Naming

  • ONAP_generated_naming: yes: boolean
  • naming_policy: no: string
  • instance_name: no: string




min_instancesnointeger

SOL001

...

3.

...

3.1 VNFD Mapping from/to SDC AID DM VNFD

SOL001

...

3.

...

3.1 VNFD Template

tosca_definitions_version: tosca_simple_yaml_1_23

description:

imports:

data_types:

...

SOL001 VNFD mapping to/from SDC AID DM VFD


SOL001 VNFD
SDC AID DM VFD
NameGrammar
NameGrammar
tosca_definitions_version

string

(tosca_simple_yaml_1_

2

3)


tosca_definitions_version

string

(tosca_simple_yaml_1_

2

3)

descriptionstring
descriptionstring
metadatamap of <string>
metadatamap of <string>
imports

Single-line grammar

  • <URI_1>
  • <URI_2>

Multi-line grammar

  • file: <file_URI>
  • repository: <repository name>
  • namespace_uri: <definition_namespace_uri> # deprecated
  • namespace_prefix: <definition_namespace_prefix>

importsIdentifies the lower level models (VFC, CP, VL, heat)
data_types

<data_type_name>:

derived_from: <existing_type_name>

version: <version_number>

metadata:

<map of string>

description: <datatype_description>

constraints:

- <type_constraints>

properties:

<property_definitions>


data_types

<data_type_name>:

derived_from: <existing_type_name>

version: <version_number>

metadata:

<map of string>

description: <datatype_description>

constraints:

- <type_constraints>

properties:

<property_definitions>

node_types

<node_type_name>:

derived_from: <parent_node_type_name>

version: <version_number>

metadata:

<map of string>

description: <node_type_description>

attributes:

<attribute_definitions>

properties:

<property_definitions>

requirements:

- <requirement_definitions>

capabilities:

<capability_definitions>

interfaces:

<interface_definitions>

artifacts:

<artifact_definitions>


node_types

<node_type_name>:

derived_from: <parent_node_type_name>

version: <version_number>

metadata:

<map of string>

description: <node_type_description>

attributes:

<attribute_definitions>

properties:

<property_definitions>

requirements:

- <requirement_definitions>

capabilities:

<capability_definitions>

interfaces:

<interface_definitions>

artifacts:

<artifact_definitions>

topology_template

topology_template:

description: <template_description>

inputs: <input_parameter_list>

outputs: <output_parameter_list>

node_templates: <node_template_list>

relationship_templates: <relationship_template_list>

groups: <group_definition_list>

policies:

- <policy_definition_list>

workflows: <workflow_list>

# Optional declaration that exports the Topology Template

# as an implementation of a Node Type.

substitution_mappings:

<substitution_mappings>


topology_template

similar, but the following are different

  • node_templates contents
  • groups
  • workflows
  • description
string
  • description
string
  • inputs


  • inputs

<parameter name>:

type: <parameter_type>

description: <parameter_description>

required: <parameter_required>

default: <parameter_default_value>

constraints:

- <parameter_constraints>

  • node_templates

vnf: tosca.nodes.nfv.Vnf

vdu: tosca.nodes.nfv.Vdu

vl: tosca.nodes.nfv.VnfVirtualLink

vduCp: tosca.nodes.nfv.VduCp

vduCompute: tosca.nodes.nfv.Vdu.Compute


  • node_templates

vfc:

    type: org.openecomp.resources.vfc.<>

vl:

    type: org.openecomp.resources.vl.<>

cp: 

    type: org.openecomp.resources.cp.<>

allotted_resource:

    type: org.openecomp.resource.allottedResource.<>





  • workflows
<workflow name>

policies

  • scaling aspect

tosca.datatypes.nfv.ScalingAspect

  • description
  • properties
    • name:
    • description
    • max_scale_level:
    • step_deltas:

  • groups

list of VF Modules

VFModule_Base:

    type: org.openecomp.groups.VfModule

VFModule_Expansion:

    type: org.openecomp.groups.VfModule




  • policies
optional list of policies
substitution_mappings

substitution_mappings
  • node_type


  • node_type

  • capabilities

<capability_type_name>:

derived_from: <parent_capability_type_name>

version: <version_number>

description: <capability_description>

properties:

<property_definitions>

attributes:

<attribute_definitions>

valid_source_types: [ <node type_names> ]


capabilities

<capability_type_name>:

derived_from: <parent_capability_type_name>

version: <version_number>

description: <capability_description>

properties:

<property_definitions>

attributes:

<attribute_definitions>

valid_source_types: [ <node type_names> ]

  • requirements


  • requirements

groupnot defined
group

<group_type_name>:

derived_from: <parent_group_type_name>

version: <version_number>

metadata:

<map of string>

description: <group_description>

properties:

<property_definitions>

members: [ <list_of_valid_member_types> ]

requirements:

- <requirement_definitions>

capabilities:

policy

only the Abstract.SecurityGroupRule policy type is defined

  • not sure if we can map this into SDC AID DM

policy

<policy_type_name>:

derived_from: <parent_policy_type_name>

version: <version_number>

metadata:

<map of string>

description: <policy_description>

properties:

<property_definitions>

targets: [ <list_of_valid_target_types> ]

triggers:

<list_of_trigger_definitions>

relationship

tosca.relationships.nfv.VirtualBindsTo

tosca.relationships.nfv.AttachesTo


relationship

<relationship_type_name>:

derived_from: <parent_relationship_type_name>

version: <version_number>

metadata:

<map of string>

description: <relationship_description>

properties:

<property_definitions>

attributes:

<attribute_definitions>

interfaces:

<interface_definitions>

valid_target_types: [ <capability_type_names> ]




annotation_type

<annotation_type_name>:

version: <version_number>

description: <annotation_type_description>

properties:

<property_definitions>




annotation

<annotation_name>:

type: <annotation_type>

properties:

<property_assignments>






VF-Module Initial Input 

The following is a summary of initial input from Gil Bullard (AT&T).

...

org.openecomp.group.VfModule Attribute and SOL001 VNF Policies deduction

NameRequiredTypeSOL001 VNFD Policies
vf_module_typeyes

string

valid values: Base, Expansion

Base

default: Base

vf_module_labelyesstringaspects: <A>
min_vf_module_instancesyesinteger

initial_delta: 0

max_vf_module_instancesnointegermax_scale_level
initial_countyesinteger

initial_data:

  number_of_instances

vf_module_descriptionnostring

aspects: 

  description

volume_groupyesBooleandefault to false
group_namingnoorg.openecomp.datatypes.Namingoptional field, leave it empty

VirtualLink Mapping to SDC AID DM

...

<tosca.nodes.nfv.ext.zte.VL>

tosca.nodes.nfv.ext.zte.VL

namerequiredtype
segmentation_idfalsestring
network_namefalsestring
is_predefinedfalseboolean
mtufalseinteger
dns_nameserversfalselist
physical_networkfalsestring
dhcp_enabledfalseboolean
network_idfalsestring
host_routesfalselist
ip_versionfalseinteger
vendorfalsestring
namefalsestring
start_ipfalsestring
vlan_transparentfalseboolean
cidrfalsestring
gateway_ipfalsestring
network_typefalsestring
end_ipfalsestring
location_infofalsetosca.datatypes.nfv.ext.LocationInfo


  tosca.nodes.nfv.ext.zte.VL:

...