summaryrefslogtreecommitdiffstats
path: root/docs/files/pkgtool.rst
blob: 0728170da83ef581b18f178a1f8506f3a9a68c0b (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
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 OPEN-O components
* VNF Package Dry Run - performs a "dry run" install to ensure that the package can be deployed during instantiation
�
The tools are provided in a 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 autoamtion framework.

Repository Name:�vnf-sdk-design-pkg

Clone command:�git clone https://gerrit.open-o.org/r/vnf-sdk-design-pkg

Installation
------------
Python module with CLI is installed by Python pip command. It is possible to install into a virtual environment (virtualenv).
The following commands are executed in the cloned repository directory
1. pip install -r requirements.txt
Install all required dependencies
2. pip install .

Install VNF SDK tools package�
-----------------------------
Usage
* Create CSAR by specifying a directory
vnfsdk csar-create -d DESTINATION source entry
* Extract CSAR content
vnfsdk csar-open -d DESTINATION source
* Validate CSAR content
vnfsdk csar-validate source
�
All commands have -h switch which displays help and description of all paramaters.