Pre-Onboarding
==============
- * `Create a Tenant`_
- * `Validate VFs (Virtual Functions)`_
- * `Generate Manifest and Package Artifacts`_
+ * `Create a Tenant`_ (will be moved to "Service Deployment")
+ * `Generate Manifest and Package Artifacts`_ (for HEAT based VNFs)
+ * `Validate xNF Package (VNF/PNF)`_
+
+.. _doc_guide_user_des_pre-onb_cre-ten:
Create a Tenant
---------------
+.. note::
+ This section is not really belonging to the "Design" phase,
+ but to the preparation of the "Service Deployment" and will be
+ moved in the next release
+
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
|image1|
-Validate VFs (Virtual Functions)
---------------------------------
-
-Prior to resource onboarding, the Certification Group does the following:
-
- - 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
-
-In parallel, the Certification Group onboards the VF Image and OS to a
-standalone ONAP instance (the "sandbox") and performs the following:
-
- - security scan
- - compatibility test for the OS and vendor binary
- - malware scan
-
-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.
-
-No VF functionality testing is performed at this stage.
-
+.. _doc_guide_user_des_pre-onb_gen-man:
Generate Manifest and Package Artifacts
---------------------------------------
+.. 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
+
Before onboarding resources, run generate-manifest.py to generate a
MANIFEST file. These steps are performed outside SDC.
-OBSOLETE: **Prerequisites:** Obtain Heat/ENV files and other files required for
-onboarding. See the reference document `VNF Heat Template Requirements
-for OpenECOMP <https://wiki.onap.org/download/attachments/1015849/VNF%20Heat%20Template%20Requirements%20for%20OpenECOMP.pdf?version=2&modificationDate=1487262292000&api=v2>`__ for details.
+**Prerequisites:** Obtain Heat/ENV files and other files required for
+onboarding. The requirements are found in the following document.
-UPDATE: see VNF Modeling Requirements / HEAT: https://onap.readthedocs.io/en/casablanca/submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.html
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ Heat requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.rst>
#. Put the Heat, ENV, nested Heat, and other files used by get-file in templates
in a directory.
- [dir y] contains the Heat/ENV files and other files
- [dir x] contains the python script
-#. Run the script on the Windows command line:
+#. Run the script on the Windows command line (not valid anymore):
- .. code-block::
+ .. code-block:: python
- python generate-manifest.py -f "dir y"
+ python generate-manifest.py -f "dir y"
#. 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.
+.. _doc_guide_user_des_pre-onb_val:
+
+Validate xNF Package (VNF/PNF)
+------------------------------
+
+VNF and PNF packages have to follow the requirements described in:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ VNF and PNF Modeling Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/index.rst>
+ ONAP Management Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter7/index.rst>
+
+For Validation of VNF and PNF packages the tools delivered by VNFSDK can be
+used:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../onap-provider/vnfvalidator.rst
+
+Prior to resource onboarding, the Certification Group does the following:
+
+ - 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
+
+In parallel, the Certification Group onboards the VF Image and OS to a
+standalone ONAP instance (the "sandbox") and performs the following:
+
+ - security scan
+ - compatibility test for the OS and vendor binary
+ - malware scan
+
+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.
+
+No VF functionality testing is performed at this stage.
+
.. |image1| image:: media/tenant.png
.. _tenant: https://wiki.onap.org/display/DW/Glossary#Glossary-tenant
Resource Onboarding
===================
-**Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC.
+**Goal:** Add models and other artifacts required to create, configure,
+ instantiate, and manage a VF and, optionally, a VFC.
**Tool:** SDC
|image1|
+.. _doc_guide_user_des_res-onb_cre-lic:
+
Create a License Model
----------------------
-VSPs optionally require a license and entitlements to enable the service provider to track the usage.
+VSPs optionally require a license and entitlements to enable the service
+provider to track the usage.
-Note: For interim saving while creating the license model and its components, click |image2|
+Note: For interim saving while creating the license model and its components,
+click |image2|
-**Prerequisites:** To obtain license information, contact the service provider's Supply Chain Management (SCM) group.
+**Prerequisites:** To obtain license information, contact the service
+ provider's Supply Chain Management (SCM) group.
|image3|
#. Hover over Add and select New License Model.
#. Complete all fields.
#. Click *Save*.
-#. In the ONBOARD header, hover over the arrow after License Agreements to reveal a menu.
+#. In the ONBOARD header, hover over the arrow after License Agreements to
+ reveal a menu.
Select the following options in order:
- #. Create 0 or more license key groups (see `Create a License Key Group [Optional]`_).
+ #. Create 0 or more license key groups (see
+ `Create a License Key Group [Optional]`_).
#. Create 1 or more entitlement pools (see `Create an Entitlement Pool`_).
#. Create 1 or more feature groups (see `Create a Feature Group`_).
#. Create 1 or more license agreements (see `Create a License Agreement`_).
- Note: Perform all steps above before submitting the license model to the SDC catalog.
+ Note: Perform all steps above before submitting the license model to
+ the SDC catalog.
#. In the header, click the license model created in steps 1 to 4.
#. Click *Check In* to save changes.
-#. Click *Submit* to add the license model to the catalog. A success message displays.
-#. After creating a license, complete `Create a Vendor Software Product`_ to add the VSP required for the associated VF.
+#. Click *Submit* to add the license model to the catalog. A success message
+ displays.
+#. After creating a license, complete `Create a Vendor Software Product`_ to
+ add the VSP required for the associated VF.
Create a License Key Group [Optional]
-------------------------------------
-If required by the resource model, create one or more license key groups; otherwise the license key group is optional.
+If required by the resource model, create one or more license key groups;
+otherwise the license key group is optional.
**Prerequisites:** `Create a License Model`_
Create an Entitlement Pool
--------------------------
-**Prerequisites:** If required by the resource model, create one or more license key groups (see `Create a License Key Group [Optional]`_).
+**Prerequisites:** If required by the resource model, create one or more
+ license key groups (see
+ `Create a License Key Group [Optional]`_).
|image5|
**Prerequisites:** Create one or more:
-* license key groups if required by the resource model (see `Create a License Key Group [optional]`_)
+* license key groups if required by the resource model
+ (see `Create a License Key Group [optional]`_)
* entitlement pools (see `Create an Entitlement Pool`_)
|image6|
Create a License Agreement
--------------------------
-**Prerequisites:** Create one or more feature groups (see `Create a Feature Group`_).
+**Prerequisites:** Create one or more feature groups
+ (see `Create a Feature Group`_).
|image7|
1. From the drop-down menu, select License Agreements.
2. Click *Add License Agreement*.
The Create New License Agreement box displays.
-3. On the General tab, complete required fields (mandatory fields are marked by a red asterisk).
+3. On the General tab, complete required fields (mandatory fields are marked
+ by a red asterisk).
4. Click *Feature Groups*.
5. If not selected, click *Available Feature Groups*.
6. Select one or more groups and click the right arrow.
7. Click *Save*.
8. Return to step 5 of `Create a License Model`_ to complete the license model.
+.. _doc_guide_user_des_res-onb_cre-vsp:
+
Create a Vendor Software Product
--------------------------------
-Create one or more Vendor Software Products (VSPs) as the building blocks for VFs.
+Create one or more Vendor Software Products (VSPs) as the building blocks
+for VFs.
.. note::
For interim saving while creating a VSP, click |image2|
**Prerequisites:**
* `Create a License Model`_
-* Generate manifest and package artifacts.
+* Existing VNF HEAT package or VNF/PNF CSAR/Zip package
#. From the SDC HOME page, click *ONBOARD*.
#. Hover over Add and select New Vendor Software Product.
The Overview section is displayed.
.. note::
- A warning is displayed under License Agreement if the VSP does not have an associated license.
+ A warning is displayed under License Agreement if the VSP does not have
+ an associated license.
#. Click *Software Product Details* (left pane).
|image8|
-#. In order, select a licensing version, a license agreement, and one or more feature groups.
-#. [Optional] Complete other fields, such as Availability (high-availability zones) and Storage
- Data Replication (requirement for storage replication), as required.
+#. In order, select a licensing version, a license agreement, and one or more
+ feature groups.
+#. [Optional] Complete other fields, such as Availability (high-availability
+ zones) and Storage Data Replication (requirement for storage replication),
+ as required.
#. In Software Product Attachments (right pane), click *Select file*.
-#. Locate a Heat .zip package and click *Open*.
- SDC validates the files in the package. After successful validation, SDC displays the files
- and a success message. If validation fails, SDC displays the errors in the files.
+#. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
+ In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
+ and click *Open*.
+#. SDC validates the files in the package. After successful validation, SDC
+ displays the files and a success message. If validation fails, SDC displays
+ the errors in the files.
Example Heat errors:
#. Click *Check In* to save the changes.
#. Click *Submit* to add the VSP to the catalog.
-#. A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit.
-#. To configure VFCs associated with the VSP, see `Update VFCs in a VSP [optional]`_, below.
+#. A success message is displayed. If the VSP attachments contain errors, an
+ error message is displayed instead. Fix the issue(s) and re-submit.
+#. To configure VFCs associated with the VSP, see
+ `Update VFCs in a VSP [optional]`_, below.
+
+.. _doc_guide_user_des_res-onb_upd-vfc:
Update VFCs in a VSP [optional]
-------------------------------
-If required, configure Virtual Function Components (VFCs) associated with a VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed on the Components tab.
+If required, configure Virtual Function Components (VFCs) associated with a
+VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed
+on the Components tab.
.. note::
- All fields are optional. Answers to questionnaires are stored as metadata only on the SDC platform.
+ All fields are optional. Answers to questionnaires are stored as metadata
+ only on the SDC platform.
-**Prerequisites:** Add one or more VSPs (see `Create a Vendor Software Product`_).
+**Prerequisites:** Add one or more VSPs
+ (see `Create a Vendor Software Product`_).
#. From the SDC HOME page, click *ONBOARD* and search for a VSP.
#. In the Overview section, click *Check Out*.
#. In Components (bottom pane), click a VFC (VSP component).
The component links display in the left pane.
-#. Click *General* to view and edit general parameters such as hypervisor, image format, VM recovery details, and DNS configuration.
-#. Click *Compute* to view and edit VM parameters such as the number of VMs required for a VFC instance and persistent storage/volume size.
-#. Click *High Availability & Load Balancing* to answer questions related to VM availability and load balancing.
-#. Click *Networks* to view or edit parameters related to network capacity and interfaces.
+#. Click *General* to view and edit general parameters such as hypervisor,
+ image format, VM recovery details, and DNS configuration.
+#. Click *Compute* to view and edit VM parameters such as the number of VMs
+ required for a VFC instance and persistent storage/volume size.
+#. Click *High Availability & Load Balancing* to answer questions related
+ to VM availability and load balancing.
+#. Click *Networks* to view or edit parameters related to network capacity
+ and interfaces.
.. note::
- Click an interface to view or edit it. A dialog box displays similar to the figure below.
+ Click an interface to view or edit it. A dialog box displays similar
+ to the figure below.
|image10|
-#. Click *Storage* to configure storage information, such as backup type, storage size, and logging.
-#. Click *Process Details*, click *Add Component Process Details*, and complete the Create New Process Details dialog box. Use Process Details to identify the processes and configuration associated with VFCs.
+#. Click *Storage* to configure storage information, such as backup type,
+ storage size, and logging.
+#. Click *Process Details*, click *Add Component Process Details*, and complete
+ the Create New Process Details dialog box. Use Process Details to identify
+ the processes and configuration associated with VFCs.
#. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
#. Click *Overview* and click *Check In* to save changes.
-#. If updating a VSP, click *Submit*. If this procedure is performed during the workflow to create a VSP, there is no need to click *Submit* now.
+#. If updating a VSP, click *Submit*. If this procedure is performed during the
+ workflow to create a VSP, there is no need to click *Submit* now.
+
+.. _doc_guide_user_des_res-onb_upd-vsp:
Update a VSP [optional]
-----------------------
Upload a new Heat package to a VSP. Afterward, update the VF and service.
-**Prerequisites:** Add one or more VSPs (see `Create a Vendor Software Product`_).
+**Prerequisites:** Add one or more VSPs
+ (see `Create a Vendor Software Product`_).
#. From the SDC HOME page, click *ONBOARD* and search for a VSP.
#. In the Overview section, click *Check Out*.
#. In Software Product Attachments (right pane), click *Select file*.
-#. Locate a Heat .zip package and click *Open*.
+#. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
+
+ In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
+ and click *Open*.
+
SDC warns that uploading a new package erases existing data.
-#. Click *Continue* to upload the new Heat package.
- SDC validates the files in the package. After successful validation, SDC displays the files and a success message. If validation fails, SDC displays the errors in the files.
+#. Click *Continue* to upload the new package.
+ SDC validates the files in the package. After successful validation, SDC
+ displays the files and a success message. If validation fails, SDC displays
+ the errors in the files.
.. note::
- If the Heat template contains errors, contact the Certification Group for guidance on how to proceed.
+ If the Heat template contains errors, contact the Certification Group for
+ guidance on how to proceed.
#. Click *Check In* to save changes.
#. Click *Submit* to add the VSP to the catalog.
- A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit.
+ A success message is displayed. If the VSP attachments contain errors, an
+ error message is displayed instead. Fix the issue(s) and re-submit.
#. After updating the VSP:
- #. Upload the VSP to the VF (see steps 3 to 5 in (TBD)Update a VF [optional]).
- #. Update the VF version in services that include the VF (see step 4 in (TBD) Update a service [optional]).
+ #. Upload the VSP to the VF
+ (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
+ #. Update the VF version in services that include the VF (see step 4
+ in :ref:`doc_guide_user_des_ser-des`).
.. |image0| image:: media/sdro-resource-onboarding-workflow.png
Steps
-----
-- `Create a VF`_
-- `Update a VF [optional]`_
-- `Submit a VF for testing`_
-- `Test a VF`_
+- `Create a VF/PNF by VSP import`_
+- `Create a VF/PNF manually`_
+- `Update a VF/PNF [optional]`_
+- `Submit for testing`_
+- `Test a VF/PNF`_
-Create a VF
------------
+.. _doc_guide_user_des_vf-cre_cre-imp:
-**Prerequisites:**
+Create a VF/PNF by VSP import
+-----------------------------
+
+**Prerequisites:** (see :ref:`doc_guide_user_des_res-onb` )
-- Create a license for each VF (see Create a license model) (see also the
- tutorial Creating a Licensing Model)
+- Create a license for each VF/PNF
- Create a Vendor Software Product.
**Steps**
-#. From the SDC HOME page, click the *Vendor Software Component* icon in the
- header (upper right).
+#. From the SDC HOME page, click the *Import VSP*
|image2|
-#. From the Import VF box, expand a VSP name and click the *Import VSP* icon.
+#. From the *Import VF* box, expand a VSP name and click the *Import VSP* icon.
|image3|
#. In the General section, complete all fields.
- .. note:: Use the letters "VF" in the name to indicate that the component is a VF.
+ .. note:: Use the letters "VF" or "PNF" in the name to indicate that the
+ component type.
#. Click *Create*.
- - A message displays while VF creation is in progress. (This can take up to
+ - A message displays while creation is in progress. (This can take up to
10 minutes.)
- - A message displays when VF creation is complete.
+ - A message displays when creation is complete.
#. Click *Check In* to save changes.
#. Enter a comment and click *OK*.
- - A message displays when the VF is checked in.
+ - A message displays when the VF/PNF is checked in.
-#. [Optional] At any time before submitting the VF for testing, click these
- options to update VF information:
+#. [Optional] At any time before submitting the VF/PNF for testing, click
+ these options to update VF/PNF information:
.. note:: These tasks can be done only before submitting the VF for testing.
- - Icon ??? change the icon associated with the VF (vendor-supplied icons are
+ - **Icon** change the icon associated with the VF/PNF (vendor-supplied icons
+ are preferred)
+ - **Deployment Artifacts** download, view, modify, or change deployment
+ artifacts (for example, the contents of the Heat .zip file, which contains
+ the Heat volume template, the license, etc.)
+ - **Information Artifacts** view or upload artifacts, such as test scripts, test
+ results, or the AIC questionnaire
+ - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template
+ - **Properties** define or update properties
+ - **Composition** view or edit the graphical representation of the resource-level
+ TOSCA model (generated from the Heat template)
+ - **Activity Log** view activity related to assets associated with the VF/PNF
+ (displays the action, date, user, status, and any comments related to each
+ action)
+ - **Deployment** view VF modules defined in the Heat template
+ - **Inputs** view inputs defined for the resource-level TOSCA model
+
+#. After creating a VF/PNF, submit it for testing (see `Submit for testing`_).
+
+.. _doc_guide_user_des_vf-cre_cre-man:
+
+Create a VF/PNF manually
+------------------------
+
+**Steps**
+
+#. From the SDC HOME page, click the *Add VF* or *Add PNF*
+
+ |image9|
+
+#. In the General section, complete all fields.
+
+#. Before submitting the VF/PNF for testing, click these
+ options to update VF/PNF information:
+
+ .. note:: These tasks can be done only before submitting the VF/PNF for testing.
+
+ - **Icon** change the icon associated with the VF/PNF (vendor-supplied icons are
preferred)
- - Deployment Artifacts ??? download, view, modify, or change VF deployment
+ - **Deployment Artifacts** download, view, modify, or change VF/PNF deployment
artifacts (for example, the contents of the Heat .zip file, which contains
the Heat volume template, the VF license, etc.)
- - Information Artifacts ??? view or upload artifacts, such as test scripts, test
+ - **Information Artifacts** view or upload artifacts, such as test scripts, test
results, or the AIC questionnaire
- - TOSCA Artifacts ??? view or upload the TOSCA model or the TOSCA template
- - Properties ??? define or update VF properties (not used in Release 1)
- - Composition ??? view or edit the graphical representation of the resource-level
+ - **TOSCA Artifacts** view or download the TOSCA model or the TOSCA template
+ - **Properties** define or update properties
+ - **Composition** view or edit the graphical representation of the resource-level
TOSCA model (generated from the Heat template)
- - Activity Log ??? view activity related to assets associated with the VF
+ - **Activity Log** view activity related to assets associated with the VF/PNF
(displays the action, date, user, status, and any comments related to each
action)
- - Deployment ??? view VF modules defined in the Heat template
- - Inputs ??? view inputs defined for the resource-level TOSCA model
+ - **Deployment** view VF modules defined in the Heat template
+ - **Inputs** view inputs defined for the resource-level TOSCA model
+
+#. Click *Create*.
+
+ - A message displays while creation is in progress. (This can take up to
+ 10 minutes.)
+ - A message displays when creation is complete.
+
+#. Click *Check In* to save changes.
+
+ - A box displays for confirming the changes.
+
+#. Enter a comment and click *OK*.
+
+ - A message displays when the is checked in.
+
+
+#. After creating a VF/PNF, submit it for testing (see `Submit for testing`_).
-#. After creating a VF, submit it for testing (see `Submit a VF for testing`_).
-Update a VF [optional]
-----------------------
+.. _doc_guide_user_des_vf-cre_vf-upd:
+
+Update a VF/PNF [optional]
+--------------------------
- Update the VSP and other artifacts in a VF.
- Upload a new version the VSP to the VF whenever the VSP is updated (see steps
**Prerequisites:**
-- `Create a VF`_.
-- If the VSP was updated: Update a VSP [optional]
+- `Create a VF/PNF by VSP import`_ or `Create a VF/PNF manually`_
+- If the VSP was updated: :ref:`doc_guide_user_des_res-onb_upd-vsp`
**Steps**
#. After updating the VF:
- - Submit the VF for testing (see Submit a VF for testing).
+ - Submit the VF for testing (see `Submit for testing`_).
- Update the VF version in any service that contains the VF
(see step 4 in Update a service [optional]).
-Submit a VF for testing
------------------------
+.. _doc_guide_user_des_vf-cre_sub-tst:
+
+Submit for testing
+------------------
-**Prerequisites:** `Create a VF`_
+**Prerequisites:** `Create a VF/PNF by VSP import`_ or
+`Create a VF/PNF manually`_
**Steps**
-#. When a VF is ready for testing, click *CATALOG* and service for the VF.
-#. Click the VF and click *Submit for Testing*.
+#. When a VF/PNF is ready for testing, click *CATALOG* and service for the
+ VF/PNF.
+#. Click the VF/PNF and click *Submit for Testing*.
|image7|
#. Add the email addresses of the people on the Certification Group for this
site with the *Tester* role and send the email.
-Test a VF
----------
+.. _doc_guide_user_des_vf-cre_tst-vf:
-Test the design and artifacts of a VF.
+Test a VF/PNF
+-------------
-**Prerequisites:** `Submit a VF for testing`_.
+Test the design and artifacts of a VF/PNF.
+
+**Prerequisites:** `Submit for testing`_
**Steps**
#. When testing is complete, click *Accept*.
.. |image1| image:: media/design_vf_workflow.png
-.. |image2| image:: media/image2017-1-27_11-13-30.png
+.. |image2| image:: media/SDC-Import.png
.. |image3| image:: media/image2017-1-27_11-14-3.png
.. |image4| image:: media/image2017-1-27_11-17-18.png
.. |image5| image:: media/sdc_artifact_update.png
.. |image6| image:: media/design_vf_updatevspmessage.png
.. |image7| image:: media/image2017-1-27_11-20-13.png
.. |image8| image:: media/image2017-1-27_11-21-4.png
+.. |image9| image:: media/SDC-Add.png
+
Code Review / doc.git / commitdiff
