ditrit / workflows

Workflow module. Builds RETE like rule-engine from TOSCA workflow definitions.

workflows

This is a very first implementation for a TOSCA 1.1 engine built to handle explicit workflows.

The purpose is to implement TOSCA declarative workflows defined at node type and relationship type level as described in the OASIS normative document TOSCA Simple Profile in YAML Version 1.1.

Workflow definition is parsed into a simple rule based RETE like engine. Engine uses a set of workers which insert facts into RETE rules and execute operations. Workers are sateless and coordination is provided using LINDA coordination language primitives. Consul is used as storage backend (used for facts and RETE rules) and as the Tuple-Space used by workers. Artifacts for operations are stored into a S3 compatible storage backend.

A REST API is provided (at manager level) to manage TOSCA CSARs, models, instances and execute workflows

Resiliency and high availibility

• Linda coordination provides distribution of operations whatever the number of workers.
• Consul provides high availibility, resiliency and coherency at Space level.

The example

• Workflows implemented are standard `install and uninstall TOSCA workflow as defined in § "7.4.2 Weaving improvements" of the normative document.
• The Model used as exemple describe connections between 4 nodes (`A-->B B-->D D-->C and A -->C ), each one node being hosted onto an other node (A is hosted on srvA, B is hosted on srvB, C is hosted on srvC and D is hosted on D).
• Default scaling is used on several nodes. 19 real nodes are built when the 'install' workflow is executed for an instance of the model.

Running the example

1. Prerequisite :
   • An up and running Linux OS with ansible 2.3, lxc and libvirtd installed (tested with Redhat 7 and Ubuntu 16.10)
   • python2-lxc is a requirement for the lxc-container module of ansible. If it is not packaged for your distrib, you have to build it from github: python2-lxc repository
2. Installation :
   • Clone the repository :

     git clone https://github.com/ditrit/workflows.git

   • Go into the install directory.
   • Adapt the inventory hosts file with adequate ip addresses.
   • Install ditrit as root :

     utils/ansible-deploy.sh

3. Use Ditrit:
   • Go into one of the manager containers :

     lxc-attach -n manager1

   • Upload a CSAR archive and provide a name for the model :

     curl -X PUT "http://localhost:5000/csar?model=un_model" -F "file=@example/appli.zip"

   • Instanciate a deployment from the model :

     curl -X PUT "http://localhost:5000/instance?model=un_model&name=une_instance"

   • Execute a workflow :

     curl -X PUT "http://localhost:5000/exec?model=un_model&instance=une_instance&workflow=install"

   • Watch execution on each workflow worker

     tail -f /opt/execs

   • Swagger API documentation (minimalist...) is available from root url (http://localhost:5000)
4. Destroy, stop or start workers or consul server members during execution and verify it's still working.

Caution

This project is not production ready at all and has not been tested. The API may change at each commit.