summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/kpi-computation-ms
diff options
context:
space:
mode:
authorHansen, Tony (th1395) <th1395@att.com>2023-05-23 21:27:17 +0000
committerHansen, Tony (th1395) <th1395@att.com>2023-05-31 21:01:29 +0000
commit663df2c1b8d9176094a62b00b7e80de096180621 (patch)
tree849841dc428fcfba07d9c39494f95ccd1f25da8a /docs/sections/services/kpi-computation-ms
parentbcd436a1be4fbe2c8ad7ce074d86b94b8ff44f4e (diff)
clean up some sphinx warnings
Change-Id: I8c2d925e8b27b4740227af0be3ab5d6f7153ec38 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Issue-ID: DCAEGEN2-3399 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Diffstat (limited to 'docs/sections/services/kpi-computation-ms')
-rw-r--r--docs/sections/services/kpi-computation-ms/configuration.rst2
-rw-r--r--docs/sections/services/kpi-computation-ms/installation-helm.rst4
-rw-r--r--docs/sections/services/kpi-computation-ms/kpi_computation_ms_overview.rst18
3 files changed, 17 insertions, 7 deletions
diff --git a/docs/sections/services/kpi-computation-ms/configuration.rst b/docs/sections/services/kpi-computation-ms/configuration.rst
index 269fd16a..f17b0ee5 100644
--- a/docs/sections/services/kpi-computation-ms/configuration.rst
+++ b/docs/sections/services/kpi-computation-ms/configuration.rst
@@ -7,6 +7,7 @@ Configuration
KPI Computation MS expects to be able to fetch configuration in following JSON format:
.. code-block:: json
+
{
"pollingInterval": 20,
"aafUsername": "dcae@dcae.onap.org",
@@ -40,4 +41,3 @@ KPI Computation MS expects to be able to fetch configuration in following JSON f
}
During ONAP OOM/Kubernetes deployment this configuration is created from Helm chart based on properties defined under **applicationConfig** section.
-
diff --git a/docs/sections/services/kpi-computation-ms/installation-helm.rst b/docs/sections/services/kpi-computation-ms/installation-helm.rst
index be43234f..87286baa 100644
--- a/docs/sections/services/kpi-computation-ms/installation-helm.rst
+++ b/docs/sections/services/kpi-computation-ms/installation-helm.rst
@@ -52,7 +52,7 @@ Deployment steps
- Update monitoring policy ID in below configuration which is used to enable Policy-Sync Side car container to be deployed and retrieves active policy configuration.
- .. code-block :: bash
+ .. code-block :: yaml
dcaePolicySyncImage: onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1
policies:
@@ -61,7 +61,7 @@ Deployment steps
- Enable KPI MS component in oom/kubernetes/dcaegen2-services/values.yaml
- .. code-block:: bash
+ .. code-block:: yaml
dcae-kpi-ms:
enabled: true
diff --git a/docs/sections/services/kpi-computation-ms/kpi_computation_ms_overview.rst b/docs/sections/services/kpi-computation-ms/kpi_computation_ms_overview.rst
index 9e733e0f..d02e8c73 100644
--- a/docs/sections/services/kpi-computation-ms/kpi_computation_ms_overview.rst
+++ b/docs/sections/services/kpi-computation-ms/kpi_computation_ms_overview.rst
@@ -1,5 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0
- International License. http://creativecommons.org/licenses/by/4.0
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
.. _docs_kpi_computation_ms_overview:
@@ -10,7 +10,7 @@ Introduction
Subscribe original PM data from DMaaP.
Do KPI computation based on KPI formula which can be got from config policies and the formula can be configued dynamically.
Publish KPI results on DMaaP.
- Receive request for specific KPI computation (future scope) on specific ‘objects’ (e.g., S-NSSAI, Service).
+ Receive request for specific KPI computation (future scope) on specific 'objects' (e.g., S-NSSAI, Service).
Architecture
------------
@@ -35,6 +35,9 @@ Publish a file to the PM-Mapper using the following example curl:
curl -k -X PUT https://dcae-pm-mapper:8443/delivery/<filename> -H 'X-DMAAP-DR-META:{"productName": "AcmeNode","vendorName": "Acme","lastEpochMicrosec": "1538478000000","sourceName": "oteNB5309","startEpochMicrosec": "1538478900000","timeZoneOffset": "UTC+05:00","location": "ftpes://127.0.0.1:22/ftp/rop/A20161224.1045-1100.bin.gz","compression": "gzip","fileFormatType": "org.3GPP.32.435#measCollec","fileFormatVersion": "V9"}' -H "Content-Type:application/xml" --data-binary @<filename> -H 'X-ONAP-RequestID: 12345' -H 'X-DMAAP-DR-PUBLISH-ID: 12345'
Example type A file:
+
+.. code-block:: xml
+
<?xml version="1.0" encoding="utf-8"?>
<measCollecFile xmlns="http://www.3gpp.org/ftp/specs/archive/32_series/32.435#measCollec">
<fileHeader dnPrefix="www.google.com" vendorName="CMCC" fileFormatVersion="32.435 V10.0">
@@ -73,11 +76,17 @@ Example type A file:
</fileFooter>
</measCollecFile>
+
Curl the topic on Message Router to retrieve the published event:
+.. code-block::
+
curl -k https://message-router:3905/events/unauthenticated.DCAE_KPI_OUTPUT/$ConsumerGroup/$ID
Example message output:
+
+.. code-block:: json
+
{
"event": {
"commonEventHeader": {
@@ -121,6 +130,7 @@ Example message output:
}
}
+
Interaction
"""""""""""
-Kpi Computation MS interacts with the Config Binding Service to get configuration information. \ No newline at end of file
+Kpi Computation MS interacts with the Config Binding Service to get configuration information.