diff options
Diffstat (limited to 'docs/sections/services/pm-subscription-handler/configuration.rst')
| -rw-r--r-- | docs/sections/services/pm-subscription-handler/configuration.rst | 143 |
1 files changed, 62 insertions, 81 deletions
diff --git a/docs/sections/services/pm-subscription-handler/configuration.rst b/docs/sections/services/pm-subscription-handler/configuration.rst index e5b7b48c..8f02af0e 100644 --- a/docs/sections/services/pm-subscription-handler/configuration.rst +++ b/docs/sections/services/pm-subscription-handler/configuration.rst @@ -6,70 +6,54 @@ Configuration ============= -The PMSH is configured and deployed via CLAMP. +The PMSH is configured and deployed via the DCAE dashboard. 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 | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| policy_model_id | Monitoring policy model ID. | string | True | onap.policies.monitoring.dcae-pm-subscription-handler | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| policy_id | Monitoring policy ID. | string | True | onap.policies.monitoring.dcae-pm-subscription-handler | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| operational_policy_name | Name of the operational policy that the service will prompt. | string | True | pmsh-operational-policy | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| control_loop_name | Name of the control loop the service is part of. | string | True | | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| pm_publish_topic_name | The topic that PMSH will publish to, and which policy will subscribe to. | string | True | DCAE_CL_OUTPUT | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| policy_feedback_topic_name | The topic that PMSH will subscribe to, and which policy will publish to. | string | True | PMSH_CL_INPUT | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| aai_notification_topic_name | The topic that PMSH will subscribe to, and which AAI will publish change events to. | string | True | AAI-EVENT | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| publisher_client_role | The client role used to publish to the topic that policy will subscribe to. | string | True | org.onap.dcae.pmPublisher | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| 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 | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| 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 | | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| dcae_location | Location of the DCAE cluster. | string | True | san-francisco | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| pmsh_service_protocol | Protocol of the PMSH service. | string | True | https | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| pmsh_service_port | Port of the PMSH service. | string | True | 8443 | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| dmaap_mr_service_protocol | Protocol of Message Router service. | string | True | https | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| dmaap_mr_service_host | Hostname of the Message Router service. | string | True | message-router | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| dmaap_mr_service_port | Port of the Message Router service. | string | True | 3905 | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| cpu_limit | CPU limit for the PMSH service. | string | True | 1000m | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| cpu_request | Requested CPU for the PMSH service. | string | True | 1000m | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| memory_limit | Memory limit for the PMSH service. | string | True | 1024Mi | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| memory_request | Requested Memory for the PMSH service. | string | True | 1024Mi | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ -| pgaas_cluster_name | Cluster name for Postgres As A Service. | string | True | dcae-pg-primary.onap | -+-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------+ - -Subscription configuraton -""""""""""""""""""""""""" - -The subscription is configured within the monitoring policy in CLAMP. The subscription model schema is as follows: +specified in the dashboard 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:1.0.3 | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| replicas | Number of instances. | integer | True | 1 | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| operational_policy_name | Name of the operational policy to be executed. | string | True | pmsh-operational-policy | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| control_loop_name | Name of the control loop. | string | True | pmsh-control-loop | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| pm_publish_topic_name | The topic that PMSH will publish to, and which policy will subscribe to. | string | True | unauthenticated.DCAE_CL_OUTPUT | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| policy_feedback_topic_name | The topic that PMSH will subscribe to, and which policy will publish to. | string | True | unauthenticated.PMSH_CL_INPUT | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| aai_notification_topic_name | The topic that PMSH will subscribe to, and which AAI will publish change events to. | string | True | AAI-EVENT | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| publisher_client_role | The client role used to publish to the topic that policy will subscribe to. | string | True | org.onap.dcae.pmPublisher | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| 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 | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| dcae_location | Location of the DCAE cluster. | string | True | san-francisco | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| cpu_limit | CPU limit for the PMSH service. | string | True | 1000m | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| cpu_request | Requested CPU for the PMSH service. | string | True | 1000m | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| memory_limit | Memory limit for the PMSH service. | string | True | 1024Mi | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| memory_request | Requested Memory for the PMSH service. | string | True | 1024Mi | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ +| pgaas_cluster_name | Cluster name for Postgres As A Service. | string | True | dcae-pg-primary.onap | ++-----------------------------+----------------------------------------------------------------------------------------+---------+----------+-------------------------------------------------------------------------------------+ + +.. _Subscription: + +Subscription configuration +"""""""""""""""""""""""""" + +The subscription is configured within the monitoring policy. The subscription model schema is as follows: **subscription** @@ -81,7 +65,6 @@ The subscription is configured within the monitoring policy in CLAMP. The subscr "administrativeState": "UNLOCKED", "fileBasedGP": 15, "fileLocation": "/pm/pm.xml", - "nfTypeModelInvariantId": "2829292", "nfFilter": { "swVersions": [ "1.0.0", @@ -122,23 +105,21 @@ The subscription is configured within the monitoring policy in CLAMP. The subscr } } -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ -| 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. | | | | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ -| measurementGroups | List containing measurementGroup. | | | | -+------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ ++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| 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. | | | | ++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| nfFilter | The network function filter will be used to filter the list of nf's stored in A&AI to produce a subset. | | | | ++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ +| measurementGroups | List containing measurementGroup. | | | | ++---------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------+----------+--------+ **nfFilter** @@ -209,7 +190,7 @@ specified in the ``nfNames`` field, which can also contain regex as seen below. .. _Topics: MR Topics -""""""""""""""""""""" +""""""""" Subscriber: ^^^^^^^^^^^ @@ -223,7 +204,7 @@ This topic is used so that the PMSH can listen for new NFs getting registered. I :: - PMSH_CL_INPUT + unauthenticated.PMSH_CL_INPUT This topic enables the operational policy to provide feedback on the status of a subscription attempt back to the PMSH service. @@ -233,7 +214,7 @@ Publisher: :: - DCAE_CL_OUTPUT + unauthenticated.DCAE_CL_OUTPUT The PMSH publishes subscriptions to this topic. They will be consumed by an operational policy which will make a request to CDS to -change the state of the subscription.
\ No newline at end of file +change the state of the subscription. |