A REST API for analysing and planning the management of TOSCA YAML apps, based on management protocols
After cloning the repository of the management analyser, please move to the corresponding folder and issue the following commands:
mvn clean install(to build the service)java -jar target\management-analyser-ws-0.1.jar server config.yml(to run the service)
Once the management analyser is running, it can be used as follows.
An application app can be added to those managed by the management analyser by issuing
- a POST request to the
{host}/mmendpoint, - whose body is the TOSCA yaml specification of app (see POST-body for a concrete example).
IMPORTANT: The current version of the management analyser requires that each requirement of each node in a POSTed application must indicate both the node and the capability satisfying such requirement (please see the corresponding issue).
The current and target state of an application app previously added to the management analyser can be updated by issuing
- a PUT request to the
{host}/mm/appendpoint, - whose body is a JSON object specifying the
currentand/ortargetstate of each node forming app (see PUT-body for a concrete example).
Once the current and target state of an application app have been set, the management analyser permits retrieving the sequence of operations allowing app to move from the current state to the target one. Such a sequence can be retrieved by issuing
- a GET request to the
{host}/mm/app/planendpoint.
The body of the reply of such requests will be as that in GET-plan-reply
To retrieve a set of operations to be executed in parallel on app to update the current state to a state closer to the target state, please issue
- a GET request to the
{host}/mm/app/pstepsendpoint.
The body of the reply of such requests will be as that in GET-psteps-reply