Gitiles
Code Review Sign In
gerrit.nordix.org / onap / vnfsdk / model / 941a5d2bc0b0ec39a8fe1165fe84f7d3aea4f5ba / . / docs / index.rst
blob: 8f28b8bc663c6069adbe081ab31dc1f17b112f8b [file] [log] [blame]
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Chris Donley6cd6a1d2017-10-30 11:22:17 -0700[diff] [blame]2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright 2017 Huawei Technologies Co., Ltd.
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]4
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]5VNFSDK Documentation
6====================
7
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]8.. toctree::
9 :maxdepth: 1
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]10 :titlesonly:
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]11
Chris Donley1e094612018-02-26 09:38:37 -0800[diff] [blame]12 files/swagger.json
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]13 files/vnfsdk-apis
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]14
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]15Components
16----------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]17
Eric Debeaude6efbf2017-10-14 08:06:12 +0000[diff] [blame]18VNF Packaging Model/Blueprint
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]19-----------------------------
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]20
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]21VNF product model/blueprint provides a declarative way to define deployment,
22operational and functional attributes of a VNF product. The VNF product is
23defined in terms of deployment time requirements and dependencies and exposed
24telemetry indicator definitions.
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]25
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]26The deployment time requirements and dependencies define any and all compute
27infrastructure needs of the VNF product, such as specific hardware
28architecture, on-chip features, instruction set availability and hypervisor
29capabilities.
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]30
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]31The telemetry indicator definitions define a set of default indicators exposed
32by a given VNF product for use by monitoring and assurance tools. This list
33can be extended and customized once a given VNF product is on-boarded and
34instantiated at run-time.
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]35
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]36The VNF product model is specified using the TOSCA NFV simple profile. It is
37persisted, along with the product executables and data, using TOSCA CSAR files.
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]38
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]39.. toctree::
40 :maxdepth: 1
41 :titlesonly:
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]42 :glob:
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]43
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]44 files/pkgtool
45 files/*blueprints
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]46
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]47VNF SDK Marketplace
48-------------------
Chris Donley2edcb8b2017-10-10 11:20:43 -0700[diff] [blame]49
50.. include:: files/marketplace-overview.rst
51
52Installation instructions
53-------------------------
54
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]55.. toctree::
56 :maxdepth: 1
57
Chris Donley2edcb8b2017-10-10 11:20:43 -0700[diff] [blame]58 files/mktplace-install
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]59
Eric Debeaude6efbf2017-10-14 08:06:12 +0000[diff] [blame]60VNF SDK Tools
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]61-------------
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]62
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]63VNF SDK tools provide VNF product DevOps engineers with command line tools and
64client side API language bindings to define the VNF product model and package
65content. The following tools are included...
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]66
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]67• VNF Package Builder - creates a CSAR file based on inputs provided by the VNF
Chris Donley24d831b2017-11-15 09:57:25 -0800[diff] [blame]68 product DevOps engineer
69
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]70• VNF Package Validator - validates the content of the VNF packages to ensure
Chris Donley24d831b2017-11-15 09:57:25 -0800[diff] [blame]71 that everything has been built correctly
72
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]73• VNF Package Extractor - extracts VNF product model and executables from the
Chris Donley24d831b2017-11-15 09:57:25 -0800[diff] [blame]74 CSAR file
75
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]76• VNF Package Parser - translates VNF proeduct blueprint into a format
Chris Donley24d831b2017-11-15 09:57:25 -0800[diff] [blame]77 consumable by ONAP components
78
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]79• VNF Package Dry Run - performs a "dry run" install to ensure that the package
Chris Donley24d831b2017-11-15 09:57:25 -0800[diff] [blame]80 can be deployed during instantiation
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]81
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]82
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]83User Guides
Eric Debeaude6efbf2017-10-14 08:06:12 +0000[diff] [blame]84-----------
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]85
Eric Debeaude6efbf2017-10-14 08:06:12 +0000[diff] [blame]86VNF Package Tools User Guide
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]87----------------------------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]88
Chris Donleya3adf072017-11-09 15:17:45 -0800[diff] [blame]89VNF Package Designer, provides VNF product DevOps engineers with a graphical
90tool to define the VNF product model and package content. It is made available
91as part of the VNF Supplier SDK tools.The package designer makes use of the VNF
92SDK command line interfaces (CLIs) and client-side API language bindings in
93order to define the model and the package content. As such, it is functionally
94equivalent to the VNF SDK tools.
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]95
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]96.. toctree::
97 :maxdepth: 1
98 :titlesonly:
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]99 :glob:
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]100
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]101 files/*Bundling*
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]102
Eric Debeaude6efbf2017-10-14 08:06:12 +0000[diff] [blame]103Marketplace User Guide for Operators
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]104------------------------------------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]105
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]106.. toctree::
107 :maxdepth: 1
108 :titlesonly:
109
110 files/VNFSDK-Marketplace-userguide-operators
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]111
Eric Debeaude6efbf2017-10-14 08:06:12 +0000[diff] [blame]112Marketplace User Guide for VNF Suppliers
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]113----------------------------------------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]114
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]115.. toctree::
116 :maxdepth: 1
117 :titlesonly:
118
119 files/VNFSDK-Marketplace-userguide-vendors
120
Chris Donley6cd6a1d2017-10-30 11:22:17 -0700[diff] [blame]121VES Client Guidelines
122---------------------
123
124.. toctree::
125 :maxdepth: 1
126 :titlesonly:
127
128 files/VESEventRegistration
129 files/VESEventListener
brucetciscobfd600e2018-03-01 10:39:51 -0600[diff] [blame]130
131VNF Certification Testing Framework - Dovetail
132----------------------------------------------
133
134.. toctree::
135 :maxdepth: 1
136 :titlesonly:
137
138 files/Dovetail