X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fonboardingpackages.rst;h=d48c2d62551ef096469aa1cdfee58cace8dac2fb;hb=5eec3c5ec841aaca0a64e10028197a47ed2acbc6;hp=ee668a31786c350bc50cce267b9a36c6efd134d5;hpb=4b88c4265bd9170ab37384d291288ddf3dc132b3;p=sdc.git diff --git a/docs/onboardingpackages.rst b/docs/onboardingpackages.rst index ee668a3178..d48c2d6255 100644 --- a/docs/onboardingpackages.rst +++ b/docs/onboardingpackages.rst @@ -14,6 +14,11 @@ SDC supports the following packages types - Heat Package - ONAP Tosca CSAR Package - ETSI SOL004 Tosca CSAR Package +- Basic Helm package support for CNF + +For an extensive guide on how to perform onboarding, please refer to the ONAP User guide: +* :ref:`User Guides ` + Heat Package ^^^^^^^^^^^^ @@ -39,10 +44,27 @@ in `ONAP wiki page `_ ETSI SOL004 Tosca CSAR Package ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ETSI SOL004 Tosca CSAR Package is a zip archive with a .csar extension. The structure of the supported CSAR package +The ETSI SOL004 Tosca CSAR Package is a zip archive with a .csar extension. The structure necessary for the supported CSAR package +depends on the model selected in onboarding as detailed below. + +**SDC AID** + +If the package is onboarded using the SDC AID model, the structure of the supported CSAR package is as described in `ETSI NFV-SOL 004v2.6.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory. -The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1 `_ +The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1 `_. The descriptor is partially mapped into the SDC AID model. There is also limited support for v2.7.1 and 3.3.1 + +**ETSI SOL001 v2.5.1** + +If the package is onboarded using the ETSI SOL001 v2.5.1 model, the structure of the supported CSAR package +is as described in `ETSI NFV-SOL 004v2.5.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory. + +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). + +Note in relation to model selection: + +- 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. +- For a package to be used in service design it must be imported with the same model as is selected during service creation. Other Points to note when onboarding this package are: @@ -50,6 +72,15 @@ Other Points to note when onboarding this package are: - 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. - The non-mano artifacts are mapped to the corresponding SDC Artifact Type in the xNF internal model. + +Basic Helm package support for CNF +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The helm package support is new since Guilin release, helm chart packaged as tgz file can be onboarded and distributed. +The support is limited for this first release. + +Since Istanbul release there is also an additional helm chart validation step during package onboarding process. More information: :ref:`SDC Helm Validator `. + Package Types applicable to Resource Types ------------------------------------------ VF @@ -86,9 +117,17 @@ ONAP model. How does SDC determine which package type is being onboarded ------------------------------------------------------------ SDC onboarding processes each of the package types differently. SDC determines which package type is being onboarded, and -hence which logic to use, based on the following +hence which logic to use. + +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`_. + +If the SDC AID model is selected during onboarding, SDC will determine the package type based on the following. + +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`_. + +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. -First SDC checks the extension of the package. If the package extension is *.zip* then the package is treated as a `Heat package`_. +If it determines that this is a Helm package, SDC will add dummy Heat descriptor files. If the package extension is *.csar* and the following is true @@ -128,3 +167,5 @@ SDC supports the signature in Cryptographic Message Syntax (CMS) format. needs to be pre-installed in SDC before onboarding is started. The details of this procedure are described :ref:`here `. .. _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 +.. _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 +.. _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