diff options
| author |   shangxdy <shang.xiaodong@zte.com.cn> | 2017-10-30 18:48:39 +0800 |
|---|---|---|
| committer | shangxdy <shang.xiaodong@zte.com.cn> | 2017-10-30 18:48:39 +0800 |
| commit | 33b4108956d9465a2237b2c94b4339cbc70b1b5a (patch) | |
| tree | 59eef3726b77414ea704f5b56e7d2c66653e5cfa /docs/nfvparser/userguide | |
| parent | 3a1aef8c2594b41883366b03b22007f2e9792e32 (diff) | |
Update nfv-toscaparser documents.
Update nfv-toscaparser documents for release 1.
JIRA: MODELING-33
Change-Id: Id4da5581db400d82a0b23de8b8e6e9dc3b005b4c
Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
Diffstat (limited to 'docs/nfvparser/userguide')
| -rw-r--r-- | docs/nfvparser/userguide/feature.userguide.rst | 27 | ||||
| -rw-r--r-- | docs/nfvparser/userguide/index.rst | 25 |
2 files changed, 52 insertions, 0 deletions
diff --git a/docs/nfvparser/userguide/feature.userguide.rst b/docs/nfvparser/userguide/feature.userguide.rst new file mode 100644 index 0000000..c674e30 --- /dev/null +++ b/docs/nfvparser/userguide/feature.userguide.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + + + +nfv parser Execution +===================== + +Following is shown how to use nfv-toscaparser: + +.. code-block:: bash + + tosca-parser --template-file=<path to the YAML template> [--nrpv] [--debug] + or + tosca-parser --template-file=<path to the CSAR zip file> [--nrpv] [--debug] + or + tosca-parser --template-file=<URL to the template or CSAR> [--nrpv] [--debug] + options: + --nrpv Ignore input parameter validation when parse template. + --debug debug mode for print more details other than raise exceptions when errors happen + +Example: + +.. code-block:: bash + + tosca-parser --template-file=vRNC.yaml --nrpv diff --git a/docs/nfvparser/userguide/index.rst b/docs/nfvparser/userguide/index.rst new file mode 100644 index 0000000..addc37e --- /dev/null +++ b/docs/nfvparser/userguide/index.rst @@ -0,0 +1,25 @@ +.. _parser-userguide: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +======================= +OPNFV Parser User Guide +======================= + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 1 + + feature.userguide +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + + |