Page History

...

SDC Onboarding and Distribution Sequence

...

ONAP SDC supports SOL004-conformed CSAR onboarding with the TOSCA-Metadata directory, which includes the TOSCA.meta metadata file providing and entry information for processing a CSAR file.Note: SOL001 VNFD

• REQUIREMENT #<>: The App Package shall be compliant to the ETSI NFV SOL004 CSAR structure with the TOSCA-Metadata directory
  • ONAP SDC supports only the CSAR onboarding with the TOSCA-Metadata directory
• SOL001 VNFD mandatory requirement in the current SOL004 needs to be changed; i.e., make SOL001 VNFD in SOL004 optional. 
  

...

• • Note: this PoC assume the SOL001 VNFD is optional in the SOL004 package. Instead, ASD will be embedded in the App package
• Locations of files in CSAR are defined by Tosca.meta, Manifest and main TOSCA definition files

App Package structure that is defined in ETSI NFV SOL004

The following describes the App package structure.

Note: blue directory names and file type suffixes are requested by SOL004

REQUIREMENT #<>: ASD_1_0_types.yaml will represent Application Service Descriptor (ASD) in TOSCA

!----- MRF.mf                                      // main manifest file

!------TOSCA-Metadata

!------TOSCA.meta

!------TOSCA.meta.sig.cms

!------Definitions

!----- MRF.yaml.   (main App yaml)

!----- MRF.yaml.sig.cms (signature)

...

|----- OtherTemplates signatures.                       // signature for other templates

!------Files (note: it is allowed that its sub directories are placed under the root directory.

...

!----- install.sh.sig.cms

!----- MRF.mf                                      // main manifest file

Root directoryApp Package Directory and File Details

• MRF.mf : It is the main manifest file for the Application package introduce metadata for ASD (metadata:): TBDasdpackage, which contains
  • metadata list
  • list of all files
  • non-MANO-artifacts list: contains locations of non-MANO-artifacts 

• • REQUIREMENT #<>: introduce the following metadata for App package. By using the new metadata, SDC and orchestrator know this package is based on ASD 
    • asd_id
    • app_provider_id
    • app_product_name
• asd_provider_id
• • • app_release_date_time
    • app_software_version
    • app
asd
• • • _package_version
asd
• • • compatible_
release
• • • specification_
date
• • • versions
    • cnfm_
time 
• • • info

• • • e.g.,
  f5
  • • app_
  FW
  • • main_
  cnf
  • • descripter.mf

metadata:

asd_id:  2116fd24-83f2-416b-bf3c-ca1964793bcf

asd_product_name: vFW

...

app_provider_id: <vendorA>

...

app_

...

product_

...

asd_package_version: 1.0

...

name: vFW

app_release_date_time:

...

2021-10-18T10:00:00+03:00

...

app_software_

...

version: 1.0.0

app_package_version: 1.0

compatible_specification_versions: 1.0.0

cnfm_info: cnfm:v1.0.0

• • Define Source paths: Define the Source for 
    • Source: ChangeLog
    • Source: Definitions
    • Source: Images
    • Source: LcmScripts
    • Source: License
    • Source: TOSCA-Metadata

• TOSCA-Metadata directory: It contains the entry points:

<ETSI keynames extension>

Image Added

• • TOSCA.meta
    • REQUIREMENT #<>: introduce a new key name to metadata,
asd_definitions
• • • "ASD-Entry-Definitions"
      • note: we are evaluating the above manifest metadata is enough to distinguish the app package model from other models.

e.g.,

TOSCA-Meta-File-Version: 1.0

CSAR-Version: 1.1

Created-By: <vendor>

Entry-Definitions: Definitions/f5main_FWapp_cnftemplate.yaml

asd_definitionsASD-Entry-Definitions: Definitions/f5main_FWapp_cnftemplate.yaml yaml                       // should we introduce ASD definition to distinguish the app package model?

ETSI-Entry-Manifest: f5_FW_cnf.mf

ETSI-Entry-Licenses: Licenses

ETSI-Entry-Change-Log: ChangeLog.txt

<ETSI keynames extension>

Image Removed

• Definitions
  
  • ASD_1_0_types.yaml                        // node_types, artifact_types, data_types
  • f5main_FWapp_cnftemplate.yaml.               // descriptor leveraging ASD

e.g., Sample main_app_template.App

• Files . (optional; Images, Licenses and Artifacts directories can be located under the root directory)
  • Images
    • <image>
    • <image>
  • Licenses
    • LICENSE.txt
  • Artifacts Artifacts
    • Deployment
      • HELM             //Requirement #<>: use the "HELM" directory to contain Helm Charts
        • <Helm Chart file>        
        • <Helm Chart file>
• Scripts
  • <script> file

Create VSP CSAR file

• TOSCA-Metadata
  • TOSCA.meta (: It is generated by SDC), and ETSI and other custom metadata will be not copied to here.

e.g., 

TOSCA-Meta-File-Version: 1.0
CSAR-Version: 1.1
Created-By: ASDC Onboarding portal
Entry-Definitions: Definitions/f5_FW_cnf.yaml

...