docs/guides/onap-user/design/pre-onboarding/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2019 ONAP Contributors. All rights reserved.
   4
   5 .. _doc_guide_user_des_pre-onb:
   6
   7 Pre-Onboarding
   8 ==============
   9
  10     * `Generate Manifest and Package Artifacts`_ (for HEAT based VNFs)
  11     * `Validate xNF Package (VNF/PNF)`_
  12
  13
  14 .. _doc_guide_user_des_pre-onb_gen-man:
  15
  16 Generate Manifest and Package Artifacts
  17 ---------------------------------------
  18
  19 .. note::
  20    This section describes the steps required to package a given HEAT
  21    template into a zip-file, which can be onboarded to SDC. Instructions
  22    to create TOSCA based VNF or PNF Onboarding Packages are not described
  23    here
  24
  25 The for onboarding the zip-file requires besides the Heat template also a
  26 MANIFEST.json file, which describes the content of the package. To generate a
  27 MANIFEST.json file a script can be used offered by the SDC project:
  28 `generate-manifest.py`_
  29
  30 These steps are performed outside SDC.
  31
  32 **Prerequisites:** Obtain Heat/ENV files and other files required for
  33 onboarding. The requirements are found in the following document.
  34
  35
  36 :ref:`Heat requirements<onap-vnfrqts-requirements:heat_requirements>`
  37
  38 #. Put the Heat, ENV, nested Heat, and other files used by get-file in templates
  39    in a directory on a host, which supports python.
  40
  41    Naming guidelines:
  42
  43     - The base Heat should include "base" in the name.
  44     - The ENV file name should match the name of the Heat file with which it
  45       is associated.
  46     - All get-file file names need to be unique.
  47
  48 #. Put the python script in a directory one level above the directory that
  49    contains the Heat/ENV and other files.
  50
  51    For example, [dir x]/[dir y]
  52
  53     - [dir y] contains the Heat/ENV files and other files
  54     - [dir x] contains the python script
  55
  56 #. Run the script via command line:
  57
  58    .. code-block:: python
  59
  60       python generate-manifest.py -f "dir y"
  61
  62 #. Examine the manifest file and confirm that is correct.
  63
  64 #. Package all Heat/ENV files, all other files, and the MANIFEST.json
  65    into one .zip file.
  66
  67 Example packages can be found in the SDC poject: `example-packages`_
  68
  69 .. _doc_guide_user_des_pre-onb_val:
  70
  71 Validate xNF Package (VNF/PNF)
  72 ------------------------------
  73
  74 VNF and PNF packages have to follow the requirements described in:
  75
  76 :ref:`VNF and PNF Modeling Requirements
  77 <onap-vnfrqts-requirements:tosca_requirements>`
  78
  79 :ref:`ONAP Management Requirements
  80 <onap-vnfrqts-requirements:onap_management_requirements>`
  81
  82 For Validation of VNF and PNF packages the tools delivered by VNFSDK can be
  83 used:
  84
  85 `VNF Validation Documentation <../../../onap-provider/vnfvalidator.rst>`_
  86
  87 Prior to resource onboarding, the Certification Group does the following:
  88
  89  - for VNF and PNF
  90      - Validation of the delivered xNF package and artifacts
  91      - using the VNF Validation Tools
  92  - in case of VNF
  93     - onboards the Heat template(s) and metadata to the SDC catalog
  94     - creates a test VF
  95     - runs the Heat scanning tools
  96  - shares the results with any group that approves Virtual Functions
  97
  98 In parallel, the Certification Group onboards the VF Image and OS to a
  99 standalone ONAP instance (the "sandbox") and performs the following:
 100
 101  - security scan
 102  - compatibility test for the OS and vendor binary
 103  - malware scan
 104
 105 The Certification group then instantiates the VF image using the vendor
 106 Heat (if provided) in order to validate that the VM can run on the Network
 107 Cloud.
 108
 109 No VF functionality testing is performed at this stage.
 110
 111
 112 .. _generate-manifest.py: https://git.onap.org/sdc/tree/openecomp-be/tools/scripts/generate-manifest.py
 113 .. _example-packages: https://git.onap.org/sdc/tree/test-apis-ci/sdc-api-tests/chef-repo/cookbooks/sdc-api-tests/files/default/Files