diff options
| author |   Chris Donley <christopher.donley@huawei.com> | 2017-09-21 08:59:41 -0700 |
|---|---|---|
| committer | Chris Donley <christopher.donley@huawei.com> | 2017-09-21 08:59:41 -0700 |
| commit | 1ac02e74a4a1ed8dcd451fa7a512f085233d40fc (patch) | |
| tree | 93b61ef36d367a811c4ab0d49c13caf303351c4e /docs/index.rst | |
| parent | 17032db43dda5fda5e8165d5e3ba8b4e9657883c (diff) | |
documentation update
- moved api docs to a subdirectory
- cleaned up index
Issue-ID: VNFSDK-95
Change-Id: Ic11340589161b8d44dbd95ffde69bf06e96582a3
Signed-off-by: Chris Donley <christopher.donley@huawei.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 37 |
1 files changed, 24 insertions, 13 deletions
diff --git a/docs/index.rst b/docs/index.rst index ec64377..5ad8ac5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,16 +3,20 @@ .. toctree:: :maxdepth: 1 - vnfsdk-apis + files/vnfsdk-apis +VNFSDK +====== -# Documentation Outline +Documentation Outline +--------------------- -API Documentation -# Components +Components +---------- + + VNF Packaging Model/Blueprint + ----------------------------- -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. @@ -21,7 +25,9 @@ The telemetry indicator definitions define a set of default indicators exposed b 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. -# VNF SDK Tools + 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 @@ -34,20 +40,25 @@ 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 + VNF Validation Tests + -------------------- TBD -# User Guides - - ## VNF Package Tools User Guide + 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. - ## Marketplace User Guide for Operators + Marketplace User Guide for Operators + ------------------------------------ TBD - ## Marketplace User Guide for VNF Suppliers + Marketplace User Guide for VNF Suppliers + ---------------------------------------- TBD |