Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
==== Parser ====

  * ''Proposed name for the project'': Parser
  * ''Proposed name for the repository'': parser
  * ''Project Categories'': (Integration & Testing)

==== Project description: ====

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. This project 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.


==== Scope: ====

  * ''Scope of this project''

There are various deployment descriptors and operation records that are defined in the ETSI NFV documents for the purpose of on-board instanitiation and information collection. These descriptors/records are the information elements with input/output parameters exchanged via different interfaces produced and/or consumed by NFV-MANO functional blocks, and particular implementations are not specified.

This project aims to specifically deal with such descriptors/records that are produced and/or consumed by VIM, which is within the initial scope of the OPNFV.


  * ''Describe the problem being solved by project''

Many Telecom operators had expressed interests in an OASIS TOSCA based reference framework, and there is a good possibility that OASIS CAMP maybe also considered as a candidate alongside TOSCA. However operators may define high level deployment descriptions/records that are not necessary TOSCA or CAMP templates in the first place (descriptions based on YANG schema for example). Furthermore even if TOSCA/CAMP based templates are available, in the current OpenStack implementations, neither TOSCA nor CAMP is supported. HOT (HEAT Orchestration Template) is the de facto/de jure reference framework for OpenStack Heat. 

To help solving this problem, this project aims to provide the capability to:
  - translate operator defined templates to TOSCA/CAMP templates
  - parse TOSCA/CAMP templates generated in the first step to a common template. 

For the moment the common template could be referred to HOT. However if there is demand for a output template other than HOT, this project could also be used to generate a non-HOT common template, and later translated to the desired output template by third party translation engines via Parser API.

Example Use Case : When Operators want to do automation on utilizing VIM to manage hypervisor-level accelerators which VNFs don't have knowledge of, certain templates would be deployed and Parser would be used if operator defined template could not be supported by VIM automation/orchestration tools directly.

  * ''Specify any interface/API specification proposed''

New Parser API specification is proposed here.

  * ''Identity a list of features and functionality will be developed.''

Several TOSCA related feature have already been developed by the upstream project, additional TOSCA related feature as well as development for CAMP related feature will be needed.

  * ''Identify what is in or out of scope. So during the development phase, it helps reduce discussion.''

In scope: Tooling for template translation related to VIM+NFVI

Out of scope: template definition, Tooling for template translation related to components outside of VIM+NFVI.


  * ''Describe how the project is extensible in future''

It can be extended to parse any non-heat templates to a common template, support two-way translation, and in the future for new templates related to new information elements defined in ETSI NFV

==== Testability: ''(optional, Project Categories: Integration & Testing)'' ====

This project is intended to be integrated in the OPNFV Platform. No specific Testability is required.

==== Documentation: ''(optional, Project Categories: Documention)'' ====

This project intends to produce the following documentation supporting the meta distribution:
  * Installation Guide
  * User Guide
  * Developer Guide
  * Parser API Document

==== Dependencies: ====

  * ''Identify similar projects is underway or being proposed in OPNFV or upstream project''

The [[https://launchpad.net/heat-translator|Heat-Translator Project]] is identified as the upstream project for this project. 

  * ''Identify any open source upstream projects and release timeline.''

The [[https://launchpad.net/heat-translator|Heat-Translator Project]] is identified as the upstream project for this project. 

It would be aligned with OpenStack release schedule (per cycle) and OPNFV schedule. Hence it would meet both March release mark of OpenStack and OPNFV


  * ''Identify any specific development be staged with respect to the upstream project and releases.''

The deliverables from upstream project could be used in opnfv.

  * ''Are there any external fora or standard development organization dependencies. If possible, list and informative and normative reference specifications.''

  * [[https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=tosca|OASIS TOSCA]]
  * [[https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=camp|OASIS CAMP]]
  * [[http://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec|Heat Orchestration Template]]


  * ''If project is an integration and test, identify hardware dependency.''

This project does not require any hardware dependencies

==== Committers and Contributors: ====

  * ''Names and affiliations of the committers'':
Ruifeng(Victor) Hu, huruifeng@huawei.com;

Zhipeng(Howard) Huang, huangzhipeng@huawei.com;

Qi Zhou, zhouqi5@huawei.com

Vinayak Ram,  vinayak.ram@hp.com;

Sarbajit Chatterjee, sarbajit.chatterjee@hp.com;

Senthil Kumar Subramaniam,  senthil-kumar.subramaniam@hp.com

Julien, zhang.jun3g@zte.com.cn


==== Planned deliverables ====

  * ''Project release package as OPNFV or open source upstream projects''

This project would be released as an installable package from the open source upstream project, and it could be easily integrated to OPNFV platform

  * ''Project deliverables with multiple dependencies across other project categories''

N/A

==== Proposed Release Schedule: ====

This project is ready for the first release of OPNFV platform.
Wiki

User Tools

Site Tools

Page Tools
