From de198abead505a2a94dcdf1474d93c0ce900c7a7 Mon Sep 17 00:00:00 2001 From: Lianhao Lu Date: Fri, 14 Sep 2018 22:17:11 +0800 Subject: pkgtools: update doc for bug fixes 1. Fixed the doc bug to keep '--' intact in the source. 2. Updated the doc to simplify the installation procedure. Change-Id: Ie35d47d061310f2255d2ea066de51c21fa4738f5 Issue-ID: VNFSDK-325 Signed-off-by: Lianhao Lu --- docs/files/pkgtool.rst | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/files/pkgtool.rst b/docs/files/pkgtool.rst index c9d5ffd..83df2bb 100644 --- a/docs/files/pkgtool.rst +++ b/docs/files/pkgtool.rst @@ -33,14 +33,17 @@ install into a virtual environment (virtualenv). To install the vnfsdk package tool from source, run the following commands in the cloned repository directory: -1. pip install -r requirements.txt - Install all required dependencies -2. pip install . +.. code-block:: bash + + $ pip install -r requirements.txt + $ pip install . To install the vnfsdk pkgtools from onap hosted pypi repository, run the following commands in a python virtual environment: -1. pip install -i https://nexus3.onap.org/repository/PyPi.release/simple --extra-index-url https://pypi.org/simple vnfsdk +.. code-block:: bash + + $ pip install -i https://nexus3.onap.org/repository/PyPi.public/simple vnfsdk Use VNF SDK package tools ------------------------- @@ -48,24 +51,42 @@ Usage * Create CSAR by specifying a directory +.. code-block:: bash + vnfsdk [-v] csar-create [-h] -d DESTINATION [--manifest MANIFEST] [--history HISTORY] [--tests TESTS] [--licenses LICENSES] [--digest {SHA256,SHA512}] [--certificate CERTIFICATE] [--privkey PRIVKEY] source entry - e.g. $ vnfsdk csar-create -d /tmp/helloworld.csar --manifest helloworld.mf --history ChangeLog.txt +e.g. + +.. code-block:: bash + + $ vnfsdk csar-create -d /tmp/helloworld.csar --manifest helloworld.mf --history ChangeLog.txt --tests Tests --licenses Licenses --certificate test.crt --privkey test.key --digest SHA256 ./hello-world/ helloworld.yaml * Extract CSAR content +.. code-block:: bash + vnfsdk -v csar-open [-h] -d DESTINATION [--no-verify-cert] source - e.g. $ vnfsdk csar-open -d /tmp/helloworld --no-verify-cert /tmp/helloworld.csar +e.g. + +.. code-block:: bash + + $ vnfsdk csar-open -d /tmp/helloworld --no-verify-cert /tmp/helloworld.csar * Validate CSAR content +.. code-block:: bash + vnfsdk -v csar-validate [-h] source - e.g. $ vnfsdk csar-validate /tmp/helloworld.csar +e.g. + +.. code-block:: bash + + $ vnfsdk csar-validate /tmp/helloworld.csar All commands have -h switch which displays help and description of all parameters. -- cgit 1.2.3-korg