Add limitations for CDS actor

Adding limitations for CDS actor in release notes & cds actor document to highlight the fact that vserver information is always needed to process ONSET events targeted towards VNF.

Issue-ID: POLICY-2882
Change-Id: I55d3de6bb86ae323d509790ad25004c1687e3e12
Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>

diff --git a/docs/development/actors/cds/cds.rst b/docs/development/actors/cds/cds.rst
index 0e49da8..115130b 100644 (file)
--- a/docs/development/actors/cds/cds.rst
+++ b/docs/development/actors/cds/cds.rst
@@ -419,3 +419,29 @@ To view the configured policies use the below REST API.
       https://{$POLICY_API_URL}:{$POLICY_API_SERVICE_PORT}/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/operational.modifyconfig \
       -H 'Authorization: Basic aGVhbHRoY2hlY2s6emIhWHp0RzM0' \
       -H 'Content-Type: application/json' \
+
+4.4 Limitations
+---------------
+
+For an operational policy targeted towards VNF, the CDS actor always requires "vserver" information to query A&AI while processing ONSET events.
+Example of an ONSET event below:
+
+.. code-block:: bash
+
+    {
+      "closedLoopControlName": "ControlLoop-vFirewall-d0a1dfc6-94f5-4fd4-a5b5-4630b438850a",
+      "closedLoopAlarmStart": 1463679805324,
+      "closedLoopEventClient": "microservice.stringmatcher",
+      "closedLoopEventStatus": "ONSET",
+      "requestID": "c7c6a4aa-bb61-4a15-b831-ba1472dd4a65",
+      "target_type": "VNF",
+      "target": "generic-vnf.vnf-id",
+      "AAI": {
+        "generic-vnf.is-closed-loop-disabled": "false",
+        "generic-vnf.prov-status": "ACTIVE",
+        "generic-vnf.vnf-id": "5483ffc5-2ecd-4352-bb9f-7d945a7561d5",
+        "vserver.vserver-name": "RegionOne_ONAP-NF_20200418T084319286Z_vfw_001"
+      },
+      "from": "DCAE",
+      "version": "1.0.2"
+    }

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index c5fd986..3dd177a 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -259,6 +259,8 @@ Therefore, upgrades require a fresh new database installation.
 Please see the
 `Installing or Upgrading Policy <https://onap.readthedocs.io/en/frankfurt/submodules/policy/parent.git/docs/installation/oom.html#installing-or-upgrading-policy>`__ section for appropriate procedures.
 
+For an operational policy targeted towards VNF, the CDS actor always requires "vserver" information to query A&AI while processing ONSET events.
+
 Known Vulnerabilities
 ---------------------