Versions Compared

Key

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

Table of Contents

Use Case

...

SO-2429features

Epic

User Story

Description

In Frankfurt?JIRASize
SOL003 Adapter Enhancement for Frankfurt









Epic: ETSI Alignment Support - SOL003 Adapter Enhancement for FrankfurtYes (partially)

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2156


SOL003  Adapter NBI Enhancement

Expose the Adapter NBI to any SOL003 Adapter client in ONAP

YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2407


  • Create (Create/Instantiate)
  • Create (Create/Instantiate)
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2408


  • Delete (Terminate/Delete)
  • Delete (Terminate/Delete)
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2409


  • Query
  • Query
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2410


  • Get Operation Status
  • Get Operation Status
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2411


  • Modify
  • Modify
TBDNo-
  • Heal
  • Heal VNF (triggered by SOL003 Adapter, not auto-healing)
TBDNo-
  • Scaling (Stretch goal)
  • Scaling (Stretch goal)
TBDNo-

SOL003 Adapter Package Management by leveraging ONAP-ETSI Catalog Manager

Support VNF Package Management interfaces between the SOL003 Adapter and SVNFM (SVNFM → SOL003 Adapter) by leveraging ONAP-ETSI Catalog Manager (SOL003 Adapter → ONAP-ETSI Catalog Mgr)

Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2412


  • Query VNF SOL003 Package Management Swagger updateQuery VNF Package (SVNFM →
  • SOL003 Adapter & SOL003 Adapter → ETSI Catalog Manager) : query information about one or multiple VNF PackageSOL003 Package Management Swagger update
    • SOL003 Package Management Swagger
    • ETSI Catalog Manager Swagger
    • SOL003 Package Management Notification Swagger
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-24132501

  • Read VNFD
  • Read VNFD of an onboarded VNF package : VNFD is returned (SVNFM → SOL003 Adapter & SOL003 Adapter → ETSI Catalog Manager)
  • View file
    nameparse_vnfpacakge.txt
    height250
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2542

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-24142464


  • Fetch Query VNF Package Content
  • Fetch Query VNF Package Package (SVNFM → SOL003 Adapter & SOL003 Adapter → ETSI Catalog Manager) : fetch the content of an onboarded VNF package (VNF package file is returned)query information about one or multiple VNF Package
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2415

  • Fetch VNF Package Artifacts
Fetch VNF Package Artifacts 

2413


  • Read VNFD
  • Read VNFD of an onboarded VNF package : VNFD is returned (SVNFM → SOL003 Adapter & SOL003 Adapter → ETSI Catalog Manager)
: fetch an individual artifact contained in an onboarded VNF package
  • ETSI Catalog Manager will return a zip file of the Definition directory.
  • View file
    nameparse_vnfpacakge.txt
    height250
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2416

  • Subscribe
Subscribe 

2414


  • Fetch VNF Package Content
  • Fetch VNF Package (SVNFM → SOL003 Adapter & SOL003 Adapter → ETSI Catalog Manager) : subscribe to notifications related to onboarding and/or changes of VNF packagefetch the content of an onboarded VNF package (VNF package file is returned) 
  • Support of the package_contents partial is a stretch goal in Frankfurt. The ETSI Catalog Manager supports fetching package_contents partial by setting the HTTP_RANGE in the request headers when the SOL003 Adapter wants to obtain a single range of bytes from the VNF package file. 
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2417

  • Query Subscription Info
Query Subscription Info (SVNFM → SOL003 Adapter)

2415


  • Fetch VNF Package Artifacts
  • Fetch VNF Package Artifacts (SVNFM → SOL003 Adapter & SOL003 Adapter → ETSI Catalog Manager) : fetch an individual artifact contained in an onboarded VNF package
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2418

  • Terminate/Delete Subscription
Terminate/Delete Subscription (SVNFM → SOL003 Adapter)

2416


  • Subscribe
  • Subscribe (SVNFM → SOL003 Adapter & SOL003 Adapter → ETSI Catalog Manager) : subscribe to notifications related to onboarding and/or changes of VNF package
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-24192417


  • Notify
  • Notify (SVNFM ← SOL003 Adapter) : notify about VNF package onboarding or changeQuery Subscription Info
  • Query Subscription Info (SVNFM → SOL003 Adapter)
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2418


  • Terminate/Delete Subscription
  • Terminate/Delete Subscription (SVNFM → SOL003 Adapter)
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2419


  • Notify
  • Notify (SVNFM ← SOL003 Adapter & ETSI Catalog Manager → SOL003 Adapter) : notify about VNF package onboarding or change
Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2420


  • SOL003 Adapter Package Management - Get VNF Packages from ONAP-ETSI Catalog Manager
  • This is obsolete, by merge the functions into the above SO-2412 story and sub-tasks.
  • Support the following VNF Package management (SOL003 Adapter → ONAP-ETSI Catalog Manager). ETSI Catalog Manager will return the original vendor package to the Adapter.
    • Query VNF Package (/api/catalog/v1/vnfpackages)
    • Read VNFD   // get the VNF package and extract VNFD model (sample 
      View file
      nameparse_vnfpacakge.txt
      height250
      )
    • Fetch VNF package content
    • Fetch VNF package artifacts
    • subscribe
    • Notify
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2421


SOL003 Adapter Grant Enhancement that supports HPA by leveraging OOF VNF Granting that supports HPA by leveraging OOFYes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2422


SOL003 Adapter Enhancement for VNF QueryTo invoke VNF QueryYesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-1636


SOL003 Adapter Enhancement for VNF Operation Status To invoke Operation StatusYesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2423


SOL003 Adapter Enhancement for VNF ModifyTo invoke VNF ModifyTBDNo

-


SOL003 Adapter Enhancement for VNF HealTo invoke VNF HealTBDNo-
SOL003 Adapter Enhancement for VNF Scaling (Stretch goal)to support Policy-based VNF Scaling support; Interface to DCAE for VES eventTBDNo-
Secured communication support between SOL003 Adapter and SVNFMSecured communication between SOL003 Adapter and SVNFMYes (minimum)

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2424


Authentication and authorization support between between SOL003 Adapter and SVNFMAuthentication and authorization support between between SOL003 Adapter and SVNFMYes (minimum)

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2425


Preload using user_param (without UI changes)Preload using user_param (without UI changes)Yes

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-1635


SO BPPN Workflows & Java for SOL003 Operations

SO BPMN Workflows & Java for SOL003 Operations by leveraging the SOL003 Adapter NBIs

YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2466


  • Enhance Create/Instantiate Workflows & Associated Java code
  • Enhance Create/Instantiate Workflows & Associated Java code
    • Modify the existing workflow to separate Create and Instantiate tasks
    • Invoke the modified SOL003 Adapter NBIs
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2467


  • Enhance Terminate/Delete Workflows & Associated Java code
  • Enhance Terminate/Delete Workflows & Associated Java code
    • Modify the existing workflow to separate Terminate and Delete tasks
    • Invoke the modified SOL003 Adapter NBIs
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2468


  • Create Query VNF Workflows & Associated Java code
  • Create Query VNF Workflows & Associated Java code
    • Invoke the modified SOL003 Adapter Query VNF NBI
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2469


  • Create Get Operation Status Workflows & Associated Java code
  • Create Get Operation Status Workflows & Associated Java code
    • Invoke the modified SOL003 Adapter Get Operation Status NBI
    • This operation could be used by the Instantiation and Termination of VNF; in this case, its workflow could be omitted
YesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-2470


CSIT enhancement for testing SOL003 Adapter package management enhancementCSIT enhancement for testing SOL003 Adapter package management enhancementYesNo

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keySO-22952683


Documentation for SOL003 Adapter enhancement featuresDocumentation for SOL003 Adapter enhancement featuresYes
Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyNO



SOL003 VNFM Adapter Architecture for Frankfurt

...

Gliffy
nameSOL003 VNFM Adapter Architecture in Frankfurt
pagePin1021


  1. VNFM Adapter SOL003 Adapter continues to be an SO microservice component, and exposes its NBI to any VNFM SOL003 Adapter client in ONAPVNFM
  2. SOL003 Adapter continues to be a SO microservice componentis registered to MSB.
  3. VNFM Adapter will be registered to MSB.
  4. a VNFM Adapter client (e.g., GNFC) will locate the VNFM Adapter through MSB.
  5. Interfaces are refactored to be
  6. generic (accessed by other ONAP/External components) - TBDthe VNFM Adapter Operator registers VNFM and VIM to ESR in AAI.
  7. SOL003 Adapter exposes its NBI to any SOL003 Adapter client in ONAP (not for Frankfurt)
    1. Interfaces will be refactored to be generic to allow access by other ONAP components.
    2. The NBI will be enhanced for additional SOL003 operation support.
  8. SDC CSAR including the SDC internal model and the vendor original SOL004 package is supported
  9. SO leverages ONAP-ETSI Catalog microservice for ETSI-based NS, VNF and PNF
  10. VNFM distributes SDC packages including the vendor original SOL004 (VNF and PNF) and SOL007 (NS) packages – SOL007 is not for Frankfurts
  11. SO (SDC Controller) passes the SDC CSAR ID to ETSI Catalog Manager to invoke storage
  12. ETSI Catalog Manager queries for SDC CSAR with the SDC CSAR id & store SOL004/SOL007 package.
  13. SO (BPMN) and the SOL003 Adapter client locates SOL003 Adapter.
  14. SO (BPMN) and the SOL003 Adapter client invokes SOL003 Adapter.
  15. SOL003 Adapter retrieves VNF package from Catalog Manager.
  16. VNFM Adapter Client uses MSB to locate the VNFM Adapter
  17. VNFM Adapter locates a VNFM SOL003 Adapter gets available VNFM locations (endpoints) and gets VIM and VNF Info.
  18. SOL003 Adapter selects a VNFM, based on a better VNFM locating mechanism.
  19. VNFM SOL003 Adapter and SVNFM support additional SOL003 operations, possibly including modification for configurationVNFM supports SOL003 VNF LCM, granting and package management operations.
  20. SOL003 Adapter supports HPA-based Granting, leveraging OOF.
  21. SOL003 Adapter updates vServer, status and VNF association in AAI
  22. SOL003 Adapter and SVNFM support authentication and authorization
    1. AAF will be used for authentication and authorization
    2. But, vendor SVNFMs may use their own AA mechanism
  23. VNFM Adapter interfaces with OOF to support HPA-support granting (see the Granting enhancement section)
  24. For the (AAF, and vendor AA mechanism) – partially for Frankfurt.
  25. For integration testing, the VNFM Simulator in the CSIT container will be is used.


SOL003 Operations

The following SOL003 operations will be supported:

...

  • Reading VNFD of an on-boarded VNF package (VNFM → SOL003 Adapter → ETSI Catalog Manager)
    • SOL003 Adapter Package Management - Read VNFD

      • SOL003 Adapter provides the SOL003 Reading VNFD service to SVNFM.
      • SVNFM requests for a VNFD for the given vnfd to SOL003 Adapter
        • GET .../vnf_packages/{vnfpkgid}/vnfd
      • SOL003 Adapter requests for a VNFD for the given vnfd to ETSI Catalog Manager
        • GET /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd
      • ETSI Catalog Manager returns a zip file of VNF package including vnfdModel JSONDefinition directory to SOL003 Adapter
      • SOL003 Adapter returns a Vnfd with the vnfdModel JSON zip file of VNF package Definition directory to SVNFM


      Precondition: The VNF package is onboarded to the ONAP-ETSI Catalog Manager

      Postcondition: SVNFM receives Vnfda Vnf package definition zip file



  • Fetching an on-boarded VNF package (VNFM → SOL003 Adapter)
    • SOL003 Adapter supports the whole package content fetch only..
      • Support of the package_contents partial is a stretch goal in Frankfurt. The ETSI Catalog Manager supports fetching package_contents partial by setting the HTTP_RANGE in the request headers when the SOL003 Adapter wants to obtain a single range of bytes from the VNF package file. 
    • SVNFM sends a GET request for the VNF package content resource to the SOL003 Adapter.
      • GET .../vnf_packages/{vnfPkgId}/package_content
    • SOL003 Adapter sends a GET request for the VNF package content resource to the ETSI Catalog Manager
      • GET /api/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content
    • ETSI Catalog Manager returns a copy of the VNF package file in the payload body to SOL003 Adapter.
    • SOL003 Adapter returns with a copy of the VNF package file in the payload body to SVNFM.

...

                           SVNFM gets package subscription (PkgmSubscription)subscription (PkgmSubscription)

<Sequence Diagram SVNFM → SOL003 Adapter>



<Sequence Diagram SOL003 Adapter → ETSI_Catalog_Manager>


  • Query Subscription Info
    • SVNFM re-synchronizes all or selected subscriptions after some errors in SVNFM or some exception handling.
    • SVNFM sends a Query Subscription Info request to the SOL003 Adapter.
      • GET .../subscriptions  // for all subscriptions
    • SOL003 Adapter returns package subscription lists in the form of PkgmSubscription[] in the payload
    • or
    • SVNFM sends a Query Subscription Info request for a selected subscription to the SOL003 Adapter 
      • GET .../subscriptions/{subscriptionId}
    • SOL003 Adapter returns a selected package subscription to SVNFM.

...

Postcondition: SVNFM receives a notification


  • Receiving notifications for the package management (ETSI Catalog Manager → SOL003 Adapter)
    • The ETSI Catalog Manager team is working on the Notification API.
    • Once the notification api is settled, the subscribed SOL003 Adapter will receive package notifications from the ETSI Catalog Manager.
  • <Sequence Diagram: TBD>


Grant Request with Synchronous Response with HPA (VNFM → SOL003 Adapter)

...

There are two methods to support HPA in SO:. In the Frankfurt release, only the Method 1 will be supported.

  • Method 1: Use of Homing information that is made during the SO decompose processing.
    • During SO decompose processing, SO calls OOF for collecting homing information for the service (which includes the VNFs).
    • Call the OOF APIs to perform the optimize service/VNF homing and placement
    • Use the existing homing workflows to pass hardware platform capability requirements to OOF
    • See the following diagram for the component interaction.

...

  • Method 2: If the above processing does not work for the vendor VNF HPA, OOF will be called from the SOL003 Adapter per VNF. The following describes the interactions between SOL003 Adapter and OOF.
    • Note: current, OOF does NOT support the VNF Level Homing request. OOF API enhancement is under discussion. Otherwise, the method 1 (Service Level Homing) is used for Frankfurt. TBD.Frankfurt - Out of Frankfurt Release scope
    • VNFM Adapter sends out homing requests to OOF (OSDF) containing resource info
    • OOF (OSDF) pulls all the related homing constraints from Policy
    • OOF (HAS) checks AAI database to pull region (flavor) information
    • OOF (HAS) communicates with Multi-Cloud to check cloud capacity (vims which fulfill the requirements)
    • OOF (OSDF) returns homing allocation solution to VNFM Adapter
    • OOF collects information as following:
    • Service and Resource Info, from: AAI
    • HPA Flavors/Capabilities/Capacity Info, from: AAI
    • Policy Models (Homing, PCI) from: Policy
    • Infrastructure Metrics Info (capacity), from: MultiCloud
    • Cloud Agnostic Intent Info, from: MultiCloud
    • PCI configuration data (not yet a part of SDC model)
  • SOL003 Adapter Homing Request to OOF
    • <describe the homing request API and contract here>

...