From c7491340551cdd9d757d63b4bbe79132506e386a Mon Sep 17 00:00:00 2001 From: shangxdy Date: Mon, 17 Jul 2017 17:40:59 +0800 Subject: Synchronize upstream version of 0.9 Synchronize heat-translator wiht upstream versionn of 0.9 JIRA: PARSER-128 Change-Id: I4d2c62a0e81119d5c0305e3ac052415a6d5acee3 Signed-off-by: shangxdy --- tosca2heat/heat-translator/README.rst | 56 +++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 tosca2heat/heat-translator/README.rst (limited to 'tosca2heat/heat-translator/README.rst') diff --git a/tosca2heat/heat-translator/README.rst b/tosca2heat/heat-translator/README.rst new file mode 100644 index 0000000..c8af42a --- /dev/null +++ b/tosca2heat/heat-translator/README.rst @@ -0,0 +1,56 @@ +======================== +Team and repository tags +======================== + +.. image:: http://governance.openstack.org/badges/heat-translator.svg + :target: http://governance.openstack.org/reference/tags/index.html + +.. Change things from this point on + +=============== +Heat-Translator +=============== + +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. + +Architecture +------------ + +Heat-Translator project takes a non-Heat template (e.g. TOSCA flat YAML +template or template embedded in TOSCA Cloud Service Archive (CSAR) format) as +an input, calls an appropriate Parser (e.g. TOSCA Parser) per the type of input +template to parse it and create an in-memory graph, maps it to Heat resources +and then produces a Heat Orchestration Template (HOT) as an output. + +How To Use +---------- +Please refer to `doc/source/usage.rst `_ + +Directory Structure +------------------- + +Three main directories related to the heat-translator are: + +1. hot: It is the generator, that has logic of converting TOSCA in memory graph to HOT YAML files. +2. common: It has all the file that can support the execution of parser and generator. +3. tests: It contains test programs and more importantly several templates which are used for testing. + +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 -- cgit 1.2.3-korg