bb16f78280
This patch provides the following User guide and API documentation updates (fixes) in Tacker Antelope. User doc: * Update current support v2 API operation status in the cli doc. * Fix the settings of "vimConnectionInfo". * Add vimType "ETSINFV.KUBERNETES.V_1" to the samples of "vimConnectionInfo". API doc: * Fix the misdescription of VNF LCM Interface v2. * Fix the misdescription of VNF FM Interface v1. * Fix the misdescription of VNF PM Interface v2. * Fix the format of request parameters in Prometheus Plugin Interface and Fault Notification Interface. Implements: blueprint enhance-change-package Implements: blueprint support-auto-lcm Co-Author: Taiki Kimura <taiki.kimura@ntt-at.co.jp> Change-Id: I50c130d5de812efac631ed8ad1432a98a9d00e6c
152 lines
3.4 KiB
ReStructuredText
152 lines
3.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
===========================
|
|
Prometheus Plugin Interface
|
|
===========================
|
|
|
|
This interface is used for notifying alert that is detected by
|
|
the External Monitoring Tool. The External Monitoring Tool is
|
|
Prometheus based Monitoring system.
|
|
|
|
The Prometheus Plugin has 3 functions:
|
|
|
|
- Alerting interface for ETSI NFV-SOL 002/003 based Performance Management.
|
|
- Alerting interface for ETSI NFV-SOL 002/003 based Fault Management.
|
|
- Alerting interface for Prometheus Plugin AutoScaling.
|
|
|
|
Alerting interface for ETSI NFV-SOL 002/003 based Performance Management
|
|
========================================================================
|
|
|
|
.. rest_method:: POST /pm_event
|
|
|
|
Alert Tacker when one or more Performance values are obtained.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 204
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 404: prometheus_plugin_pm
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
.. rest_parameters:: parameters_prometheus_plugin.yaml
|
|
|
|
- alert: alert
|
|
- status: status
|
|
- labels: labels
|
|
- receiver_type: receiver_type
|
|
- function_type: function_type_pm
|
|
- job_id: job_id
|
|
- object_instance_id: object_instance_id
|
|
- sub_object_instance_id: sub_object_instance_id
|
|
- metric: metric
|
|
- annotations: annotations
|
|
- value: value
|
|
- startsAt: startsAt
|
|
- endsAt: endsAt
|
|
- fingerprint: fingerprint
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/prometheus_plugin/alert_pm.json
|
|
:language: javascript
|
|
|
|
|
|
Alerting interface for ETSI NFV-SOL 002/003 based Fault Management
|
|
==================================================================
|
|
|
|
.. rest_method:: POST /alert
|
|
|
|
Alert Tacker when one or more Fault event are obtained.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 204
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 404: prometheus_plugin_fm
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
.. rest_parameters:: parameters_prometheus_plugin.yaml
|
|
|
|
- alert: alert
|
|
- status: status
|
|
- labels: labels
|
|
- receiver_type: receiver_type
|
|
- function_type: function_type_fm
|
|
- vnf_instance_id: vnf_instance_id
|
|
- pod: pod
|
|
- perceived_severity: perceived_severity
|
|
- event_type: event_type
|
|
- annotations: annotations
|
|
- probable_cause: probable_cause
|
|
- fault_type: fault_type
|
|
- fault_details: fault_details
|
|
- startsAt: startsAt
|
|
- endsAt: endsAt
|
|
- fingerprint: fingerprint
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/prometheus_plugin/alert_fm.json
|
|
:language: javascript
|
|
|
|
Alerting interface for Prometheus Plugin AutoScaling
|
|
====================================================
|
|
|
|
.. rest_method:: POST /alert
|
|
|
|
Alert Tacker when scaling should be performed.
|
|
|
|
Response Codes
|
|
--------------
|
|
|
|
.. rest_status_code:: success status.yaml
|
|
|
|
- 204
|
|
|
|
.. rest_status_code:: error status.yaml
|
|
|
|
- 400
|
|
- 404: prometheus_plugin_auto_scale
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
.. rest_parameters:: parameters_prometheus_plugin.yaml
|
|
|
|
- alert: alert
|
|
- status: status
|
|
- labels: labels
|
|
- receiver_type: receiver_type
|
|
- function_type: function_type_auto_scale
|
|
- vnf_instance_id: vnf_instance_id
|
|
- auto_scale_type: auto_scale_type
|
|
- aspect_id: aspect_id
|
|
- annotations: annotations
|
|
- startsAt: startsAt
|
|
- endsAt: endsAt
|
|
- fingerprint: fingerprint
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/prometheus_plugin/alert_auto_scale.json
|
|
:language: javascript
|