| 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
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 10 | * VNF Package Parser - translates VNF product blueprint into a format consumable by ONAP components
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 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 |
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 15 | Repository Name: vnfsdk/pkgtools
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 16 |
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 17 | Clone command: git clone http://gerrit.onap.org/r/vnfsdk/pkgtools
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 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).
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 22 | The following commands are executed in the cloned repository directory:
|
| 23 |
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 24 | 1. pip install -r requirements.txt
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 25 | Install all required dependencies
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 26 | 2. pip install .
|
| 27 |
|
| Lianhao Lu | 020ed5c | 2017-10-12 11:08:34 +0800 | [diff] [blame] | 28 | Or run the following commands in the cloned repository directory to install:
|
| 29 |
|
| 30 | 1. python setup.py install
|
| 31 |
|
| 32 | Install VNF SDK tools package
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 33 | -----------------------------
|
| 34 | Usage
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 35 |
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 36 | * Create CSAR by specifying a directory
|
| Lianhao Lu | 020ed5c | 2017-10-12 11:08:34 +0800 | [diff] [blame] | 37 | vnfsdk csar-create -d DESTINATION [--manifest MANIFEST] [--history HISTORY] [--tests TESTS] [--licenses LICENSES] source entry
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 38 |
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 39 | * Extract CSAR content
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 40 | vnfsdk csar-open -d DESTINATION source
|
| 41 |
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 42 | * Validate CSAR content
|
| Chris Donley | ab6c6f0 | 2017-10-05 17:09:49 -0700 | [diff] [blame] | 43 | vnfsdk csar-validate source
|
| Chris Donley | 030be9d | 2017-10-02 09:47:23 -0700 | [diff] [blame] | 44 |
|
| 45 | All commands have -h switch which displays help and description of all paramaters.
|