.. This work is licensed under a .. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. _api-label: Policy Life Cycle API ##################### .. contents:: :depth: 2 Policy life cycle API comprises of policy design API and policy deployment API. This documentation focuses on policy design API. Policy design API is publicly exposed for clients to Create/Read/Update/Delete (CRUD) policy types, policy type implementation and policies which can be recognized and executable by appropriate policy engines incorporated in ONAP policy framework. Policy design API backend is running in an independent building block component of policy framework that provides REST service for aforementioned CRUD behaviors. Policy design API component interacts with a policy database for storing and fetching new policies or policy types as needed. Apart from CRUD, API is also exposed for clients to retrieve healthcheck status of this API REST service and statistics report including a variety of counters that reflect the history of API invocation. Starting from Dublin release, we strictly follow `TOSCA Specification `_ to define policy type and policy. Policy type is equivalent to policy model mentioned by clients before Dublin release. Both policy type and policy are included in a TOSCA Service Template which is used as the entity passed into API POST call and the entity returned by API GET and DELETE calls. More details are presented in following sessions. We encourage clients to compose all kinds of policies and corresponding policy types in well-formed TOSCA Service Template. One Service Template can contain one or more policies and policy types. Each policy type can have multiple policies created atop. In other words, different policies can match the same or different policy types. Existence of a policy type is a prerequisite of creating such type of policies. In the payload body of each policy to create, policy type name and version should be indicated and the specified policy type should be valid and existing in policy database. In El Alto release, to ease policy creation, we preload several widely used policy types in policy database. Below is a table summarizing preloaded policy types. .. csv-table:: :header: "Policy Type Name", "Payload" :widths: 15,10 "Controlloop.Guard.Blacklist", `onap.policies.controlloop.guard.Blacklist.yaml `_ "Controlloop.Guard.FrequencyLimiter", `onap.policies.controlloop.guard.FrequencyLimiter.yaml `_ "Controlloop.Guard.MinMax", `onap.policies.controlloop.guard.MinMax.yaml `_ "Controlloop.Guard.Coordination.FirstBlocksSecond", `onap.policies.controlloop.guard.coordination.FirstBlocksSecond.yaml `_ "Controlloop.Operational", `onap.policies.controlloop.Operational.yaml `_ "Monitoring.TCA", `onap.policies.monitoring.cdap.tca.hi.lo.app.yaml `_ "Monitoring.Collectors", `onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.yaml `_ "Optimization", `onap.policies.Optimization.yaml `_ "Optimization.AffinityPolicy", `onap.policies.optimization.AffinityPolicy.yaml `_ "Optimization.DistancePolicy", `onap
.. This work is licensed under a
.. Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0


Policy Component Installation
-----------------------------

.. toctree::
   :maxdepth: 1

   oom.rst
   docker.rst
ions/1.0.0/policies/operational.modifyconfig/versions/1" -H "Accept: application/json" -H "Content-Type: application/json"