diff options
author | Eric Debeau <eric.debeau@orange.com> | 2017-10-14 09:08:10 +0000 |
---|---|---|
committer | Chris Donley <christopher.donley@huawei.com> | 2017-10-15 19:54:15 +0000 |
commit | 6bc6ab33a2da23e335237ea1d84398a25de94eb7 (patch) | |
tree | 55a3ddcadefd0e7100f550c723a0a27c70606c8b /docs/files/pkgtool.rst | |
parent | de6efbfa1c15852665f6ff6df58788169ad26e15 (diff) |
Corrections to pass doc8
Change-Id: I753838f44e3c82563b6f272a9a38264398b644cf
Issue-ID: DOC-94
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Diffstat (limited to 'docs/files/pkgtool.rst')
-rw-r--r-- | docs/files/pkgtool.rst | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/docs/files/pkgtool.rst b/docs/files/pkgtool.rst index e334e0c..ec19bdf 100644 --- a/docs/files/pkgtool.rst +++ b/docs/files/pkgtool.rst @@ -1,45 +1,45 @@ -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 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: vnfsdk/pkgtools
-
-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:
-
-1. pip install -r requirements.txt
- Install all required dependencies
-2. pip install .
-
-Or run the following commands in the cloned repository directory to install:
-
-1. python setup.py install
-
-Install VNF SDK tools package
------------------------------
-Usage
-
-* Create CSAR by specifying a directory
- vnfsdk csar-create -d DESTINATION [--manifest MANIFEST] [--history HISTORY] [--tests TESTS] [--licenses LICENSES] 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.
+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 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: vnfsdk/pkgtools + +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: + +1. pip install -r requirements.txt + Install all required dependencies +2. pip install . + +Or run the following commands in the cloned repository directory to install: + +1. python setup.py install + +Install VNF SDK tools package +----------------------------- +Usage + +* Create CSAR by specifying a directory + vnfsdk csar-create -d DESTINATION [--manifest MANIFEST] [--history HISTORY] [--tests TESTS] [--licenses LICENSES] 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. |