| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 1 | VNF Package Tool
|
| 2 | ================
|
| 3 |
|
| 4 | Provided tools
|
| 5 | --------------
|
| 6 |
|
| 7 | * VNF Package Builder - creates a CSAR file based on inputs provided by the VNF product DevOps engineer
|
| 8 | * VNF Package Validator - validates the content of the VNF packages to ensure that everything has been built correctly
|
| 9 | * VNF Package Extractor - extracts VNF product model and executables from the CSAR file
|
| 10 | * VNF Package Parser - translates VNF product blueprint into a format consumable by OPEN-O components
|
| 11 | * VNF Package Dry Run - performs a "dry run" install to ensure that the package can be deployed during instantiation
|
| 12 |
|
| 13 | 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.
|
| 14 |
|
| 15 | Repository Name: vnf-sdk-design-pkg
|
| 16 |
|
| 17 | Clone command: git clone https://gerrit.open-o.org/r/vnf-sdk-design-pkg
|
| 18 |
|
| 19 | Installation
|
| 20 | ------------
|
| 21 | Python module with CLI is installed by Python pip command. It is possible to install into a virtual environment (virtualenv).
|
| 22 | The following commands are executed in the cloned repository directory
|
| 23 | 1. pip install -r requirements.txt
|
| 24 | Install all required dependencies
|
| 25 | 2. pip install .
|
| 26 |
|
| 27 | Install VNF SDK tools package
|
| 28 | -----------------------------
|
| 29 | Usage
|
| 30 | * Create CSAR by specifying a directory
|
| 31 | vnfsdk csar-create -d DESTINATION source entry
|
| 32 | * Extract CSAR content
|
| 33 | vnfsdk csar-open -d DESTINATION source
|
| 34 | * Validate CSAR content
|
| 35 | vnfsdk csar-validate source
|
| 36 |
|
| 37 | All commands have -h switch which displays help and description of all paramaters.
|