clean up some sphinx warnings
[dcaegen2.git] / docs / sections / services / kpi-computation-ms / configuration.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Configuration
5 =============
6
7 KPI Computation MS expects to be able to fetch configuration in following JSON format:
8
9 .. code-block:: json
10
11     {
12       "pollingInterval": 20,
13       "aafUsername": "dcae@dcae.onap.org",
14       "streams_publishes": {
15         "kpi_topic": {
16           "type": "message-router",
17           "dmaap_info": {
18             "topic_url": "https://message-router.onap.svc.cluster.local:3905/events/unauthenticated.DCAE_KPI_OUTPUT"
19           }
20         }
21       },
22       "trust_store_pass_path": "/opt/app/kpims/etc/cert/trust.pass",
23       "cid": "kpi-cid",
24       "cg": "kpi-cg",
25       "streams_subscribes": {
26         "performance_management_topic": {
27           "aaf_password": "demo123456!",
28           "type": "message-router",
29           "dmaap_info": {
30             "topic_url": "https://message-router.onap.svc.cluster.local:3905/events/org.onap.dmaap.mr.PERFORMANCE_MEASUREMENTS"
31           },
32           "aaf_username": "dcae@dcae.onap.org"
33         }
34       },
35       "trust_store_path": "/opt/app/kpims/etc/cert/trust.jks",
36       "pollingTimeout": 60,
37       "cbsPollingInterval": 60,
38       "aafPassword": "demo123456!",
39       "kpi.policy": "{\"domain\":\"measurementsForKpi\",\"methodForKpi\":[{\"eventName\":\"perf3gpp_CORE-AMF_pmMeasResult\",\"controlLoopSchemaType\":\"SLICE\",\"policyScope\":\"resource=networkSlice;type=configuration\",\"policyName\":\"configuration.dcae.microservice.kpi-computation\",\"policyVersion\":\"v0.0.1\",\"kpis\":[{\"measType\":\"AMFRegNbr\",\"operation\":\"SUM\",\"operands\":\"RM.RegisteredSubNbrMean\"}]},{\"eventName\":\"perf3gpp_AcmeNode-Acme_pmMeasResult\",\"controlLoopSchemaType\":\"SLICE\",\"policyScope\":\"resource=networkSlice;type=configuration\",\"policyName\":\"configuration.dcae.microservice.kpi-computation\",\"policyVersion\":\"v0.0.1\",\"kpis\":[{\"measType\":\"UpstreamThr\",\"operation\":\"SUM\",\"operands\":\"GTP.InDataOctN3UPF\"},{\"measType\":\"DownstreamThr\",\"operation\":\"SUM\",\"operands\":\"GTP.OutDataOctN3UPF\"}]}]}",
40       "dmaap.server": ["message-router"]
41     }
42
43 During ONAP OOM/Kubernetes deployment this configuration is created from Helm chart based on properties defined under **applicationConfig** section.