diff --git a/docs/AlertsConfiguration.md b/docs/AlertsConfiguration.md index 72a83acac03f7de0b07bb7255195f8a0c132b5d9..ab7a1e9bf04d809dcf7a2fed48727f2a76393a91 100644 --- a/docs/AlertsConfiguration.md +++ b/docs/AlertsConfiguration.md @@ -21,26 +21,28 @@ // Created for Project : FLAME --> -# **FLAME - Alerts Configuration** +# **FLAME - TOSCA Alerts Specification** #### **Authors** |Authors|Organisation| |:---:|:---:| |[Nikolay Stanchev](mailto:ns17@it-innovation.soton.ac.uk)|[University of Southampton, IT Innovation Centre](http://www.it-innovation.soton.ac.uk)| - +|[Michael Boniface](mailto:mjb@it-innovation.soton.ac.uk)|[University of Southampton, IT Innovation Centre](http://www.it-innovation.soton.ac.uk)| #### Description -This document outlines the configuration of alerts within CLMC. Alerts are configured through a YAML-based -TOSCA-compliant document. This document is passed to the CLMC service, which parses and validates the document. Subsequently, -the CLMC service creates and activates the alerts within Kapacitor, then registers the HTTP alert handlers specified in the document. +This document outlines the TOSCA alert specification used to configure alerts within CLMC. Alerts are configured through a YAML-based +TOSCA-compliant document according to the TOSCA simple profile. This document is passed to the CLMC service, which parses and validates the document. Subsequently, the CLMC service +creates and activates the alerts within Kapacitor, then registers the HTTP alert handlers specified in the document. +The specification is compliant with the TOSCA policy template as implemented by the Openstack tosca parser. See an example below: +https://github.com/openstack/tosca-parser/blob/master/toscaparser/tests/data/policies/tosca_policy_template.yaml -#### TOSCA Alerts Configuration Document +#### TOSCA Alerts Specification Document -The TOSCA Alerts Configuration Document consists of two main sections - **metadata** and **policies**. Full definitions and -clarification of the structure of the document is given in the following sections. An example of a valid alert configuration +The TOSCA Alerts Specification Document consists of two main sections - **metadata** and **triggers**. Full definitions and +clarification of the structure of the document is given in the following sections. An example of a valid alert specification document will look like: ```yaml @@ -104,7 +106,7 @@ topology_template: ##### Metadata The ***metadata*** section specifies the service function chain ID and the service function chain instance ID, for which this -alerts configuration relates to. The format is the following: +alerts specification relates to. The format is the following: ```yaml metadata: