summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorGildas Lanilis <gildas.lanilis@huawei.com>2018-11-09 10:45:50 -0800
committerGildas Lanilis <gildas.lanilis@huawei.com>2018-11-16 13:38:46 -0800
commitb2c75a1834f30a6e4ed08059aa0efebec8b38e1d (patch)
treedb67cc59ccc1fabd9156849445c1423ce30d6ef5 /docs/index.rst
parent73a3ce10b49dfdf68aa7276629b285f55c8baee9 (diff)
Refactor VNFSDSK ReadTheDocs3.0.0-ONAPcasablanca
To facilite browsing and user experience Change-Id: Ic54d6f8a2779bd45a2765a61b694e17a231c9b07 Issue-ID: DOC-333 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst134
1 files changed, 5 insertions, 129 deletions
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