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