Application Service Descriptor (ASD) Onboarding Packaging Format

Owned by Marian Darula
Last updated: Mar 28, 2022 by Zu Qiang
2 min read

Package Requirements

The ASD onboarding package format is based on the TOSCA CSAR with TOSCA-Metadata directory format, with the following additional:  

  • The structure and format of an ASD package shall conform to the TOSCA Simple Profile YAML v1.1 or v1.3 Specification of the CSAR format, as specified in ETSI NFV SOL004ed431 section 4.1.1.

  • An ASD package shall contain a main TOSCA definitions YAML file representing all or part of the ASD, and additional files.
  • CSAR format with TOSCA-Metadata directory, specified in ETSI NFV SOL004ed431 section 4.1.2, with the differences that the following TOSCA.meta file keynames extensions are optional:
    • ETSI-Entry-Change-Log
    • ETSI-Entry-Tests
    • ETSI-Entry-Licenses

  • Support non-MANO artifact sets description in the manifest file, as specified in ETSI NFV-SOL004ed431 clause 4.3.7

  • Registered non-MANO artifact keywords (ONAP Non-MANO Artifacts Set Identifiers) can be reused, to avoid duplication

  • Package and artifacts security, specified in ETSI NFV SOL004 ed431 section 5 and 4.3.6

  • Package manifest file, specified in ETSI NFV SOL004ed431 section 4.3.2, with the exception that table 4.3.2-1 (the valid names and values) is replaced with the following table:

Name

Value

Notes

Qualifier

application_name

A sequence of UTF-8 characters.

The value shall be identical to those specified in the MainServiceDescriptor, e.g., application_name in ASD

O

application_provider

A sequence of UTF-8 characters.

The value shall be identical to those specified in the MainServiceDescriptor, e.g., provider in ASD

O

release_date_time

A string formatted according to IETF RFC 3339

Timestamp of the package release time

M

entry_definition_type

enum[asd]

asd: only ASD is included in the package

M

Additional non-mano-artifact keyword

The non-mamo-artifact-set in manifest file is used to onboard any additional NF specific artifacts. There is a need to onboard NF specific artifacts  consumed by rAPP.

The following keywords are defined:

  • “onap_vendor_artifacts”: NF specific artifacts consumed by rAPP
  • “vendor_name”: global unique id of the artifact provider.
  • “artifact_type”: artifact type which shall be unique id  within the artifact provider
  • “source”: artifact path/file name.

EXAMPLE:

onap_vendor_artifacts:
   vendor_name: Ericsson
   artifact_type: [rApp_name1]
   source:/artifacts/[rapp_name1]/rapp.zip 
   source:/artifacts/[rapp_name1]/rapp.yml
   vendor_name: Ericsson
   artifact_type: [rApp_name2]
   source:/artifacts/[rapp_name2]/rapp.zip

ASD Package Example

The following is an example of ASD metadata:

metadata:                                                  

  application_name: vCU

  application_provider: Ericsson

  release_date_time: 2021-10-21T11:30:00+05:00

  entry_definition_type: asd

Here is an example of an ASD onboarding package (without package security): asd.csar

The following is an example of an ASD onboarding package with package security in picture: