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-DecisionMakerExample.rst
  14
  15 .. contents::
  16     :depth: 3
  17
  18 Sample APEX Policy in TOSCA format
  19 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  20
  21          .. container:: paragraph
  22
  23             An example APEX policy in TOSCA format for the vCPE
  24             use case can be found here:
  25
  26          .. container:: ulist
  27
  28             -  `APEX TOSCA Policy
  29                vCPE <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.apex.policy.operational.input.tosca.json>`__
  30
  31 My First Policy
  32 ^^^^^^^^^^^^^^^
  33
  34          .. container:: paragraph
  35
  36             A good starting point is the ``My First Policy`` example. It
  37             describes a sales problem, to which policy can be applied.
  38             The example details the policy background, shows how to use
  39             the REST Editor to create a policy, and provides details for
  40             running the policies. The documentation can be found:
  41
  42          .. container:: ulist
  43
  44             -  :ref:`My-First-Policy Example <apex-myFirstExample>`
  45
  46 Decision Maker
  47 ^^^^^^^^^^^^^^
  48
  49          .. container:: paragraph
  50
  51             The domain Decision Maker shows a very simple policy for
  52             decisions. Interesting here is that the it creates a Docker
  53             image to run the policy and that it uses the APEX REST
  54             applications to update the policy on the-fly. It also has
  55             local context to remember past decisions, and shows how to
  56             use that to no make the same decision twice in a row. The
  57             documentation can be found:
  58
  59          .. container:: ulist
  60
  61             -  :ref:`Decision Maker on APEX site <apex-DecisionMakerExample>`
  62
  63 .. container::
  64    :name: footer
  65
  66    .. container::
  67       :name: footer-text
  68
  69       2.3.0-SNAPSHOT
  70       Last updated 2020-04-08 16:04:24 GMT