diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 101 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 46 |
2 files changed, 66 insertions, 81 deletions
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 =========================== |