summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorChris Donley <christopher.donley@huawei.com>2017-11-09 15:17:45 -0800
committerChris Donley <christopher.donley@huawei.com>2017-11-09 15:17:45 -0800
commita3adf07306490e9d0e88229c165630124376c86f (patch)
tree1c873e3a462f4d521de70049ddd95dab7896418e /docs/index.rst
parent78123d36ca3583fa9ba204cda9724016df63ba60 (diff)
Documentation clean-up
Cleaned up documentation per: (1) Docs project feedback (2) License cleanup (3) other typos, etc. Issue-ID: VNFSDK-129 Change-Id: If125784b3b0656128ca897e82ad0e5d9873a7e07 Signed-off-by: Chris Donley <christopher.donley@huawei.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst50
1 files changed, 33 insertions, 17 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 9ecdee7..f5dbab4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,7 +2,6 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-
VNFSDK Documentation
====================
@@ -18,13 +17,23 @@ 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.
+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 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 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.
+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
@@ -50,17 +59,20 @@ Installation instructions
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 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 Extractor - extracts VNF product model and executables from the CSAR file
-
-• VNF Package Parser - translates VNF proeduct 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
+• 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 proeduct 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
User Guides
@@ -69,7 +81,12 @@ 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.
+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
@@ -105,4 +122,3 @@ VES Client Guidelines
files/VESEventRegistration
files/VESEventListener
-