X-Git-Url: https://gerrit.onap.org/r/gitweb?p=dcaegen2%2Fanalytics%2Ftca.git;a=blobdiff_plain;f=dpo%2FtcaSpec.json;h=8e69c068ea47300707b8131fbc8d71e9a47af8a2;hp=73276bb50a089505e3cd41eee8f542c3c7a9947e;hb=HEAD;hpb=4edf0fa48892bf38d0e3838d125e9bf2324b38e0 diff --git a/dpo/tcaSpec.json b/dpo/tcaSpec.json index 73276bb..8e69c06 100644 --- a/dpo/tcaSpec.json +++ b/dpo/tcaSpec.json @@ -1,7 +1,7 @@ { "self": { "name": "cdap.tca.hi.lo.app", - "version": "1.0.3", + "version": "1.0.5", "description": "cdap tca hi lo application", "component_type": "cdap" }, @@ -9,16 +9,16 @@ "subscribes": [ { "config_key": "tca_handle_in", - "format": "Common Event Format Definition", - "version": "25.0.0", + "format": "VES_specification", + "version": "5.28.4", "type": "message router" } ], "publishes": [ { "config_key": "tca_handle_out", - "format": "TCA Alert Definition", - "version": "1.0.0", + "format": "DCAE_CL_Output", + "version": "1.0.1", "type": "message router" } ] @@ -49,7 +49,7 @@ }, "artifacts": [ { - "uri": "${nexusproxy}/repository/dcae-dev-raw/jar_files/dcae-analytics-tca-2.0.0.jar", + "uri": "https://nexus.onap.org/service/local/repositories/staging/content/org/onap/dcaegen2/analytics/tca/dcae-analytics-cdap-tca/2.0.0/dcae-analytics-cdap-tca-2.0.0.jar", "type": "jar" } ], @@ -107,6 +107,36 @@ } ], "app_preferences": [ + { + "name" : "subscriberHostName", + "description" : "", + "value" : "HOSTNAME" + }, + { + "name" : "subscriberHostPort", + "description" : "", + "value" : 1234 + }, + { + "name" : "subscriberTopicName", + "description" : "", + "value" : "com.att.dcae.dmaap.mtnje2.DcaeTestVESSub" + }, + { + "name" : "subscriberProtocol", + "description" : "", + "value" : "https" + }, + { + "name" : "subscriberUserName", + "description" : "", + "value" : "USERNAME" + }, + { + "name" : "subscriberUserPassword", + "description" : "", + "value" : "PASSWORD" + }, { "name": "subscriberContentType", "description": "Subscriber Content Type", @@ -137,6 +167,36 @@ "description": "Subscriber Polling Interval in milliseconds", "value": 30000 }, + { + "name" : "publisherHostName", + "description" : "", + "value" : "HOSTNAME" + }, + { + "name" : "publisherHostPort", + "description" : "", + "value" : 1234 + }, + { + "name" : "publisherTopicName", + "description" : "", + "value" : "com.att.dcae.dmaap.mtnje2.DcaeTestVESPub" + }, + { + "name" : "publisherProtocol", + "description" : "", + "value" : "https" + }, + { + "name" : "publisherUserName", + "description" : "", + "value" : "USERNAME" + }, + { + "name" : "publisherUserPassword", + "description" : "", + "value" : "PASSWORD" + }, { "name": "publisherContentType", "description": "Publisher Content Type", @@ -159,152 +219,169 @@ }, { "name": "enableAlertCEFFormat", - "description": "", + "description": "Enable output alert to be in CEF Format", "value": "false" }, + { + "name": "enableAAIEnrichment", + "description": "Enable A&AI Enrichment of generated TCA Alerts", + "value": "true" + }, + { + "name": "aaiEnrichmentHost", + "description": "A&AI Enrichment API Host name", + "value": "123.123.123.123" + }, + { + "name": "aaiEnrichmentPortNumber", + "description": "A&AI Enrichment API Host port number", + "value": 8443 + }, + { + "name": "aaiEnrichmentProtocol", + "description": "A&AI Enrichment API protocol", + "value": "https" + }, + { + "name": "aaiEnrichmentUserName", + "description": "A&AI Enrichment API username", + "value": "USERNAME" + }, + { + "name": "aaiEnrichmentUserPassword", + "description": "A&AI Enrichment API password", + "value": "PASSWORD" + }, + { + "name": "aaiEnrichmentIgnoreSSLCertificateErrors", + "description": "A&AI Ignore SSL Certification Errors", + "value": "true" + }, + { + "name": "aaiVNFEnrichmentAPIPath", + "description": "A&AI VNF Enrichment API Path", + "value": "/aai/v11/network/generic-vnfs/generic-vnf" + }, + { + "name": "aaiVMEnrichmentAPIPath", + "description": "A&AI VM Enrichment API Path", + "value": "/aai/v11/search/nodes-query" + }, + { + "name": "aaiEnrichmentProxyURL", + "description": "A&AI Enrichment API Proxy URL", + "value": "URL" + }, { "name": "tca_policy", "description": "TCA Policy JSON", - "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\"}]}]}" - } - ], - "program_preferences": [], - "policy_schema": [ - { - "name": "domain", - "description": "Domain name to which TCA needs to be applied", - "type": "string", - "value": "measurementsForVfScaling", - "constraints": [ - { + "value":"{\"domain\":\"measurementsForVfScaling\",\"metricsPerEventName\":[{\"eventName\":\"vFirewallBroadcastPackets\",\"controlLoopSchemaType\":\"VNF\",\"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.vNicUsageArray[*].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.vNicUsageArray[*].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.vNicUsageArray[*].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\"}]}]}", + "policy_editable": true, + "policy_schema": [{ + "name": "domain", + "description": "Domain name to which TCA needs to be applied", + "type": "string", + "value": "measurementsForVfScaling", + "constraints": [{ "equal": "measurementsForVfScaling" - } - ] - }, - { - "name": "metricsPerEventName", - "description": "Contains eventName and threshold details that need to be applied to given eventName", - "type": "list", - "entry_schema": [ - { + }] + }, { + "name": "metricsPerEventName", + "description": "Contains eventName and threshold details that need to be applied to given eventName", + "type": "list", + "entry_schema": [{ "name": "eventName", "description": "Event name to which thresholds need to be applied", "type": "string", "value": "" - }, - { + }, { "name": "controlLoopSchemaType", "description": "Specifies Control Loop Schema Type for the event Name e.g. VNF, VM", "type": "string", "value": "", - "constraints": [ - { - "valid_value": [ - "VM", - "VNF" - ] - } - ] - }, - { + "constraints": [{ + "valid_values": ["VM", "VNF"] + }] + }, { "name": "policyScope", "description": "TCA Policy Scope", "type": "string", "value": "" - }, - { + }, { "name": "policyName", "description": "TCA Policy Scope Name", "type": "string", "value": "" - }, - { + }, { "name": "policyVersion", "description": "TCA Policy Scope Version", "type": "string", "value": "" - }, - { + }, { "name": "thresholds", "description": "Thresholds associated with eventName", "type": "list", - "entry_schema": [ - { - "name": "closedLoopControlName", - "description": "Closed Loop Control Name associated with the threshold", - "type": "string", - "value": "" - }, - { - "name": "version", - "description": "Version number associated with the threshold", - "type": "string", - "value": "" - }, - { - "name": "fieldPath", - "description": "Json field Path as per CEF message which needs to be analyzed for TCA", - "type": "string", - "value": "" - }, - { - "name": "thresholdValue", - "description": "Threshold value for the field Path inside CEF message", - "type": "number", - "value": "" - }, - { - "name": "direction", - "description": "Direction of the threshold", - "type": "string", - "value": "", - "constraints": [ - { - "valid_value": [ + "entry_schema": [{ + "name": "closedLoopControlName", + "description": "Closed Loop Control Name associated with the threshold", + "type": "string", + "value": "" + }, { + "name": "version", + "description": "Version number associated with the threshold", + "type": "string", + "value": "" + }, { + "name": "fieldPath", + "description": "Json field Path as per CEF message which needs to be analyzed for TCA", + "type": "string", + "value": "" + }, { + "name": "thresholdValue", + "description": "Threshold value for the field Path inside CEF message", + "type": "number", + "value": "" + }, { + "name": "direction", + "description": "Direction of the threshold", + "type": "string", + "value": "", + "constraints": [{ + "valid_values": [ "LESS", "LESS_OR_EQUAL", "GREATER", - "GREATER_OR_EQUAL" - ] - } + "GREATER_OR_EQUAL", + "EQUAL" ] - }, - { - "name": "closedLoopEventStatus", - "description": "Closed Loop Event Status of the threshold", - "type": "string", - "value": "", - "constraints": [ - { - "valid_value": [ - "ONSET", - "ABATED" - ] - } + }] + }, { + "name": "closedLoopEventStatus", + "description": "Closed Loop Event Status of the threshold", + "type": "string", + "value": "", + "constraints": [{ + "valid_values": ["ONSET", "ABATED"] + }] + }, { + "name": "severity", + "description": "Threshold Event Severity", + "value": "", + "type": "string", + "constraints": [{ + "valid_values": [ + "CRITICAL", + "MAJOR", + "MINOR", + "WARNING", + "NORMAL" ] - }, - { - "name": "severity", - "description": "Threshold Event Severity", - "value": "", - "type": "string", - "constraints": [ - { - "valid_value": [ - "CRITICAL", - "MAJOR", - "MINOR", - "WARNING", - "NORMAL" - ] - } - ] - } - ] - } - ] + }] + }] + }] + }] } - ] + ], + "program_preferences": [] } } -