Eliminate Sphinx Warnings from svnfm repo
[vfc/nfvo/driver/vnfm/svnfm.git] / nokiav2 / docs / vnfintegration.rst
1 Prepare a ONAP VNF package
2 ==========================
3
4 Automatic
5 ---------
6
7 - Visit http://msb.api.simpledemo.onap.org/api/NokiaSVNFM/v1/convert
8 - Select the CBAM package to be converted into an ONAP package
9 - Click on upload button and the ONAP package will be downloaded
10
11
12 Manual
13 ------
14
15 - the VNF must declare the externalVnfmId and onapCsarId as modifyable attribute in CBAM package. Each should have
16   a default value. (The concrete value will be filled out by CBAM)
17 - each operation must declare a jobId additional parameter in CBAM package (value will be filled out by CBAM)
18 - the heal operation must declare the jobId, vmName, vnfcId and action parameters in CBAM package (values will be filled out by CBAM)
19 - each operation (including built-in) must include the following section as the last pre_action (all JS are provided by CBAM)
20
21 .. code-block:: console
22
23     - javascript: javascript/cbam.pre.collectConnectionPoints.js
24       include:
25         - javascript/cbam.collectConnectionPoints.js
26       output: operation_result
27
28 - each operation must include the following section as the last post_action (all JS are provided by CBAM)
29
30 .. code-block:: console
31
32     - javascript: javascript/cbam.post.collectConnectionPoints.js
33       include:
34         - javascript/cbam.collectConnectionPoints.js
35       output: operation_result
36
37 - CBAM supplied JavaScrips
38
39  - :download:`cbam.post.collectConnectionPoints.js <sample/cbam.post.collectConnectionPoints.js>`
40  - :download:`cbam.pre.collectConnectionPoints.js <sample/cbam.pre.collectConnectionPoints.js>`
41  - :download:`cbam.collectConnectionPoints.js <sample/cbam.collectConnectionPoints.js>`
42
43 - the ONAP package must be written so that the VDU.Compute, VDU.VirtualStorage, VnfVirtualLinkDesc, VduCpd has exactly the same name as in CBAM package
44 - the metadata section of the ONAP package must be the following
45
46  - the vendor must be the same as in Nokia package vendor field
47  - the vnfdVersion must be the same as in Nokia package the descriptor_version field
48  - the name must be the same as in Nokia package the product_info_name field
49  - the version must be the same as in Nokia package the software_version field
50  - the vnfmType must be NokiaSVNFM
51
52 - the complete CBAM package must be placed in the in Artifacts/OTHER/cbam.package.zip file