From 61a6e142120e622eb74751c4ff1ba9fa9ffceba4 Mon Sep 17 00:00:00 2001 From: shangxdy Date: Sat, 11 Mar 2017 01:08:53 +0800 Subject: Add apigateway docs Add documents for apigateway. JIRA:PARSER-123 Change-Id: Ibe8ebd6e3a3f62d58d8da0da4d9be8ceb673fb7b Signed-off-by: shangxdy --- .../installation/installation.instruction.rst | 36 ++++++++++++++++++++-- docs/release/release-notes/release-notes.rst | 24 +++++++++++---- 2 files changed, 52 insertions(+), 8 deletions(-) (limited to 'docs/release') diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index de6956a..ae2cbb1 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -3,7 +3,7 @@ Parser tosca2heat Installation -============================ +============================== Please follow the below installation steps to install tosca2heat submodule in parser. @@ -81,7 +81,7 @@ Step 3: Change directory to the downloaded directory and run the setup file. python setup.py Step 4: install python-lxml --------------- +--------------------------- Please follow the below installation link. http://lxml.de/installation.html @@ -131,3 +131,35 @@ Step 2: Go to the verigraph directory. Step3: Follow the instructions in README.rst for downloading verigraph dependencies and for installing verigraph. + + +Parser apigateway Installation +============================== + +In the present release, apigateway requires that the following software is also installed: + + - grpcio (https://github.com/golang/protobuf/protoc-gen-go) + +Please follow the below installation steps to install apigateway submodule in parser. + +Step 1: Clone the parser project. + +.. code-block:: bash + + git clone https://gerrit.opnfv.org/gerrit/parser + +Step 2: Install the apigateway submodule. + +.. code-block:: bash + + # change directory to apigateway + cd parser/apigateway + + # install requirements + pip install -r requirements.txt + + # install apigateway + python setup.py install + +**Notes**: In release D, apigateway submodule is only initial framework code, and more feature will +be provided in the next release. \ No newline at end of file diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 5d62b74..0db5c35 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -90,12 +90,22 @@ Feature additions | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| | | +| PARSER-111 | Verigraph Code Base | +--------------------------------------+--------------------------------------+ -| | | +| PARSER-112 | Init api gateway framework | +--------------------------------------+--------------------------------------+ -| PARSER-111 | Verigraph Code Base | -| | | +| PARSER-113 | Add input validation test case | ++--------------------------------------+--------------------------------------+ +| PARSER-114 | Add output in vRNC for substitution | +| | mappings. | ++--------------------------------------+--------------------------------------+ +| PARSER-115 | Add output validation for | +| | substitution. | ++--------------------------------------+--------------------------------------+ +| PARSER-116 | Add output validation test case for | +| | substitution. | ++--------------------------------------+--------------------------------------+ +| PARSER-121 | Add ip output in compute node | +--------------------------------------+--------------------------------------+ @@ -108,9 +118,10 @@ Bug corrections | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| | | +| PARSER-117 | Fix ci bug when integrated with | +| | functest | +--------------------------------------+--------------------------------------+ -| | | +| PARSER-122 | Fix docs bug | +--------------------------------------+--------------------------------------+ Deliverables @@ -123,6 +134,7 @@ Software deliverables - yang2tosca - policy2tosca - verigraph +- apigateway Documentation deliverables ^^^^^^^^^^^^^^^^^^^^^^^^^^ -- cgit 1.2.3-korg