From 342f5e82a6d2b8619d07e260bac07235ef228415 Mon Sep 17 00:00:00 2001 From: zhipengh Date: Thu, 7 Jan 2016 16:33:16 +0800 Subject: JIRA:PARSER-17 Clean up documentation setup Change-Id: I2863a76a5d5417c184283fdf97282c94359162dc (cherry picked from commit a83cb309a399fd3043695e6620441d8d8ec7727d) --- docs/intro/intro.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/intro/intro.rst (limited to 'docs/intro/intro.rst') diff --git a/docs/intro/intro.rst b/docs/intro/intro.rst new file mode 100644 index 0000000..3272c65 --- /dev/null +++ b/docs/intro/intro.rst @@ -0,0 +1,32 @@ +.. + This work is licensed under a Creative Commons Attribution 3.0 Unported + License. + + http://creativecommons.org/licenses/by/3.0/legalcode + +============================ +Introduction of Parser Project +============================ + +In NFV, various templates (such as descriptors, records and so on) are utilized +to describe the deployment requirements (such as basic VM requirements – vCPU, +memory, storage, as well as the NFV acceleration management requirement such as +Huge Pages support, SR-IOV, NUMA affinity, DPDK support etc.), +the post-instaniation records (such as storage usage report, CPU performance +report etc.) 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. + +Project Parser will help to provide such tooling mechanism, by parsing Telecom +operators’ descriptors/records into TOSCA/CAMP templates and then further +translate TOSCA/CAMP templates into certain common templates, which could be +used in IaaS orchestration projects like OpenStack Heat. + +For Release B, Parser offers the following capabilities: +* Integration of Heat-Translator Liberty release code. (both heat in-tree code and standalone package are provided) +* Yang2Tosca module which offers the capability to translate yang based +scriptors to tosca formate templates. Users could further use Heat-translator +module to translate this tosca template to Heat Orchestration template. +Yang2Tosca module could be installed seperately after user installed +OPNFV B release platform. +* Use Case Analysis documents which include RNC use case analysis and Parser keyword proposal. -- cgit 1.2.3-korg