docs/parser_docs/intro/intro.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ==============================
   5 Introduction of Parser Project
   6 ==============================
   7
   8 In NFV, various templates (such as descriptors, records and so on) are utilized
   9 to describe the deployment requirements (such as basic VM requirements – vCPU,
  10 memory, storage, as well as the NFV acceleration management requirement such as
  11 Huge Pages support, SR-IOV, NUMA affinity, DPDK support etc.),
  12 the post-instaniation records (such as storage usage report, CPU performance
  13 report etc.) or other purposes. However in order to make these templates
  14 adaptable and feasible for purpose like deployment orchestration/automation,
  15 certain tooling mechanism that provides template translation is necessary.
  16
  17 Project Parser will help to provide such tooling mechanism, by parsing Telecom
  18 operators’ descriptors/records into TOSCA/CAMP templates and then further
  19 translate TOSCA/CAMP templates into certain common templates, which could be
  20 used in IaaS orchestration projects like OpenStack Heat.
  21
  22 For Release B, Parser offers the following capabilities:
  23
  24 * Integration of Heat-Translator Liberty release code. (both heat in-tree code and standalone package are provided)
  25
  26 * Yang2Tosca module which offers the capability to translate yang based
  27   scriptors to tosca formate templates. Users could further use Heat-translator
  28   module to translate this tosca template to Heat Orchestration template.
  29   Yang2Tosca module could be installed seperately after user installed
  30   OPNFV B release platform.
  31
  32 * The "parser_new_keywords" document demonstrate a set of keywords concluded by
  33   Parser team that need to be supported in tosca to heat translation. However
  34   it should be noted that these keywords only serve as a roadmap. We will start
  35   from Release C to indicate which specific set of keywords are supported in
  36   Parser.
  37
  38 * The "vRNC_tosca_intro" document describes Parser's use case analysis on vRNC scenario.
  39   The "example" folder contains examples of tosca-nfv standard and vRNC scenario.
  40   See also https://wiki.opnfv.org/parser .