Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.81 KB

README.md

File metadata and controls

53 lines (37 loc) · 1.81 KB
Raw

SF2HEAT (SuperFluidity HEAt Translator)

Overview

SuperFluidity HEAt Translator is developed under the Superfluidity project and licensed under Apache 2. It is a python lib which takes Superfluity descriptors as an input and produces a Heat Orchestration Template (HOT) which can be deployed by Heat.

Architecture

SFHEAT project takes a set of Superfluity descriptors as an input(YAML or JSON), calls an appropriate parser, maps it to Heat resources and then produces a Heat Orchestration Template (HOT) as an output.

How to Install

Install from source code:

Clone from GitHub repository

git clone https://github.com/superfluidity/sfehat.git
cd sfehat

Install inside python environment

python setup.py install

Install with pip:

pip install -e git+https://github.com/superfluidity/sfehat.git#egg=sf2heat

Usage example lib

from sf2heat.nsdtranslator import NSDTranslator
# with ansible playbook
nsd_translator = NSDTranslator(ns_data, hot_path, True)
nsd_translator.translate()

# without ansible playbook
nsd_translator = NSDTranslator(ns_data, hot_path)
nsd_translator.translate()

Usage example from CLI

From Superfluidity descriptor to HEAT

python sf2heat/cli.py -i tests/test_project_2.json -o /tmp/heat_output.yaml

From Superfluidity descriptor to HEAT with Ansible Playbook

python sf2heat/cli.py -i tests/test_project_2.json -d /tmp/heat_with_playbook -a

Project Info

Aknowledgements

This work has been performed in the context of the project Superfluidity, which received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No. 671566.