blob: cf582aa2ed1b7f1c998c8b1235f406d449c31e8a [file] [log] [blame]
ramvermaaf74a622018-07-31 18:25:39 +01001//
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
16A good starting point is the `My First Policy` example.
17It describes a sales problem, to which policy can be applied.
18The example details the policy background, shows how to use the REST Editor to create a policy, and provides details for running the policies.
19The documentation can be found:
20
liamfallona41c8772018-09-05 15:46:31 +010021* link:https://ericsson.github.io/apex-docs/modules/examples/examples-myfirstpolicy/MyFirstPolicyHowto.html[My-First-Policy on the APEX site]
ramvermaaf74a622018-07-31 18:25:39 +010022* 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
28The domain Policy-controlled Video Streaming (PCVS) contains a policy for controlling video streams with different strategies.
29It also provides details for installing an actual testbed with off-the-shelve software (Mininet, Floodlight, Kafka, Zookeeper).
30The 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.
31The documentation can be found:
32
liamfallona41c8772018-09-05 15:46:31 +010033* link:https://ericsson.github.io/apex-docs/modules/examples/examples-pcvs/vpnsla/policy.html[VPN SLA Policy on the APEX site]
ramvermaaf74a622018-07-31 18:25:39 +010034
35
36== Decision Maker
37
38The domain Decision Maker shows a very simple policy for decisions.
39Interesting 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.
40It also has local context to remember past decisions, and shows how to use that to no make the same decision twice in a row.
41The documentation can be found:
42
liamfallona41c8772018-09-05 15:46:31 +010043* link:https://ericsson.github.io/apex-docs/modules/examples/examples-decisionmaker/index.html[Decision Maker on APEX site]
ramvermaaf74a622018-07-31 18:25:39 +010044