Application Package Onboarding to SDC

Note: work in progress

SDC Package Onboarding Process

SDC Epic

• SDC shall support Application Package onboarding and distribution, where the onboarding package conforms to ETSI SOL004 and the embedded model conforms to ASD.

User Story

SDC Onboarding and Distribution Sequence

Vendor App Package

Application Service Package conforms to ETSI SOL004 (inspired) until SOL004 1) makes the SOL001 VNFD optional and 2) allow App package-specific metadata.

SOL004 Package CSAR Structure

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.

• 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 (e.g. type definitions).    // e.g., ASD_1_0_types.yaml. once ASD types are standardized, we will have a formal name.

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

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

!----- ChangeLog.txt

!----- ChangeLog.txt.sig.cms

!----- global.cert (global certificate for the package)

!----- image(s)

!----- image(s) signature(s)

!----- other artifacts

!----- other artifacts signatures

!------Tests

!----- file(s)

!----- signature(s)

!------Licenses

!----- file(s)

!----- signature(s)

!------Scripts

!----- install.sh

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

App Package Directory and File Details

• MRF.mf : It is the main manifest file for the Application package, 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
    • app_release_date_time
    • app_software_version
    • app_package_version
    • compatible_specification_versions
    • cnfm_info

• • • e.g., app_main_descripter.mf

metadata:

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

app_provider_id: <vendorA>

app_product_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: 
    • Source: ChangeLog
    • Source: Definitions
    • Source: Images
    • Source: LcmScripts
    • Source: License
    • Source: TOSCA-Metadata

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

<ETSI keynames extension>

• • TOSCA.meta
    • REQUIREMENT #<>: introduce a new key name to metadata, "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/main_app_template.yaml

ASD-Entry-Definitions: Definitions/main_app_template.yaml     

ETSI-Entry-Manifest: f5_FW_cnf.mf

ETSI-Entry-Licenses: Licenses

ETSI-Entry-Change-Log: ChangeLog.txt

• Definitions
  
  • ASD_1_0_types.yaml                        // node_types, artifact_types, data_types
  • main_app_template.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>.          // or image reference
    • <image>           // or image reference
  • Licenses
    • LICENSE.txt
  • Artifacts
    • Deployment
      • HELM             //REQUIREMENT #<>: use the "HELM" directory to contain Helm Charts
        • <Helm Chart file>                                  // Helm Charts can include values.schema.json along with values.yaml
        • <Helm Chart file>                                  // It is for imposing a structure on the values.yaml file

                                                                                                                     // REQUIREMENT #<>: If values.schema.json files exist, SDC UI uses them to validate values.yaml files and populates customizable values

• Scripts
  • <script> file

SDC creates VSP CSAR file for App Package Onboarding

• TOSCA-Metadata
  • TOSCA.meta:
    • It is generated by SDC, and SDC copies the following metadata and drops other custom metadata 
    • REQUIREMENT #<>: SDC copies the ASD-Entry-Definitions metadata from the onboarding App package.  note: it is under discussion

e.g., 

TOSCA-Meta-File-Version: 1.0

CSAR-Version: 1.1

Created-By: ASDC Onboarding portal

Entry-Definitions: Definitions/main_app_template.yaml

ASD-Entry-Definitions: Definitions/main_app_template.yaml

• Definitions: SDC generates this directory based on the onboarding App package directory
  • Note: it is under discussion if we use the existing ONAP internal models after mapping from the ASD model, or put the ASD model separately. The second case will impact the existing ONAP runtime components, such as AAI, SDNC and others.
  • Note: the mapping between ASD and ONAP internal model is under discussion: 
    • ASD ↔ ONAP VF
    • DeploymentItems ↔ VF-Modules

• • main_app_template.yaml
  • GlobalSubstitutionTypesServiceTemplate.yaml.            // REQUIREMENT #<>: SDC generates this by including the app_main_descripter.mf information
  •  onap (TBD)
    • _index.yml
    • artifacts.yml
    • capabilities.yml
    • data.yml
    • interfaces.yml
    • nodes.yml
    • relationships.yml
  • onapecomp                                // TBD
    
    • _index.yml
    • artifacts.yml
    • capabilities.yml
    • data.yml
    • interfaces.yml
    • nodes.yml
    • relationships.yml
  • openecomp-heat                       // REQUIREMENT #<>: SDC does not use this directory for the App Package
    • _index.yml
    • data.yml
    • groups.yml
    • nodes.yml
  •  tosca
    • _index.yml
    • artifacts.yml
    • capabilities.yml
    • data.yml
    • groups.yml
    • interfaces.yml
    • nodes.yml
    • policies.yml
    • relationships.yml
• Artifacts: REQUIREMENT #<>: SDC generates this directory by copying artifacts from the onboarding App package
  
  • F5_FW_cnf.mf
  • Definitions
    • main_app_template.yaml
  • Deployment: REQUIREMENT #<>: SDC preserves the original onboarding App package 
    • APP_PACKAGE.              // copy of the original AS package
  • Images: REQUIREMENT #<>: SDC should be able to handle large-size image files. SDC stores the image files to the Kubernetes Object Storage temporarily and waits for the Runtime Catalog Manager picks up and stores the images files to the Image repository.  
    • <image>
    • <image>
  • Informational
    • <Guide>
      • VSP_f5_Information.txt
  • LcmScripts
    • <scripts>
  • Licenses
    • LICENSE.txt
  • TOSCA-Metadata: REQUIREMENT #<>: SDC preserves the original onboarding TOSCA.metadata
    • TOSCA.meta.original
  • ChangeLog.txt
  • vendor-license-model.xml (not sure how SO uses)
  • vf-license-model.xml (not sure how SO uses)

Create VF CSAR file - an OLD way; not used for the ASD

• TOSCA-Metadata: REQUIREMENT #<>: SDC generates TOSCA-Metadata directory and TOSCA.meta
  • TOSCA.meta
• Definitions: REQUIREMENT #<>: SDC maps the onboarding ASD models into the ONAP internal. Note: mapping is under discussion.
  • artifacts.yml
  • capabilities.yml
  • data.yml (if mapping, extra date types will be here)
  • groups.yml
  • interfaces.yml
  • nodes.yml (add ASD nodes)
  • policies.yml
  • relationships.yml
  • resource-<...>-template.yml. REQUIREMENT #<>: SDC generates this based on the onboarding ASD model
  • resource-<...>-template-interface.yml REQUIREMENT #<>: SDC generates this based on the onboarding ASD model
• Artifacts
  • Deployment: REQUIREMENT #<>: SDC preserves the original onboarding App package and additional License files thru SDC UI
    • AS_PACKAGE (original)
    • VENDOR_LICENSE
    • VF_LICENSE
  • Informational
    • OTHER
      • VSP_f5_Information.txt
• csar.meta
• Files. (missing from SDC****; Its handling is under discussion)
  • Images
    • <image>
    • <image>

Create VF CSAR file thru the SDC Multi Model Way.       // Propose to use for the AS Package Onboarding

• TOSCA-Metadata
  • TOSCA.meta REQUIREMENT #<>: SDC generates TOSCA-Metadata directory and TOSCA.meta
• Definitions: REQUIREMENT #<>: for the Multi Model way, SDC does not use ONAP internal model. Note: impact to the existing ONAP components are under discussion.
•  
  • artifacts.yml
  • capabilities.yml
  • data.yml
  • groups.yml
  • interfaces.yml
  • nodes.yml
  • policies.yml
  • relationships.yml
  • asd_types.yaml.                            // instead of using ONAP type definitions, support the ASD model specific definitions are included
  • resource-<...>-template.yml.       // REQUIREMENT #<>: SDC UI modifies onboarding ASD for changing the default values
  • resource-<...>-template-interface.yml.  // REQUIREMENT #<>: SDC UI modifies onboarding ASD for changing the default values.
• Artifacts
  • Deployment
    • AS_PACKAGE
      • AS_<...>DataTypes.csar
    • VENDOR_LICENSE
      • vendor-license-model.xml

e.g.,

<vendor-license-model xmlns="http://xmlns.openecomp.org/asdc/license-model/1.0">

<vendor-name>VendorA</vendor-name>

<entitlement-pool-list/>

<license-key-group-list/>

</vendor-license-model>

• • • VF_LICENSE
      • vf-license-model.xml

e.g., 

<vf-license-model xmlns="http://xmlns.openecomp.org/asdc/license-model/1.0">

<vendor-name>VendorA</vendor-name>

<vf-id>367db414413b4f3e96fcb92df023df27</vf-id>

<feature-group-list/>

</vf-license-model> 

• • Informational
    • OTHER
      • VSP_<?>_Information.txt
• csar.meta

Create Service CSAR file

• TOSCA-Metadata REQUIREMENT #<>: SDC generates TOSCA-Metadata directory and TOSCA.meta
  • TOSCA.meta
• Definitions. REQUIREMENT #<>: SDC maps the onboarding ASD models into the ONAP internal. Note: mapping is under discussion
  • annotations.yml
  • artifacts.yml
  • capabilities.yml
  • data.yml
  • groups.yml
  • interfaces.yml
  • nodes.yml
  • policies.yml
  • relationships.yml
  • asd_types.yaml.                            // instead of using ONAP type definitions, support the ASD model specific definitions are included; TBD
  • resource-<...>-template-inteface.yml (came from VF)
  • resource-<...>-template.yml
  • service-<...>-template-interface.yml
  • service-<...>-template.yml. (put input parameters, additional properties...)
• Artifacts
  • Resources
    • <VF-name>
      • Deployment //REQUIREMENT #<>: use the "HELM" directory to contain Helm Charts
        • HELM
          • <helm files>
• csar.meta
• NS.mf