1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 .. _sdc_onboarding_package_types:
6 ========================
7 Onboarding Package Types
8 ========================
10 Supported Package Types
11 -----------------------
12 SDC supports the following packages types
15 - ONAP Tosca CSAR Package
16 - ETSI SOL004 Tosca CSAR Package
17 - Basic Helm package support for CNF
19 For an extensive guide on how to perform onboarding, please refer to the ONAP User guide:
20 * :ref:`User Guides <onap-doc:doc_guide_user_des>`
25 The heat package is a zip archive with a .zip extension. The package contains heat template yaml file(s), corresponding
26 environment file(s) and a MANIFEST.json file. The MANIFEST.json file describes the contents of the package.
28 There must be at least one heat template yaml file in the package whose name starts with *base_*. The other heat
29 templates in the package can have any name. All environment files that are included in the package must have the same
30 name as its corresponding yaml file with a .env file extension.
32 An example of a simple heat package stucture is a zip archive containing the following 3 files
34 - base_vFW.yaml (heat template)
35 - base_vFW.env (corresponding environment file)
36 - MANIFEST.json (describes files included in the package)
38 Examples of heat packages are the packages with .zip extension available in `SDC git repo <https://git.onap.org/sdc/tree/integration-tests/src/test/resources/Files/VNFs>`_
40 ONAP Tosca CSAR Package
41 ^^^^^^^^^^^^^^^^^^^^^^^
42 The ONAP Tosca CSAR package is a zip archive with a .csar extension. The structure of the CSAR package is as described
43 in `ONAP wiki page <https://wiki.onap.org/display/DW/Csar+Structure>`_
45 ETSI SOL004 Tosca CSAR Package
46 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
47 The ETSI SOL004 Tosca CSAR Package is a zip archive with a .csar extension. The structure necessary for the supported CSAR package
48 depends on the model selected in onboarding as detailed below.
52 If the package is onboarded using the SDC AID model, the structure of the supported CSAR package
53 is as described in `ETSI NFV-SOL 004v2.6.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory.
55 The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1 <https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20001v2.5.1%20-%20GS%20-%20TOSCA-based%20NFV%20descriptors%20spec.pdf>`_. The descriptor is partially mapped into the SDC AID model. There is also limited support for v2.7.1 and 3.3.1
57 **ETSI SOL001 v2.5.1**
59 If the package is onboarded using the ETSI SOL001 v2.5.1 model, the structure of the supported CSAR package
60 is as described in `ETSI NFV-SOL 004v2.5.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory.
62 The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1`_. The tosca types defined in this version of the ETSI NFV-SOL 001 are used in the created VF (rather than the types defined in the SDC AID model).
64 Note in relation to model selection:
66 - More than one model can be selected during onboarding. In the subsequent VSP import one model from the list of models selected at onboarding time must be selected.
67 - For a package to be used in service design it must be imported with the same model as is selected during service creation.
69 Other Points to note when onboarding this package are:
71 - During onboarding the ETSI NFV-SOL004 CSAR structure is transformed to the internal ONAP CSAR structure.
72 - The original input CSAR is maintained and stored as the SDC artifact *ETSI_PACKAGE* in the xNF internal model. For existing legacy xNF, it can be stored as *ONBOARDED_PACKAGE* instead.
73 - The non-mano artifacts are mapped to the corresponding SDC Artifact Type in the xNF internal model.
76 Basic Helm package support for CNF
77 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
79 The helm package support is new since Guilin release, helm chart packaged as tgz file can be onboarded and distributed.
80 The support is limited for this first release.
82 Since Istanbul release there is also an additional helm chart validation step during package onboarding process. More information: :ref:`SDC Helm Validator <sdc_helm_validator>`.
84 Package Types applicable to Resource Types
85 ------------------------------------------
88 The 3 package types described in `Supported Package Types`_ are all applicable for a VF i.e. a VF can be onboarded using any of
93 Only the `ETSI SOL004 Tosca CSAR Package`_ is applicable for a PNF.
96 The PNF is not explicitly mentioned in ETSI NFV-SOL 004v2.6.1. There is a CR pending on the SOL004 specification
97 describing the PNFD archive. SDC supports and expects the metadata section in the PNFD archive manifest to be
98 aligned with this CR i.e. the entries contain the following names (keys)
102 - pnfd_release_date_time
103 - pnfd_archive_version
105 An example of valid manifest file metadata section
110 pnfd_provider: SunShineCompany
111 pnfd_archive_version: 1.0
112 pnfd_release_date_time: 2017-01-01T10:00:00+03:00
114 When the PNF package in onboarded, the PNFD (descriptor) is transformed from ETSI NFV-SOL 001 model to the internal
117 How does SDC determine which package type is being onboarded
118 ------------------------------------------------------------
119 SDC onboarding processes each of the package types differently. SDC determines which package type is being onboarded, and
120 hence which logic to use.
122 If the ETSI SOL001 v2.5.1 model is selected during onboarding, SDC will always treat the package as an `ETSI SOL004 Tosca CSAR Package`_.
124 If the SDC AID model is selected during onboarding, SDC will determine the package type based on the following.
126 First SDC checks the extension of the package. If the package extension is *.zip* then the package is treated as a `Heat package`_ or `Basic Helm package support for CNF`_.
128 To determine whether the package is of type Helm, SDC looks into the package content and tries to find Helm base files if not found it will treat it as Heat.
130 If it determines that this is a Helm package, SDC will add dummy Heat descriptor files.
132 If the package extension is *.csar* and the following is true
134 - CSAR package contains TOSCA-Metadata directory
135 - The TOSCA.meta file exists within the TOSCA-Metadata directory
136 - The TOSCA.meta file contains the following keynames in block_0
139 - ETSI-Entry-Manifest
140 - ETSI-Entry-Change-Log
142 then the package is treated as an `ETSI SOL004 Tosca CSAR Package`_. Otherwise the package is treated as an `ONAP Tosca CSAR Package`_.
146 SDC validates the authenticity and integrity of onboarding packages that are secured according to
147 Security option 2 described in `ETSI NFV-SOL 004v2.6.1`_.
149 In this option the whole package is signed and delivered as part of a zip file. SDC supports both zip file structures
150 specified in the standard i.e
152 1. Zip file containing 3 artifacts
155 b. Signing Certificate File
158 2. Zip file containing 2 artifacts
161 b. Signature File containing signing certificate
163 SDC supports the signature in Cryptographic Message Syntax (CMS) format.
166 For SDC to validate the authenticity and integrity of the onboarding package, the root certificate of the trusted CA
167 needs to be pre-installed in SDC before onboarding is started. The details of this procedure are described :ref:`here <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
169 .. _ETSI NFV-SOL 004v2.6.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.6.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20-%20spec.pdf
170 .. _ETSI NFV-SOL 004v2.5.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.5.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20spec.pdf
171 .. _ETSI NFV-SOL 001v2.5.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20001v2.5.1%20-%20GS%20-%20TOSCA-based%20NFV%20descriptors%20spec.pdf