blob: a089381be17d55da5d72be073f7511598c31dc7e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017-2018 Huawei Technologies Co., Ltd.
VNF Package Tool
================
Provided tools
--------------
* VNF Package Builder - creates a CSAR file based on inputs provided by the VNF
product DevOps engineer
* VNF Package Validator - validates the content of the VNF packages to ensure
that everything has been built correctly
* VNF Package Extractor - extracts VNF product model and executables from the
CSAR file
* VNF Package Parser - translates VNF product blueprint into a format
consumable by ONAP components
The tools are provided in the form of a shared library (Python module) that can
be used in other projects. A CLI is also provided out-of-the-box for DevOps to
use the library with their scripts and automation framework.
Repository Name: vnfsdk/pkgtools
Clone command: git clone https://git.onap.org/vnfsdk/pkgtools
Installation
------------
Python module with CLI is installed by Python pip command. It is possible to
install into a virtual environment (virtualenv).
To install the vnfsdk package tool from source, run the following commands
in the cloned repository directory:
.. code-block:: bash
$ pip install -r requirements.txt
$ pip install .
To install the vnfsdk pkgtools from onap hosted pypi repository, run the
following commands in a python virtual environment:
.. code-block:: bash
$ pip install -i https://nexus3.onap.org/repository/PyPi.public/simple vnfsdk
Use VNF SDK package tools
-------------------------
Usage
* Create CSAR by specifying a directory
.. code-block:: bash
vnfsdk [-v] csar-create [-h] -d DESTINATION [--manifest MANIFEST] [--history HISTORY]
[--tests TESTS] [--licenses LICENSES] [--digest {SHA256,SHA512}]
[--certificate CERTIFICATE] [--privkey PRIVKEY] source entry
e.g.
.. code-block:: bash
$ vnfsdk csar-create -d /tmp/helloworld.csar --manifest helloworld.mf --history ChangeLog.txt
--tests Tests --licenses Licenses --certificate test.crt --privkey test.key --digest SHA256
./hello-world/ helloworld.yaml
* Extract CSAR content
.. code-block:: bash
vnfsdk -v csar-open [-h] -d DESTINATION [--no-verify-cert] source
e.g.
.. code-block:: bash
$ vnfsdk csar-open -d /tmp/helloworld --no-verify-cert /tmp/helloworld.csar
* Validate CSAR content
.. code-block:: bash
vnfsdk -v csar-validate [-h] source
e.g.
.. code-block:: bash
$ vnfsdk csar-validate /tmp/helloworld.csar
All commands have -h switch which displays help and description of all parameters.
|
