Skip to content
Snippets Groups Projects
Commit af59d5dd authored by Michael Boniface's avatar Michael Boniface
Browse files

Update AlertsConfiguration.md

parent 830a0750
No related branches found
No related tags found
No related merge requests found
......@@ -21,25 +21,29 @@
// 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
This document outlines the TOSCA alert specificatio used to configure of 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 **triggers**. Full definitions and
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 an alert configuration
document will look like:
......@@ -88,7 +92,7 @@ triggers:
##### 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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment