diff options
| author |   Chris Donley <christopher.donley@huawei.com> | 2017-10-02 09:47:23 -0700 |
|---|---|---|
| committer | Chris Donley <christopher.donley@huawei.com> | 2017-10-02 09:51:24 -0700 |
| commit | 030be9d9f0311b03dec3b3ec2133362a7d6fbb2c (patch) | |
| tree | 6c4db28bd05a24a87a9fa9927564a88e38c56c57 /docs/files/pkgtool.rst | |
| parent | fecfefd3fa6c2548ba5cea77ec5a8dd8c6ec81e9 (diff) | |
pkgtools documentation
Adding three files (usage doc, guidelines for VNF vendors, blueprint files)
Issue-ID: VNFSDK-102
Change-Id: Ic2b9eb8b2193baaa255c6c8e9ffbf8f3864bd90d
Signed-off-by: Chris Donley <christopher.donley@huawei.com>
Diffstat (limited to 'docs/files/pkgtool.rst')
| -rwxr-xr-x | docs/files/pkgtool.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/files/pkgtool.rst b/docs/files/pkgtool.rst new file mode 100755 index 0000000..0728170 --- /dev/null +++ b/docs/files/pkgtool.rst @@ -0,0 +1,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.
|