docs/developer/overview/overview.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 OPNFV Parser Danube Overview Doumentation
   6 =========================================
   7
   8 .. contents::
   9    :depth: 3
  10    :local:
  11
  12 Introduction
  13 ---------------
  14
  15 In NFV, various templates (such as descriptors, records and so on) are utilized
  16 to describe the deployment requirements (such as basic VM requirements – vCPU,
  17 memory, storage, as well as the NFV acceleration management requirement such as
  18 Huge Pages support, SR-IOV, NUMA affinity, DPDK support etc.),
  19 the post-instaniation records (such as storage usage report, CPU performance
  20 report etc.) or other purposes. However in order to make these templates
  21 adaptable and feasible for purpose like deployment orchestration/automation,
  22 certain tooling mechanism that provides template translation is necessary.
  23
  24 Project Parser will help to provide such tooling mechanism, by parsing Telecom
  25 operators’ descriptors/records into TOSCA/CAMP templates and then further
  26 translate TOSCA/CAMP templates into certain common templates, which could be
  27 used in IaaS orchestration projects like OpenStack Heat.
  28
  29 Upgrades from Arno
  30 ------------------------
  31
  32 For Release B, Parser offers the following additional capabilities:
  33
  34 * Integration of Heat-Translator Liberty release code. (both heat in-tree code and standalone package are provided)
  35
  36 * Yang2Tosca module which offers the capability to translate yang based
  37   scriptors to tosca formate templates. Users could further use Heat-translator
  38   module to translate this tosca template to Heat Orchestration template.
  39   Yang2Tosca module could be installed seperately after user installed
  40   OPNFV B release platform.
  41
  42 * The "parser_new_keywords" document demonstrate a set of keywords concluded by
  43   Parser team that need to be supported in tosca to heat translation. However
  44   it should be noted that these keywords only serve as a roadmap. We will start
  45   from Release C to indicate which specific set of keywords are supported in
  46   Parser.
  47
  48 * The "vRNC_tosca_intro" document describes Parser's use case analysis on vRNC scenario.
  49   The "example" folder contains examples of tosca-nfv standard and vRNC scenario.
  50   See also https://wiki.opnfv.org/parser.
  51
  52 Upgrades from Brumapatra
  53 -----------------------
  54
  55 For Release C, Parser offers the following additional capabilities:
  56
  57 * Policy2Tosca module which enables policy related fields in tosca could be translated
  58   into heat orchestration template correctly. Policy2Tosca module could be installed seperately
  59   after user installed OPNFV C release platform.
  60
  61 * Tosca2Heat enhancements which includes a set of feature addons (such as substitution mapping)
  62 for OpenStack tosca-parser module which is integrated in the OPNFV C release platform. And the
  63 main details are listed below:
  64
  65   ** support substitution mapping semantic in tosca-parser:
  66     - support parse and validation about substitution mapping definition;
  67     - support import nested template;
  68     - support deployment a node which is substituted by a template;
  69     - support deployment a template alone which has substitution mapping definition.
  70
  71   ** afinity and anti-affinity support when deploy servers:
  72     - tosca.policies.Placement.Colocate;
  73     - tosca.policies.Placement.Antilocate;
  74
  75   ** add validation about input parameters;
  76
  77   ** add high availability and block volume in compute translation;
  78
  79   ** add ip output in compute translation;
  80
  81   ** add deployment a whole vRNC testcase with parser.
  82
  83 * Additional testing support.
  84
  85 Upgrades from Colorado
  86 ----------------------
  87
  88 For Release D, Parser offers the following additional capabilities:
  89