summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/son-handler/installation.rst
blob: 7e8affce210357358e7888a4ebaed1bd8a0ce308 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
Installation
============

SON handler microservice can be deployed using cloudify blueprint using bootstrap container of an existing DCAE deployment

Deployment Prerequisites
~~~~~~~~~~~~~~~~~~~~~~~~

- SON-Handler service requires DMAAP and Policy components to be functional.

- 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
        
            .. 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
~~~~~~~~~~~~~~~~
1.Using DCAE Dashboard
 - Login to DCAE Dashboard
 - Go to Inventory --> Blueprints
 - Click on Deploy Action for son-handler blueprint
 - Override the value of 'tag_version' to 'nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.son-handler:2.0.4' (latest version) and click deploy.
 - Deployment logs can be viewed under Deployments section 

2.Using cloudify commands 

- Login to the bootstrap container
        kubectl exec -ti --namespace onap <bootstrap pod name> bash
- The blueprint can be found under dcaegen2 blueprint repo and is part of bootstrap container. (https://gerrit.onap.org/r/dcaegen2/platform/blueprints)
- Deploy the microservice into the cloudify using the following command
        cfy install -d sonhms -b sonhms <blueprint file path>
- Deployment status of the microservice can be found from kubernetes pods status (MS will be deployed as a k8s pod in the kubernetes environment under the same namespace as the DCAE environment).
        kubectl get pods --namespace onap
- To uninstall the microservice
        cfy uninstall sonhms
- To delete the blueprint from the cloudify instance
        cfy blueprints delete sonhms


Application Configurations
--------------------------
+-------------------------------+------------------------------------------------+
|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                    |
+-------------------------------+------------------------------------------------+
|sonhandler.poorCountThreshold  | Threshold for number of times poorThreshold    |
|                               | can be recorded for the cell                   |
+-------------------------------+------------------------------------------------+
|sonhandler.badCountThreshold   | Threshold for number of times badThreshold can |
|                               | be recorded for the cell                       |
+-------------------------------+------------------------------------------------+
|sonhandler.                    | Timer for oof triggered count in minutes       |
|oofTriggerCountTimer           |                                                |
+-------------------------------+------------------------------------------------+
|sonhandler.policyRespTimer     | Timer to wait for notification from policy     |
+-------------------------------+------------------------------------------------+
|sonhandler.                    | Maximum number of negative acknowledgements    |
|policyNegativeAckThreshold     | from policy for a given cell                   |
+-------------------------------+------------------------------------------------+
|sonhandler.                    | Time interval to trigger OOF with fixed pci    |
|policyFixedPciTimeInterval     | cells                                          |
+-------------------------------+------------------------------------------------+
|sonhandler.nfNamingCode        | Parameter to filter FM and PM notifications    |
|                               | coming from ves                                |
+-------------------------------+------------------------------------------------+