ramverma | af74a62 | 2018-07-31 18:25:39 +0100 | [diff] [blame] | 1 | // |
| 2 | // ============LICENSE_START======================================================= |
| 3 | // Copyright (C) 2016-2018 Ericsson. All rights reserved. |
| 4 | // ================================================================================ |
| 5 | // This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE |
| 6 | // Full license text at https://creativecommons.org/licenses/by/4.0/legalcode |
| 7 | // |
| 8 | // SPDX-License-Identifier: CC-BY-4.0 |
| 9 | // ============LICENSE_END========================================================= |
| 10 | // |
| 11 | // @author Sven van der Meer (sven.van.der.meer@ericsson.com) |
| 12 | // |
| 13 | |
| 14 | == My First Policy |
| 15 | |
| 16 | A good starting point is the `My First Policy` example. |
| 17 | It describes a sales problem, to which policy can be applied. |
| 18 | The example details the policy background, shows how to use the REST Editor to create a policy, and provides details for running the policies. |
| 19 | The documentation can be found: |
| 20 | |
| 21 | * link:https://ericsson.github.io/apex-docs/modules/apex-domains/apex-domains.myfirstpolicy/MyFirstPolicyHowto.html[My-First-Policy on the APEX site] |
| 22 | * link:https://ericsson.github.io/apex-docs/docs-apex/html/HowTo-MyFirstPolicy.html[Stand-alone HTML] |
| 23 | * link:https://ericsson.github.io/apex-docs/docs-apex/pdf/HowTo-MyFirstPolicy.pdf[Stand-alone PDF] |
| 24 | |
| 25 | |
| 26 | == VPN SLA |
| 27 | |
| 28 | The domain Policy-controlled Video Streaming (PCVS) contains a policy for controlling video streams with different strategies. |
| 29 | It also provides details for installing an actual testbed with off-the-shelve software (Mininet, Floodlight, Kafka, Zookeeper). |
| 30 | 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. |
| 31 | The documentation can be found: |
| 32 | |
| 33 | * link:https://ericsson.github.io/apex-docs/modules/apex-domains/apex-domains.pcvs/vpnsla/policy.html[VPN SLA Policy on the APEX site] |
| 34 | |
| 35 | |
| 36 | == Decision Maker |
| 37 | |
| 38 | The domain Decision Maker shows a very simple policy for decisions. |
| 39 | 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. |
| 40 | 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. |
| 41 | The documentation can be found: |
| 42 | |
| 43 | * link:https://ericsson.github.io/apex-docs/modules/apex-domains/apex-domains.decisionmaker/index.html[Decision Maker on APEX site] |
| 44 | |