diff options
author | Saryu Shah <ss3917@att.com> | 2019-11-25 18:08:00 +0000 |
---|---|---|
committer | Saryu Shah <ss3917@att.com> | 2019-11-25 18:08:00 +0000 |
commit | 1c3ea0bbc61f8dfb86a971fdbc7a4eb728c1717b (patch) | |
tree | 131fcfa4b013539c1cc46ebb1e7ff82d52e3d735 /docs | |
parent | e0892b981a2e6c4ef0a9d72bc10a62fa472cea58 (diff) |
Documentation - wild card suffixes for PDP supported policy types
Updated documentation to include wilcard suffixes for PDP supported policy types
Issue-ID: POLICY-2247
Signed-off-by: Saryu Shah <ss3917@att.com>
Change-Id: Ibbd030d569616b1e7a5b3f1ca0deb3ecf642aea3
Diffstat (limited to 'docs')
-rw-r--r-- | docs/apex/APEX-OnapPf-Guide.rst | 88 | ||||
-rw-r--r-- | docs/design/design.rst | 7 | ||||
-rw-r--r-- | docs/pap/response/group-query-pap-resp.json | 10 |
3 files changed, 52 insertions, 53 deletions
diff --git a/docs/apex/APEX-OnapPf-Guide.rst b/docs/apex/APEX-OnapPf-Guide.rst index 24291859..5e75f325 100644 --- a/docs/apex/APEX-OnapPf-Guide.rst +++ b/docs/apex/APEX-OnapPf-Guide.rst @@ -369,45 +369,49 @@ Format of the configuration file (OnapPfConfig.json) explained .. container:: colist arabic - +-----------------------------------+-----------------------------------+ - | **1** | parameters for setting up the | - | | rest server such as host, port | - | | userName and password. | - +-----------------------------------+-----------------------------------+ - | **2** | https flag if enabled will enable | - | | https support by the rest server. | - +-----------------------------------+-----------------------------------+ - | **3** | time interval in which PDP-A | - | | has to send heartbeats to PAP. | - | | Specified in milliseconds. | - +-----------------------------------+-----------------------------------+ - | **4** | Type of the pdp. | - +-----------------------------------+-----------------------------------+ - | **5** | List of policy types supported by | - | | the PDP. | - +-----------------------------------+-----------------------------------+ - | **6** | List of topics' details from | - | | which messages are received. | - +-----------------------------------+-----------------------------------+ - | **7** | Topic name of the source to which | - | | PDP-A listens to for messages | - | | from PAP. | - +-----------------------------------+-----------------------------------+ - | **8** | List of servers for the source | - | | topic. | - +-----------------------------------+-----------------------------------+ - | **9** | The source topic infrastructure. | - | | For e.g. dmaap, noop, ueb | - +-----------------------------------+-----------------------------------+ - | **10** | List of topics' details to which | - | | messages are sent. | - +-----------------------------------+-----------------------------------+ - | **11** | Topic name of the sink to which | - | | PDP-A sends messages. | - +-----------------------------------+-----------------------------------+ - | **12** | List of servers for the sink | - | | topic. | - +-----------------------------------+-----------------------------------+ - | **13** | The sink topic infrastructure. | - | | For e.g. dmaap, noop, ueb | - +-----------------------------------+-----------------------------------+ + +-----------------------------------+-------------------------------------------------+ + | **1** | parameters for setting up the | + | | rest server such as host, port | + | | userName and password. | + +-----------------------------------+-------------------------------------------------+ + | **2** | https flag if enabled will enable | + | | https support by the rest server. | + +-----------------------------------+-------------------------------------------------+ + | **3** | time interval in which PDP-A | + | | has to send heartbeats to PAP. | + | | Specified in milliseconds. | + +-----------------------------------+-------------------------------------------------+ + | **4** | Type of the pdp. | + +-----------------------------------+-------------------------------------------------+ + | **5** | List of policy types supported by | + | | the PDP. A trailing “.*” can be used to | + | | specify multiple policy types; for example, | + | | “onap.policies.controlloop.operational.apex.*” | + | | would match any policy type beginning with | + | | “onap.policies.controlloop.operational.apex.” | + +-----------------------------------+-------------------------------------------------+ + | **6** | List of topics' details from | + | | which messages are received. | + +-----------------------------------+-------------------------------------------------+ + | **7** | Topic name of the source to which | + | | PDP-A listens to for messages | + | | from PAP. | + +-----------------------------------+-------------------------------------------------+ + | **8** | List of servers for the source | + | | topic. | + +-----------------------------------+-------------------------------------------------+ + | **9** | The source topic infrastructure. | + | | For e.g. dmaap, noop, ueb | + +-----------------------------------+-------------------------------------------------+ + | **10** | List of topics' details to which | + | | messages are sent. | + +-----------------------------------+-------------------------------------------------+ + | **11** | Topic name of the sink to which | + | | PDP-A sends messages. | + +-----------------------------------+-------------------------------------------------+ + | **12** | List of servers for the sink | + | | topic. | + +-----------------------------------+-------------------------------------------------+ + | **13** | The sink topic infrastructure. | + | | For e.g. dmaap, noop, ueb | + +-----------------------------------+-------------------------------------------------+ diff --git a/docs/design/design.rst b/docs/design/design.rst index da0c3dc3..84beb9e1 100644 --- a/docs/design/design.rst +++ b/docs/design/design.rst @@ -396,7 +396,10 @@ pdp_subgroups R M N/A A list of PDP subgroups ->pdp_type R M N/A The PDP type of this PDP subgroup, currently xacml, drools, or apex ->supported_policy_types R N/A N/A A list of the policy types supported by the PDPs in this PDP - subgroup + subgroup. A trailing “.*” can be used to specify multiple + policy types; for example, “onap.policies.monitoring.*” + would match any policy type beginning with + “onap.policies.monitoring.” ->policies R M N/A The list of policies running on the PDPs in this PDP subgroup ->->(name) R M N/A The name of a TOSCA policy running in this PDP subgroup ->->policy_type R N/A N/A The TOSCA policy type of the policy @@ -861,7 +864,7 @@ services O List of String One or more services the policy appli resources O List of String The unique ID for the Control Loop geography O List of String The target VNF the actor is executing the recipe on -================= ======= ======== ================================================================== +================= ======= ============== ================================================================== This example below shows the JSON body of an Optimize Decision API call. diff --git a/docs/pap/response/group-query-pap-resp.json b/docs/pap/response/group-query-pap-resp.json index eb8b1dbe..cbdf508f 100644 --- a/docs/pap/response/group-query-pap-resp.json +++ b/docs/pap/response/group-query-pap-resp.json @@ -134,15 +134,7 @@ "version": "1.0.0" }, { - "name": "onap.policies.monitoring.cdap.tca.hi.lo.app", - "version": "1.0.0" - }, - { - "name": "onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server", - "version": "1.0.0" - }, - { - "name": "onap.policies.monitoring.docker.sonhandler.app", + "name": "onap.policies.monitoring.*", "version": "1.0.0" }, { |