Gitiles
Code Review Sign In
gerrit.nordix.org / onap / vnfsdk / model / 2edcb8b3b55f8df976c5b9c1338925fd2f0b490c / . / docs / index.rst
blob: 9eb757f90030416228ac167a81a09b7b9cfc195b [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.
2
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]3
4VNFSDK Documentation
5====================
6
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]7.. toctree::
8 :maxdepth: 1
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]9 :titlesonly:
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]10
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]11 files/vnfsdk-apis
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]12
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]13Components
14----------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]15
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]16VNF Packaging Model/Blueprint
17-----------------------------
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]18
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]19VNF 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.
20
21The 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.
22
23The 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.
24
25The 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.
26
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]27.. toctree::
28 :maxdepth: 1
29 :titlesonly:
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]30 :glob:
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]31
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]32 files/pkgtool
33 files/*blueprints
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]34
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]35VNF SDK Marketplace
36-------------------
Chris Donley2edcb8b2017-10-10 11:20:43 -0700[diff] [blame^]37
38.. include:: files/marketplace-overview.rst
39
40Installation instructions
41-------------------------
42
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]43.. toctree::
44 :maxdepth: 1
45
Chris Donley2edcb8b2017-10-10 11:20:43 -0700[diff] [blame^]46 files/mktplace-install
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]47
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]48VNF SDK Tools
49-------------
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]50
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]51VNF 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...
52
53• VNF Package Builder - creates a CSAR file based on inputs provided by the VNF product DevOps engineer
54
55• VNF Package Validator - validates the content of the VNF packages to ensure that everything has been built correctly
56
57• VNF Package Extractor - extracts VNF product model and executables from the CSAR file
58
59• VNF Package Parser - translates VNF proeduct blueprint into a format consumable by OPEN-O components
60
61• VNF Package Dry Run - performs a "dry run" install to ensure that the package can be deployed during instantiation
62
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]63
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]64User Guides
65-----------
Chris Donley1ac02e72017-09-21 08:59:41 -0700[diff] [blame]66
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]67VNF Package Tools User Guide
68----------------------------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]69
70VNF 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.
71
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]72.. toctree::
73 :maxdepth: 1
74 :titlesonly:
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]75 :glob:
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]76
Chris Donley29648052017-10-05 11:40:40 -0700[diff] [blame]77 files/*Bundling*
Chris Donley825678b2017-10-02 10:06:12 -0700[diff] [blame]78
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]79Marketplace User Guide for Operators
80------------------------------------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]81
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]82.. toctree::
83 :maxdepth: 1
84 :titlesonly:
85
86 files/VNFSDK-Marketplace-userguide-operators
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]87
Chris Donleyfecfefd2017-09-22 09:25:38 -0700[diff] [blame]88Marketplace User Guide for VNF Suppliers
89----------------------------------------
Chris Donley17032db2017-09-20 06:42:44 -0700[diff] [blame]90
Chris Donleydbf7fb12017-10-06 16:45:44 -0700[diff] [blame]91.. toctree::
92 :maxdepth: 1
93 :titlesonly:
94
95 files/VNFSDK-Marketplace-userguide-vendors
96