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