docs/apex/APEX-Policy-Examples.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 Policy Examples
   5 ***************
   6
   7 .. toctree::
   8    :maxdepth: 1
   9
  10    APEX-MyFirstPolicyExample.rst
  11    APEX-PCVS-Example.rst
  12    APEX-DecisionMakerExample.rst
  13
  14 .. contents::
  15     :depth: 3
  16
  17 Sample APEX Policy in TOSCA format
  18 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  19
  20          .. container:: paragraph
  21
  22             An example APEX policy in TOSCA format for the vCPE
  23             use case can be found here:
  24
  25          .. container:: ulist
  26
  27             -  `APEX TOSCA Policy
  28                vCPE <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.apex.policy.operational.input.tosca.json>`__
  29
  30 My First Policy
  31 ^^^^^^^^^^^^^^^
  32
  33          .. container:: paragraph
  34
  35             A good starting point is the ``My First Policy`` example. It
  36             describes a sales problem, to which policy can be applied.
  37             The example details the policy background, shows how to use
  38             the REST Editor to create a policy, and provides details for
  39             running the policies. The documentation can be found:
  40
  41          .. container:: ulist
  42
  43             -  :ref:`My-First-Policy on the APEX site <apex-myFirstExample>`
  44
  45 VPN SLA
  46 ^^^^^^^
  47
  48          .. container:: paragraph
  49
  50             The domain Policy-controlled Video Streaming (PCVS) contains
  51             a policy for controlling video streams with different
  52             strategies. It also provides details for installing an
  53             actual testbed with off-the-shelve software (Mininet,
  54             Floodlight, Kafka, Zookeeper). The policy model here
  55             demonstrates virtually all APEX features: local context and
  56             policies controlling it, task selection logic and multiple
  57             tasks in a single state, AVRO schemas for context, AVOR
  58             schemas for events (trigger and local), and a CLI editor
  59             specification of the policy. The documentation can be found:
  60
  61          .. container:: ulist
  62
  63             -  :ref:`VPN SLA Policy on the APEX site <apex-PCVSExample>`
  64
  65 Decision Maker
  66 ^^^^^^^^^^^^^^
  67
  68          .. container:: paragraph
  69
  70             The domain Decision Maker shows a very simple policy for
  71             decisions. Interesting here is that the it creates a Docker
  72             image to run the policy and that it uses the APEX REST
  73             applications to update the policy on the-fly. It also has
  74             local context to remember past decisions, and shows how to
  75             use that to no make the same decision twice in a row. The
  76             documentation can be found:
  77
  78          .. container:: ulist
  79
  80             -  :ref:`Decision Maker on APEX site <apex-DecisionMakerExample>`
  81
  82 .. container::
  83    :name: footer
  84
  85    .. container::
  86       :name: footer-text
  87
  88       2.3.0-SNAPSHOT
  89       Last updated 2020-04-08 16:04:24 GMT