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