diff options
| author |   dfarrelly <david.farrelly@est.tech> | 2020-04-02 08:59:17 +0100 |
|---|---|---|
| committer | dfarrelly <david.farrelly@est.tech> | 2020-04-22 14:31:25 +0100 |
| commit | 4e457425203cd42635eeea0bde044abf8b119946 (patch) | |
| tree | 3be494eaf5d9bd9d862995df17e5d5188374eb98 /docs | |
| parent | 06d45b681f12fcb88fcca76bcc6170eaf020560b (diff) | |
[PMSH] Update PMSH Frankfurt docs
Issue-ID: DCAEGEN2-1820
Signed-off-by: dfarrelly <david.farrelly@est.tech>
Change-Id: I0ef088ae7f6a97ab101a7097e6ea9bf81424c343
Diffstat (limited to 'docs')
9 files changed, 120 insertions, 118 deletions
diff --git a/docs/sections/apis/PMSH.rst b/docs/sections/apis/PMSH.rst index 17fd6d26..221c3c13 100644 --- a/docs/sections/apis/PMSH.rst +++ b/docs/sections/apis/PMSH.rst @@ -34,19 +34,3 @@ Responses +===========+=====================+ | **200** | successful response | +-----------+---------------------+ - -GET ``/subscriptions`` ----------------------- - -Description -~~~~~~~~~~~ -The subscriptions endpoint can be used to fetch all subscriptions which exist in the database. - -Responses -~~~~~~~~~ - -+-----------+---------------------+ -| HTTP Code | Description | -+===========+=====================+ -| **200** | successful response | -+-----------+---------------------+ diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst index 98cd41a0..56fa2da7 100644 --- a/docs/sections/offeredapis.rst +++ b/docs/sections/offeredapis.rst @@ -16,5 +16,6 @@ Offered APIs apis/DFC.rst apis/PNDA.rst apis/pmmapper.rst + apis/PMSH.rst apis/SDK.rst apis/mod-onboardingapi.rst 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. diff --git a/docs/sections/services/pm-subscription-handler/delivery.rst b/docs/sections/services/pm-subscription-handler/delivery.rst index 874efad8..2412f548 100644 --- a/docs/sections/services/pm-subscription-handler/delivery.rst +++ b/docs/sections/services/pm-subscription-handler/delivery.rst @@ -13,4 +13,4 @@ The PMSH is delivered as a docker image that can be downloaded from ONAP docker :: - nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-subscription-handler
\ No newline at end of file + nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-subscription-handler:1.0.3 diff --git a/docs/sections/services/pm-subscription-handler/index.rst b/docs/sections/services/pm-subscription-handler/index.rst index 83b831f1..bac35c87 100644 --- a/docs/sections/services/pm-subscription-handler/index.rst +++ b/docs/sections/services/pm-subscription-handler/index.rst @@ -15,4 +15,4 @@ PM Subscription Handler ./logging.rst ./installation.rst ./configuration.rst - ./troubleshooting.rst
\ No newline at end of file + ./troubleshooting.rst diff --git a/docs/sections/services/pm-subscription-handler/installation.rst b/docs/sections/services/pm-subscription-handler/installation.rst index 49da2ea9..3865cfbd 100644 --- a/docs/sections/services/pm-subscription-handler/installation.rst +++ b/docs/sections/services/pm-subscription-handler/installation.rst @@ -6,18 +6,60 @@ Installation ============ -The PMSH will be configured and instantiated through CLAMP. During instantiation, the PMSH will fetch its configuration -from the Config Binding Service. +Due to a bug in the Frankfurt release, the PMSH cannot be deployed through CLAMP. The PMSH can instead be deployed +using the DCAE Dashboard or via CLI. Steps to deploy using CLI will be shown below. Deployment Prerequisites ^^^^^^^^^^^^^^^^^^^^^^^^ -In order to succesfully deploy the PMSH, the following components are required to be running. They -can be verified by running the healtchecks. +In order to successfully deploy the PMSH, one will need administrator access to the kubernetes cluster, as a service +will need to be exposed. As well as this, the following components are required to be running. They can be verified by +running the health checks. - DCAE Platform - DMaaP - - SDC - - CLAMP - A&AI - AAF + +The healthcheck can be run from one of the Kubernetes controllers. + +.. code-block:: bash + + ./oom/kubernetes/robot/ete-k8s.sh onap health + +Deployment Procedure +^^^^^^^^^^^^^^^^^^^^ + +To deploy the PMSH in the Frankfurt release, the monitoring policy needs to be pushed directly to CONSUL. The CONSUL +service must first be exposed. + +.. code-block:: bash + + kubectl expose svc -n onap consul-server-ui --name=x-consul-server-ui --type=NodePort + +The monitoring policy can then be pushed with the following request, for information on creating a monitoring policy see +See :ref:`Subscription configuration<Subscription>` + +.. code-block:: bash + + curl -X PUT http://<k8s-node-ip>:<consul-port>/v1/kv/dcae-pmsh:policy \ + -H 'Content-Type: application/json' \ + -d @monitoring-policy.json + +To deploy the PMSH microservice using the deployment handler API, the ``serviceTypeId`` is needed, this can be retrieved +using the inventory API + +.. code-block:: bash + + curl https://<k8s-node-ip>:<inventory-port>/dcae-service-types + +The ``serviceTypeId`` for the PMSH can be found under typeID. The PMSH can then be deployed. + +.. code-block:: bash + + curl https://<k8s-node-ip>:<dep-handler-port>/dcae-deployments/dcae-pmsh \ + -H 'Content-Type: application/json' \ + -d '{ + "inputs": (), + "serviceTypeId": "<typeId>" + }' diff --git a/docs/sections/services/pm-subscription-handler/logging.rst b/docs/sections/services/pm-subscription-handler/logging.rst index aeae7c46..59518d91 100644 --- a/docs/sections/services/pm-subscription-handler/logging.rst +++ b/docs/sections/services/pm-subscription-handler/logging.rst @@ -14,4 +14,3 @@ The PMSH application writes logs on the debug level to the following file: .. code-block:: bash /var/log/ONAP/dcaegen2/services/pmsh/debug.log - diff --git a/docs/sections/services/pm-subscription-handler/overview.rst b/docs/sections/services/pm-subscription-handler/overview.rst index 076d384a..f520329f 100644 --- a/docs/sections/services/pm-subscription-handler/overview.rst +++ b/docs/sections/services/pm-subscription-handler/overview.rst @@ -8,15 +8,18 @@ Overview Introduction """""""""""" -The PM Subscription Handler (PMSH) is a micro service written in Python, which allows for the definition and unlocking +The PM Subscription Handler (PMSH) is a micro service written in Python, which allows for the definition and activation of PM subscriptions on one or more network function (NF) instances. .. _Delivery: ./delivery.html Functionality """"""""""""" -The PMSH allows for the definition of subscriptions on a network level, which enables the -configuration of PM data on a set of NF instances. +The PMSH allows for the definition of subscriptions on a network level, which enables the configuration of PM data on a +set of NF instances. During creation of a subscription, PM reporting configuration and a network function filter will +be defined. This filter will then be used to produce a subset of NF's to which the subscription will be applied. If +a NF matching the filter is registered in ONAP after the microservice has been deployed, the subscription will +be applied to that NF. Interaction """"""""""" @@ -44,11 +47,3 @@ Policy and CDS The PMSH will indirectly interact with Policy and CDS in order to push subscriptions to NF's. A policy will be used to make a request to CDS, which will apply the subscription to the NF. - - - - - - - - diff --git a/docs/sections/services/pm-subscription-handler/troubleshooting.rst b/docs/sections/services/pm-subscription-handler/troubleshooting.rst index 07787c41..4e0b2b97 100644 --- a/docs/sections/services/pm-subscription-handler/troubleshooting.rst +++ b/docs/sections/services/pm-subscription-handler/troubleshooting.rst @@ -21,4 +21,4 @@ Invalid Configuration ^^^^^^^^^^^^^^^^^^^^^ If the PMSH is able to connect to Config Binding Service, but is failing to start. It may be due to -invalid configuration. Check Kibana for an incorrect configuration error.
\ No newline at end of file +invalid configuration. Check Kibana for an incorrect configuration error. |