summaryrefslogtreecommitdiffstats
path: root/docs/developer
diff options
context:
space:
mode:
Diffstat (limited to 'docs/developer')
-rw-r--r--docs/developer/design/apigateway.rst38
-rw-r--r--docs/developer/design/images/API_gateway_architecture.pngbin0 -> 323213 bytes
-rw-r--r--docs/developer/design/index.rst1
-rw-r--r--docs/developer/design/policy2tosca.rst44
-rw-r--r--docs/developer/design/tosca2heat.rst16
-rw-r--r--docs/developer/design/verigraph.rst4
-rw-r--r--docs/developer/overview/overview.rst14
-rw-r--r--docs/developer/requirements/parser_requirement_arno_release.rst2
8 files changed, 107 insertions, 12 deletions
diff --git a/docs/developer/design/apigateway.rst b/docs/developer/design/apigateway.rst
new file mode 100644
index 0000000..dbeb94d
--- /dev/null
+++ b/docs/developer/design/apigateway.rst
@@ -0,0 +1,38 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+=================
+Parser apigateway
+=================
+
+This document provides a description of apigateway, a message relay submodule for the other
+parser submodules.
+
+.. contents::
+ :depth: 3
+ :local:
+
+Overview
+--------
+Provide unified access interfaces for follow independent parser components:
+ - tosca2heat
+ - yang2tosca
+ - policy2tosca
+ - verigraph
+ - parser ui
+ The apigateway will relay message between above submodules throngh gRPC interface, in additon,
+apigateway also exposes restful api to provide parser all functions to the 3rd applications.
+
+
+Architecture
+------------
+Apigateway exploits three sub-components:
+
+- **APIGW**, the main part of apigateway, which is the message center.
+- **gRPC**, provide gRPC client and server for the other parser sub-modules, it can be devided
+into defferent pair of client/server according to the function.
+- **CLI**, command line tool for apigateway access and management .
+
+Apigateway architecture is shown below:
+
+.. image:: /images/API_gateway_architecture.png
diff --git a/docs/developer/design/images/API_gateway_architecture.png b/docs/developer/design/images/API_gateway_architecture.png
new file mode 100644
index 0000000..7fbaa74
--- /dev/null
+++ b/docs/developer/design/images/API_gateway_architecture.png
Binary files differ
diff --git a/docs/developer/design/index.rst b/docs/developer/design/index.rst
index 0f29a8a..fa13788 100644
--- a/docs/developer/design/index.rst
+++ b/docs/developer/design/index.rst
@@ -15,3 +15,4 @@ OPNFV Parser Design Documentation
yang2tosca.rst
policy2tosca.rst
verigraph.rst
+ apigateway.rst
diff --git a/docs/developer/design/policy2tosca.rst b/docs/developer/design/policy2tosca.rst
index 3753d6c..3ef1dca 100644
--- a/docs/developer/design/policy2tosca.rst
+++ b/docs/developer/design/policy2tosca.rst
@@ -1,8 +1,48 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-===================
+==================
Parser polic2tosca
-===================
+==================
+Problem description
+-------------------
+In NFV, various templates are utilized to describe the deployment requirements,
+the post-instantiation records or other purposes.However in order to make these
+templates adaptable and feasible for purpose like deployment orchestration/
+automation,certain tooling mechanism that provides template translation is
+necessary.When an end user needs to inject/remove policies from the TOSCA
+file generated the policy2tosca module comes in as part of parser project.
+Design
+------
+The following modules are implemented in policy2tosca module.
+
+CLIFF
+-----
+cliff is a framework for building command line programs. It uses plugins to
+define sub-commands, output formatters, and other extensions.In policy2tosca
+we use cliff to define the commands to inject or remove policies from
+TOSCA templates.
+Reference for PYANG: https://docs.openstack.org/developer/cliff/
+
+policy2tosca
+------------
+policy2tosca is a custom module written with the plugins of cliff where we
+define adding/removing definitions and/or types of policies.
+Following are the sub modules under policy2tosca
+ * add_definition.py: To inject a policy definition to the TOSCA template.
+ * add_type.py: To inject a policy type to the TOSCA template.
+ * del_definition.py: To remove a policy definition from the TOSCA template.
+ * del_type.py: To remove a policy type from the TOSCA template.
+
+Input
+-----
+The user specifies the input in command line arguments for the policy2tosca
+custom module with the source TOSCA file to which the policies should be
+injected/removed.
+
+Output
+------
+The output TOSCA template will be the input TOSCA file with the
+modification of policies.
diff --git a/docs/developer/design/tosca2heat.rst b/docs/developer/design/tosca2heat.rst
index d4ead14..e49718e 100644
--- a/docs/developer/design/tosca2heat.rst
+++ b/docs/developer/design/tosca2heat.rst
@@ -1,7 +1,19 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-===================
+=================
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/design/verigraph.rst b/docs/developer/design/verigraph.rst
index d364091..1362e23 100644
--- a/docs/developer/design/verigraph.rst
+++ b/docs/developer/design/verigraph.rst
@@ -1,9 +1,9 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-=================
+================
Parser verigraph
-=================
+================
This document provides a description of VeriGraph, a formal verification tool for service graphs.
diff --git a/docs/developer/overview/overview.rst b/docs/developer/overview/overview.rst
index 8baffdd..0a6e9bb 100644
--- a/docs/developer/overview/overview.rst
+++ b/docs/developer/overview/overview.rst
@@ -10,7 +10,7 @@ OPNFV Parser Danube Overview Doumentation
:local:
Introduction
----------------
+------------
In NFV, various templates (such as descriptors, records and so on) are utilized
to describe the deployment requirements (such as basic VM requirements – vCPU,
@@ -27,7 +27,7 @@ translate TOSCA/CAMP templates into certain common templates, which could be
used in IaaS orchestration projects like OpenStack Heat.
For Arno Release
-------------------------
+----------------
Parser is not one of the Arno Release projects, however the project has established
the code base for the later releases:
@@ -35,7 +35,7 @@ the code base for the later releases:
* Initial documentation on use cases
Upgrades from Arno Release
-------------------------
+--------------------------
For Brahmaputra Release, Parser offers the following additional capabilities:
@@ -59,7 +59,7 @@ For Brahmaputra Release, Parser offers the following additional capabilities:
scenario. See also https://wiki.opnfv.org/parser.
Upgrades from Brahmaputra Release
------------------------
+---------------------------------
For Colorado Release, Parser offers the following additional capabilities:
@@ -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/developer/requirements/parser_requirement_arno_release.rst b/docs/developer/requirements/parser_requirement_arno_release.rst
index 96d1d38..67f812c 100644
--- a/docs/developer/requirements/parser_requirement_arno_release.rst
+++ b/docs/developer/requirements/parser_requirement_arno_release.rst
@@ -10,7 +10,7 @@ OPNFV Parser Requirements In Arno Release
: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