summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorzhipengh <huangzhipeng@huawei.com>2017-03-02 11:51:07 +0800
committerzhipengh <huangzhipeng@huawei.com>2017-03-02 12:05:07 +0800
commit53b22cfb7ad8b323073213e4e55584261dd4e50a (patch)
treefc8c6bed95c2dc66cb812b7023bafdbd2799d3a6 /docs
parent9a2b86ff190a16822ec3f68b2c1d070d54a47da9 (diff)
Danube Release Docs Fixup patch 1
Done in this patch 1. Fixes in overview.rst 2. Moves governance folder under docs 3. Adds arno release use case doc from https://wiki.opnfv.org/display/parser/Parser+Use+Cases to the requirement folder 4. Moves two old tosca2heat documents into developer/design/examples 5. Adds new empty tosca2heat and verigraph design document under developer/design. 6. Remove old contents in yang2tosca and policy2tosca design docs since they are all related to installation/execution, not design. 7. Fixes in installation.instruction.rst and usage,guide.rst To do in the following patches 1. Design doc writeup: Xiaodong(tosca2heat), Shiva(yang2tosca/policy2tosca), Serena(verigraph) 2. Release doc writeup: Xiaodong and Howard (postinstall.rst,scenario.description.rst), Serena(verigraph part of release-notes.rst), release-notes.rst Change-Id: If4f51067dd33acd2332e503ee31d6941b4df4c89 Signed-off-by: zhipengh <huangzhipeng@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/developer/design/examples/parser_new_keywords.rst (renamed from docs/developer/design/parser_new_keywords.rst)0
-rw-r--r--docs/developer/design/examples/vRNC_tosca_intro.rst (renamed from docs/developer/design/vRNC_tosca_intro.rst)0
-rw-r--r--docs/developer/design/index.rst4
-rw-r--r--docs/developer/design/policy2tosca.rst81
-rw-r--r--docs/developer/design/tosca2heat.rst7
-rw-r--r--docs/developer/design/verigraph.rst7
-rw-r--r--docs/developer/design/yang2tosca.rst93
-rw-r--r--docs/developer/overview/overview.rst56
-rw-r--r--docs/developer/requirements/parser requirement arno release.rst19
-rw-r--r--docs/governance/committer/colorado release committer email motion vote record93
-rw-r--r--docs/governance/committer/parser project committer promotion guidline.rst68
-rw-r--r--docs/governance/index.rst12
-rw-r--r--docs/release/installation/installation.instruction.rst101
-rw-r--r--docs/release/userguide/feature.userguide.rst46
14 files changed, 314 insertions, 273 deletions
diff --git a/docs/developer/design/parser_new_keywords.rst b/docs/developer/design/examples/parser_new_keywords.rst
index f430b1d..f430b1d 100644
--- a/docs/developer/design/parser_new_keywords.rst
+++ b/docs/developer/design/examples/parser_new_keywords.rst
diff --git a/docs/developer/design/vRNC_tosca_intro.rst b/docs/developer/design/examples/vRNC_tosca_intro.rst
index 11e1bdb..11e1bdb 100644
--- a/docs/developer/design/vRNC_tosca_intro.rst
+++ b/docs/developer/design/examples/vRNC_tosca_intro.rst
diff --git a/docs/developer/design/index.rst b/docs/developer/design/index.rst
index ab83cec..55be2b5 100644
--- a/docs/developer/design/index.rst
+++ b/docs/developer/design/index.rst
@@ -9,7 +9,7 @@ OPNFV Parser Design Documentation
:numbered:
:maxdepth: 6
+ tosca2heat.rst
yang2tosca.rst
policy2tosca.rst
- parser_new_keywords.rst
- vRNC_tosca_intro.rst
+ verigraph.rst
diff --git a/docs/developer/design/policy2tosca.rst b/docs/developer/design/policy2tosca.rst
index fa238b2..3753d6c 100644
--- a/docs/developer/design/policy2tosca.rst
+++ b/docs/developer/design/policy2tosca.rst
@@ -2,86 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
===================
-Parser POLICY2TOSCA
+Parser polic2tosca
===================
-Overview
-========
-Parser is an open source project and licensed under Apache 2. Parser will help
-to provide a tooling mechanism, by parsing Telecom operators’ VNF descriptors
-(YANG templates) into TOSCA templates and then further translate TOSCA
-templates into certain common templates, which could be used in IaaS orchestration
-projects like OpenStack Heat.
-
-Prerequisites
-=============
-
-Parser - POLICY2TOSCA requires the following to be installed.
-
-1. cliff
---------
-
-Install cliff with the following links.
-::
-- `install <http://docs.openstack.org/developer/cliff/install.html>`
-or
-- `demoapp <http://docs.openstack.org/developer/cliff/demoapp.html>`
-
-Installation
-============================
-
-Please follow the below installation steps to install parser - POLICY2TOSCA.
-
-Step 1: Clone the parser project.
-
-.. code-block:: bash
-
- git clone https://gerrit.opnfv.org/gerrit/parser
-
-Step 2: Install the policy2tosca module.
-
-.. code-block:: bash
-
- cd parser/policy2tosca
- python setup.py install
-
-Execution
-===========================
-
-Step 1: To see a list of commands available.
-
-.. code-block:: bash
-
- policy2tosca --help
-
-Step 2: To see help for an individual command, include the command name on the command line
-
-.. code-block:: bash
-
- policy2tosca help <service>
-
-Step 3: To inject/remove policy types/policy definitions provide the TOSCA file as input to policy2tosca command line.
-
-.. code-block:: bash
-
- policy2tosca <service> [arguments]
-
-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
-
-
-Step 4: Verify the TOSCA YAMl updated with the injection/removal executed.
-
-.. code-block:: bash
-
- cat "<source tosca file>"
-
-Example:
-
-.. code-block:: bash
-
- cat example_tosca.yaml
diff --git a/docs/developer/design/tosca2heat.rst b/docs/developer/design/tosca2heat.rst
new file mode 100644
index 0000000..d4ead14
--- /dev/null
+++ b/docs/developer/design/tosca2heat.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+===================
+Parser tosca2heat
+===================
+
diff --git a/docs/developer/design/verigraph.rst b/docs/developer/design/verigraph.rst
new file mode 100644
index 0000000..91d5a36
--- /dev/null
+++ b/docs/developer/design/verigraph.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+=================
+Parser verigraph
+=================
+
diff --git a/docs/developer/design/yang2tosca.rst b/docs/developer/design/yang2tosca.rst
index 5aaf463..61d31b2 100644
--- a/docs/developer/design/yang2tosca.rst
+++ b/docs/developer/design/yang2tosca.rst
@@ -2,97 +2,6 @@
.. http://creativecommons.org/licenses/by/4.0
=================
-Parser YANG2TOSCA
+Parser yang2tosca
=================
-Overview
-========
-
-Parser is an open source project and licensed under Apache 2. Parser will help
-to provide a tooling mechanism, by parsing Telecom operators’ VNF descriptors
-(YANG templates) into TOSCA templates and then further translate TOSCA
-templates into certain common templates, which could be used in IaaS orchestration
-projects like OpenStack Heat.
-
-Prerequisites
-=============
-
-Parser requires the following to be installed.
-
-1. PYANG
---------
-
-Please follow the below installation steps.
-
-Step 1: Clone pyang tool or download the zip file from the following link.
-
-.. code-block:: bash
-
- git clone https://github.com/mbj4668/pyang.git
-
-OR
-
-.. code-block:: bash
-
- wget https://github.com/mbj4668/pyang/archive/master.zip
-
-Step 2: Change directory to the downloaded directory and run the setup file.
-
-.. code-block:: bash
-
- cd pyang
- python setup.py
-
-2. python-lxml
---------------
-
-Please follow the below installation link. http://lxml.de/installation.html
-
-
-Installation
-============================
-
-Please follow the below installation steps to install parser.
-
-Step 1: Clone the parser project.
-
-.. code-block:: bash
-
- git clone https://gerrit.opnfv.org/gerrit/parser
-
-Execution
-===========================
-
-Step 1: Change directory to where the scripts are present.
-
-.. code-block:: bash
-
- cd parser/yang2tosca
-
-Step 2: Copy the YANG file which needs to be converted into TOSCA to
- current (parser/yang2tosca) folder.
-
-Step 3: Run the python script "parser.py" with the YANG file as an input option.
-
-.. code-block:: bash
-
- python parser.py -n "YANG filename"
-
-Example:
-
-.. code-block:: bash
-
- python parser.py -n example.yaml
-
-Step 4: Verify the TOSCA YAMl which file has been created with the same name
- as the YANG file with a “_tosca” suffix.
-
-.. code-block:: bash
-
- cat "YANG filename_tosca.yaml"
-
-Example:
-
-.. code-block:: bash
-
- cat example_tosca.yaml
diff --git a/docs/developer/overview/overview.rst b/docs/developer/overview/overview.rst
index d1cad64..f9efebe 100644
--- a/docs/developer/overview/overview.rst
+++ b/docs/developer/overview/overview.rst
@@ -26,14 +26,23 @@ operators’ descriptors/records into TOSCA/CAMP templates and then further
translate TOSCA/CAMP templates into certain common templates, which could be
used in IaaS orchestration projects like OpenStack Heat.
-Upgrades from Arno
+For Arno Release
------------------------
+Parser is not one of the Arno Release projects, however the project has established
+the code base for the later releases:
-For Release B, Parser offers the following additional capabilities:
+* OpenStack Heat Translator Kilo Release
+* Initial documentation on use cases
-* Integration of Heat-Translator Liberty release code. (both heat in-tree code and standalone package are provided)
+Upgrades from Arno Release
+------------------------
+
+For Brahmaputra Release, Parser offers the following additional capabilities:
+
+* Update with the integration of OpenStack Heat-Translator Liberty Release, of which
+ both heat in-tree code and standalone package are provided.
-* Yang2Tosca module which offers the capability to translate yang based
+* New module yang2tosca module which offers the capability to translate yang based
scriptors to tosca formate templates. Users could further use Heat-translator
module to translate this tosca template to Heat Orchestration template.
Yang2Tosca module could be installed seperately after user installed
@@ -45,22 +54,22 @@ For Release B, Parser offers the following additional capabilities:
from Release C to indicate which specific set of keywords are supported in
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.
+* 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.
-Upgrades from Brumapatra
+Upgrades from Brahmaputra Release
-----------------------
-For Release C, Parser offers the following additional capabilities:
+For Colorado Release, Parser offers the following additional capabilities:
-* Policy2Tosca module 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.
+* 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.
-* 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:
+* 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:
** support substitution mapping semantic in tosca-parser:
- support parse and validation about substitution mapping definition;
@@ -82,8 +91,19 @@ main details are listed below:
* Additional testing support.
-Upgrades from Colorado
-----------------------
+Upgrades from Colorado Release
+------------------------------
+
+For Danube Release, Parser offers the following additional capabilities:
+
+* New module verigraph which is a formal verification tool for service graphs. Given
+ a service graph, which can include stateful network functions and their configurations
+ (e.g., filtering rules for firewalls, and blacklists for anti-spamming filters), verigraph
+ can accurately and quickly check reachability properties in the graph (e.g. if a particular
+ flow of packets can go from one node of the graph to another node). Verigraph exploits
+ Satisfiability Modulo Theories (SMT) and the general-purpose SMT solver Z3. It includes a
+ library of network function models.
-For Release D, Parser offers the following additional capabilities:
+* The tosca2heat module updated with the intgeration of OpenStack tosca-parser and heat-translator
+ 0.7.0 releases.
diff --git a/docs/developer/requirements/parser requirement arno release.rst b/docs/developer/requirements/parser requirement arno release.rst
new file mode 100644
index 0000000..96d1d38
--- /dev/null
+++ b/docs/developer/requirements/parser requirement arno release.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*****************************************
+OPNFV Parser Requirements In Arno Release
+*****************************************
+
+.. contents::
+ :depth: 3
+ :local:
+
+Use Case Description
+---------------
+
+* When Operators want to do automation on utilizing VIM to manage hypervisor
+level accelerators which VNFs don't have knowledge of, certain templates
+would be deployed and Parser would be used if operator defined template could
+not be supported by VIM automation/orchestration tools directly.
+
diff --git a/docs/governance/committer/colorado release committer email motion vote record b/docs/governance/committer/colorado release committer email motion vote record
new file mode 100644
index 0000000..84cfc75
--- /dev/null
+++ b/docs/governance/committer/colorado release committer email motion vote record
@@ -0,0 +1,93 @@
+From: "Ram, Vinayak (NFV BU)" <vinayak.ram@hpe.com>
+To: "zhang.jun3g@zte.com.cn" <zhang.jun3g@zte.com.cn>, huangzhipeng <huangzhipeng@huawei.com>
+Cc: "Huruifeng (Victor)" <huruifeng@huawei.com>
+Date: Mon, 18 Apr 2016 12:06:52 +0000
+Subject: RE: Parser Committer Promotion Guidline call for approval from comitters
++1
+
+From: zhang.jun3g@zte.com.cn [mailto:zhang.jun3g@zte.com.cn]
+Sent: Monday, April 18, 2016 12:07 PM
+To: huangzhipeng <huangzhipeng@huawei.com>
+Cc: Huruifeng (Victor) <huruifeng@huawei.com>; Ram, Vinayak (NFV BU) <vinayak.ram@hpe.com>
+Subject: 答复: Parser Committer Promotion Guidline call for approval from comitters
+
+Hi,team,
+
++1
+
+it's ok for me!
+
+Regards,
+Julien
+
+
+
+
+
+
+ Julien(Jun) Zhang
+ NFV Architect
+D206(D2028), R&D Building, ZTE Plaza, #889, Bibo RD,
+Pudong District, Shang Hai, P.R.China, 201203
+T:+86 21 68897791 M:+86 15317680806 F:+86 21 50801070
+E: zhang.jun3g@zte.com.cn G: julienjut@gmail.com
+www.zte.com.cn, www.opnfv.org
+
+
+
+
+
+发件人: huangzhipeng <huangzhipeng@huawei.com>
+收件人: "Huruifeng (Victor)" <huruifeng@huawei.com>, "zhang.jun3g@zte.com.cn" <zhang.jun3g@zte.com.cn>, "vinayak.ram@hpe.com" <vinayak.ram@hpe.com>,
+日期: 2016/04/18 08:33
+主题: 答复: Parser Committer Promotion Guidline call for approval from comitters
+
+
+Hi Guys,
+
+Please perform the actions as described below by the end of this week.
+
+发件人: huangzhipeng
+发送时间: 2016年4月11日 16:30
+收件人: Huruifeng (Victor); 'zhang.jun3g@zte.com.cn'; 'vinayak.ram@hpe.com'
+主题: Parser Committer Promotion Guidline call for approval from comitters
+
+Hi everyone,
+
+Since I received only one comment from Julien so far on the cap of committer number, I updated the slide to address Juline’s comment and call for your approval. Please reply +1 if you are ok with our non-mandatory additional guideline, or specify your concerns if you have doubts about the current version.
+
+As I discussed in the previous meetings, after the slide (i.e the “Motion”) got unanimous +1 approval, I will submit it to our Parser repo so that it becomes a public document. Any further changes to the document should be done in a similar way: PTL or committer initiate a motion via email, and after committer approval submit it to parser repo, and merge after all the concerns addressed (all the -1 comments)
+
+This first document will be merged after the consent from you guys tho, since this is the starting piece.
+
+I will also show the record of the committer voting for openness and publicity.
+
+
+Best Regards
+
+Zhipeng Huang (Howard)
+IT Standard & Patent
+华为技术有限公司 Huawei Technologies Co., Ltd.
+
+Mobile: +86-18576658966
+Email: huangzhipeng@huawei.com
+地址:深圳市龙岗区坂田华为基地 邮编:518129
+Huawei Technologies Co., Ltd.
+Bantian, Longgang District,Shenzhen 518129, P.R.China
+http://www.huawei.com
+本邮件及其附件含有华为公司的保密信息,仅限于发送给上面地址中列出的个人或群组。禁
+止任何其他人以任何形式使用(包括但不限于全部或部分地泄露、复制、或散发)本邮件中
+的信息。如果您错收了本邮件,请您立即电话或邮件通知发件人并删除本邮件!
+This e-mail and its attachments contain confidential information from HUAWEI, which
+is intended only for the person or entity whose address is listed above. Any use of the
+information contained herein in any way (including, but not limited to, total or partial
+disclosure, reproduction, or dissemination) by persons other than the intended
+recipient(s) is prohibited. If you receive this e-mail in error, please notify the sender by
+phone or email immediately and delete it!
+
+
+
+--------------------------------------------------------
+ZTE Information Security Notice: The information contained in this mail (and any attachment transmitted herewith) is privileged and confidential and is intended for the exclusive use of the addressee(s). If you are not an intended recipient, any disclosure, reproduction, distribution or other dissemination or use of the information contained is strictly prohibited. If you have received this mail in error, please delete it and notify us immediately.
+
+
diff --git a/docs/governance/committer/parser project committer promotion guidline.rst b/docs/governance/committer/parser project committer promotion guidline.rst
new file mode 100644
index 0000000..cc65a2d
--- /dev/null
+++ b/docs/governance/committer/parser project committer promotion guidline.rst
@@ -0,0 +1,68 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+============================================
+Parser Project Committer Promotion Guideline
+============================================
+
+Note
+====
+
+This rst document serves only as a guideline for current committers and PTL to
+refer when they are electing new committers. We would strongly recommend the
+qualities listed in this document (in the Guidelines section) to be taken into
+consideration, however there is no legal or mandatory authority whatsoever.
+Any terms that might be in conflict with TSC charter is void by nature.
+
+Goal
+====
+
+* Make Parser grow stronger and healthier, with more new ideas and new
+ contributors.
+* Few committers who work with more contributors on a large size of work.
+* Committers number expands when Parser project itself grows.
+* Committer swap to ensure participating company’s interest.
+* Do not mandatory set limit to ban contributors to run, the ultimate result of
+ a promotion is still a consensus driven by community discussion.
+
+Rationale
+=========
+
+* Committers should be a small group of core contributors that could provide
+ a leading force for a balk of work in the project.
+* As a small new project, the growth of Parser is very important.
+* For any newly proposed committers, besides KPIs like commits, they should be
+ able to bring and work on an appropriate size of workload, with or without new
+ work force, so that the ratio between committer numbers and the workload is
+ appropriate.
+* Key mission of the committer is to expand and strengthen the project,
+ with new ideas or new participants.
+
+Guidelines
+==========
+
+* For those who are proposed as committers, if other KPI holds, for approval
+ they should have new work plan proposed that are beyond the work from past
+ release. For those who have brought forward both new work plan as well as
+ new contributors, their promotion should be considered approved in a fast
+ track.
+* For those who are proposed as committers, if other KPI holds, but they only
+ cover a similar size of work to the past release, for approval they should
+ replace the original committer of the same company. If there is no previous
+ committer member from the same company, then the promotion should be put
+ through with enough discussions.
+* There will be a cap on committer number per company. It is recommended that
+ each participating should not have more than 2 committers at the moment.
+ However this cap subjects to modification in the future should the team
+ decide to change. There is no cap for individual contributors.
+
+Guideline Creation and Modification Procedure
+=============================================
+
+* Current committers vote on this motion via email, approval require a unanimous
+ consent.
+* Submit this motion as a rst file into the parser governance repo, to setup a
+ precedent. PTL should kick off a review for the document each cycle.
+* Any future change to the guideline should be done via new patches and code
+ reviews, with record of showing a previous committer unanimous vote result on
+ the motion of such modification.
diff --git a/docs/governance/index.rst b/docs/governance/index.rst
new file mode 100644
index 0000000..6413aa9
--- /dev/null
+++ b/docs/governance/index.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+*************************************
+OPNFV Parser Governance Documentation
+*************************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 6
+
+ ../committer/parser project committer promotion guidline.rst
diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
index 3a1417a..63a8b09 100644
--- a/docs/release/installation/installation.instruction.rst
+++ b/docs/release/installation/installation.instruction.rst
@@ -2,40 +2,66 @@
.. http://creativecommons.org/licenses/by/4.0
-Parser general configuration
-=====================
-Parser can be configured with any installer in current OPNFV.
+Parser tosca2heat Installation
+============================
+
+Please follow the below installation steps to install tosca2heat submodule in parser.
+
+Step 1: Clone the parser project.
+
+.. code-block:: bash
+
+ git clone https://gerrit.opnfv.org/gerrit/parser
+
+Step 2: Install the heat-translator sub project.
-Pre-configuration activities
------------------------------
-For parser, there is not specific pre-configuration activities.
+.. code-block:: bash
+
+ # uninstall pre-installed tosca-parser
+ pip uninstall -y heat-translator
+
+ # change directory to heat-translator
+ cd parser/tosca2heat/heat-translator
+
+ # install requirements
+ pip install -r requirements.txt
-Hardware configuration
------------------------
-For parser, there is not hardware configuration needed for this specific installer.
+ # install heat-translator
+ python setup.py install
+
+Step 3: Install the tosca-parser sub project.
+
+.. code-block:: bash
-Jumphost configuration
------------------------
-For parser, there is not intial Jumphost configuration (network and software)needed in order
-to deploy any installer.
+ # uninstall pre-installed tosca-parser
+ pip uninstall -y tosca-parser
+ # change directory to tosca-parser
+ cd parser/tosca2heat/tosca-parser
-Parser tosca2heat configuration
-=====================
-For tosca2heat components(tosca-parser and heat-translator) in parser,there are not specific
-configuration of each component in installer.
+ # install requirements
+ pip install -r requirements.txt
+ # install tosca-parser
+ python setup.py install
-Parser yang2tosca configuration
-=====================
+
+ **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
+==============================
Parser yang2tosca requires the following to be installed.
-1. PYANG
---------
+Step 1: Clone the parser project.
-Please follow the below installation steps.
+.. code-block:: bash
-Step 1: Clone pyang tool or download the zip file from the following link.
+ git clone https://gerrit.opnfv.org/gerrit/parser
+
+Step 2: Clone pyang tool or download the zip file from the following link.
.. code-block:: bash
@@ -47,30 +73,35 @@ OR
wget https://github.com/mbj4668/pyang/archive/master.zip
-Step 2: Change directory to the downloaded directory and run the setup file.
+Step 3: Change directory to the downloaded directory and run the setup file.
.. code-block:: bash
cd pyang
python setup.py
-2. python-lxml
+Step 4: install python-lxml
--------------
Please follow the below installation link. http://lxml.de/installation.html
-Parser policy2tosca configuration
-============================
-Parser - POLICY2TOSCA requires the following to be installed.
+Parser policy2tosca installation
+================================
+
+Please follow the below installation steps to install parser - POLICY2TOSCA.
-1. cliff
---------
+Step 1: Clone the parser project.
+
+.. code-block:: bash
+
+ git clone https://gerrit.opnfv.org/gerrit/parser
+
+Step 2: Install the policy2tosca module.
+
+.. code-block:: bash
-Install cliff with the following links.
-::
-- `install <http://docs.openstack.org/developer/cliff/install.html>`
-or
-- `demoapp <http://docs.openstack.org/developer/cliff/demoapp.html>
+ cd parser/policy2tosca
+ python setup.py install
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
index c42330c..e6e8974 100644
--- a/docs/release/userguide/feature.userguide.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -2,53 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-Parser tosca2heat Installation
-============================
-
-Please follow the below installation steps to install tosca2heat submodule in parser.
-
-Step 1: Clone the parser project.
-
-.. code-block:: bash
-
- git clone https://gerrit.opnfv.org/gerrit/parser
-
-Step 2: Install the heat-translator sub project.
-
-.. code-block:: bash
-
- # uninstall pre-installed tosca-parser
- pip uninstall -y heat-translator
-
- # change directory to heat-translator
- cd parser/tosca2heat/heat-translator
-
- # install requirements
- pip install -r requirements.txt
-
- # install heat-translator
- python setup.py install
-
-Step 3: Install the tosca-parser sub project.
-
-.. code-block:: bash
-
- # uninstall pre-installed tosca-parser
- pip uninstall -y tosca-parser
-
- # change directory to tosca-parser
- cd parser/tosca2heat/tosca-parser
-
- # install requirements
- pip install -r requirements.txt
-
- # install tosca-parser
- 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.
Parser tosca2heat Execution
===========================