fix pkgtool references
Fixed git clone command and other typos in pkgtools doc.
Issue-ID: VNFSDK-102
Change-Id: Ia49da31f3e4fae223098b76691af9f2edd443e85
Signed-off-by: Chris Donley <christopher.donley@huawei.com>
diff --git a/docs/files/pkgtool.rst b/docs/files/pkgtool.rst
index 0728170..616b212 100755
--- a/docs/files/pkgtool.rst
+++ b/docs/files/pkgtool.rst
@@ -7,31 +7,35 @@
* 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 Parser - translates VNF product blueprint into a format consumable by ONAP 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
+Repository Name: vnfsdk/pkgtools
-Clone command: git clone https://gerrit.open-o.org/r/vnf-sdk-design-pkg
+Clone command: git clone http://gerrit.onap.org/r/vnfsdk/pkgtools
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
+The following commands are executed in the cloned repository directory:
+
1. pip install -r requirements.txt
-Install all required dependencies
+ 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
+ vnfsdk csar-create -d DESTINATION source entry
+
* Extract CSAR content
-vnfsdk csar-open -d DESTINATION source
+ vnfsdk csar-open -d DESTINATION source
+
* Validate CSAR content
-vnfsdk csar-validate source
+ vnfsdk csar-validate source
All commands have -h switch which displays help and description of all paramaters.