docs/api/api.rst

   1 .. This work is licensed under a
   2 .. Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4
   5 .. _api-label:
   6
   7 Policy Life Cycle API
   8 #####################
   9
  10 .. contents::
  11     :depth: 2
  12
  13
  14 Policy life cycle API comprises of policy design API and policy deployment API. This documentation focuses on policy
  15 design API. Policy design API is publicly exposed for clients to Create/Read/Update/Delete (CRUD) policy types, policy type
  16 implementation and policies which can be recognized and executable by appropriate policy engines incorporated in ONAP
  17 policy framework. Policy design API backend is running in an independent building block component of policy framework
  18 that provides REST service for aforementioned CRUD behaviors. Policy design API component interacts with a policy database
  19 for storing and fetching new policies or policy types as needed. Apart from CRUD, API is also exposed for clients to retrieve
  20 healthcheck status of this API REST service and statistics report including a variety of counters that reflect the history
  21 of API invocation.
  22
  23 Starting from Dublin release, we strictly follow `TOSCA Specification <http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.1/TOSCA-Simple-Profile-YAML-v1.1.pdf>`_
  24 to define policy type and policy. Policy type is equivalent to policy model mentioned by clients before Dublin release.
  25 Both policy type and policy are included in a TOSCA Service Template which is used as the entity passed into API POST call
  26 and the entity returned by API GET and DELETE calls. More details are presented in following sessions.
  27 We encourage clients to compose all kinds of policies and corresponding policy types in well-formed TOSCA Service Template.
  28 One Service Template can contain one or more policies and policy types. Each policy type can have multiple policies created
  29 atop. In other words, different policies can match the same or different policy types. Existence of a policy type is a prerequisite
  30 of creating such type of policies. In the payload body of each policy to create, policy type name and version should be indicated and
  31 the specified policy type should be valid and existing in policy database.
  32
  33 In Dublin release, to ease policy creation, we preload several widely used policy types in policy database. Below is a table summarizing
  34 preloaded policy types.
  35
  36 .. csv-table::
  37    :header: "Policy Type Name", "Preloaded JSON"
  38    :widths: 15,10
  39
  40    "Controlloop.Guard.Blacklist", ":download:`link <policytypes/onap.policies.controlloop.guard.Blacklist.json>`"
  41    "Controlloop.Guard.FrequencyLimiter", ":download:`link <policytypes/onap.policies.controlloop.guard.FrequencyLimiter.json>`"
  42    "Controlloop.Guard.MinMax", ":download:`link <policytypes/onap.policies.controlloop.guard.MinMax.json>`"
  43    "Controlloop.Operational", ":download:`link <policytypes/onap.policies.controlloop.Operational.json>`"
  44    "Monitoring.TCA", ":download:`link <policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json>`"
  45    "Monitoring.Collectors", ":download:`link <policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.json>`"
  46    "Optimization.AffinityPolicy", ":download:`link <policytypes/onap.policies.optimization.AffinityPolicy.json>`"
  47    "Optimization.DistancePolicy", ":download:`link <policytypes/onap.policies.optimization.DistancePolicy.json>`"
  48    "Optimization.HpaPolicy", ":download:`link <policytypes/onap.policies.optimization.HpaPolicy.json>`"
  49    "Optimization.OptimizationPolicy", ":download:`link <policytypes/onap.policies.optimization.OptimizationPolicy.json>`"
  50    "Optimization.PciPolicy", ":download:`link <policytypes/onap.policies.optimization.PciPolicy.json>`"
  51    "Optimization.QueryPolicy", ":download:`link <policytypes/onap.policies.optimization.QueryPolicy.json>`"
  52    "Optimization.SubscriberPolicy", ":download:`link <policytypes/onap.policies.optimization.SubscriberPolicy.json>`"
  53    "Optimization.Vim_fit", ":download:`link <policytypes/onap.policies.optimization.Vim_fit.json>`"
  54    "Optimization.VnfPolicy", ":download:`link <policytypes/onap.policies.optimization.VnfPolicy.json>`"
  55
  56
  57 Also, in Dublin release, We provide backward compatibility support for controlloop operational and guard
  58 policies encoded in legacy format. Below is a table containing sample legacy guard/operational policies and
  59 well-formed TOSCA monitoring policies.
  60
  61 .. csv-table::
  62    :header: "Policy Name", "Policy JSON"
  63    :widths: 15,10
  64
  65    "vCPE.Monitoring.Tosca", ":download:`link <policies/vCPE.policy.monitoring.input.tosca.json>`"
  66    "vCPE.Operational.Legacy", ":download:`link <policies/vCPE.policy.operational.input.json>`"
  67    "vDNS.Guard.FrequencyLimiting.Legacy", ":download:`link <policies/vDNS.policy.guard.frequency.input.json>`"
  68    "vDNS.Guard.MinMax.Legacy", ":download:`link <policies/vDNS.policy.guard.minmax.input.json>`"
  69    "vDNS.Monitoring.Tosca", ":download:`link <policies/vDNS.policy.monitoring.input.tosca.json>`"
  70    "vDNS.Operational.Legacy", ":download:`link <policies/vDNS.policy.operational.input.json>`"
  71    "vFirewall.Monitoring.Tosca", ":download:`link <policies/vFirewall.policy.monitoring.input.tosca.json>`"
  72    "vFirewall.Operational.Legacy", ":download:`link <policies/vFirewall.policy.operational.input.json>`"
  73
  74
  75 Below is a global API table from where swagger JSON for different types of policy design API can be downloaded.
  76
  77 Global API Table
  78 --------------------
  79 .. csv-table::
  80    :header: "API name", "Swagger JSON"
  81    :widths: 10,5
  82
  83    "Healthcheck API", ":download:`link <swagger/healthcheck-api.json>`"
  84    "Statistics API", ":download:`link <swagger/statistics-api.json>`"
  85    "Tosca Policy Type API", ":download:`link <swagger/policytype-api.json>`"
  86    "Tosca Policy API", ":download:`link <swagger/policy-api.json>`"
  87    "Legacy Guard Policy API", ":download:`link <swagger/guard-policy-api.json>`"
  88    "Legacy Operational Policy API", ":download:`link <swagger/operational-policy-api.json>`"
  89
  90 API Swagger
  91 --------------------
  92
  93 It is worth noting that we use basic authorization for API access with username and password set to *healthcheck* and *zb!XztG34* respectively.
  94 Also, the new APIs support both *http* and *https*.
  95
  96 For every API call, client is encouraged to insert an uuid-type requestID as parameter. It is helpful for tracking each http transaction
  97 and facilitates debugging. Mostly importantly, it complies with Logging requirements v1.2. If client does not provider the requestID in API call,
  98 one will be randomly generated and attached to response header *x-onap-requestid*.
  99
 100 In accordance with `ONAP API Common Versioning Strategy Guidelines <https://wiki.onap.org/display/DW/ONAP+API+Common+Versioning+Strategy+%28CVS%29+Guidelines>`_,
 101 in the response of each API call, several custom headers are added::
 102
 103     x-latestversion: 1.0.0
 104     x-minorversion: 0
 105     x-patchversion: 0
 106     x-onap-requestid: e1763e61-9eef-4911-b952-1be1edd9812b
 107
 108 x-latestversion is used only to communicate an API's latest version.
 109
 110 x-minorversion is used to request or communicate a MINOR version back from the client to the server, and from the server back to the client.
 111
 112 x-patchversion is used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request.
 113
 114 x-onap-requestid is used to track REST transactions for logging purpose, as described above.
 115
 116
 117 .. swaggerv2doc:: swagger/healthcheck-api.json
 118
 119 .. swaggerv2doc:: swagger/statistics-api.json
 120
 121 .. swaggerv2doc:: swagger/policytype-api.json
 122
 123 .. swaggerv2doc:: swagger/policy-api.json
 124
 125 It is worth noting that in POST policy API, client needs to provide a policy payload encoded in well-formed TOSCA Service Template, and
 126 in the JSON payload, "type" field value should strictly match the policy type name embedded in the API path (case sensitive).
 127 Otherwise, it will complain the policy type does not exist. Please check out the sample policies in above policy table.
 128
 129 .. swaggerv2doc:: swagger/guard-policy-api.json
 130
 131 It is worth noting that guard policy name should start with one of the three: *guard.frequency.*, *guard.minmax.*, or *guard.blacklist.*.
 132 Otherwise, it will complain that guard policy type cannot be found (does not exist). Apart from policy name, the policy version specified
 133 in API path should be an integer, e.g. 1, 2, 10, instead of "1.0.0", "2.0.1", etc.
 134 These naming restrictions will disappear after we evolve to use well-formed TOSCA Service Template for guard policies and
 135 legacy policy design API is then deprecated.
 136
 137 .. swaggerv2doc:: swagger/operational-policy-api.json
 138
 139 Likewise, the policy version specified in operational policy API path should be an integer too, e.g. 1, 2, 10, instead of
 140 "1.0.0", "2.0.1", etc. This restriction will disappear after we deprecate legacy policy design API in the near future release.
 141
 142
 143 Regarding DELETE APIs for both TOSCA policies and legacy policies, we only expose API to delete one particular version of policy
 144 or policy type at a time for safety purpose. If client has the need to delete multiple or a group of policies or policy types,
 145 they will need to delete one by one.
 146
 147 Sample API Curl Commands
 148 -------------------------
 149
 150 From API client perspective, using *http* or *https* does not have much difference in curl command. Here we list some sample curl commands (using *http*)
 151 for POST, GET and DELETE monitoring and operational policies that are used in vFirewall use case.
 152
 153 JSON payload for POST calls can be downloaded from policy table above.
 154
 155 Create vFirewall Monitoring Policy::
 156   curl --user 'healthcheck:zb!XztG34' -X POST "http://{ip}:{port}/policy/api/v1/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app/versions/1.0.0/policies" -H "Accept: application/json" -H "Content-Type: application/json" -d @vFirewall.policy.monitoring.input.tosca.json
 157
 158 Get vFirewall Monitoring Policy::
 159   curl --user 'healthcheck:zb!XztG34' -X GET "http://{ip}:{port}/policy/api/v1/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app/versions/1.0.0/policies/onap.vfirewall.tca/versions/1.0.0" -H "Accept: application/json" -H "Content-Type: application/json"
 160
 161 Delete vFirewall Monitoring Policy::
 162   curl --user 'healthcheck:zb!XztG34' -X DELETE "http://{ip}:{port}/policy/api/v1/policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app/versions/1.0.0/policies/onap.vfirewall.tca/versions/1.0.0" -H "Accept: application/json" -H "Content-Type: application/json"
 163
 164 Create vFirewall Operational Policy::
 165   curl --user 'healthcheck:zb!XztG34' -X POST "http://{ip}:{port}/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies" -H "Accept: application/json" -H "Content-Type: application/json" -d @vFirewall.policy.operational.input.json
 166
 167 Get vFirewall Operational Policy::
 168   curl --user 'healthcheck:zb!XztG34' -X GET "http://{ip}:{port}/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/operational.modifyconfig/versions/1" -H "Accept: application/json" -H "Content-Type: application/json"
 169
 170 Delete vFirewall Operational Policy::
 171   curl --user 'healthcheck:zb!XztG34' -X DELETE "http://{ip}:{port}/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/operational.modifyconfig/versions/1" -H "Accept: application/json" -H "Content-Type: application/json"
 172
 173