dcae-analytics/dpo/tca/tca_spec.json

   1 {
   2   "self": {
   3     "name": "docker.tca",
   4     "version": "1.0.5",
   5     "description": "TCA 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": "TCA Alert Definition",
  21         "version": "1.0.0",
  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": "get_with_query_params",
  33           "version": "1.0.0"
  34         },
  35         "response": {
  36           "format": "aai_broker_response",
  37           "version": "3.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   },
  51   "artifacts": [
  52     {
  53       "uri": "docker_repository.com:5100/org.onap.dcae.analytics/dcae-analytics-web:1.0",
  54       "type": "docker image"
  55     }
  56   ],
  57   "parameters": [
  58     {
  59       "name": "spring.mongodb.uri",
  60       "value": "mongodb://localhost:27017/analytics-tca",
  61       "description": "Mongodb database uri",
  62       "designer_editable": true,
  63       "sourced_at_deployment": true,
  64       "policy_editable": false,
  65       "type": "string",
  66       "required": true
  67     },
  68     {
  69       "name": "tca.policy",
  70       "value": "{\"domain\":\"measurementsForVfScaling\",\"metricsPerEventName\":[{\"eventName\":\"Mfvs_eNodeB_RANKPI\",\"controlLoopSchemaType\":\"VNF\",\"policyScope\":\"resource=vFirewall;type=configuration\",\"policyName\":\"configuration.dcae.microservice.tca.xml\",\"policyVersion\":\"v0.0.1\",\"thresholds\":[{\"closedLoopControlName\":\"CL-FRWL-LOW-TRAFFIC-SIG-d925ed73-8231-4d02-9545-db4e101f88f8\",\"closedLoopEventStatus\":\"ONSET\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated\",\"thresholdValue\":4000,\"direction\":\"LESS_OR_EQUAL\",\"severity\":\"MAJOR\"},{\"closedLoopControlName\":\"CL-FRWL-HIGH-TRAFFIC-SIG-EA36FE84-9342-5E13-A656-EC5F21309A09\",\"closedLoopEventStatus\":\"ONSET\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated\",\"thresholdValue\":20000,\"direction\":\"GREATER_OR_EQUAL\",\"severity\":\"CRITICAL\"},{\"closedLoopControlName\":\"CL-FRWL-HIGH-TRAFFIC-SIG-EA36FE84-9342-5E13-A656-EC5F21309A09\",\"closedLoopEventStatus\":\"ABATED\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated\",\"thresholdValue\":0,\"direction\":\"EQUAL\",\"severity\":\"CRITICAL\"}]},{\"eventName\":\"vLoadBalancer\",\"controlLoopSchemaType\":\"VNF\",\"policyScope\":\"resource=vLoadBalancer;type=configuration\",\"policyName\":\"configuration.dcae.microservice.tca.xml\",\"policyVersion\":\"v0.0.1\",\"thresholds\":[{\"closedLoopControlName\":\"CL-LBAL-LOW-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241AB1A\",\"closedLoopEventStatus\":\"ONSET\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated\",\"thresholdValue\":500,\"direction\":\"LESS_OR_EQUAL\",\"severity\":\"MAJOR\"},{\"closedLoopControlName\":\"CL-LBAL-LOW-TRAFFIC-SIG-0C5920A6-B564-8035-C878-0E814352BC2B\",\"closedLoopEventStatus\":\"ONSET\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated\",\"thresholdValue\":5000,\"direction\":\"GREATER_OR_EQUAL\",\"severity\":\"CRITICAL\"}]},{\"eventName\":\"virtualVMEventName\",\"controlLoopSchemaType\":\"VM\",\"policyScope\":\"resource=virtualVM;type=configuration\",\"policyName\":\"configuration.dcae.microservice.tca.xml\",\"policyVersion\":\"v0.0.1\",\"thresholds\":[{\"closedLoopControlName\":\"CL-LBAL-LOW-TRAFFIC-SIG-FB480F95-A453-6F24-B767-FD703241AB1A\",\"closedLoopEventStatus\":\"ONSET\",\"version\":\"1.0.2\",\"fieldPath\":\"$.event.measurementsForVfScalingFields.vNicPerformanceArray[*].receivedBroadcastPacketsAccumulated\",\"thresholdValue\":500,\"direction\":\"LESS_OR_EQUAL\",\"severity\":\"MAJOR\"}]}]}",
  71       "description": "Threshold Crossing Alert Policy JSON as string",
  72       "designer_editable": false,
  73       "sourced_at_deployment": false,
  74       "policy_editable": true,
  75       "type": "string",
  76       "required": true
  77     },
  78     {
  79       "name": "tca.processing_batch_size",
  80       "value": 10000,
  81       "description": "Batch size for TCA Application Transaction",
  82       "designer_editable": true,
  83       "sourced_at_deployment": false,
  84       "policy_editable": false,
  85       "type": "number",
  86       "required": false
  87     },
  88     {
  89       "name": "tca.enable_abatement",
  90       "value": true,
  91       "description": "Enables / Disables TCA Alerts Abatement",
  92       "designer_editable": true,
  93       "sourced_at_deployment": false,
  94       "policy_editable": false,
  95       "type": "boolean",
  96       "required": false
  97     },
  98     {
  99       "name": "tca.enable_ecomp_logging",
 100       "value": true,
 101       "description": "Enables / Disables ECOMP Logging",
 102       "designer_editable": true,
 103       "sourced_at_deployment": false,
 104       "policy_editable": false,
 105       "type": "boolean",
 106       "required": false
 107     },
 108     {
 109       "name": "tca.aai.enable_enrichment",
 110       "value": false,
 111       "description": "Enables / Disables TCA A&AI Enrichment",
 112       "designer_editable": true,
 113       "sourced_at_deployment": true,
 114       "policy_editable": false,
 115       "type": "boolean",
 116       "required": false
 117     },
 118     {
 119       "name": "tca.aai.url",
 120       "value": "http://localhost:8443",
 121       "description": "A&AI Enrichment Service URL. Required only if A&AI Enrichment is enabled",
 122       "designer_editable": true,
 123       "sourced_at_deployment": true,
 124       "policy_editable": false,
 125       "type": "string",
 126       "required": false
 127     },
 128     {
 129       "name": "tca.aai.username",
 130       "value": "DCAE",
 131       "description": "A&AI Enrichment Service basic authentication user name",
 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.password",
 140       "value": "DCAE",
 141       "description": "A&AI Enrichment Service basic authentication user password",
 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.generic_vnf_path",
 150       "value": "aai/v11/network/generic-vnfs/generic-vnf",
 151       "description": "A&AI Enrichment Service VNF query endpoint path",
 152       "designer_editable": true,
 153       "sourced_at_deployment": false,
 154       "policy_editable": false,
 155       "type": "string",
 156       "required": false
 157     },
 158     {
 159       "name": "tca.aai.node_query_path",
 160       "value": "aai/v11/search/nodes-query",
 161       "description": "A&AI Enrichment Service Node 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": "streams_subscribes.tca_handle_in.consumer_group",
 170       "value": "cg1",
 171       "description": "Subscriber consumer group",
 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_ids[0]",
 180       "value": "c0",
 181       "description": "Subscriber first consumer id",
 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[1]",
 190       "value": "c1",
 191       "description": "Subscriber second 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.message_limit",
 200       "value": 50000,
 201       "description": "Maximum message fetched by TCA Subscriber",
 202       "designer_editable": true,
 203       "sourced_at_deployment": false,
 204       "policy_editable": false,
 205       "type": "number",
 206       "required": true
 207     },
 208     {
 209       "name": "streams_subscribes.tca_handle_in.timeout",
 210       "value": -1,
 211       "description": "Timeout for TCA Subscriber",
 212       "designer_editable": true,
 213       "sourced_at_deployment": false,
 214       "policy_editable": false,
 215       "type": "number",
 216       "required": false
 217     },
 218     {
 219       "name": "streams_subscribes.tca_handle_in.polling.fixedRate",
 220       "value": 0,
 221       "description": "Subscriber fixed polling interval in milliseconds. Value of 0 indicated auto adjusting polling will be used",
 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.auto_adjusting.min",
 230       "value": 30000,
 231       "description": "Subscriber Auto Adjusting polling minimum interval in milliseconds",
 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.step_up",
 240       "value": 10000,
 241       "description": "Subscriber Auto Adjusting polling step up delta in milliseconds when message is not found",
 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.max",
 250       "value": 60000,
 251       "description": "Subscriber Auto Adjusting polling maximum interval in milliseconds",
 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.step_down",
 260       "value": 30000,
 261       "description": "Subscriber Auto Adjusting polling step down delta in milliseconds when message is found",
 262       "designer_editable": true,
 263       "sourced_at_deployment": false,
 264       "policy_editable": false,
 265       "type": "number",
 266       "required": false
 267     }
 268   ]
 269 }