diff options
Diffstat (limited to 'docs/apex/APEX-Policy-Examples.rst')
| -rw-r--r-- | docs/apex/APEX-Policy-Examples.rst | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/docs/apex/APEX-Policy-Examples.rst b/docs/apex/APEX-Policy-Examples.rst new file mode 100644 index 00000000..cb8fa8d3 --- /dev/null +++ b/docs/apex/APEX-Policy-Examples.rst @@ -0,0 +1,82 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Policy Examples +*************** + +.. contents:: + :depth: 3 + +Sample APEX Policy in TOSCA format +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + .. container:: paragraph + + An example APEX policy in TOSCA format for the vCPE + use case can be found here: + + .. container:: ulist + + - `APEX TOSCA Policy + vCPE <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.apex.policy.operational.input.tosca.json>`__ + +My First Policy +^^^^^^^^^^^^^^^ + + .. container:: paragraph + + A good starting point is the ``My First Policy`` example. It + describes a sales problem, to which policy can be applied. + The example details the policy background, shows how to use + the REST Editor to create a policy, and provides details for + running the policies. The documentation can be found: + + .. container:: ulist + + - :ref:`My-First-Policy on the APEX site <apex-myFirstExample>` + +VPN SLA +^^^^^^^ + + .. container:: paragraph + + The domain Policy-controlled Video Streaming (PCVS) contains + a policy for controlling video streams with different + strategies. It also provides details for installing an + actual testbed with off-the-shelve software (Mininet, + Floodlight, Kafka, Zookeeper). The policy model here + demonstrates virtually all APEX features: local context and + policies controlling it, task selection logic and multiple + tasks in a single state, AVRO schemas for context, AVOR + schemas for events (trigger and local), and a CLI editor + specification of the policy. The documentation can be found: + + .. container:: ulist + + - :ref:`VPN SLA Policy on the APEX site <apex-PCVSExample>` + +Decision Maker +^^^^^^^^^^^^^^ + + .. container:: paragraph + + The domain Decision Maker shows a very simple policy for + decisions. Interesting here is that the it creates a Docker + image to run the policy and that it uses the APEX REST + applications to update the policy on the-fly. It also has + local context to remember past decisions, and shows how to + use that to no make the same decision twice in a row. The + documentation can be found: + + .. container:: ulist + + - :ref:`Decision Maker on APEX site <apex-DecisionMakerExample>` + +.. container:: + :name: footer + + .. container:: + :name: footer-text + + 2.3.0-SNAPSHOT + Last updated 2020-04-08 16:04:24 GMT
\ No newline at end of file |