docs/pap/pap.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 .. _pap-label:
   5
   6 Policy Administration Point (PAP) Architecture
   7 ##############################################
   8
   9 .. contents::
  10     :depth: 3
  11
  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.
  14
  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.
  18
  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.
  23
  24 There are a number of rules for PDP group and PDP state management:
  25
  26 1. Only one version of a PDP group may be ACTIVE at any time
  27
  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
  30
  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
  33
  34 4. There is no restriction on the number of PASSIVE versions of a PDP group that can exist in the system
  35
  36
  37 1 APIs
  38 ======
  39 The APIs in the subchapters below are supported by the PAP.
  40
  41 1.1 REST API
  42 ------------
  43
  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.
  47
  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
  50 also be modified.
  51
  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.
  54
  55 PAP supports the operations listed in the following table, via its REST API:
  56
  57 .. csv-table::
  58    :header: "Operation", "Description"
  59    :widths: 25,70
  60
  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"
  69
  70 1.2 DMaaP API
  71 -------------
  72
  73 PAP interacts with the PDPs via the DMaaP Message Router.  The messages listed
  74 in the following table are transmitted via DMaaP:
  75
  76 .. csv-table::
  77    :header: "Message", "Direction", "Description"
  78    :widths: 25,10,70
  79
  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"
  83
  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.
  86
  87 Here is a sample notification:
  88
  89 .. literalinclude:: notification/dmaap-pap-notif.json
  90     :language: json
  91
  92
  93 2 PAP REST API Swagger
  94 ======================
  95
  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.
  98
  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,
 102 *x-onap-requestid*.
 103
 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:
 107
 108 .. csv-table::
 109    :header: "Header", "Example value", "Description"
 110    :widths: 25,10,70
 111
 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"
 116
 117
 118 .. swaggerv2doc:: swagger/health-check-pap.json
 119
 120 This operation performs a health check on the PAP.
 121
 122 Here is a sample response:
 123
 124 .. literalinclude:: response/health-check-pap-resp.json
 125     :language: json
 126
 127 .. swaggerv2doc:: swagger/statistics-pap.json
 128
 129 This operation allows statistics for PDP groups, PDP subgroups, and individual PDPs to be retrieved.
 130
 131 .. note::
 132   While this API is supported, most of the statistics are not currently updated; that work has been deferred to a later
 133   release.
 134
 135 Here is a sample response:
 136
 137 .. literalinclude:: response/statistics-pap-resp.json
 138     :language: json
 139
 140 .. swaggerv2doc:: swagger/state-change-pap.json
 141
 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.
 144
 145 .. swaggerv2doc:: swagger/groups-batch-pap.json
 146
 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 update the policy types supported by various subgroups.
 150 However, it cannot be used to update policies; that is done using one of
 151 the deployment requests.  Consequently, the "policy" property of this
 152 request will be ignored.
 153
 154 .. note::
 155   Due to current limitations, if a subgroup is to be deleted from a PDP Group, then the policies must be removed from
 156   the subgroup first.
 157
 158 Here is a sample request:
 159
 160 .. literalinclude:: request/groups-batch-pap-req.json
 161     :language: json
 162
 163 .. swaggerv2doc:: swagger/group-delete-pap.json
 164
 165 The API also allows PDP groups to be deleted. DELETE operations are only permitted on PDP groups in PASSIVE state.
 166
 167 .. swaggerv2doc:: swagger/group-query-pap.json
 168
 169 This operation allows the PDP groups and subgroups to be listed as well as the policies that are deployed on each PDP
 170 group and subgroup.
 171
 172 Here is a sample response:
 173
 174 .. literalinclude:: response/group-query-pap-resp.json
 175     :language: json
 176
 177 .. swaggerv2doc:: swagger/deployments-batch-pap.json
 178
 179 This operation allows policies to be deployed on specific PDP groups.
 180 Each subgroup includes an "action" property, which is used to indicate
 181 that the policies are being added (POST) to the subgroup, deleted (DELETE)
 182 from the subgroup, or that the subgroup's entire set of policies is being
 183 replaced (PATCH) by a new set of policies.  As such, a subgroup may appear
 184 more than once in a single request, one time to delete some policies and
 185 another time to add new policies to the same subgroup.
 186
 187 Here is a sample request:
 188
 189 .. literalinclude:: request/deployment-batch-pap-req.json
 190     :language: json
 191
 192 .. swaggerv2doc:: swagger/policy-deploy-pap.json
 193
 194 This operation allows policies to be deployed across all relevant PDP groups.
 195 PAP will deploy the specified policies to all relevant subgroups.  Only the
 196 policies supported by a given subgroup will be deployed to that subgroup.
 197
 198 .. note::
 199   The policy version is optional.  If left unspecified, then the latest version of the policy is deployed. On the other
 200   hand, if it is specified, it may be an integer, or it may be a fully qualified version (e.g., "3.0.2").
 201   In addition, a subgroup to which a policy is being deployed must have at
 202   least one PDP instance, otherwise the request will be rejected.
 203
 204 Here is a sample request:
 205
 206 .. literalinclude:: request/policy-deploy-pap-req.json
 207     :language: json
 208
 209 .. swaggerv2doc:: swagger/policy-undeploy-pap.json
 210
 211 This operation allows policies to be undeployed from PDP groups.
 212
 213 .. note::
 214   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").
 215   On the other hand, if left unspecified, then the latest deployed version will be undeployed.
 216
 217 .. note::
 218   Due to current limitations, a fully qualified policy version must always be specified.
 219
 220 3 Future Features
 221 =================
 222
 223 3.1 Order Health Check on PDPs
 224 ==============================
 225
 226 This operation will allow a PDP group health check to be ordered on PDP groups and on individual PDPs. The operation
 227 will return a HTTP status code of *202: Accepted* if the health check request has been accepted by the PAP. The PAP will
 228 then order execution of the health check on the PDPs.
 229
 230 As health checks may be long lived operations, Health checks will be scheduled for execution by this operation. Users
 231 will check the result of a health check test by issuing a PDP Group Query operation and checking the *healthy* field of
 232 PDPs.
 233
 234
 235 End of Document