diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/files/VNFSDK-Marketplace-userguide-operators.rst | 10 | ||||
| -rw-r--r-- | docs/files/VNFSDK-Marketplace-userguide-vendors.rst | 15 | ||||
| -rw-r--r-- | docs/files/marketplace-overview.rst | 29 | ||||
| -rw-r--r-- | docs/files/vnfsdk-marketplace.png | bin | 0 -> 38613 bytes | |||
| -rw-r--r-- | docs/index.rst | 24 |
5 files changed, 72 insertions, 6 deletions
diff --git a/docs/files/VNFSDK-Marketplace-userguide-operators.rst b/docs/files/VNFSDK-Marketplace-userguide-operators.rst new file mode 100644 index 0000000..450f669 --- /dev/null +++ b/docs/files/VNFSDK-Marketplace-userguide-operators.rst @@ -0,0 +1,10 @@ +VNF SDK Marketplace User Guide for Operators
+============================================
+
+The VNFSDK Marketplace helps operators download pre-validated VNFs through the web GUI.
+
+1. Log into the portal
+2. Using the buttons in the upper right corner, an operator can see the currently validated VNFs in a list or grid view.
+3. The marketplace provides an onboarding report for each VNF. Operators can see the testing results by clicking on the VNF. In the Amsterdam release, only validation tests are run. In the future, we plan to add lifecycle and functional tests.
+4. Operators can download a VNF by clicking on the ÒdownloadÓ button.
+5. VNFSDK also supports integration with SDC. A VNF can be onboarded into SDC by visiting the SDC portal. SDC connects to VNFSDK and can query all available VNFs. When an operator selects a VNF in the SDC portal, it will be downloaded from VNFSDK and installed in the SDC catalog.
diff --git a/docs/files/VNFSDK-Marketplace-userguide-vendors.rst b/docs/files/VNFSDK-Marketplace-userguide-vendors.rst new file mode 100644 index 0000000..768d8b3 --- /dev/null +++ b/docs/files/VNFSDK-Marketplace-userguide-vendors.rst @@ -0,0 +1,15 @@ +VNF SDK Marketplace User Guide for Vendors +========================================== + +The VNFSDK Marketplace helps vendors validate VNFs and connect with suppliers. To upload and validate VNFs, vendors will use the web GUI. + +1. Log into the portal +2. Click ÒuploadÓ in the upper right to upload a VNF. Select the file and enter a short description and details. +3. The file is uploaded into the system and the marketplace automatically starts the VNF validation process. +4. Once validation is complete, the VNF is installed in the marketplace. +5. A vendor can re-upload a VNF if there are changes by clicking the Òre-uploadÓ button. +6. A vendor can also delete a VNF by clicking the ÒdeleteÓ button. +7. Using the buttons in the upper right corner, a user can see a list or grid of VNFs. +8. The marketplace provides an onboarding report for each VNF. You can see the testing results by clicking on the VNF. In the Amsterdam release, only validation tests are run. In the future, we plan to add lifecycle and functional tests. + + diff --git a/docs/files/marketplace-overview.rst b/docs/files/marketplace-overview.rst new file mode 100644 index 0000000..cede8f5 --- /dev/null +++ b/docs/files/marketplace-overview.rst @@ -0,0 +1,29 @@ +VNF SDK Marketplace +================== + +VNF SDK provides a reference implementation "marketplace" to help vendors validate and manage VNF packages. It also supports operator VNF onboarding into ONAP. + +|image0| + +.. |image0| image:: vnfsdk-marketplace.png + :height: 600px + :width: 800px + +1. **VNF Repository** is a reference repository for VNFs. + a. It provides functionalities: + i. Upload/Re-upload VNF + ii. Download VNF + iii. Query VNF based on several parameters + iv. Delete VNF + b. It also provides an intuitive Graphical user interface to perform above activities. + +2. Along with these, VNFSDK also provides hooks to call other tools or libraries including **Validation and Function Tests**. + + a. Validation verifies the package structure, mandatory files and their format. Currently, the tool performs basic validation to support SDC. In a future release, it will also ensure integrity and authenticity of the package as described by VNF Requirements. + b. Function Test provides Robot framework test cases present in each VNF. Function test executes those test cases and send the test response back to the marketplace. While the framework is in place, actual test development is deferred for a future release. + +3. **VNFSDK Integration with SDC** + + a. In Amsterdam, the SDC-UI is being integrated with the VNF Repository backend. It provides seamless download, search, view of the VNF present in VNF repository. The user can onboard these validated VNF into the SDC catalogue. + + diff --git a/docs/files/vnfsdk-marketplace.png b/docs/files/vnfsdk-marketplace.png Binary files differnew file mode 100644 index 0000000..12bf65b --- /dev/null +++ b/docs/files/vnfsdk-marketplace.png diff --git a/docs/index.rst b/docs/index.rst index 4251917..e00e602 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,13 @@ The VNF product model is specified using the TOSCA NFV simple profile. It is per files/pkgtool files/*blueprints +VNF SDK Marketplace +------------------- +.. toctree:: + :maxdepth: 1 + + files/marketplace-overview + VNF SDK Tools ------------- @@ -47,10 +54,6 @@ VNF SDK tools provide VNF product DevOps engineers with command line tools and c • VNF Package Dry Run - performs a "dry run" install to ensure that the package can be deployed during instantiation -VNF Validation Tests --------------------- - -TBD User Guides ----------- @@ -70,9 +73,18 @@ VNF Package Designer, provides VNF product DevOps engineers with a graphical too Marketplace User Guide for Operators ------------------------------------ -TBD +.. toctree:: + :maxdepth: 1 + :titlesonly: + + files/VNFSDK-Marketplace-userguide-operators Marketplace User Guide for VNF Suppliers ---------------------------------------- -TBD +.. toctree:: + :maxdepth: 1 + :titlesonly: + + files/VNFSDK-Marketplace-userguide-vendors + |
