summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/son-handler
diff options
context:
space:
mode:
authorVijay VK <vv770d@att.com>2019-05-23 22:02:50 +0100
committerVijay Venkatesh Kumar <vv770d@att.com>2019-05-23 21:28:45 +0000
commit6cdebe0d51014c9cfbbee0b63f31f671a25f4f7a (patch)
treee0a5f257e641e41e6a809a038fe6acec9e1c33d6 /docs/sections/services/son-handler
parentf9e4344e9c9834face106b6c153ede020ff5410f (diff)
Fix doc issues
Change-Id: I711a40a64a1d47b50f0923ba67b02ad121ace5b4 Signed-off-by: VENKATESH KUMAR <vv770d@att.com> Issue-ID: DCAEGEN2-1505
Diffstat (limited to 'docs/sections/services/son-handler')
-rw-r--r--docs/sections/services/son-handler/installation.rst170
1 files changed, 91 insertions, 79 deletions
diff --git a/docs/sections/services/son-handler/installation.rst b/docs/sections/services/son-handler/installation.rst
index f529bc4a..edfcb39f 100644
--- a/docs/sections/services/son-handler/installation.rst
+++ b/docs/sections/services/son-handler/installation.rst
@@ -10,38 +10,48 @@ Deployment Prerequisites
- SON-hadler service requires the following dmaap topics to be present in the running DMAAP instance :
- 1.PCI-NOTIF-TOPIC-NGHBR-LIST-CHANGE-INFO
-
- 2.unauthenticated.SEC_FAULT_OUTPUT
-
- 3.unauthenticated.SEC_MEASUREMENT_OUTPUT
-
- 4.DCAE_CL_RSP
-
-- Policy model required for SON-handler service should be created and pushed to policy component.Steps for creating and pushing the policy model:
- 1.Login to PDP container and execute
- kubectl exec -ti --namespace onap policy-pdp-0 bash
- 2.Create policy model
- curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
- "policyName": "com.PCIMS_CONFIG_POLICY",
- "configBody": "{ \"PCI_NEIGHBOR_CHANGE_CLUSTER_TIMEOUT_IN_SECS\":60, \"PCI_MODCONFIG_POLICY_NAME\":\"ControlLoop-vPCI-fb41f388-a5f2-11e8-98d0-529269fb1459\", \"PCI_OPTMIZATION_ALGO_CATEGORY_IN_OOF\":\"OOF-PCI-OPTIMIZATION\", \"PCI_SDNR_TARGET_NAME\":\"SDNR\" }",
- "policyType": "Config",
- "attributes" : { "matching" : { "key1" : "value1" } },
- "policyConfigType": "Base",
- "onapName": "DCAE",
- "configName": "PCIMS_CONFIG_POLICY",
- "configBodyType": "JSON"
-}' 'https://pdp:8081/pdp/api/createPolicy'
-
- 3.Push policy model
- curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
- "policyName": "com.PCIMS_CONFIG_POLICY",
- "policyType": "Base"
-}' 'https://pdp:8081/pdp/api/pushPolicy'
-
- 4.Verify config policy is present
-
- curl -k -v --silent -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{ "configName": "PCIMS_CONFIG_POLICY", "policyName": "com.Config_PCIMS_CONFIG_POLICY1*", "requestID":"e65cc45a-9efb-11e8-98d0-529269ffa459" }' 'https://pdp:8081/pdp/api/getConfig'
+ 1.PCI-NOTIF-TOPIC-NGHBR-LIST-CHANGE-INFO
+
+ 2.unauthenticated.SEC_FAULT_OUTPUT
+
+ 3.unauthenticated.SEC_MEASUREMENT_OUTPUT
+
+ 4.DCAE_CL_RSP
+
+- Policy model required for SON-handler service should be created and pushed to policy component. Steps for creating and pushing the policy model:
+
+ 1.Login to PDP container and execute
+
+ .. code-block:: bash
+
+ kubectl exec -ti --namespace onap policy-pdp-0 bash
+
+ 2.Create policy model
+
+ .. code-block:: bash
+
+ curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "policyName": "com.PCIMS_CONFIG_POLICY",
+ "configBody": "{ \"PCI_NEIGHBOR_CHANGE_CLUSTER_TIMEOUT_IN_SECS\":60, \"PCI_MODCONFIG_POLICY_NAME\":\"ControlLoop-vPCI-fb41f388-a5f2-11e8-98d0-529269fb1459\", \"PCI_OPTMIZATION_ALGO_CATEGORY_IN_OOF\":\"OOF-PCI-OPTIMIZATION\", \"PCI_SDNR_TARGET_NAME\":\"SDNR\" }",
+ "policyType": "Config", "attributes" : { "matching" : { "key1" : "value1" } },
+ "policyConfigType": "Base",
+ "onapName": "DCAE",
+ "configName": "PCIMS_CONFIG_POLICY",
+ "configBodyType": "JSON" }' 'https://pdp:8081/pdp/api/createPolicy'
+
+ 3.Push policy model
+
+ .. code-block:: bash
+
+ curl -k -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{
+ "policyName": "com.PCIMS_CONFIG_POLICY",
+ "policyType": "Base"}' 'https://pdp:8081/pdp/api/pushPolicy'
+
+ 4.Verify config policy is present
+
+ .. code-block:: bash
+
+ curl -k -v --silent -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'ClientAuth: cHl0aG9uOnRlc3Q=' --header 'Authorization: Basic dGVzdHBkcDphbHBoYTEyMw==' --header 'Environment: TEST' -d '{ "configName": "PCIMS_CONFIG_POLICY", "policyName": "com.Config_PCIMS_CONFIG_POLICY1*", "requestID":"e65cc45a-9efb-11e8-98d0-529269ffa459" }' 'https://pdp:8081/pdp/api/getConfig'
Deployment steps
~~~~~~~~~~~~~~~~
@@ -60,51 +70,53 @@ Deployment steps
Application Configurations
--------------------------
-
-Streams_subscribes Dmaap topics that the MS will consume messages
-
-Streams_publishes Dmaap topics that the MS will publish messages
-
-postgres.host Host where the postgres database is running
-
-postgres.port Host where the postgres database is running
-
-postgres.username Postgres username
-
-postgres.password Postgres password
-
-sonhandler.pollingInterval Polling Interval for consuming dmaap messages
-
-sonhandler.pollingTimeout Polling timeout for consuming dmaap messages
-
-sonhandler.numSolutions Number for solutions for OOF optimization
-
-sonhandler.minCollision Minimum collision criteria to trigger OOF
-
-sonhandler.minConfusion Minimum confusion criteria to trigger OOF
-
-sonhandler.maximumClusters Maximum number of clusters MS can process
-
-sonhandler.badThreshold Bad threshold for Handover success rate
-
-sonhandler.poorThreshold Poor threshold for Handover success rate
-
-sonhandler.namespace Namespace where MS is going to be deployed
-
-sonhandler.sourceId Source ID of the Microservice (Required for Sending request to OOF)
-
-sonhandler.dmaap.server Location of message routers
-
-sonhandler.bufferTime Buffer time for MS to wait for more notifications when the optimization criteria is not met
-
-sonhandler.cg Consumer group for the MS to consume message from dmaap
-
-sonhandler.cid Consumer ID for the MS to consume message from dmaap
-
-sonhandler.configDbService Location of the config DB (protocol, host & port)
-
-sonhandler.oof.service Location of OOF (protocol, host & port)
-
-sonhandler.optimizers Optimizer to trigger in OOF
-
++-------------------------------+------------------------------------------------+
+|Configuration | Description |
++===============================+================================================+
+|Streams_subscribes | Dmaap topics that the MS will consume messages |
++-------------------------------+------------------------------------------------+
+|Streams_publishes | Dmaap topics that the MS will publish messages |
++-------------------------------+------------------------------------------------+
+|postgres.host | Host where the postgres database is running |
++-------------------------------+------------------------------------------------+
+|postgres.port | Host where the postgres database is running |
++-------------------------------+------------------------------------------------+
+|postgres.username | Postgres username |
++-------------------------------+------------------------------------------------+
+|postgres.password | Postgres password |
++-------------------------------+------------------------------------------------+
+|sonhandler.pollingInterval | Polling Interval for consuming dmaap messages |
++-------------------------------+------------------------------------------------+
+|sonhandler.pollingTimeout | Polling timeout for consuming dmaap messages |
++-------------------------------+------------------------------------------------+
+|sonhandler.numSolutions | Number for solutions for OOF optimization |
++-------------------------------+------------------------------------------------+
+|sonhandler.minCollision | Minimum collision criteria to trigger OOF |
++-------------------------------+------------------------------------------------+
+|sonhandler.minConfusion | Minimum confusion criteria to trigger OOF |
++-------------------------------+------------------------------------------------+
+|sonhandler.maximumClusters | Maximum number of clusters MS can process |
++-------------------------------+------------------------------------------------+
+|sonhandler.badThreshold | Bad threshold for Handover success rate |
++-------------------------------+------------------------------------------------+
+|sonhandler.poorThreshold | Poor threshold for Handover success rate |
++-------------------------------+------------------------------------------------+
+|sonhandler.namespace | Namespace where MS is going to be deployed |
++-------------------------------+------------------------------------------------+
+|sonhandler.sourceId | Source ID of the Microservice (to OOF) |
++-------------------------------+------------------------------------------------+
+|sonhandler.dmaap.server | Location of message routers |
++-------------------------------+------------------------------------------------+
+|sonhandler.bufferTime | Buffer time for MS to wait for notifications |
++-------------------------------+------------------------------------------------+
+|sonhandler.cg | DMAAP Consumer group for subscription |
++-------------------------------+------------------------------------------------+
+|sonhandler.cid | DMAAP Consumer id for subcription |
++-------------------------------+------------------------------------------------+
+|sonhandler.configDbService | Location of config DB (protocol, host & port) |
++-------------------------------+------------------------------------------------+
+|sonhandler.oof.service | Location of OOF (protocol, host & port) |
++-------------------------------+------------------------------------------------+
+|sonhandler.optimizers | Optimizer to trigger in OOF |
++-------------------------------+------------------------------------------------+