diff options
| -rw-r--r-- | docs/files/Dovetail.rst | 16 | ||||
| -rw-r--r-- | docs/files/VNF SDK - Guide for Bundling VNFs.rst | 23 | ||||
| -rw-r--r-- | docs/files/VNFSDK-Marketplace-userguide-vendors.rst | 2 | ||||
| -rw-r--r-- | docs/files/marketplace-overview.rst | 50 | ||||
| -rw-r--r-- | docs/files/mktplace-install.rst | 27 | ||||
| -rw-r--r-- | docs/files/ves-client-guidelines.rst | 15 | ||||
| -rw-r--r-- | docs/files/vnf-packaging-model-blueprint.rst | 30 | ||||
| -rw-r--r-- | docs/index.rst | 134 |
8 files changed, 124 insertions, 173 deletions
diff --git a/docs/files/Dovetail.rst b/docs/files/Dovetail.rst index 422832b..2ce0289 100644 --- a/docs/files/Dovetail.rst +++ b/docs/files/Dovetail.rst @@ -5,14 +5,14 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Dovetail Integration's documentation! -================================================= +Dovetail Integration +==================== .. toctree:: :maxdepth: 2 User Stories -============ +------------ 1. An ONAP User wants to ensure that VNFs which appear in the VNF Marketplace can be on-boarded with the Service Design & Creation tool @@ -32,7 +32,7 @@ User Stories develop tests. OPNFV Dovetail Description -========================== +-------------------------- The Open Platform for NFV (OPNFV) is a collaborative project under the Linux Foundation that is transforming global networks through open @@ -85,7 +85,7 @@ Figure 1 below illustrates the Dovetail test framework architecture. Figure 1: OPNFV Dovetail Test Framework Architecture Implementation Overview -======================= +----------------------- OPNFV Dovetail will be integrated into the ONAP VNF Marketplace. The ONAP VNF Marketplace is an ONAP application which displays all VNFs that @@ -180,10 +180,10 @@ Marketplace. ONAP VNF On Boarding processes. Implementation Details -====================== +---------------------- Introduce a new test module under VNFSDK ----------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A new test module ‘VnfTest’ will be added as a subproject in VNF-SDK. @@ -191,7 +191,7 @@ This project will be similar to ‘Yardstick’ in the way it defines and runs tests. Dovetail to support new type ----------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A new test framework type will be introduced to dovetail – “VNFTest\ **”.** diff --git a/docs/files/VNF SDK - Guide for Bundling VNFs.rst b/docs/files/VNF SDK - Guide for Bundling VNFs.rst index 99f3ccf..8bf2f31 100644 --- a/docs/files/VNF SDK - Guide for Bundling VNFs.rst +++ b/docs/files/VNF SDK - Guide for Bundling VNFs.rst @@ -2,12 +2,23 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. -VNF SDK - Guide for Bundling VNFs -================================= +VNF Package Tools User Guide +============================ + +VNF Package Designer, provides VNF product DevOps engineers with a graphical +tool to define the VNF product model and package content. It is made available +as part of the VNF Supplier SDK tools.The package designer makes use of the VNF +SDK command line interfaces (CLIs) and client-side API language bindings in +order to define the model and the package content. As such, it is functionally +equivalent to the VNF SDK tools. + +VNF SDK - Guide for Bundling VNFs +--------------------------------- + Step 1: Requirements --------------------- +~~~~~~~~~~~~~~~~~~~~ 1. Virtual machine images for each of your VDUs (likely in qcow2 format). 2. Scripts for installing and configuring each VDU per the standard TOSCA @@ -16,14 +27,14 @@ Step 1: Requirements 4. VNF SDK pkgtools Step 2: Start with the provided VNF blueprint as a template ------------------------------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The VNF SDK comes with a "pingpong.yaml" template. Copy the file and rename it as is appropriate for your VNF. Step 3: Edit the VNF blueprint ------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You will need a node template for each VDU, which in turn has a "dependency" requirement on a host (a Compute node template). @@ -70,7 +81,7 @@ Otherwise, this is a standard TOSCA blueprint using the Simple Profile for NFV, and you may extend the blueprint as is required. Step 4: Bundle the VNF ----------------------- +~~~~~~~~~~~~~~~~~~~~~~ Arrange all your files (the TOSCA template, your scripts, and your virtual machine images) in the correct directory structure. File references provided in diff --git a/docs/files/VNFSDK-Marketplace-userguide-vendors.rst b/docs/files/VNFSDK-Marketplace-userguide-vendors.rst index f6385c0..01d7b4c 100644 --- a/docs/files/VNFSDK-Marketplace-userguide-vendors.rst +++ b/docs/files/VNFSDK-Marketplace-userguide-vendors.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. -VNF SDK Marketplace User Guide for Vendors +VNF SDK Marketplace User Guide for VNF Suppliers ========================================== The VNF SDK Marketplace helps vendors validate VNFs and connect with suppliers. diff --git a/docs/files/marketplace-overview.rst b/docs/files/marketplace-overview.rst index 4864777..0f53d78 100644 --- a/docs/files/marketplace-overview.rst +++ b/docs/files/marketplace-overview.rst @@ -8,11 +8,11 @@ VNF SDK Marketplace VNF SDK provides a reference implementation "marketplace" to help vendors validate and manage VNF packages. It also supports the operator to onboard VNF into ONAP.The API documentation using swagger can be found at http://hostIP:8702/apidocs -or :download:`json <swagger.json>` :download:`yaml <swagger.yaml>` +or :download:`json <../swagger.json>` :download:`yaml <../swagger.yaml>` |image0| -.. |image0| image:: files/vnfsdk-marketplace.png +.. |image0| image:: vnfsdk-marketplace.png :height: 600px :width: 800px @@ -45,3 +45,49 @@ or :download:`json <swagger.json>` :download:`yaml <swagger.yaml>` 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. + +VNF SDK Marketplace Installation Instructions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Download vnfsdk/refrepo from Gerrit +:: + + git clone http://gerrit.onap.org/r/vnfsdk/refrepo + +2. Goto vnfmarket-be/deployment/install, +:: + + Delete old docker images of refrepo (if any). + Enter command "source .env" to set up few environment variables. + Enter command "docker-compose up -d" + +This will start two Docker containers: + + a. VNF Repository + b. PostgreSQL database. + +Once started, access the Marketplace from your web browser. + +3. Connect to http://{host}:8702/onapui/vnfmarket to access the user interface + +VNF SDK Tools +~~~~~~~~~~~~~ + +VNF SDK tools provide VNF product DevOps engineers with command line tools and +client side API language bindings to define the VNF product model and package +content. The following tools are included... + +• VNF Package Builder - creates a CSAR file based on inputs provided by the VNF + product DevOps engineer + +• VNF Package Validator - validates the content of the VNF packages to ensure + that everything has been built correctly + +• VNF Package Extractor - extracts VNF product model and executables from the + CSAR file + +• VNF Package Parser - translates VNF product blueprint into a format + consumable by ONAP components + +• VNF Package Dry Run - performs a "dry run" install to ensure that the package + can be deployed during instantiation
\ No newline at end of file diff --git a/docs/files/mktplace-install.rst b/docs/files/mktplace-install.rst deleted file mode 100644 index 5e9fa6d..0000000 --- a/docs/files/mktplace-install.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -VNF SDK Marketplace Installation Instructions -============================================= - -1. Download vnfsdk/refrepo from Gerrit -:: - - git clone http://gerrit.onap.org/r/vnfsdk/refrepo - -2. Goto vnfmarket-be/deployment/install, -:: - - Delete old docker images of refrepo (if any). - Enter command "source .env" to set up few environment variables. - Enter command "docker-compose up -d" - -This will start two Docker containers: - - a. VNF Repository - b. PostgreSQL database. - -Once started, access the Marketplace from your web browser. - -3. Connect to http://{host}:8702/onapui/vnfmarket to access the user interface diff --git a/docs/files/ves-client-guidelines.rst b/docs/files/ves-client-guidelines.rst new file mode 100644 index 0000000..da22335 --- /dev/null +++ b/docs/files/ves-client-guidelines.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017-2018 Huawei Technologies Co., Ltd. + +VES Client Guidelines +===================== + + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + VESEventRegistration_3_0.rst + VESEventListener_7_0_1.rst + :download:`common event format json <files/CommonEventFormat_29.json>` diff --git a/docs/files/vnf-packaging-model-blueprint.rst b/docs/files/vnf-packaging-model-blueprint.rst new file mode 100644 index 0000000..b475f25 --- /dev/null +++ b/docs/files/vnf-packaging-model-blueprint.rst @@ -0,0 +1,30 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 Huawei Technologies Co., Ltd. + +VNF Packaging Model/Blueprint +============================= + +VNF product model/blueprint provides a declarative way to define deployment, +operational and functional attributes of a VNF product. The VNF product is +defined in terms of deployment time requirements and dependencies and exposed +telemetry indicator definitions. + +The deployment time requirements and dependencies define any and all compute +infrastructure needs of the VNF product, such as specific hardware +architecture, on-chip features, instruction set availability and hypervisor +capabilities. + +The telemetry indicator definitions define a set of default indicators exposed +by a given VNF product for use by monitoring and assurance tools. This list +can be extended and customized once a given VNF product is on-boarded and +instantiated at run-time. + +The VNF product model is specified using the TOSCA NFV simple profile. It is +persisted, along with the product executables and data, using TOSCA CSAR files. + +.. toctree:: + :maxdepth: 1 + :titlesonly: + :glob: +
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 2c5d77b..4030f1f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,146 +13,22 @@ VNFSDK Documentation :download:`swagger json <files/swagger.json>` :download:`swagger yaml <files/swagger.yaml>` -Components ----------- - -VNF Packaging Model/Blueprint ------------------------------ - -VNF product model/blueprint provides a declarative way to define deployment, -operational and functional attributes of a VNF product. The VNF product is -defined in terms of deployment time requirements and dependencies and exposed -telemetry indicator definitions. - -The deployment time requirements and dependencies define any and all compute -infrastructure needs of the VNF product, such as specific hardware -architecture, on-chip features, instruction set availability and hypervisor -capabilities. - -The telemetry indicator definitions define a set of default indicators exposed -by a given VNF product for use by monitoring and assurance tools. This list -can be extended and customized once a given VNF product is on-boarded and -instantiated at run-time. - -The VNF product model is specified using the TOSCA NFV simple profile. It is -persisted, along with the product executables and data, using TOSCA CSAR files. - -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - files/pkgtool - -VNF SDK Marketplace -=================== - -.. include:: files/marketplace-overview.rst - -Installation instructions -------------------------- - -.. toctree:: - :maxdepth: 1 - - files/mktplace-install - -VNF SDK Tools -------------- - -VNF SDK tools provide VNF product DevOps engineers with command line tools and -client side API language bindings to define the VNF product model and package -content. The following tools are included... - -• VNF Package Builder - creates a CSAR file based on inputs provided by the VNF - product DevOps engineer - -• VNF Package Validator - validates the content of the VNF packages to ensure - that everything has been built correctly - -• VNF Package Extractor - extracts VNF product model and executables from the - CSAR file - -• VNF Package Parser - translates VNF product blueprint into a format - consumable by ONAP components - -• VNF Package Dry Run - performs a "dry run" install to ensure that the package - can be deployed during instantiation - + files/vnf-packaging-model-blueprint + files/marketplace-overview User Guides =========== -VNF Package Tools User Guide ----------------------------- - -VNF Package Designer, provides VNF product DevOps engineers with a graphical -tool to define the VNF product model and package content. It is made available -as part of the VNF Supplier SDK tools.The package designer makes use of the VNF -SDK command line interfaces (CLIs) and client-side API language bindings in -order to define the model and the package content. As such, it is functionally -equivalent to the VNF SDK tools. - .. toctree:: :maxdepth: 1 :titlesonly: :glob: + files/pkgtool files/*Bundling* - -Marketplace User Guide for Operators ------------------------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - files/VNFSDK-Marketplace-userguide-operators - -Marketplace User Guide for VNF Suppliers ----------------------------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - files/VNFSDK-Marketplace-userguide-vendors - -VES Client Guidelines ---------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - files/VESEventRegistration_3_0.rst - files/VESEventListener_7_0_1.rst - :download:`common event format json <files/CommonEventFormat_29.json>` - - -VNF Certification Testing Framework - Dovetail ----------------------------------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - + files/ves-client-guidelines files/Dovetail - -ICE tools for HEAT validation ------------------------------ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - files/ICE - -VNF SDK in LF Networking User Guide ------------------------------------ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - files/VNFSDK-LFN-CVC.rst + files/VNFSDK-LFN-CVC |