00cf73fac6b3463d21e554f29ebd7b6d9ec674e8
[dcaegen2/analytics/tca-gen2.git] / dcae-analytics / dpo / tcagen2_spec.json
1 {
2   "self": {
3     "name": "docker-tcagen2",
4     "version": "1.0.0",
5     "description": "TCAGen2 Docker Application",
6     "component_type": "docker"
7   },
8   "streams": {
9     "subscribes": [
10       {
11         "config_key": "tca_handle_in",
12         "format": "VES_specification",
13         "version": "5.28.4",
14         "type": "message_router"
15       }
16     ],
17     "publishes": [
18       {
19         "config_key": "tca_handle_out",
20         "format": "DCAE_CL_Output",
21         "version": "1.0.1",
22         "type": "message_router"
23       }
24     ]
25   },
26   "services": {
27     "calls": [
28       {
29         "config_key": "aai_broker_handle",
30         "verb": "GET",
31         "request": {
32           "format": "tca.aai",
33           "version": "1.0.0"
34         },
35         "response": {
36           "format": "tca.aai",
37           "version": "1.0.0"
38         }
39       }
40     ],
41     "provides": []
42   },
43   "auxilary": {
44     "healthcheck": {
45       "type": "http",
46       "interval": "30s",
47       "timeout": "10s",
48       "endpoint": "/actuator/health"
49     },
50     "ports": [
51       "9091:0"
52     ],
53     "log_info": {
54         "log_directory": "/opt/logs/dcae-analytics-tca"
55      },
56     "tls_info":{
57         "cert_directory":"/opt/app/dcae-certificate/",
58         "use_tls":true
59      }
60   },
61   "artifacts": [
62     {
63       "uri": "nexus3.onap.org:10001/onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.0",
64       "type": "docker image"
65     }
66   ],
67   "parameters": [
68     {
69       "name": "spring.data.mongodb.uri",
70       "value": "mongodb://dcae-mongohost/dcae-tcagen2",
71       "description": "Mongodb database uri",
72       "designer_editable": true,
73       "sourced_at_deployment": true,
74       "policy_editable": false,
75       "type": "string",
76       "required": true
77     },
78     {
79       "name": "tca.policy",
80       "value" : "{\"domain\":\"measurementsForVfScaling\",\"metricsPerEventName\":[{\"eventName\":\"vFirewallBroadcastPackets\",\"controlLoopSchemaType\":\"VM\",\"policyScope\":\"DCAE\",\"policyName\":\"DCAE.Config_tca-hi-lo\",\"policyVersion\":\"v0.0.1\",\"thresholds\":[{\"closedLoopControlName\":\"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsDelta\",\"thresholdValue\":300,\"direction\":\"LESS_OR_EQUAL\",\"severity\":\"MAJOR\",\"closedLoopEventStatus\":\"ONSET\"},{\"closedLoopControlName\":\"ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsDelta\",\"thresholdValue\":700,\"direction\":\"GREATER_OR_EQUAL\",\"severity\":\"CRITICAL\",\"closedLoopEventStatus\":\"ONSET\"}]},{\"eventName\":\"vLoadBalancer\",\"controlLoopSchemaType\":\"VM\",\"policyScope\":\"DCAE\",\"policyName\":\"DCAE.Config_tca-hi-lo\",\"policyVersion\":\"v0.0.1\",\"thresholds\":[{\"closedLoopControlName\":\"ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedTotalPacketsDelta\",\"thresholdValue\":300,\"direction\":\"GREATER_OR_EQUAL\",\"severity\":\"CRITICAL\",\"closedLoopEventStatus\":\"ONSET\"}]},{\"eventName\":\"Measurement_vGMUX\",\"controlLoopSchemaType\":\"VNF\",\"policyScope\":\"DCAE\",\"policyName\":\"DCAE.Config_tca-hi-lo\",\"policyVersion\":\"v0.0.1\",\"thresholds\":[{\"closedLoopControlName\":\"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value\",\"thresholdValue\":0,\"direction\":\"EQUAL\",\"severity\":\"MAJOR\",\"closedLoopEventStatus\":\"ABATED\"},{\"closedLoopControlName\":\"ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.additionalMeasurements[*].arrayOfFields[0].value\",\"thresholdValue\":0,\"direction\":\"GREATER\",\"severity\":\"CRITICAL\",\"closedLoopEventStatus\":\"ONSET\"}]}]}",
81       "description": "Threshold Crossing Alert Policy JSON as string",
82       "designer_editable": false,
83       "sourced_at_deployment": false,
84       "policy_editable": true,
85       "type": "string",
86       "required": true
87     },
88     {
89       "name": "tca.processing_batch_size",
90       "value": 10000,
91       "description": "Batch size for TCA Application Transaction",
92       "designer_editable": true,
93       "sourced_at_deployment": false,
94       "policy_editable": false,
95       "type": "number",
96       "required": false
97     },
98     {
99       "name": "tca.enable_abatement",
100       "value": "true",
101       "description": "Enables / Disables TCA Alerts Abatement",
102       "designer_editable": true,
103       "sourced_at_deployment": false,
104       "policy_editable": false,
105       "type": "boolean",
106       "required": false
107     },
108     {
109       "name": "tca.enable_ecomp_logging",
110       "value": "true",
111       "description": "Enables / Disables ECOMP Logging",
112       "designer_editable": true,
113       "sourced_at_deployment": false,
114       "policy_editable": false,
115       "type": "boolean",
116       "required": false
117     },
118     {
119       "name": "tca.aai.enable_enrichment",
120       "value": "true",
121       "description": "Enables / Disables TCA A&AI Enrichment",
122       "designer_editable": true,
123       "sourced_at_deployment": true,
124       "policy_editable": false,
125       "type": "boolean",
126       "required": false
127     },
128     {
129       "name": "tca.aai.url",
130       "value": "http://aai.onap.svc.cluster.local",
131       "description": "A&AI Enrichment Service URL. Required only if A&AI Enrichment is enabled",
132       "designer_editable": true,
133       "sourced_at_deployment": true,
134       "policy_editable": false,
135       "type": "string",
136       "required": false
137     },
138     {
139       "name": "tca.aai.username",
140       "value": "DCAE",
141       "description": "A&AI Enrichment Service basic authentication user name",
142       "designer_editable": true,
143       "sourced_at_deployment": true,
144       "policy_editable": false,
145       "type": "string",
146       "required": false
147     },
148     {
149       "name": "tca.aai.password",
150       "value": "DCAE",
151       "description": "A&AI Enrichment Service basic authentication user password",
152       "designer_editable": true,
153       "sourced_at_deployment": true,
154       "policy_editable": false,
155       "type": "string",
156       "required": false
157     },
158     {
159       "name": "tca.aai.generic_vnf_path",
160       "value": "aai/v11/network/generic-vnfs/generic-vnf",
161       "description": "A&AI Enrichment Service VNF query endpoint path",
162       "designer_editable": true,
163       "sourced_at_deployment": false,
164       "policy_editable": false,
165       "type": "string",
166       "required": false
167     },
168     {
169       "name": "tca.aai.node_query_path",
170       "value": "aai/v11/search/nodes-query",
171       "description": "A&AI Enrichment Service Node query endpoint path",
172       "designer_editable": true,
173       "sourced_at_deployment": false,
174       "policy_editable": false,
175       "type": "string",
176       "required": false
177     },
178     {
179       "name": "streams_subscribes.tca_handle_in.consumer_group",
180       "value": "cg1",
181       "description": "Subscriber consumer group",
182       "designer_editable": true,
183       "sourced_at_deployment": false,
184       "policy_editable": false,
185       "type": "string",
186       "required": false
187     },
188     {
189       "name": "streams_subscribes.tca_handle_in.consumer_ids[0]",
190       "value": "c0",
191       "description": "Subscriber first consumer id",
192       "designer_editable": true,
193       "sourced_at_deployment": false,
194       "policy_editable": false,
195       "type": "string",
196       "required": false
197     },
198     {
199       "name": "streams_subscribes.tca_handle_in.consumer_ids[1]",
200       "value": "c1",
201       "description": "Subscriber second consumer id",
202       "designer_editable": true,
203       "sourced_at_deployment": false,
204       "policy_editable": false,
205       "type": "string",
206       "required": false
207     },
208     {
209       "name": "streams_subscribes.tca_handle_in.message_limit",
210       "value": 50000,
211       "description": "Maximum message fetched by TCA Subscriber",
212       "designer_editable": true,
213       "sourced_at_deployment": false,
214       "policy_editable": false,
215       "type": "number",
216       "required": true
217     },
218     {
219       "name": "streams_subscribes.tca_handle_in.timeout",
220       "value": -1,
221       "description": "Timeout for TCA Subscriber",
222       "designer_editable": true,
223       "sourced_at_deployment": false,
224       "policy_editable": false,
225       "type": "number",
226       "required": false
227     },
228     {
229       "name": "streams_subscribes.tca_handle_in.polling.fixed_rate",
230       "value": 0,
231       "description": "Subscriber fixed polling interval in milliseconds. Value of 0 indicated auto adjusting polling will be used",
232       "designer_editable": true,
233       "sourced_at_deployment": false,
234       "policy_editable": false,
235       "type": "number",
236       "required": false
237     },
238     {
239       "name": "streams_subscribes.tca_handle_in.polling.auto_adjusting.min",
240       "value": 30000,
241       "description": "Subscriber Auto Adjusting polling minimum interval in milliseconds",
242       "designer_editable": true,
243       "sourced_at_deployment": false,
244       "policy_editable": false,
245       "type": "number",
246       "required": false
247     },
248     {
249       "name": "streams_subscribes.tca_handle_in.polling.auto_adjusting.step_up",
250       "value": 10000,
251       "description": "Subscriber Auto Adjusting polling step up delta in milliseconds when message is not found",
252       "designer_editable": true,
253       "sourced_at_deployment": false,
254       "policy_editable": false,
255       "type": "number",
256       "required": false
257     },
258     {
259       "name": "streams_subscribes.tca_handle_in.polling.auto_adjusting.max",
260       "value": 60000,
261       "description": "Subscriber Auto Adjusting polling maximum interval in milliseconds",
262       "designer_editable": true,
263       "sourced_at_deployment": false,
264       "policy_editable": false,
265       "type": "number",
266       "required": false
267     },
268     {
269       "name": "streams_subscribes.tca_handle_in.polling.auto_adjusting.step_down",
270       "value": 30000,
271       "description": "Subscriber Auto Adjusting polling step down delta in milliseconds when message is found",
272       "designer_editable": true,
273       "sourced_at_deployment": false,
274       "policy_editable": false,
275       "type": "number",
276       "required": false
277     }
278   ]
279 }