openstack/tosca-parser
Code Issues Proposed changes

Create README

Browse Source 
Create an intial README for stand alone parser.

Change-Id: Ic153610ad55e942dc8a8f5c26ddac2a56aea1188
This commit is contained in:
spzala 2015-08-25 16:19:45 -07:00
parent 540c3e73fc
commit 76c3a594a8
3 changed files with 11 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.rst
View File

@ -13,4 +13,4 @@ Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/heat-translator
https://bugs.launchpad.net/tosca-parser

2
HACKING.rst
View File

@ -1,4 +1,4 @@
heat-translator Style Commandments
tosca-parser Style Commandments
===============================================
Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

39
README.rst
View File

@ -1,49 +1,28 @@
===============
Heat-Translator
TOSCA Parser
===============
Tool to translate non-heat templates to Heat Orchestration Template (HOT).
Parser for TOSCA Simple Profile in YAML.
Overview
--------
Heat-Translator is an Openstack project and licensed under Apache 2. It 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. Currently the
development and testing is done with an aim to translate OASIS Topology and
Orchestration Specification for Cloud Applications (TOSCA) templates to
HOT. However, the tool is designed to be easily extended to use with any
format other than TOSCA.
The TOSCA Parser is an OpenStack project and licensed under Apache 2. It 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.
Architecture
------------
Heat-Translator project is mainly built of two components:
1. **Parser** - parser for a particular template format e.g. TOSCA parser
2. **Generator** - takes an in-memory graph from **Parser**, maps it to Heat resources and software configuration and then produces a HOT.
**Parser** - parser for a TOSCA Simple Profile in YAML.
How To Use
**********
Please refer to `doc/source/usage.rst <https://github.com/openstack/heat-translator/blob/master/doc/source/usage.rst>`_
Directory Structure
*******************
Three main directories related to the heat-translator are:
1. toscalib: It is TOSCA parser for TOSCA Simple Profile YAML. It validates tosca input file and creates an in memory graphs.
2. hot: It is the generator, that has logic of converting TOSCA in memory graph to HOT yaml files.
3. common: It has all the file that can support the execution of parser and generator.
Please refer to `doc/source/usage.rst <https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst>`_
Project Info
------------
* License: Apache License, Version 2.0
* Documentation: http://docs.openstack.org/developer/heat-translator/
* Launchpad: https://launchpad.net/heat-translator
* Blueprints: https://blueprints.launchpad.net/heat-translator
* Bugs: https://bugs.launchpad.net/heat-translator
* Source: http://git.openstack.org/cgit/openstack/heat-translator/
* IRC Channel: #openstack-heat-translator
* Source: http://git.openstack.org/cgit/openstack/tosca-parser/