diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/developer/overview/overview.rst | 24 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 4 | ||||
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 6 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 30 | ||||
| -rw-r--r-- | docs/release/scenarios/scenario.name/scenario.description.rst | 18 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 13 |
6 files changed, 38 insertions, 57 deletions
diff --git a/docs/developer/overview/overview.rst b/docs/developer/overview/overview.rst index f9efebe..8baffdd 100644 --- a/docs/developer/overview/overview.rst +++ b/docs/developer/overview/overview.rst @@ -55,8 +55,8 @@ For Brahmaputra Release, Parser offers the following additional capabilities: Parser. * The "vRNC_tosca_intro" document describes Parser's use case analysis on vRNC -scenario.The "example" folder contains examples of tosca-nfv standard and vRNC -scenario. See also https://wiki.opnfv.org/parser. + scenario.The "example" folder contains examples of tosca-nfv standard and vRNC + scenario. See also https://wiki.opnfv.org/parser. Upgrades from Brahmaputra Release ----------------------- @@ -64,30 +64,30 @@ Upgrades from Brahmaputra Release For Colorado Release, Parser offers the following additional capabilities: * New module policy2tosca which enables policy related fields in tosca could be -translated into heat orchestration template correctly. Policy2Tosca module could -be installed seperately after user installed OPNFV C release platform. + translated into heat orchestration template correctly. Policy2Tosca module could + be installed seperately after user installed OPNFV C release platform. * New module tosca2heat enhancements which includes a set of feature addons (such -as substitution mapping) for OpenStack tosca-parser module which is integrated in -the OPNFV C release platform. And the main details are listed below: + as substitution mapping) for OpenStack tosca-parser module which is integrated in + the OPNFV C release platform. And the main details are listed below: - ** support substitution mapping semantic in tosca-parser: + * support substitution mapping semantic in tosca-parser: - support parse and validation about substitution mapping definition; - support import nested template; - support deployment a node which is substituted by a template; - support deployment a template alone which has substitution mapping definition. - ** afinity and anti-affinity support when deploy servers: + * afinity and anti-affinity support when deploy servers: - tosca.policies.Placement.Colocate; - tosca.policies.Placement.Antilocate; - ** add validation about input parameters; + * add validation about input parameters; - ** add high availability and block volume in compute translation; + * add high availability and block volume in compute translation; - ** add ip output in compute translation; + * add ip output in compute translation; - ** add deployment a whole vRNC testcase with parser. + * add deployment a whole vRNC testcase with parser. * Additional testing support. diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst index 53ffcbe..4887bef 100644 --- a/docs/release/configguide/postinstall.rst +++ b/docs/release/configguide/postinstall.rst @@ -25,8 +25,8 @@ case yet so each deploy tool will need to provide (hopefully very simillar) documentation of this. -<Project> post configuration procedures -======================================= +Parser post configuration procedures +==================================== Describe any deploy tool or feature specific scripts, tests or procedures that should be carried out on the deployment post install and configuration in this section. diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index 63a8b09..999080c 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -46,9 +46,9 @@ Step 3: Install the tosca-parser sub project. python setup.py install - **Notes** It must uninstall pre-installed tosca-parser and heat-translator before install the two - components, and install heat-translator before installing tosca-parser, which is sure to use the - OPNFV version of tosca-parser and heat-translator other than openstack's components. +**Notes**: It must uninstall pre-installed tosca-parser and heat-translator before install the two +components, and install heat-translator before installing tosca-parser, which is sure to use the +OPNFV version of tosca-parser and heat-translator other than openstack's components. Parser yang2tosca Installation diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 0503fd4..c5360f9 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -29,15 +29,16 @@ Version history Important notes =============== -**Attention:** Parser's submodules should be installed independantly from OPNFV platform, for instructions please -refer to the installation documention. +**Attention**: Parser's submodules should be installed independantly from OPNFV platform, for +instructions please refer to the installation documention. Summary ======= -OPNFV Parser Danube release has provides four submodules to serve as translation/prevalidation tools: tosca2heat, yang2tosca, -policy2tosca, and verigraph. Specifically, tosca2heat module provides an integration of OpenStack tosca-parser and heat-translater +OPNFV Parser Danube release has provides four submodules to serve as translation/prevalidation +tools: tosca2heat, yang2tosca, policy2tosca, and verigraph. Specifically, tosca2heat module +provides an integration of OpenStack tosca-parser and heat-translater upstream projects 0.7 release with additional Parser unique features. @@ -47,20 +48,15 @@ Release Data +--------------------------------------+--------------------------------------+ | **Project** | OPNFV Parser | -| | | +--------------------------------------+--------------------------------------+ | **Repo/commit-ID** | | -| | | +--------------------------------------+--------------------------------------+ | **Release designation** | Danube 1.0 | -| | | +--------------------------------------+--------------------------------------+ | **Release date** | E.g. 2015-04-16 | -| | | +--------------------------------------+--------------------------------------+ | **Purpose of the delivery** | OPNFV Template Translation/Prevalida-| | | tion tooling | -| | | +--------------------------------------+--------------------------------------+ Version change @@ -94,10 +90,8 @@ Feature additions | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| BGS-123 | ADD OpenDaylight ml2 integration | | | | +--------------------------------------+--------------------------------------+ -| BGS-456 | Add auto-deployment of Fuel@OPNFV | | | | +--------------------------------------+--------------------------------------+ @@ -110,10 +104,8 @@ Bug corrections | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| BGS-888 | Fuel doesn't deploy | | | | +--------------------------------------+--------------------------------------+ -| BGS-999 | Floating IP doesn't work | | | | +--------------------------------------+--------------------------------------+ @@ -156,12 +148,8 @@ Known issues | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| BGS-987 | Nova-compute process does | -| | not re-spawn when killed | | | | +--------------------------------------+--------------------------------------+ -| BGS-654 | MOS 5.1 : neutron net-list returns | -| | "400 Bad request" | | | | +--------------------------------------+--------------------------------------+ @@ -187,17 +175,9 @@ Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: | **TEST-SUITE** | **Results:** | | | | +--------------------------------------+--------------------------------------+ -| Tempest test suite 123 | Following tests failed: | -| | | -| | 1. Image resizing.... | | | | -| | 2. Heat deploy.... | +--------------------------------------+--------------------------------------+ -| Robot test suite 456 | Following tests failed: | -| | | -| | 1....... | | | | -| | 2....... | +--------------------------------------+--------------------------------------+ References diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst index 8c2cbab..cdfa5dd 100644 --- a/docs/release/scenarios/scenario.name/scenario.description.rst +++ b/docs/release/scenarios/scenario.name/scenario.description.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -This document provides scenario level details for <RELEASE> of <COMPONENT>. +This document provides scenario level details for Danube of Parser .. contents:: :depth: 3 @@ -11,25 +11,21 @@ This document provides scenario level details for <RELEASE> of <COMPONENT>. ============ Introduction ============ -.. In this section explain the purpose of the scenario and the types of capabilities provided + +Parser project can work on any scenario defined in OPNFV for which just consumes the basic +APIs provided by Openstack projects, esp Heat. Scenario components and composition =================================== -.. In this section describe the unique components that make up the scenario, -.. what each component provides and why it has been included in order -.. to communicate to the user the capabilities available in this scenario. +none Scenario usage overview ======================= -.. Provide a brief overview on how to use the scenario and the features available to the -.. user. This should be an "introduction" to the userguide document, and explicitly link to it, -.. where the specifics of the features are covered including examples and API's +none Limitations, Issues and Workarounds =================================== -.. Explain scenario limitations here, this should be at a design level rather than discussing -.. faults or bugs. If the system design only provide some expected functionality then provide -.. some insight at this point. +none References ========== diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index e6e8974..f1e1362 100644 --- a/docs/release/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -29,7 +29,7 @@ Example: heat-translator --template-file=vRNC.yaml \ --template-type=tosca --output-file=vRNC_hot.yaml -Notes: heat-translator will call class of ToscaTemplate in tosca-parser firstly to validate and +**Notes**: heat-translator will call class of ToscaTemplate in tosca-parser firstly to validate and parse input yaml file, then tranlate the file into hot file, if you only want to validate or check the input file and don't want to translate, please use tosaca-parser as following: @@ -119,9 +119,14 @@ Example: .. code-block:: bash - policy2tosca add-definition --policy_name rule2 --policy_type tosca.policies.Placement.Geolocation ---description "test description" --properties region:us-north-1,region:us-north-2,min_inst:2 --targets -VNF2,VNF4 --metadata "map of strings" --triggers "1,2,3,4" --source example.yaml + policy2tosca add-definition \ + --policy_name rule2 --policy_type tosca.policies.Placement.Geolocation \ + --description "test description" \ + --properties region:us-north-1,region:us-north-2,min_inst:2 \ + --targets VNF2,VNF4 \ + --metadata "map of strings" \ + --triggers "1,2,3,4" \ + --source example.yaml Step 4: Verify the TOSCA YAMl updated with the injection/removal executed. |