docs/sections/services/pm-subscription-handler/configuration.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 .. Configuration:
   5
   6 Configuration
   7 =============
   8
   9 The PMSH is configured and deployed via CLAMP.
  10
  11 Application specific configuration
  12 """"""""""""""""""""""""""""""""""
  13
  14 The application config is the basic information that PMSH needs to run. The following parameters are required, they are
  15 specified in the CLAMP deployment GUI.
  16
  17 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  18 | Field                       | Description                                                                            | Type    | Required | Default                                                                       |
  19 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  20 | tag_version                 | Docker image to be used.                                                               | string  | True     | nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-subscription-handler |
  21 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  22 | replicas                    | Number of instances.                                                                   | integer | True     | 1                                                                             |
  23 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  24 | policy_model_id             | Monitoring policy model ID.                                                            | string  | True     | onap.policies.monitoring.dcae-pm-subscription-handler                         |
  25 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  26 | policy_id                   | Monitoring policy ID.                                                                  | string  | True     | onap.policies.monitoring.dcae-pm-subscription-handler                         |
  27 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  28 | operational_policy_name     | Name of the operational policy that the service will prompt.                           | string  | True     | pmsh-operational-policy                                                       |
  29 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  30 | control_loop_name           | Name of the control loop the service is part of.                                       | string  | True     |                                                                               |
  31 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  32 | pm_publish_topic_name       | The topic that PMSH will publish to, and which policy will subscribe to.               | string  | True     | DCAE_CL_OUTPUT                                                                |
  33 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  34 | policy_feedback_topic_name  | The topic that PMSH will subscribe to, and which policy will publish to.               | string  | True     | PMSH_CL_INPUT                                                                 |
  35 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  36 | aai_notification_topic_name | The topic that PMSH will subscribe to, and which AAI will publish change events to.    | string  | True     | AAI-EVENT                                                                     |
  37 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  38 | publisher_client_role       | The client role used to publish to the topic that policy will subscribe to.            | string  | True     | org.onap.dcae.pmPublisher                                                     |
  39 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  40 | subscriber_client_role      | The client role used to subscribe to the topic that AAI will publish change events to. | string  | True     | org.onap.dcae.pmSubscriber                                                    |
  41 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  42 | client_id                   | Client id for given AAF client.                                                        | string  | True     | dcae@dcae.onap.org                                                            |
  43 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  44 | client_password             | Password for AAF client provided as client_id.                                         | string  | True     |                                                                               |
  45 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  46 | dcae_location               | Location of the DCAE cluster.                                                          | string  | True     | san-francisco                                                                 |
  47 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  48 | pmsh_service_protocol       | Protocol of the PMSH service.                                                          | string  | True     | https                                                                         |
  49 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  50 | pmsh_service_port           | Port of the PMSH service.                                                              | string  | True     | 8443                                                                          |
  51 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  52 | dmaap_mr_service_protocol   | Protocol of Message Router service.                                                    | string  | True     | https                                                                         |
  53 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  54 | dmaap_mr_service_host       | Hostname of the Message Router service.                                                | string  | True     | message-router                                                                |
  55 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  56 | dmaap_mr_service_port       | Port of the Message Router service.                                                    | string  | True     | 3905                                                                          |
  57 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  58 | cpu_limit                   | CPU limit for the PMSH service.                                                        | string  | True     | 1000m                                                                         |
  59 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  60 | cpu_request                 | Requested CPU for the PMSH service.                                                    | string  | True     | 1000m                                                                         |
  61 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  62 | memory_limit                | Memory limit for the PMSH service.                                                     | string  | True     | 1024Mi                                                                        |
  63 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  64 | memory_request              | Requested Memory for the PMSH service.                                                 | string  | True     | 1024Mi                                                                        |
  65 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  66 | pgaas_cluster_name          | Cluster name for Postgres As A Service.                                                | string  | True     | dcae-pg-primary.onap                                                          |
  67 +-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+
  68
  69 Subscription configuraton
  70 """""""""""""""""""""""""
  71
  72 The subscription is configured within the monitoring policy in CLAMP. The subscription model schema is as follows:
  73
  74 **subscription**
  75
  76 ::
  77
  78          {
  79            "subscription": {
  80              "subscriptionName": "someExtraPM-AllKista-gNB-R2B",
  81              "administrativeState": "UNLOCKED",
  82              "fileBasedGP": 15,
  83              "fileLocation": "/pm/pm.xml",
  84              "nfTypeModelInvariantId": "2829292",
  85              "nfFilter": {
  86                "swVersions": [
  87                  "1.0.0",
  88                  "1.0.1"
  89                ],
  90                "nfNames": [
  91                  "ABC",
  92                  "DEF",
  93                  "foo.*"
  94                ]
  95              },
  96              "measurementGroups": [
  97                 "measurementGroup": {
  98                   "measurementTypes": [
  99                     {
 100                       "measurementType": "EutranCell.*"
 101                     },
 102                     {
 103                       "measurementType": "EutranCellRelation.pmCounter1"
 104                     },
 105                     {
 106                       "measurementType": "EutranCellRelation.pmCounter2"
 107                     }
 108                   ],
 109                   "managedObjectDNsBasic": [
 110                     {
 111                       "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1"
 112                     },
 113                     {
 114                       "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter2"
 115                     },
 116                     {
 117                       "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter3"
 118                     }
 119                   ]
 120                 }
 121              ]
 122            }
 123          }
 124
 125 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 126 | Field                  | Description                                                                                                                                                                | Type | Required | Values |
 127 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 128 | subscriptionName       | Name of the subscription.                                                                                                                                                  |      |          |        |
 129 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 130 | administrativeState    | Setting a subscription to UNLOCKED will apply the subscription to the NF instances immediately. If it is set to LOCKED, it will not be applied until it is later unlocked. |      |          |        |
 131 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 132 | fileBasedGP            | The frequency at which measurements are produced.                                                                                                                          |      |          |        |
 133 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 134 | fileLocation           | Location of Report Output Period file.                                                                                                                                     |      |          |        |
 135 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 136 | nfTypeModelInvariantId | The invariant ID will be used to filter nf's if a list of nf names is not provided, or if regex is used to specify all nf's of a specific type.                            |      |          |        |
 137 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 138 | nfFilter               | The network function filter will be used to filter the list of nf's stored in A&AI to produce a subset.                                                                    |      |          |        |
 139 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 140 | measurementGroups      | List containing measurementGroup.                                                                                                                                          |      |          |        |
 141 +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+
 142
 143 **nfFilter**
 144
 145 The ``nfFilter`` will be used in order to filter the list of NF's retrieved from A&AI. It will filter on the names
 146 specified in the ``nfNames`` field, which can also contain regex as seen below.
 147
 148 ::
 149
 150         "nfFilter": {
 151             "swVersions": [
 152                 "1.0.0",
 153                 "1.0.1"
 154             ],
 155             "nfNames": [
 156                 "ABC",
 157                 "DEF",
 158                 "foo.*"
 159             ]
 160         }
 161
 162 +------------+-----------------------------------------------------------------------------+------+----------+
 163 | Field      | Description                                                                 | Type | Required |
 164 +============+=============================================================================+======+==========+
 165 | swVersions | List of software versions.                                                  | list | True     |
 166 +------------+-----------------------------------------------------------------------------+------+----------+
 167 | nfNames    | List of NF names. These names are regexes, which will be parsed by the PMSH.| list | True     |
 168 +------------+-----------------------------------------------------------------------------+------+----------+
 169
 170 **measurementGroup**
 171
 172 ``measurementGroup`` is used to specify the group of measurements that will be collected.
 173
 174 ::
 175
 176          "measurementGroup": {
 177            "measurementTypes": [
 178              {
 179                "measurementType": "EutranCell.*"
 180              },
 181              {
 182                "measurementType": "EutranCellRelation.pmCounter1"
 183              },
 184              {
 185                "measurementType": "EutranCellRelation.pmCounter2"
 186              }
 187            ],
 188            "managedObjectDNsBasic": [
 189              {
 190                "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1"
 191              },
 192              {
 193                "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter2"
 194              },
 195              {
 196                "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter3"
 197              }
 198            ]
 199          }
 200
 201 +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+
 202 | Field                 | Description                                                                                                                                       | Type | Required |
 203 +=======================+===================================================================================================================================================+======+==========+
 204 | measurementTypes      | List of measurement types. These are regexes, and it is expected that either the CDS blueprint, or NF can parse them. As the PMSH will not do so. | list | True     |
 205 +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+
 206 | managedObjectDNsBasic | List of managed object distinguished names.                                                                                                       | list | True     |
 207 +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+
 208
 209 .. _Topics:
 210
 211 MR Topics
 212 """""""""""""""""""""
 213
 214 Subscriber:
 215 ^^^^^^^^^^^
 216
 217 ::
 218
 219         AAI-EVENT
 220
 221 This topic is used so that the PMSH can listen for new NFs getting registered. If the NF matches the NF filter (See
 222 :ref:`Configuration<Configuration>`) it will be added to the relevant subscription. This topic is **AAI_EVENT**.
 223
 224 ::
 225
 226         PMSH_CL_INPUT
 227
 228 This topic enables the operational policy to provide feedback on the status of a subscription attempt back to the PMSH service.
 229
 230
 231 Publisher:
 232 ^^^^^^^^^^
 233
 234 ::
 235
 236         DCAE_CL_OUTPUT
 237
 238 The PMSH publishes subscriptions to this topic. They will be consumed by an operational policy which will make a request to CDS to
 239 change the state of the subscription.