+ :maxdepth: 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 <http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.1/TOSCA-Simple-Profile-YAML-v1.1.pdf>`_
+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 Dublin 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", "Preloaded JSON"
+ :widths: 15,10
+
+ "Controlloop.Guard.Blacklist", ":download:`link <policytypes/onap.policies.controlloop.guard.Blacklist.json>`"
+ "Controlloop.Guard.FrequencyLimiter", ":download:`link <policytypes/onap.policies.controlloop.guard.FrequencyLimiter.json>`"
+ "Controlloop.Guard.MinMax", ":download:`link <policytypes/onap.policies.controlloop.guard.MinMax.json>`"
+ "Controlloop.Operational", ":download:`link <policytypes/onap.policies.controlloop.Operational.json>`"
+ "Monitoring.TCA", ":download:`link <policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.json>`"
+ "Monitoring.Collectors", ":download:`link <policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.json>`"
+ "Optimization.AffinityPolicy", ":download:`link <policytypes/onap.policies.optimization.AffinityPolicy.json>`"
+ "Optimization.DistancePolicy", ":download:`link <policytypes/onap.policies.optimization.DistancePolicy.json>`"
+ "Optimization.HpaPolicy", ":download:`link <policytypes/onap.policies.optimization.HpaPolicy.json>`"
+ "Optimization.OptimizationPolicy", ":download:`link <policytypes/onap.policies.optimization.OptimizationPolicy.json>`"
+ "Optimization.PciPolicy", ":download:`link <policytypes/onap.policies.optimization.PciPolicy.json>`"
+ "Optimization.QueryPolicy", ":download:`link <policytypes/onap.policies.optimization.QueryPolicy.json>`"
+ "Optimization.SubscriberPolicy", ":download:`link <policytypes/onap.policies.optimization.SubscriberPolicy.json>`"
+ "Optimization.Vim_fit", ":download:`link <policytypes/onap.policies.optimization.Vim_fit.json>`"
+ "Optimization.VnfPolicy", ":download:`link <policytypes/onap.policies.optimization.VnfPolicy.json>`"
+
+
+Also, in Dublin release, We provide backward compatibility support for controlloop operational and guard
+policies encoded in legacy format. Below is a table containing sample legacy guard/operational policies and
+well-formed TOSCA monitoring policies.
+
+.. csv-table::
+ :header: "Policy Name", "Policy JSON"
+ :widths: 15,10
+
+ "vCPE.Monitoring.Tosca", ":download:`link <policies/vCPE.policy.monitoring.input.tosca.json>`"
+ "vCPE.Operational.Legacy", ":download:`link <policies/vCPE.policy.operational.input.json>`"
+ "vDNS.Guard.FrequencyLimiting.Legacy", ":download:`link <policies/vDNS.policy.guard.frequency.input.json>`"
+ "vDNS.Guard.MinMax.Legacy", ":download:`link <policies/vDNS.policy.guard.minmax.input.json>`"
+ "vDNS.Monitoring.Tosca", ":download:`link <policies/vDNS.policy.monitoring.input.tosca.json>`"
+ "vDNS.Operational.Legacy", ":download:`link <policies/vDNS.policy.operational.input.json>`"
+ "vFirewall.Monitoring.Tosca", ":download:`link <policies/vFirewall.policy.monitoring.input.tosca.json>`"
+ "vFirewall.Operational.Legacy", ":download:`link <policies/vFirewall.policy.operational.input.json>`"
+
+
+Below is a global API table from where swagger JSON for different types of policy design API can be downloaded.