openstack/heat-translator
Code Issues Proposed changes
6837f9266b
heat-translator/README.rst
spzala 0d2f71220d Update README 
The overivew section explains the project well. The one liner causes to create duplicate looking
doc when create PyPi package and it doesn't really add much value in README. Also, make all same
level heading look same.

Change-Id: I01af82cd0abf8e0d23f6c0a338880d1abe464413
2015-10-01 12:46:00 -07:00

1.8 KiB
Raw Blame History

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

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