X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fpap%2Fpap.rst;h=b2c98ef5ba319d9030e660953d16e99c72654879;hb=1d101d211bd065a8b602f2a675632fabedd6417e;hp=964712e626bada681835d3f478314abe9d92818d;hpb=e0c41c604ac6697f340bf37b137b0ca2f67143eb;p=policy%2Fparent.git diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst index 964712e6..b2c98ef5 100644 --- a/docs/pap/pap.rst +++ b/docs/pap/pap.rst @@ -9,6 +9,9 @@ Policy Administration Point (PAP) Architecture .. contents:: :depth: 3 +.. toctree:: + InternalPapPdp.rst + The Policy Administration Point (PAP) keeps track of PDPs, supporting the deployment of PDP groups and the deployment of policies across those PDP groups. Policies are created using the Policy API, but are deployed via the PAP. @@ -21,6 +24,64 @@ PDP group to arbitrarily appear and disappear and for policy consistency across maintained. The PAP is responsible for controlling the state across the PDPs in a PDP group. The PAP interacts with the policy database and transfers policies to PDPs. +The unit of execution and scaling in the Policy Framework is a *PolicyImpl* entity. A *PolicyImpl* entity runs on a PDP. +As is explained above, a *PolicyImpl* entity is a *PolicyTypeImpl* implementation parameterized with a TOSCA *Policy*. + +.. image:: images/PolicyImplPDPSubGroup.svg + +In order to achieve horizontal scalability, we group the PDPs running instances of a given *PolicyImpl* entity logically +together into a *PDPSubGroup*. The number of PDPs in a *PDPSubGroup* can then be scaled up and down using Kubernetes. In +other words, all PDPs in a subgroup run the same *PolicyImpl*, that is the same policy template implementation (in +XACML, Drools, or APEX) with the same parameters. + +The figure above shows the layout of *PDPGroup* and *PDPSubGroup* entities. The figure shows examples of PDP groups for +Control Loop and Monitoring policies on the right. + +The health of PDPs is monitored by the PAP in order to alert operations teams managing policies. The PAP manages the life +cycle of policies running on PDPs. + +The table below shows the deployment methods in which *PolicyImpl* entities can be deployed to PDP Subgroups. + +========== =========================================== ============================== ================================== +**Method** **Description** **Advantages** **Disadvantages** +========== =========================================== ============================== ================================== +Cold The *PolicyImpl* (*PolicyTypeImpl* and No run time configuration Very restrictive, no run time + TOSCA *Policy*) are predeployed on the PDP. required and run time configuration of PDPs is possible. + PDP is fully configured and ready to administration is simple. + execute when started. + + PDPs register with the PAP when they + start, providing the *pdpGroup* they + have been preconfigured with. + +Warm The *PolicyTypeImpl* entity is predeployed The configuration, parameters, Administration and management is + on the PDP. A TOSCA *Policy* may be loaded and PDP group of PDPs may be required. The configuration and + at startup. The PDP may be configured or changed at run time by loading life cycle of the TOSCA policies + reconfigured with a new or updated TOSCA or updating a TOSCA *Policy* can change at run time and must be + *Policy* at run time. into the PDP. administered and managed. + + PDPs register with the PAP when they start, Support TOSCA *Policy* entity + providing the *pdpGroup* they have been life cycle managgement is + predeployed with if any. The PAP may update supported, allowing features + the TOSCA *Policy* on a PDP at any time such as *PolicyImpl* Safe Mode + after registration. and *PolicyImpl* retirement. + +Hot The *PolicyImpl* (*PolicyTypeImpl* and The policy logic, rules, Administration and management is + TOSCA *Policy*) are deployed at run time. configuration, parameters, and more complex. The *PolicyImpl* + The *PolicyImpl* (*PolicyTypeImpl* and PDP group of PDPs may be itself and its configuration and + TOSCA *Policy*) may be loaded at startup. changed at run time by loading life cycle as well as the life + The PDP may be configured or reconfigured or updating a TOSCA *Policy* cycle of the TOSCA policies can + with a new or updated *PolicyTypeImpl* and *PolicyTypeImpl* into the change at run time and must be + and/or TOSCA *Policy* at run time. PDP. administered and managed. + + PDPs register with the PAP when they Lifecycle management of TOSCA + start, providing the *pdpGroup* they have *Policy* entities and + been preconfigured with if any. The PAP may *PolicyTypeImpl* entites is + update the TOSCA *Policy* and supported, allowing features + *PolicyTypeImpl* on a PDP at any time after such as *PolicyImpl* Safe Mode + registration and *PolicyImpl* retirement. +========== =========================================== ============================== ================================== + 1 APIs ====== @@ -105,7 +166,8 @@ are added in the response to each call: "x-minorversion", "0", "MINOR version of the API" "x-patchversion", "0", "PATCH version of the API" "x-onap-requestid", "e1763e61-9eef-4911-b952-1be1edd9812b", "described above; used for logging purposes" - + +:download:`Download Health Check PAP API Swagger ` .. swaggerv2doc:: swagger/health-check-pap.json @@ -116,6 +178,8 @@ Here is a sample response: .. literalinclude:: response/health-check-pap-resp.json :language: json +:download:`Download Consolidated Health Check PAP API Swagger ` + .. swaggerv2doc:: swagger/consolidated-healthcheck-pap.json This operation performs a health check of all policy components. The response @@ -128,6 +192,8 @@ Here is a sample response: .. literalinclude:: response/consolidated-healthcheck-pap-resp.json :language: json +:download:`Download Statistics PAP API Swagger ` + .. swaggerv2doc:: swagger/statistics-pap.json This operation allows statistics for PDP groups, PDP subgroups, and individual PDPs to be retrieved. @@ -141,11 +207,15 @@ Here is a sample response: .. literalinclude:: response/statistics-pap-resp.json :language: json +:download:`Download State Change PAP Swagger ` + .. swaggerv2doc:: swagger/state-change-pap.json The state of PDP groups is managed by this operation. PDP groups can be in states PASSIVE, TEST, SAFE, or ACTIVE. For a full description of PDP group states, see the :ref:`ONAP Policy Framework Architecture ` page. +:download:`Download Group Batch PAP API Swagger ` + .. swaggerv2doc:: swagger/groups-batch-pap.json This operation allows the PDP groups and subgroups to be created and updated. Many PDP groups can be created or updated @@ -171,10 +241,14 @@ Here is a sample request: .. literalinclude:: request/groups-batch-pap-req.json :language: json +:download:`Download Group Delete PAP API Swagger ` + .. swaggerv2doc:: swagger/group-delete-pap.json The API also allows PDP groups to be deleted. DELETE operations are only permitted on PDP groups in PASSIVE state. +:download:`Download Group Query PAP API Swagger ` + .. swaggerv2doc:: swagger/group-query-pap.json This operation allows the PDP groups and subgroups to be listed as well as the policies that are deployed on each PDP @@ -185,6 +259,8 @@ Here is a sample response: .. literalinclude:: response/group-query-pap-resp.json :language: json +:download:`Download Deployments Batch PAP API Swagger ` + .. swaggerv2doc:: swagger/deployments-batch-pap.json This operation allows policies to be deployed on specific PDP groups. @@ -200,6 +276,8 @@ Here is a sample request: .. literalinclude:: request/deployment-batch-pap-req.json :language: json +:download:`Download Deploy PAP API Swagger ` + .. swaggerv2doc:: swagger/policy-deploy-pap.json This operation allows policies to be deployed across all relevant PDP groups. @@ -217,6 +295,8 @@ Here is a sample request: .. literalinclude:: request/policy-deploy-pap-req.json :language: json +:download:`Download Undeploy PAP API Swagger ` + .. swaggerv2doc:: swagger/policy-undeploy-pap.json This operation allows policies to be undeployed from PDP groups. @@ -228,6 +308,8 @@ This operation allows policies to be undeployed from PDP groups. .. note:: Due to current limitations, a fully qualified policy version must always be specified. +:download:`Download Deployed Policy PAP API Swagger ` + .. swaggerv2doc:: swagger/deployed-policy-pap.json This operation allows the deployed policies to be listed together with their respective deployment status. @@ -238,6 +320,8 @@ Here is a sample response: .. literalinclude:: response/deployed-policy-pap-resp.json :language: json +:download:`Download PDP Statistics PAP API Swagger ` + .. swaggerv2doc:: swagger/pdp-statistics-pap.json This operation allows the PDP statistics to be retrieved for all registered PDPs.