Versions Compared

Key

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

...

SDC Package Onboarding Process

SDC Epic

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

SDC User Story

PriorityUser StoryDescriptionJIRA Ticket
1US 1

Actor:

Create an SDC VSP package thru onboarding of an Application Service CSAR based on ASD

  • create metadata to distinguish the model type (e.g., ASD)
  • create metadata to distinguish the artifact type (e.g., HELM)

1US 2

Actor:

Create AS internal CSAR (VF resource) by importing VSP CSAR to add CNF/Application based on ASD


1US 3

Actor:

Create an Service CSAR consists of one or more CNF/Application based on ASD


1US 4

Actor:

Distribute Service CSAR to ONAP runtime components thru DMaaP


1US 5

Actor:

Distribute associated Helm Charts to the target Helm Artifact Repository


1US 6

Actor:

Distribute associated Image files to the target Image Repository 






...

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.

Note: SOL001 VNFD requirement in the current SOL004 needs to be changed; i.e., make SOL001 VNFD in SOL004 optional. 

e.g., 

!------TOSCA-Metadata

...

!------Definitions

!----- MRF.yaml!----- ASD.yaml.   (main 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

...

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

!----- MRF.mf 

...

mf                                      // main manifest file


Root directory

  • MRF.mf (: It is main manifest file for the Application package 
    • introduce metadata for ASD (metadata:): TBD
      • asd_product_name
      • asd_provider_id
      • asd_package_version
      • asd_release_date_time 

...

compatible_specification_versions: 1.0.0

    • Define the Source for 
      • Source: ChangeLog
      • Source: Definitions
      • Source: Images
      • Source: LcmScripts
      • Source: License
      • Source: TOSCA-Metadata
  • TOSCA-Metadata directory
    • TOSCA.meta
      • introduce a new key name to metadata, asd_definitions

e.g.,

TOSCA-Meta-File-Version: 1.0
CSAR-Version: 1.1
Created-By: <vendor>
Entry-Definitions: Definitions/f5_FW_cnf.yaml

asd_definitions: Definitions/f5_FW_cnf.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


<keynames <ETSI keynames extension>


  • Definitions
    • asdASD_1_0_types.yaml.     yaml              // node_types, artifact_types, data_types
    • f5_FW_cnf.yaml.                // descriptor leveraging ASD

e.g., Sample App

  • Files. (optional; Images, Licenses and Artifacts directories can be located under the root directory)
    • Images
      • <image>
      • <image>
    • Licenses
      • LICENSE.txt
    •  Artifacts
      • Deployment
        • HELM
          • <Helm Chart file>        
          • <Helm Chart file>
        • AS_PACKAGE
        • ETSI_PACKAGE
    • Scripts

Create VSP CSAR file

...