summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorshangxdy <shang.xiaodong@zte.com.cn>2017-03-14 21:22:05 +0800
committershangxdy <shang.xiaodong@zte.com.cn>2017-03-14 21:27:48 +0800
commitd7b31c6be3b9ce919f1dff8e3b4bcc6f73f9b9ff (patch)
tree3d5b054fa6f9ce0d6f9bf34b360f0e0773788f11 /docs
parentea9d47bbd0a06d0cca1738f244ab8b30e57ed9c6 (diff)
Modify documents about overview
Add overview about apigateway and tosca2heat. Change-Id: I2994ebcde39dcacd248bd09d33ab48823c12e9a1 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
Diffstat (limited to 'docs')
-rw-r--r--docs/developer/design/tosca2heat.rst12
-rw-r--r--docs/developer/overview/overview.rst6
-rw-r--r--docs/release/installation/installation.instruction.rst2
3 files changed, 18 insertions, 2 deletions
diff --git a/docs/developer/design/tosca2heat.rst b/docs/developer/design/tosca2heat.rst
index 3fb1d26..e49718e 100644
--- a/docs/developer/design/tosca2heat.rst
+++ b/docs/developer/design/tosca2heat.rst
@@ -5,3 +5,15 @@
Parser tosca2heat
=================
+Tosca2heat is a opnfv sub-project of parser based on openstack two projects: tosca
+parser and heat translator.
+
+The TOSCA Parser is developed to parse TOSCA Simple Profile in YAML. It reads the
+TOSCA templates and creates an in-memory graph of TOSCA nodes and their relationship.
+Heat-Translator is a command line tool which takes non-Heat templates as an input
+and produces a Heat Orchestration Template (HOT) which can be deployed by Heat.
+
+More details please refer to openstack related sites.
+
+Tosca2heat intends to enhanced NFV features in tosca template parse and translator,
+such as huge page, dpdk and sriov.
diff --git a/docs/developer/overview/overview.rst b/docs/developer/overview/overview.rst
index 3ae173a..0a6e9bb 100644
--- a/docs/developer/overview/overview.rst
+++ b/docs/developer/overview/overview.rst
@@ -104,6 +104,10 @@ For Danube Release, Parser offers the following additional capabilities:
Satisfiability Modulo Theories (SMT) and the general-purpose SMT solver Z3. It includes a
library of network function models.
+* New module apigateway added, which focuses on message relay and provides unified restful API
+ and grpc api to end user who want use parser, additionally one module of parser(such as
+ yang2tosca) can access the other module(such as tosca2heat) through grpc provided by apigateway
+ without concern its location.
+
* The tosca2heat module updated with the intgeration of OpenStack tosca-parser and heat-translator
0.7.0 releases.
-
diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
index ae2cbb1..323fd4a 100644
--- a/docs/release/installation/installation.instruction.rst
+++ b/docs/release/installation/installation.instruction.rst
@@ -162,4 +162,4 @@ Step 2: Install the apigateway submodule.
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
+be provided in the next release.