heat-translator/README.rst
spzala b4824100a5 Update doc references
Update doc to remove toscalib references. Completing the work to remoev TOSCA
code from heat-translator herewith.

Change-Id: I6a36b443ea60ed9944caa05f0368623923715425
Implements: blueprint use-tosca-parser-library
2015-09-11 06:35:46 -07:00

1.8 KiB

Heat-Translator

Tool to translate non-heat templates to Heat Orchestration Template (HOT).

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