X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-user%2Fdesign%2Fpre-onboarding%2Findex.rst;h=42b1ca0f7fb990098982c3ba15ced09e9f9a7abb;hb=1071b0fb38fe4c08f983b8d977eb0c32f6d3c667;hp=7a09f0db533688025ce71ff0cd026e485f027601;hpb=add9addd81082edb87c69432c7345addad61c055;p=doc.git diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index 7a09f0db5..42b1ca0f7 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -7,122 +7,108 @@ Pre-Onboarding ============== - * `Create a Tenant`_ - * `Validate VFs (Virtual Functions)`_ - * `Generate Manifest and Package Artifacts`_ + * `Generate Manifest and Package Artifacts`_ (for HEAT based VNFs) + * `Validate xNF Package (VNF/PNF)`_ -Create a Tenant ---------------- -Each service requires a tenant_ (a group of users who share a common access) -in which resources are stored in the cloud. This process is performed using -facilities of the network cloud, outside of ONAP. Confirm that the tenant is -created and note the tenant ID. +.. _doc_guide_user_des_pre-onb_gen-man: -ONAP admin users can configure a cloud-owner to add new cloud resources. -These are the computing and networking resources, that will support -running VNFs. A cloud-owner holds a keystone URL, login, region and -password, in the case of an Openstack cluster. A cloud-owner also -belongs to a region. The region name should be the same as the Openstack -region. Prior to creation of a cloud-owner, its region must be created -first. Multiple tenants can share the same cloud-owner. Note that these -tenants are ONAP tenants, not Openstack tenants. Tenant register -services that customers are allowed to deploy. Finally, the customer is -like an instance of the tenant. - -Note: there is no GUI (yet) to configure these objects. REST requests -are sent to AAI to achieve the configuration. For a detailed list of -required REST commands see: - -https://wiki.onap.org/display/DW/running+vFW+Demo+on+ONAP+Amsterdam+Release +Generate Manifest and Package Artifacts +--------------------------------------- -The overall process is as follows: +.. note:: + This section describes the steps required to package a given HEAT + template into a zip-file, which can be onboarded to SDC. Instructions + to create TOSCA based VNF or PNF Onboarding Packages are not described + here - #. Create a region and a cloud-owner. This steps registers Openstack - credentials. This is the only step requiring entering Openstack specific - parameters. +The for onboarding the zip-file requires besides the HEAT template also a MANIFEST.json file, which describes the content of the package. +To generate a MANIFEST.json file a script can be used offered by the SDC project: +`generate-manifest.py`_ - #. Create a complex. The complex describes the coverage of the region with - a street address etc. +These steps are performed outside SDC. - #. Create a service. The service name should match the name of the service - onboarded in SDC. +**Prerequisites:** Obtain Heat/ENV files and other files required for +onboarding. The requirements are found in the following document. - #. Create a tenant. Tenant in ONAP stores a design for a generic customer. - #. Associate tenants with their allowed services. +:ref:`Heat requirements` - #. Create an instance of the tenant or customer. The customer is visible in - VID. A VID user can deploy allowed services on this new customer. +#. Put the Heat, ENV, nested Heat, and other files used by get-file in templates + in a directory on a host, which supports python. - |image1| + Naming guidelines: + - The base Heat should include "base" in the name. + - The ENV file name should match the name of the Heat file with which it + is associated. + - All get-file file names need to be unique. -Validate VFs (Virtual Functions) --------------------------------- +#. Put the python script in a directory one level above the directory that + contains the Heat/ENV and other files. -Prior to resource onboarding, the Certification Group does the following: + For example, [dir x]/[dir y] - - onboards the Heat template(s) and metadata to the SDC catalog - - creates a test VF - - runs the Heat scanning tools - - shares the results with any group that approves Virtual Functions + - [dir y] contains the Heat/ENV files and other files + - [dir x] contains the python script -In parallel, the Certification Group onboards the VF Image and OS to a -standalone ONAP instance (the "sandbox") and performs the following: +#. Run the script via command line: - - security scan - - compatibility test for the OS and vendor binary - - malware scan + .. code-block:: python -The Certification group then instantiates the VF image using the vendor -Heat (if provided) in order to validate that the VM can run on the Network -Cloud. + python generate-manifest.py -f "dir y" -No VF functionality testing is performed at this stage. +#. Examine the manifest file and confirm that is correct. +#. Package all Heat/ENV files, all other files, and the MANIFEST.json + into one .zip file. -Generate Manifest and Package Artifacts ---------------------------------------- +Example packages can be found in the SDC poject: `example-packages`_ -Before onboarding resources, run generate-manifest.py to generate a -MANIFEST file. These steps are performed outside SDC. +.. _doc_guide_user_des_pre-onb_val: -OBSOLETE: **Prerequisites:** Obtain Heat/ENV files and other files required for -onboarding. See the reference document `VNF Heat Template Requirements -for OpenECOMP `__ for details. +Validate xNF Package (VNF/PNF) +------------------------------ -UPDATE: see VNF Modeling Requirements / HEAT: https://onap.readthedocs.io/en/casablanca/submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.html +VNF and PNF packages have to follow the requirements described in: -#. Put the Heat, ENV, nested Heat, and other files used by get-file in templates - in a directory. +:ref:`VNF and PNF Modeling Requirements` - Naming guidelines: +:ref:`ONAP Management Requirements` - - The base Heat should include "base" in the name. - - The ENV file name should match the name of the Heat file with which it - is associated. - - All get-file file names need to be unique. +For Validation of VNF and PNF packages the tools delivered by VNFSDK can be +used: -#. Put the python script in a directory one level above the directory that - contains the Heat/ENV and other files. +.. toctree:: + :maxdepth: 1 + :titlesonly: - For example, [dir x]/[dir y] + ../../../onap-provider/vnfvalidator.rst - - [dir y] contains the Heat/ENV files and other files - - [dir x] contains the python script +Prior to resource onboarding, the Certification Group does the following: -#. Run the script on the Windows command line: + - for VNF and PNF + - Validation of the delivered xNF package and artifacts + - using the VNF Validation Tools + - in case of VNF + - onboards the Heat template(s) and metadata to the SDC catalog + - creates a test VF + - runs the Heat scanning tools + - shares the results with any group that approves Virtual Functions - .. code-block:: +In parallel, the Certification Group onboards the VF Image and OS to a +standalone ONAP instance (the "sandbox") and performs the following: - python generate-manifest.py -f "dir y" + - security scan + - compatibility test for the OS and vendor binary + - malware scan -#. Examine the manifest file and confirm that is correct. +The Certification group then instantiates the VF image using the vendor +Heat (if provided) in order to validate that the VM can run on the Network +Cloud. -#. Package all Heat/ENV files, all other files, and the MANIFEST.json - into one .zip file. +No VF functionality testing is performed at this stage. -.. |image1| image:: media/tenant.png -.. _tenant: https://wiki.onap.org/display/DW/Glossary#Glossary-tenant +.. _generate-manifest.py: https://git.onap.org/sdc/tree/openecomp-be/tools/scripts/generate-manifest.py +.. _example-packages: https://git.onap.org/sdc/tree/test-apis-ci/sdc-api-tests/chef-repo/cookbooks/sdc-api-tests/files/default/Files