tosca2heat/heat-translator/README.md

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