1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
6 Policy Administration Point (PAP) Architecture
7 ##############################################
12 The Policy Administration Point (PAP) keeps track of PDPs, supporting the deployment of PDP groups and the deployment
13 of policies across those PDP groups. Policies are created using the Policy API, but are deployed via the PAP.
15 The PAP is stateless in a RESTful sense, using the database (persistent storage) to track PDPs and the deployment of
16 policies to those PDPs. In short, policy management on PDPs is the responsibility of PAP; management of policies by
17 any other manner is not permitted.
19 Because the PDP is the main unit of scalability in the Policy Framework, the framework is designed to allow PDPs in a
20 PDP group to arbitrarily appear and disappear and for policy consistency across all PDPs in a PDP group to be easily
21 maintained. The PAP is responsible for controlling the state across the PDPs in a PDP group. The PAP interacts with the
22 policy database and transfers policies to PDPs.
24 The unit of execution and scaling in the Policy Framework is a *PolicyImpl* entity. A *PolicyImpl* entity runs on a PDP.
25 As is explained above, a *PolicyImpl* entity is a *PolicyTypeImpl* implementation parameterized with a TOSCA *Policy*.
27 .. image:: images/PolicyImplPDPSubGroup.svg
29 In order to achieve horizontal scalability, we group the PDPs running instances of a given *PolicyImpl* entity logically
30 together into a *PDPSubGroup*. The number of PDPs in a *PDPSubGroup* can then be scaled up and down using Kubernetes. In
31 other words, all PDPs in a subgroup run the same *PolicyImpl*, that is the same policy template implementation (in
32 XACML, Drools, or APEX) with the same parameters.
34 The figure above shows the layout of *PDPGroup* and *PDPSubGroup* entities. The figure shows examples of PDP groups for
35 Control Loop and Monitoring policies on the right.
37 The health of PDPs is monitored by the PAP in order to alert operations teams managing policies. The PAP manages the life
38 cycle of policies running on PDPs.
40 The table below shows the deployment methods in which *PolicyImpl* entities can be deployed to PDP Subgroups.
42 ========== =========================================== ============================== ==================================
43 **Method** **Description** **Advantages** **Disadvantages**
44 ========== =========================================== ============================== ==================================
45 Cold The *PolicyImpl* (*PolicyTypeImpl* and No run time configuration Very restrictive, no run time
46 TOSCA *Policy*) are predeployed on the PDP. required and run time configuration of PDPs is possible.
47 PDP is fully configured and ready to administration is simple.
50 PDPs register with the PAP when they
51 start, providing the *pdpGroup* they
52 have been preconfigured with.
54 Warm The *PolicyTypeImpl* entity is predeployed The configuration, parameters, Administration and management is
55 on the PDP. A TOSCA *Policy* may be loaded and PDP group of PDPs may be required. The configuration and
56 at startup. The PDP may be configured or changed at run time by loading life cycle of the TOSCA policies
57 reconfigured with a new or updated TOSCA or updating a TOSCA *Policy* can change at run time and must be
58 *Policy* at run time. into the PDP. administered and managed.
60 PDPs register with the PAP when they start, Support TOSCA *Policy* entity
61 providing the *pdpGroup* they have been life cycle managgement is
62 predeployed with if any. The PAP may update supported, allowing features
63 the TOSCA *Policy* on a PDP at any time such as *PolicyImpl* Safe Mode
64 after registration. and *PolicyImpl* retirement.
66 Hot The *PolicyImpl* (*PolicyTypeImpl* and The policy logic, rules, Administration and management is
67 TOSCA *Policy*) are deployed at run time. configuration, parameters, and more complex. The *PolicyImpl*
68 The *PolicyImpl* (*PolicyTypeImpl* and PDP group of PDPs may be itself and its configuration and
69 TOSCA *Policy*) may be loaded at startup. changed at run time by loading life cycle as well as the life
70 The PDP may be configured or reconfigured or updating a TOSCA *Policy* cycle of the TOSCA policies can
71 with a new or updated *PolicyTypeImpl* and *PolicyTypeImpl* into the change at run time and must be
72 and/or TOSCA *Policy* at run time. PDP. administered and managed.
74 PDPs register with the PAP when they Lifecycle management of TOSCA
75 start, providing the *pdpGroup* they have *Policy* entities and
76 been preconfigured with if any. The PAP may *PolicyTypeImpl* entites is
77 update the TOSCA *Policy* and supported, allowing features
78 *PolicyTypeImpl* on a PDP at any time after such as *PolicyImpl* Safe Mode
79 registration and *PolicyImpl* retirement.
80 ========== =========================================== ============================== ==================================
85 The APIs in the subchapters below are supported by the PAP.
90 The purpose of this API is to support CRUD of PDP groups and subgroups and to support the deployment and life cycles of
91 policies on PDP sub groups and PDPs. This API is provided by the *PolicyAdministration* component (PAP) of the Policy
92 Framework, see the :ref:`ONAP Policy Framework Architecture <architecture-label>` page.
94 PDP groups and subgroups may be prefedined in the system. Predefined groups and subgroups may be modified or deleted
95 over this API. The policies running on predefined groups or subgroups as well as the instance counts and properties may
98 A PDP may be preconfigured with its PDP group, PDP subgroup, and policies. The PDP sends this information to the PAP
99 when it starts. If the PDP group, subgroup, or any policy is unknown to the PAP, the PAP locks the PDP in state PASSIVE.
101 PAP supports the operations listed in the following table, via its REST API:
104 :header: "Operation", "Description"
107 "Health check", "Queries the health of the PAP"
108 "Consolidated healthcheck", "Queries the health of all policy components"
109 "Statistics", "Queries various statistics"
110 "PDP state change", "Changes the state of all PDPs in a PDP Group"
111 "PDP Group create/update", "Creates/updates PDP Groups"
112 "PDP Group delete", "Deletes a PDP Group"
113 "PDP Group query", "Queries all PDP Groups"
114 "Deployment update", "Deploy/undeploy one or more policies in specified PdpGroups"
115 "Deploy policy", "Deploys one or more policies to the PDPs"
116 "Undeploy policy", "Undeploys a policy from the PDPs"
117 "Policy deployment status", "Queries the status of all deployed policies"
118 "PDP statistics", "Queries the statistics of PDPs"
123 PAP interacts with the PDPs via the DMaaP Message Router. The messages listed
124 in the following table are transmitted via DMaaP:
127 :header: "Message", "Direction", "Description"
130 "PDP status", "Incoming", "Registers a PDP with PAP; also sent as a periodic heart beat; also sent in response to requests from the PAP"
131 "PDP update", "Outgoing", "Assigns a PDP to a PDP Group and Subgroup; also deploys or undeploys policies from the PDP"
132 "PDP state change", "Outgoing", "Changes the state of a PDP or all PDPs within a PDP Group or Subgroup"
134 In addition, PAP generates notifications via the DMaaP Message Router when policies are successfully or unsuccessfully
135 deployed (or undeployed) from all relevant PDPs.
137 Here is a sample notification:
139 .. literalinclude:: notification/dmaap-pap-notif.json
143 2 PAP REST API Swagger
144 ======================
146 It is worth noting that we use basic authorization for access with user name and password set to *healthcheck* and
147 *zb!XztG34*, respectively.
149 For every call, the client is encouraged to insert a uuid-type *requestID* as parameter. It is helpful for tracking each
150 http transaction and facilitates debugging. More importantly, it complies with Logging requirements v1.2. If the client
151 does not provide the requestID in a call, one will be randomly generated and attached to the response header,
154 In accordance with `ONAP API Common Versioning Strategy Guidelines
155 <https://wiki.onap.org/display/DW/ONAP+API+Common+Versioning+Strategy+%28CVS%29+Guidelines>`_, several custom headers
156 are added in the response to each call:
159 :header: "Header", "Example value", "Description"
162 "x-latestversion", "1.0.0", "latest version of the API"
163 "x-minorversion", "0", "MINOR version of the API"
164 "x-patchversion", "0", "PATCH version of the API"
165 "x-onap-requestid", "e1763e61-9eef-4911-b952-1be1edd9812b", "described above; used for logging purposes"
167 :download:`Download Health Check PAP API Swagger <swagger/health-check-pap.json>`
169 .. swaggerv2doc:: swagger/health-check-pap.json
171 This operation performs a health check on the PAP.
173 Here is a sample response:
175 .. literalinclude:: response/health-check-pap-resp.json
178 :download:`Download Consolidated Health Check PAP API Swagger <swagger/consolidated-healthcheck-pap.json>`
180 .. swaggerv2doc:: swagger/consolidated-healthcheck-pap.json
182 This operation performs a health check of all policy components. The response
183 contains the health check result of each component. The consolidated health check
184 is reported as healthy only if all the components are healthy, otherwise the
185 "healthy" flag is marked as false.
187 Here is a sample response:
189 .. literalinclude:: response/consolidated-healthcheck-pap-resp.json
192 :download:`Download Statistics PAP API Swagger <swagger/statistics-pap.json>`
194 .. swaggerv2doc:: swagger/statistics-pap.json
196 This operation allows statistics for PDP groups, PDP subgroups, and individual PDPs to be retrieved.
199 While this API is supported, most of the statistics are not currently updated; that work has been deferred to a later
202 Here is a sample response:
204 .. literalinclude:: response/statistics-pap-resp.json
207 :download:`Download State Change PAP Swagger <swagger/state-change-pap.json>`
209 .. swaggerv2doc:: swagger/state-change-pap.json
211 The state of PDP groups is managed by this operation. PDP groups can be in states PASSIVE, TEST, SAFE, or ACTIVE. For a full
212 description of PDP group states, see the :ref:`ONAP Policy Framework Architecture <architecture-label>` page.
214 :download:`Download Group Batch PAP API Swagger <swagger/groups-batch-pap.json>`
216 .. swaggerv2doc:: swagger/groups-batch-pap.json
218 This operation allows the PDP groups and subgroups to be created and updated. Many PDP groups can be created or updated
219 in a single POST operation by specifying more than one PDP group in the POST operation body.
220 This can be used to create the PDP group by providing all the details including the supported policy types for each subgroup.
221 However, it cannot be used to update policies; that is done using one of
222 the deployment requests. Consequently, the "policies" property of this
223 request will be ignored.
224 This can also be used to update a PDP Group, but supported policy types cannot be updated during the update operation.
225 So, "policies" and "supportedPolicyTypes" properties in the request will be ignored if provided during the PDP Group update operation.
228 If a subgroup is to be deleted from a PDP Group, then the policies must be removed from
232 Policies cannot be added/updated during PDP Group create/update operations. So, if provided, they are ignored.
233 Supported policy types are defined during PDP Group creation. They cannot be updated once they are created.
234 So, supportedPolicyTypes are expected during PDP Group create, but ignored if provided during PDP Group update.
236 Here is a sample request:
238 .. literalinclude:: request/groups-batch-pap-req.json
241 :download:`Download Group Delete PAP API Swagger <swagger/group-delete-pap.json>`
243 .. swaggerv2doc:: swagger/group-delete-pap.json
245 The API also allows PDP groups to be deleted. DELETE operations are only permitted on PDP groups in PASSIVE state.
247 :download:`Download Group Query PAP API Swagger <swagger/group-query-pap.json>`
249 .. swaggerv2doc:: swagger/group-query-pap.json
251 This operation allows the PDP groups and subgroups to be listed as well as the policies that are deployed on each PDP
254 Here is a sample response:
256 .. literalinclude:: response/group-query-pap-resp.json
259 :download:`Download Deployments Batch PAP API Swagger <swagger/deployments-batch-pap.json>`
261 .. swaggerv2doc:: swagger/deployments-batch-pap.json
263 This operation allows policies to be deployed on specific PDP groups.
264 Each subgroup includes an "action" property, which is used to indicate
265 that the policies are being added (POST) to the subgroup, deleted (DELETE)
266 from the subgroup, or that the subgroup's entire set of policies is being
267 replaced (PATCH) by a new set of policies. As such, a subgroup may appear
268 more than once in a single request, one time to delete some policies and
269 another time to add new policies to the same subgroup.
271 Here is a sample request:
273 .. literalinclude:: request/deployment-batch-pap-req.json
276 :download:`Download Deploy PAP API Swagger <swagger/policy-deploy-pap.json>`
278 .. swaggerv2doc:: swagger/policy-deploy-pap.json
280 This operation allows policies to be deployed across all relevant PDP groups.
281 PAP will deploy the specified policies to all relevant subgroups. Only the
282 policies supported by a given subgroup will be deployed to that subgroup.
285 The policy version is optional. If left unspecified, then the latest version of the policy is deployed. On the other
286 hand, if it is specified, it may be an integer, or it may be a fully qualified version (e.g., "3.0.2").
287 In addition, a subgroup to which a policy is being deployed must have at
288 least one PDP instance, otherwise the request will be rejected.
290 Here is a sample request:
292 .. literalinclude:: request/policy-deploy-pap-req.json
295 :download:`Download Undeploy PAP API Swagger <swagger/policy-undeploy-pap.json>`
297 .. swaggerv2doc:: swagger/policy-undeploy-pap.json
299 This operation allows policies to be undeployed from PDP groups.
302 If the policy version is specified, then it may be an integer, or it may be a fully qualified version (e.g., "3.0.2").
303 On the other hand, if left unspecified, then the latest deployed version will be undeployed.
306 Due to current limitations, a fully qualified policy version must always be specified.
308 :download:`Download Deployed Policy PAP API Swagger <swagger/deployed-policy-pap.json>`
310 .. swaggerv2doc:: swagger/deployed-policy-pap.json
312 This operation allows the deployed policies to be listed together with their respective deployment status.
313 The result can be filtered based on policy name & version.
315 Here is a sample response:
317 .. literalinclude:: response/deployed-policy-pap-resp.json
320 :download:`Download PDP Statistics PAP API Swagger <swagger/pdp-statistics-pap.json>`
322 .. swaggerv2doc:: swagger/pdp-statistics-pap.json
324 This operation allows the PDP statistics to be retrieved for all registered PDPs.
325 The result can be filtered based on PDP group, PDP subgroup & PDP instance.
327 Here is a sample response:
329 .. literalinclude:: response/pdp-statistics-pap-resp.json
336 3.1 Disable policies in PDP
337 ===========================
339 This operation will allow disabling individual policies running in PDP engine. It is mainly beneficial
340 in scenarios where network operators/administrators want to disable a particular policy in PDP engine
341 for a period of time due to a failure in the system or for scheduled maintenance.