Versions Compared

Key

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

...

The editing of this page is limited to Michela Bevilacqua and Andrei Kojukhov

META FILE AND MANIFEST FILE

The use of the TOSCA.meta and the Manifest file (.mf) in line with ETSI SOL004 will help to:

1) identify the path of the ETSI MANO artifacts (by the .meta file)

2) identify the path of the NON ETSI MANO artifacts (as defined in ETSI SOL004), by the .mf file.


GENERAL

According to ETSI SOL004 v.2.5.1According to ETSI SOL004, every non-MANO artifact set shall be identified by a non-MANO artifact set identifier (TAG) which shall be registered in the ETSI registry.

ETSI registry .  of non MANO artifact set identifier is available in ETSI wiki https://nfvwiki.etsi.org/index.php?title=Non_MANO_artifact_sets.

Set identifiers can be public or private. ONAP as a public community initiative decided to introduce a set of public identifiers.

Non-MANO artifact sets shall be declared in the manifest file. If the package contains at least one non-MANO artifact set, an entry named "non_mano_artifact_sets:" shall be present in the package on the manifest file on its own line after the "metadata" section.

...

ONAP PUBLIC NON-MANO ARTIFACTS SET APPROVED by ONAP TSC for REGISTRATION in ETSI

The followings are following table contains the public non-MANO artifact set identifiers which can be used in a PNF/VNF onboarding package .The introduction in the manifest file allow to isolate the ONAP specific topics as follows:per ONAP releases. The relevant examples of using the artifact tags are following the table

ONAP Release where the artifact ID is initially introducedNon-MANO artifact IDDescription

Reference ( R-146092 )

(“The published version link shall be updated after Frankfurt release”)

Notes
 Dublinonap_ves_events

...

contains VES registration files for handling external events

The latest requirements:

R-22346

R-025941

See the below example and clarifications in 5G - FM Meta Data / 5G - PM Dictionary

onap_pm_dictionary

...

contains the PM dictionary files used for Performance Management

The latest requirements: 

R-816745

See the usage in 5G - FM Meta Data / 5G - PM Dictionary

onap_yang_modules

...

contains Yang module files for configurations 

The latest requirements:

R-93443

R-26115

See the usage in 5G - Configuration with NETCONF

onap_ansible_playbooks

...

contains any ansible

...

playbooks

The latest requirements:

R-75608

See the usage in 5G - PNF Software Update

onap_others

...

contains any other non_MANO artifacts, e.g. informational documentsnoneSee about its usage in 5G - PNF Pre-Onboarding & Onboarding
 Frankfurtonap_pnf_sw_information PNF software version

The latest requirements:

R-972082

See about its usage in

Enable Service Level LCM Operations


EXAMPLES:


Example 1 (Dublin Release)

In the picture below, an example of a PNF onboarding package including a manifest file with URI's for non-MANO artifacts used in Dublin


Image Added

NOTES about the example: Folder/file name MANDATORY according to  SOL004:

  • TOSCA-Metadata directory and TOSCA.meta file (unique CSAR package structure supported in ONAP Dublin)
  • Manifest file extension, XXX.mf,  located at the root or in a location identified in the .meta file. The name of the file is the same of the TOSCA yaml file

Ín the example the following files are not provided: 

  • ChangeLog.txt, a human readable text file at the root or in a location identified in the .meta file. (NOT PROVIDED IN THE EXAMPLE )
  • xNF testing procedure, NOT mandatory files according to ETSI
  • A license term file for the xNF located in a directory named Licences located at the root or in a location identified in the .meta file (NOT PROVIDED IN THE EXAMPLE )
  • certification files as they could differ according to the type of security option provided by the vendor (NOT PROVIDED IN THE EXAMPLE )

A reference PNF CSAR PACKAGE as example is available dummyPnfv2.csar to review directories structure and new .meta and .mf files format.

NOTES about the Dummy PNF CSAR PACKAGE example:

1) Only csar package structure with TOSCA-Metadata directory will be supported in Dublin timeframe

2) PM Dictionary, Event registration and Yang modules are the only NON MANO ARTIFACTS that will be listed in the manifest file

3) Multiple yang-module files the manifest file and in the dummy package with the intent to demonstrate that multiple files can be assosicated to a single keyword (according to ETSI SOL004)

4) Example package above does not include any certification file or other security options.




Example 2 (Frankfurt Release)

In the picture below, an example of a PNF onboarding package including a manifest file with URI's for non-MANO artifacts used in Frankfurt

Image Added

A reference PNF CSAR PACKAGE as example is available dummyPnfv3.csar (TBD) to review directories structure and new .meta and .mf files format.