Merge "Updates to TCA spec and output format"

5 files changed, 149 insertions, 40 deletions

diff --git a/README.md b/README.md
index 2484768..562187e 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,32 @@ Maven Children Artifacts:
 8. dcae-analytics-cdap-plugins: CDAP Plugins
 9. dcae-analytics-cdap-it: Cucumber and CDAP Pipeline integration tests
 
-Maven Central Artifacts Location:
----------------------------------
-* Releases: TBD
-* Snapshots: TBD
+Deployment in Wind River Lab:
+-----------------------------
+# create namespace
+curl -X PUT http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo
+
+# load artifact
+curl -X POST --data-binary @/c/usr/tmp/dcae-analytics-cdap-tca-2.0.0-SNAPSHOT.jar http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/artifacts/dcae-analytics-cdap-tca
+
+# create app
+curl -X PUT -d @/c/usr/docs/ONAP/tca_app_config.json http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca
+
+# load preferences
+curl -X PUT -d @/c/usr/docs/ONAP/tca_app_preferences.json http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/preferences
+
+# start program
+curl -X POST http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/start
+curl -X POST http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/start
+curl -X POST http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/start
+
+# check status
+curl http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRPublisherWorker/status
+curl http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/workers/TCADMaaPMRSubscriberWorker/status
+curl http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/apps/dcae-tca/flows/TCAVESCollectorFlow/status
+
+# Delete namespace (and all its content)
+# curl -X DELETE http://<cdapMasterHost>:11015/v3/unrecoverable/namespaces/cdap_tca_hi_lo
+
+# Delete artifact
+# curl -X DELETE http://<cdapMasterHost>:11015/v3/namespaces/cdap_tca_hi_lo/artifacts/dcae-analytics-cdap-tca/versions/2.0.0.SNAPSHOT
diff --git a/dpo/commands b/dpo/commands
index 97c5d26..b6d138a 100644
--- a/dpo/commands
+++ b/dpo/commands
@@ -15,3 +15,5 @@ dcae_cli component undeploy cdap.tca.hi.lo.app
 dcae_cli component show cdap.tca.hi.lo.app

 dcae_cli component list

 dcae_cli component list --deployed

+

+dcae_cli catalog list --expanded

diff --git a/dpo/tcaOutput.json b/dpo/tcaOutput.json
index 172d63b..065977a 100644
--- a/dpo/tcaOutput.json
+++ b/dpo/tcaOutput.json
@@ -1,7 +1,7 @@
 {

   "self": {

     "name": "TCA Alert Definition",

-    "version": "1.0.0",

+    "version": "1.0.1",

     "description": "The format of the output event from TCA"

   },

   "dataformatversion": "1.0.0",

@@ -9,23 +9,62 @@
     "name": "TCA Alert",

     "version": "1.0.0",

     "properties": {

-      "closedLoopControlame": {

-        "type": "string"

-      },

       "version": {

-        "type": "string"

+        "type": "string",

+        "enum": [

+          "1.0.2"

+        ]

+      },

+      "closedLoopControlName": {

+        "type": "string",

+        "description" : "This is the unique ID for the Control Loop. It is created by the CLAMP platform during Control Loop design"

       },

       "requestID": {

-        "type": "string"

+        "type": "string",

+        "description" : "For the control loop, when an instance of the Control Loop occurs, this unique ID must be created. The same ID must be forwarded for both the ONSET and the ABATED control loop messages"

+      },

+      "closedLoopEventStatus": {

+        "type": "string",

+        "description" : "This is the status of the closedLoopControlName/requestID pair",

+        "enum": [

+          "ONSET",

+          "ABATED"

+        ]

       },

       "closedLoopAlarmStart": {

-        "type": "string"

+        "type": "string",

+        "description" : "When the alarm was first detected"

+      },

+      "closedLoopAlarmEnd" : {

+        "type" : "string",

+        "description" : "When the alarm was cleared. This field need only be present in the ABATED message"

       },

       "closedLoopEventClient": {

-        "type": "string"

+        "type": "string",

+        "description" : "For monitoring/logging/auditing purposes, if there is an instance ID of the DCAE micro service this field should be populated with it"

+      },

+      "policyVersion": {

+        "type": "string",

+        "description" : "The version of the Policy driving the DCAE Micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller"

+      },

+      "policyName": {

+        "type": "string",

+        "description" : "The name of the Policy driving the DCAE micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller"

+      },

+      "policyScope": {

+        "type": "string",

+        "description" : "The scope of the Policy driving the DCAE micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller"

+      },      

+      "from": {

+        "type": "string",

+        "description" : "The ONAP platform component publishing this message",

+        "enum": [

+          "DCAE"

+        ]

       },

       "target_type": {

         "type": "string",

+        "description" : "The type of the target: VM or VNF",

         "enum": [

           "VNF",

           "VM"

@@ -33,12 +72,14 @@
       },

       "target": {

         "type": "string",

+        "description" : "This is the name of the field within the A&AI sub-tag that indicates the actual entity Node details. There should be a matching node field within the A&AI subtag holding this value",

         "enum": [

           "generic-vnf.vnf-id",

           "vserver.vserver-name"

         ]

       },

       "AAI": {

+        "description" : "Contains the A&AI Node-Attribute list",

         "anyOf": [

           {

             "generic-vnf.vnf-id": {

@@ -51,28 +92,8 @@
             }

           }

         ]

-      },

-      "from": {

-        "type": "string",

-        "enum": [

-          "DCAE"

-        ]

-      },

-      "policyScope": {

-        "type": "string"

-      },

-      "policyName": {

-        "type": "string"

-      },

-      "policyVersion": {

-        "type": "string"

-      },

-      "closedLoopEventStatus": {

-        "type": "string",

-        "enum": [

-          "ONSET"

-        ]

       }

-    }

+    },

+    "required": ["version", "closedLoopControlName", "requestID", "closedLoopEventStatus", "closedLoopAlarmStart", "from", "target_type", "target", "AAI"]

   }

 }

diff --git a/dpo/tcaSpec.json b/dpo/tcaSpec.json
index c906395..0bbb4a5 100644
--- a/dpo/tcaSpec.json
+++ b/dpo/tcaSpec.json
@@ -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/snapshots/content/org/onap/dcaegen2/analytics/tca/dcae-analytics-cdap-tca/2.0.0-SNAPSHOT/dcae-analytics-cdap-tca-2.0.0-20171006.155007-46.jar",

       "type": "jar"

     }

   ],

@@ -108,6 +108,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",

         "value": "application/json"

@@ -138,6 +168,36 @@
         "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",

         "value": "application/json"

@@ -185,12 +245,12 @@
       {
         "name": "aaiEnrichmentUserName",
         "description": "A&AI Enrichment API username",
-        "value": "DCAE"
+        "value": "USERNAME"
       },
       {
         "name": "aaiEnrichmentUserPassword",
         "description": "A&AI Enrichment API password",
-        "value": "DCAE"
+        "value": "PASSWORD"
       },
       {
         "name": "aaiEnrichmentIgnoreSSLCertificateErrors",
@@ -210,7 +270,7 @@
       {
         "name": "aaiEnrichmentProxyURL",
         "description": "A&AI Enrichment API Proxy URL",
-        "value": "http://username:password@proxyhost.com:8080"
+        "value": "URL"
       },      

       {

         "name": "tca_policy",

@@ -291,7 +351,8 @@
                       "LESS",
                       "LESS_OR_EQUAL",
                       "GREATER",
-                      "GREATER_OR_EQUAL"
+                      "GREATER_OR_EQUAL",

+                      "EQUAL"
                 ]
               }]
             }, {
diff --git a/pom.xml b/pom.xml
index efb0ced..95f73ca 100644
--- a/pom.xml
+++ b/pom.xml
@@ -26,7 +26,7 @@
 

     <parent>

       <groupId>org.onap.dcaegen2</groupId>

-      <artifactId>root</artifactId>

+      <artifactId>dcaegen2</artifactId>

       <version>1.0.0-SNAPSHOT</version>

     </parent>