tosca2heat/heat-translator/README.rst

   1 ===============
   2 Heat-Translator
   3 ===============
   4
   5 Overview
   6 --------
   7
   8 Heat-Translator is an Openstack project and licensed under Apache 2. It is a
   9 command line tool which takes non-Heat templates as an input and produces a
  10 Heat Orchestration Template (HOT) which can be deployed by Heat. Currently the
  11 development and testing is done with an aim to translate OASIS Topology and
  12 Orchestration Specification for Cloud Applications (TOSCA) templates to
  13 HOT. However, the tool is designed to be easily extended to use with any
  14 format other than TOSCA.
  15
  16 Architecture
  17 ------------
  18
  19 Heat-Translator project takes a non-Heat template (e.g. TOSCA flat YAML
  20 template or template embedded in TOSCA Cloud Service Archive (CSAR) format) as
  21 an input, calls an appropriate Parser (e.g. TOSCA Parser) per the type of input
  22 template to parse it and create an in-memory graph, maps it to Heat resources
  23 and then produces a Heat Orchestration Template (HOT) as an output.
  24
  25 How To Use
  26 ----------
  27 Please refer to `doc/source/usage.rst <https://github.com/openstack/heat-translator/blob/master/doc/source/usage.rst>`_
  28
  29 Directory Structure
  30 -------------------
  31
  32 Three main directories related to the heat-translator are:
  33
  34 1. hot: It is the generator, that has logic of converting TOSCA in memory graph to HOT yaml files.
  35 2. common: It has all the file that can support the execution of parser and generator.
  36 3. tests: It contains test programs and more importantly several templates which are used for testing.
  37
  38 Project Info
  39 ------------
  40
  41 * License: Apache License, Version 2.0
  42 * Documentation: http://docs.openstack.org/developer/heat-translator/
  43 * Launchpad: https://launchpad.net/heat-translator
  44 * Blueprints: https://blueprints.launchpad.net/heat-translator
  45 * Bugs: https://bugs.launchpad.net/heat-translator
  46 * Source: http://git.openstack.org/cgit/openstack/heat-translator/
  47 * IRC Channel: #openstack-heat-translator