openstack
/
heat-translator
Code Issues Proposed changes
Translate non-heat templates to Heat Orchestration Template.
340 Commits 9 Branches 22 Tags 7.7 MiB
Python 98.1%
Shell 1.9%
Go to file
Julio Ruano 302e083de6 Fix custom import issues when using shell environments 
Translator is enabled to exectue within other shell environments by
installing as a library (in addition to command line). As such, a
separate package "translator" is installed, and pulls in everything
under the translator/ directory.

Originally the design for custom classes was to allow users to specify
their own locations for custom classes that they define outside of the
translator code. In order for this to work in the shell environments,
the user would need to install these classes via a setup.py script.
For now this is too heavy of a requirement to place on the user, so
the design for this fix is that the user will need to manually copy
over their custom classes to the translator/custom directory.

We will revist the option to install custom classes via a user defined
setup.py at a later date.

Change-Id: Ib132d9fe768a954a226724929c074034cf898da3
 		2015-10-02 19:21:16 -05:00
doc/source Update doc references 2015-09-11 06:35:46 -07:00
translator Fix custom import issues when using shell environments 2015-10-02 19:21:16 -05:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:27:05 +00:00
.gitignore Added a module for intrinsic function. 2014-07-14 17:41:55 +03:00
.gitreview Fix .gitreview after rename/transfer 2014-12-06 19:27:19 +03:00
.mailmap Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
.testr.conf Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:45 +00:00
HACKING.rst Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
LICENSE Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
MANIFEST.in Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
README.rst Update README 2015-10-01 12:46:00 -07:00
babel.cfg Add .gitreview file and apply cookiecutter template. 2014-04-01 09:43:50 -05:00
heat_translator.py Handle URLs for input templates and imports 2015-10-01 16:12:32 -07:00
heat_translator_logging.conf Supporting logging in heat-translator with config file 2015-09-04 12:46:58 +05:30
openstack-common.conf TOSCA definition types for TOSCA library. 2014-05-05 16:49:32 -05:00
requirements.txt Updated from global requirements 2015-09-18 16:37:54 +00:00
setup.cfg Update trove classifier 2015-10-01 02:00:38 +05:30
setup.py Updated from global requirements 2015-09-18 16:37:54 +00:00
test-requirements.txt Updated from global requirements 2015-09-04 19:43:25 +00:00
tox.ini Update trove classifier 2015-10-01 02:00:38 +05:30

README.rst

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