Git Product home page Git Product logo

cloudnet-tosca-toolbox's Introduction

What is Cloudnet-TOSCA-toolbox?

Cloudnet TOSCA toolbox is an OASIS TOSCA processor for checking and adjusting TOSCA service templates. TOSCA templates specify service structure and the procedure governing their life cycle. Services are typically application, infrastructure or network services.
This set of tools is intended for syntax and type checking of any service templates written in TOSCA, including e.g. NFV descriptors.
It also allows for visualizing the associated architecture in different ways (UML, TOSCA, network diagrams).
A web portal based on this code is available at this url: https://toscatoolbox.orange.com.

Table of contents

Prerequisites

To use this toolset, you'll need Docker, Python, PlantUML, nwdiag and dot. However, provided you have Docker, the others are available as containers as follows. You can build the Docker images by:

cd bin/  
./build.sh

How to use it?

If you get some TOSCA 1.0, 1.1, 1.2 or 1.3 templates to check, once you've clone the repository, you can create a directory in the 'examples' directory, and copy your yaml files inside.

cd examples/  
mkdir my_example  
cp some_place/my_tosca_template_A.yaml my_example/  
...  

Load Cloudnet commands:

CLOUDNET_BINDIR=../../bin  
. ${CLOUDNET_BINDIR}/cloudnet_rc.sh

Now, launching the command

translate my_tosca_template_A.yaml  

will :

  • check the file yaml,
  • check the TOSCA syntax and types correction,
  • translate it into the MIT Alloy language,
  • generate .dot, .nwdiag and .plantuml templates.

Then to generate network diagrams, type:

generate_network_diagrams nwdiag/*.nwdiag  

Network diagram example

To get TOSCA diagrams, use the command:

generate_tosca_diagrams tosca_diagrams/*.dot  

TOSCA diagram example

And to generate UML diagrams:

generate_uml2_diagrams uml2/*.plantuml  

UML diagram example

cloudnet-tosca-toolbox's People

Contributors

jlcoulin avatar philippemerle avatar fredkgit avatar xfmoulet avatar karggit avatar ybe-orange avatar yffick avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.