diff options
Diffstat (limited to 'docs/sections/services/pm-subscription-handler/configuration.rst')
| -rw-r--r-- | docs/sections/services/pm-subscription-handler/configuration.rst | 203 |
1 files changed, 203 insertions, 0 deletions
diff --git a/docs/sections/services/pm-subscription-handler/configuration.rst b/docs/sections/services/pm-subscription-handler/configuration.rst new file mode 100644 index 00000000..876d9085 --- /dev/null +++ b/docs/sections/services/pm-subscription-handler/configuration.rst @@ -0,0 +1,203 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. Configuration: + +Configuration +============= + +The PMSH is configured and deployed via CLAMP. + +Application specific configuration +"""""""""""""""""""""""""""""""""" + +The application config is the basic information that PMSH needs to run. The following parameters are required, they are +specified in the CLAMP deployment GUI. + ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ +| Field | Description | Type | Required | Default | ++==================+==========================================================================+=========+==========+===============================================================================+ +| tag_version | Docker image to be used. | string | True | nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-subscription-handler | ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ +| replicas | Number of instances. | integer | True | 1 | ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ +| subscriber_topic | The topic that PMSH will subscribe to. | string | True | AAI-EVENT | ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ +| publisher_topic | The topic that PMSH will publish to, and which policy will subscribe to. | string | True | org.onap.dmaap.mr.PM_SUBSCRIPTIONS | ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ +| client_role | Client role to request secure access to topic. | string | True | | ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ +| client_id | Client id for given AAF client. | string | True | dcae@dcae.onap.org | ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ +| client_password | Password for AAF client provided as client_id. | string | True | | ++------------------+--------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ + +Subscription configuraton +""""""""""""""""""""""""" + +The subscription is configured within the monitoring policy in CLAMP. The subscription model schema is as follows: + +**subscription** + +:: + + { + "subscription": { + "subscriptionName": "someExtraPM-AllKista-gNB-R2B", + "administrativeState": "UNLOCKED", + "fileBasedGP": 15, + "fileLocation": "/pm/pm.xml", + "nfTypeModelInvariantId": "2829292", + "nfFilter": { + "swVersions": [ + "1.0.0", + "1.0.1" + ], + "nfNames": [ + "ABC", + "DEF", + "foo.*" + ] + }, + "measurementGroup": { + "measurementTypes": [ + { + "measurementType": "EutranCell.*" + }, + { + "measurementType": "EutranCellRelation.pmCounter1" + }, + { + "measurementType": "EutranCellRelation.pmCounter2" + } + ], + "managedObjectDNsBasic": [ + { + "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1" + }, + { + "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter2" + }, + { + "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter3" + } + ] + } + } + } + ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| Field | Description | Type | Required | Values | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| subscriptionName | Name of the subscription | | | | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| 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. | | | | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| fileBasedGP | The frequency at which measurements are produced. | | | | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| fileLocation | Location of Report Output Period file. | | | | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| 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. | | | | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| nfFilter | The network function filter will be used to filter the list of nf's stored in A&AI to produce a subset. | | | | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| measurementGroup | List of measurement types and managed object distinguished names | | | | ++------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ + +**nfFilter** + +The ``nfFilter`` will be used in order to filter the list of NF's retrieved from A&AI. It will filter on the names +specified in the ``nfNames`` field, which can also contain regex as seen below. + +:: + + "nfFilter": { + "swVersions": [ + "1.0.0", + "1.0.1" + ], + "nfNames": [ + "ABC", + "DEF", + "foo.*" + ] + } + ++------------+-----------------------------------------------------------------------------+------+----------+ +| Field | Description | Type | Required | ++============+=============================================================================+======+==========+ +| swVersions | List of software versions | list | True | ++------------+-----------------------------------------------------------------------------+------+----------+ +| nfNames | List of NF names. These names are regexes, which will be parsed by the PMSH | list | True | ++------------+-----------------------------------------------------------------------------+------+----------+ + +**measurementGroup** + +``measurementGroup`` is used to specify the group of measurements that will be collected. + +:: + + "measurementGroup": { + "measurementTypes": [ + { + "measurementType": "EutranCell.*" + }, + { + "measurementType": "EutranCellRelation.pmCounter1" + }, + { + "measurementType": "EutranCellRelation.pmCounter2" + } + ], + "managedObjectDNsBasic": [ + { + "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1" + }, + { + "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter2" + }, + { + "DN": "ManagedElement=1,ENodeBFunction=1,EUtranCell=CityCenter1, EUtranCellRelation=CityCenter3" + } + ] + } + ++-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+ +| Field | Description | Type | Required | ++=======================+===================================================================================================================================================+======+==========+ +| 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 | ++-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+ +| managedObjectDNsBasic | List of managed object distinguished names. | list | True | ++-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+ + +.. _Topics: + +MR Topics +""""""""""""""""""""" + +Subscriber: +^^^^^^^^^^^ + +:: + + AAI-EVENT + +This topic is used so that the PMSH can listen for new NFs getting registered. If the NF matches the NF filter (See +:ref:`Configuration<Configuration>`) it will be added to the relevant subscription. This topic is **AAI_EVENT**. + +:: + + org.onap.dmaap.mr.PM_SUBSCRIPTION_EVENTS + +This topic is used for locking and unlocking events. i.e if a user has previously created a locked +subscription, they can publish an event to this topic to unlock it, or vice versa. + +Publisher: +^^^^^^^^^^ + +:: + + org.onap.dmaap.mr.PM_SUBSCRIPTIONS + +The PMSH publishes subscriptions to this topic. They will be consumed by a policy which will make a request to CDS to +unlock the subscription.
\ No newline at end of file |