Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
F
flame-clmc
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
flame
flame-clmc
Commits
65e14843
Commit
65e14843
authored
6 years ago
by
Nikolay Stanchev
Browse files
Options
Downloads
Patches
Plain Diff
Updates CLMC service documentation
parent
4f31d268
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/clmc-service.md
+8
-6
8 additions, 6 deletions
docs/clmc-service.md
with
8 additions
and
6 deletions
docs/clmc-service.md
+
8
−
6
View file @
65e14843
...
...
@@ -47,20 +47,20 @@ configuration files of the service can be found in the **src/service** folder.
* Request:
Expects a YAML-formatted file in the request
body
referenced with ID *alert-spec* representing the alert specification
Expects a YAML-formatted file in the request referenced with ID
**
*alert-spec*
**
representing the alert specification
document. This document is then parsed with the openstack TOSCA parser (https://github.com/openstack/tosca-parser/tree/master/toscaparser)
and validated against the CLMC alerts specification schema.
and validated against the CLMC alerts specification schema
(again check [documentation](AlertsSpecification.md) for more info on this)
.
*
Request e
xample for sending
such
request with curl:
*
E
xample for sending
a
request with curl:
`curl -F "alert-spec=@alert-specification.yaml" http://loclahost:9080/alerts`
where **alert-specification.yaml** is the path to the specification file.
where **alert-specification.yaml** is the path to the
alerts
specification file.
* Response:
The response of this request is a JSON-formatted content, which contains the SFC and SFC instance identifiers
from the alert specification along with errors encountered when interacting with Kapacitor.
from the alert specification along with
any
errors encountered when interacting with Kapacitor.
Returns a 400 Bad Request if the request does not contain a yaml file referenced with ID **alert-spec**.
...
...
@@ -81,7 +81,9 @@ configuration files of the service can be found in the **src/service** folder.
```
If the CLMC service encounters any errors when creating alerts and handlers in Kapacior, they will
be reported in the response as two lists of error objects (one for alert tasks and one for alert handlers):
be reported in the response as two lists of error objects. The **triggers_specification_errors** list contains
any errors encountered while trying to create the alert tasks; the **triggers_action_errors** list contains
any errors encountered while trying to subscribe the HTTP handlers to the created tasks.
```json
{
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment