diff options
Diffstat (limited to 'docs/developer/design')
| -rw-r--r-- | docs/developer/design/apigateway.rst | 38 | ||||
| -rw-r--r-- | docs/developer/design/images/API_gateway_architecture.png | bin | 0 -> 323213 bytes | |||
| -rw-r--r-- | docs/developer/design/index.rst | 1 | ||||
| -rw-r--r-- | docs/developer/design/policy2tosca.rst | 44 | ||||
| -rw-r--r-- | docs/developer/design/tosca2heat.rst | 16 | ||||
| -rw-r--r-- | docs/developer/design/verigraph.rst | 4 |
6 files changed, 97 insertions, 6 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 Binary files differnew file mode 100644 index 0000000..7fbaa74 --- /dev/null +++ b/docs/developer/design/images/API_gateway_architecture.png 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. |
