openstack/heat-translator
Code Issues Proposed changes
19572bfeb7
heat-translator/doc/source/usage.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

2.6 KiB
Raw Blame History

Usage

Use Heat-Translator with OpenStackClient (OSC)

Assuming that OpenStackClient (OSC) is available in your environment, you can easily install Heat-Translator to use with OSC by following three steps:

git clone https://github.com/openstack/heat-translator
cd heat-translator
python setup.py install

Once installation is complete, Heat-Translator is ready to use. Currently you can use it in following two ways.

Translate and get output on command line. For example: :

openstack translate template --template-file /home/openstack/heat-translator/translator/tests/data/tosca_helloworld.yaml --template-type tosca

Translate and save output of translated file to a desired destination. For example: :

openstack translate template --template-file /home/openstack/heat-translator/translator/tests/data/tosca_helloworld.yaml --template-type tosca --output-file /tmp/hot_hello_world.yaml

You can learn more about available options by running following help command:

openstack help translate template

Use Heat-Translator on its own

Heat-Translator can be used without any specific OpenStack environment set up as below:

git clone https://github.com/openstack/heat-translator
python heat_translator.py --template-file==<path to the YAML template> --template-type=<type of template e.g. tosca> --parameters="purpose=test"

The heat_translator.py test program is at the root level of the project. The program has currently tested with TOSCA templates. It requires two arguments:

  1. Path to the file that needs to be translated
  2. Type of translation (e.g. tosca)

An optional argument can be provided to handle user inputs parameters.

For example, a TOSCA hello world template can be translated by running the following command from the directory where you have cloned the project:

python heat_translator.py --template-file=translator/tests/data/tosca_helloworld.yaml --template-type=tosca

This should produce a translated Heat Orchestration Template on the command line. In the near future, new options will be added to save the output to destination file.

When deploy the translated template with Heat, please keep in mind that you have image registered in the Glance. The Heat-Translator project sets flavor and image from a pre-defined set of values (as listed in /home/openstack/heat-translator/translator/hot/tosca/tosca_compute.py) with the best possible match to the constraints defined in the TOSCA template. If there is no possible match found, a null value is set for now. Per the future plan, an image and flavor will be provided from an online repository.