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 PAP keeps track of PDPs, supporting the deployment of PDP groups and the deployment of a *policy set* across those
13 PDP groups. Policies are created using the Policy API, but are deployed via the PAP.
15 A 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 PAPs; management of policy sets or
17 policies by 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 policy sets to PDPs.
24 There are a number of rules for PDP group and PDP state management:
26 1. Only one version of a PDP group may be ACTIVE at any time
28 2. If a PDP group with a certain version is ACTIVE and a later version of the same PDP group is activated, then the
29 system upgrades the PDP group
31 3. If a PDP group with a certain version is ACTIVE and an earlier version of the same PDP group is activated, then the
32 system downgrades the PDP group
34 4. There is no restriction on the number of PASSIVE versions of a PDP group that can exist in the system
39 The APIs in the subchapters below are supported by the PAP.
44 The purpose of this API is to support CRUD of PDP groups and subgroups and to support the deployment and life cycles of
45 policies on PDP sub groups and PDPs. This API is provided by the *PolicyAdministration* component (PAP) of the Policy
46 Framework, see the :ref:`ONAP Policy Framework Architecture <architecture-label>` page.
48 PDP groups and subgroups may be prefedined in the system. Predefined groups and subgroups may be modified or deleted
49 over this API. The policies running on predefined groups or subgroups as well as the instance counts and properties may
52 A PDP may be preconfigured with its PDP group, PDP subgroup, and policies. The PDP sends this information to the PAP
53 when it starts. If the PDP group, subgroup, or any policy is unknown to the PAP, the PAP locks the PDP in state PASSIVE.
55 PAP supports the operations listed in the following table, via its REST API:
58 :header: "Operation", "Description"
61 "Health check", "Queries the health of the PAP"
62 "Statistics", "Queries various statistics"
63 "PDP state change", "Changes the state of all PDPs in a PDP Group"
64 "PDP Group create/update", "Creates/updates PDP Groups"
65 "PDP Group delete", "Deletes a PDP Group"
66 "PDP Group query", "Queries all PDP Groups"
67 "Deploy policy", "Deploys one or more policies to the PDPs"
68 "Undeploy policy", "Undeploys a policy from the PDPs"
73 PAP interacts with the PDPs via the DMaaP Message Router. The messages listed
74 in the following table are transmitted via DMaaP:
77 :header: "Message", "Direction", "Description"
80 "PDP status", "Incoming", "Registers a PDP with PAP; also sent as a periodic heart beat; also sent in response to requests from the PAP"
81 "PDP update", "Outgoing", "Assigns a PDP to a PDP Group and Subgroup; also deploys or undeploys policies from the PDP"
82 "PDP state change", "Outgoing", "Changes the state of a PDP or all PDPs within a PDP Group or Subgroup"
84 In addition, PAP generates notifications via the DMaaP Message Router when policies are successfully or unsuccessfully
85 deployed (or undeployed) from all relevant PDPs.
87 Here is a sample notification:
89 .. literalinclude:: notification/dmaap-pap-notif.json
93 2 PAP REST API Swagger
94 ======================
96 It is worth noting that we use basic authorization for access with user name and password set to *healthcheck* and
97 *zb!XztG34*, respectively.
99 For every call, the client is encouraged to insert a uuid-type *requestID* as parameter. It is helpful for tracking each
100 http transaction and facilitates debugging. More importantly, it complies with Logging requirements v1.2. If the client
101 does not provide the requestID in a call, one will be randomly generated and attached to the response header,
104 In accordance with `ONAP API Common Versioning Strategy Guidelines
105 <https://wiki.onap.org/display/DW/ONAP+API+Common+Versioning+Strategy+%28CVS%29+Guidelines>`_, several custom headers
106 are added in the response to each call:
109 :header: "Header", "Example value", "Description"
112 "x-latestversion", "1.0.0", "latest version of the API"
113 "x-minorversion", "0", "MINOR version of the API"
114 "x-patchversion", "0", "PATCH version of the API"
115 "x-onap-requestid", "e1763e61-9eef-4911-b952-1be1edd9812b", "described above; used for logging purposes"
118 .. swaggerv2doc:: swagger/health-check-pap.json
120 This operation performs a health check on the PAP.
122 Here is a sample response:
124 .. literalinclude:: response/health-check-pap-resp.json
127 .. swaggerv2doc:: swagger/statistics-pap.json
129 This operation allows statistics for PDP groups, PDP subgroups, and individual PDPs to be retrieved.
132 While this API is supported, most of the statistics are not currently updated; that work has been deferred to a later
135 Here is a sample response:
137 .. literalinclude:: response/statistics-pap-resp.json
140 .. swaggerv2doc:: swagger/state-change-pap.json
142 The state of PDP groups is managed by this operation. PDP groups can be in states PASSIVE, TEST, SAFE, or ACTIVE. For a full
143 description of PDP group states, see the :ref:`ONAP Policy Framework Architecture <architecture-label>` page.
145 .. swaggerv2doc:: swagger/groups-batch-pap.json
147 This operation allows the PDP groups and subgroups to be created and updated. Many PDP groups can be created or updated
148 in a single POST operation by specifying more than one PDP group in the POST operation body.
149 This can be used to create the PDP group by providing all the details including the supported policy types for each subgroup.
150 However, it cannot be used to update policies; that is done using one of
151 the deployment requests. Consequently, the "policies" property of this
152 request will be ignored.
153 This can also be used to update a PDP Group, but supported policy types cannot be updated during the update operation.
154 So, "policies" and "supportedPolicyTypes" properties in the request will be ignored if provided during the PDP Group update operation.
157 If a subgroup is to be deleted from a PDP Group, then the policies must be removed from
161 Policies cannot be added/updated during PDP Group create/update operations. So, if provided, they are ignored.
162 Supported policy types are defined during PDP Group creation. They cannot be updated once they are created.
163 So, supportedPolicyTypes are expected during PDP Group create, but ignored if provided during PDP Group update.
165 Here is a sample request:
167 .. literalinclude:: request/groups-batch-pap-req.json
170 .. swaggerv2doc:: swagger/group-delete-pap.json
172 The API also allows PDP groups to be deleted. DELETE operations are only permitted on PDP groups in PASSIVE state.
174 .. swaggerv2doc:: swagger/group-query-pap.json
176 This operation allows the PDP groups and subgroups to be listed as well as the policies that are deployed on each PDP
179 Here is a sample response:
181 .. literalinclude:: response/group-query-pap-resp.json
184 .. swaggerv2doc:: swagger/deployments-batch-pap.json
186 This operation allows policies to be deployed on specific PDP groups.
187 Each subgroup includes an "action" property, which is used to indicate
188 that the policies are being added (POST) to the subgroup, deleted (DELETE)
189 from the subgroup, or that the subgroup's entire set of policies is being
190 replaced (PATCH) by a new set of policies. As such, a subgroup may appear
191 more than once in a single request, one time to delete some policies and
192 another time to add new policies to the same subgroup.
194 Here is a sample request:
196 .. literalinclude:: request/deployment-batch-pap-req.json
199 .. swaggerv2doc:: swagger/policy-deploy-pap.json
201 This operation allows policies to be deployed across all relevant PDP groups.
202 PAP will deploy the specified policies to all relevant subgroups. Only the
203 policies supported by a given subgroup will be deployed to that subgroup.
206 The policy version is optional. If left unspecified, then the latest version of the policy is deployed. On the other
207 hand, if it is specified, it may be an integer, or it may be a fully qualified version (e.g., "3.0.2").
208 In addition, a subgroup to which a policy is being deployed must have at
209 least one PDP instance, otherwise the request will be rejected.
211 Here is a sample request:
213 .. literalinclude:: request/policy-deploy-pap-req.json
216 .. swaggerv2doc:: swagger/policy-undeploy-pap.json
218 This operation allows policies to be undeployed from PDP groups.
221 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").
222 On the other hand, if left unspecified, then the latest deployed version will be undeployed.
225 Due to current limitations, a fully qualified policy version must always be specified.
230 3.1 Order Health Check on PDPs
231 ==============================
233 This operation will allow a PDP group health check to be ordered on PDP groups and on individual PDPs. The operation
234 will return a HTTP status code of *202: Accepted* if the health check request has been accepted by the PAP. The PAP will
235 then order execution of the health check on the PDPs.
237 As health checks may be long lived operations, Health checks will be scheduled for execution by this operation. Users
238 will check the result of a health check test by issuing a PDP Group Query operation and checking the *healthy* field of