summaryrefslogtreecommitdiffstats
path: root/examples/examples-pcvs/src/site-docs/adoc/fragments/vpnsla/policy.adoc
diff options
context:
space:
mode:
authorDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-23 00:41:47 +0100
committerDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-23 16:56:04 +0100
commit6a2abc8402af63dd8941b4652278a6df404d781a (patch)
treed806687cf4621527e471730192f2f26c256ac311 /examples/examples-pcvs/src/site-docs/adoc/fragments/vpnsla/policy.adoc
parenta4a992216c40138cda8501ee9bed971038b530a9 (diff)
Add docs for the examples package
This review is big because it contains examples for the whole project. The big size is mainly due to the site.xml, logos and css files which are repeatedly created, and more aciidoc files are needed. The pom.xml files are changed properly. Change-Id: I42a94e4d898529f9249ef03de908c8b1a0142c7f Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com> Issue-ID: POLICY-867
Diffstat (limited to 'examples/examples-pcvs/src/site-docs/adoc/fragments/vpnsla/policy.adoc')
-rw-r--r--examples/examples-pcvs/src/site-docs/adoc/fragments/vpnsla/policy.adoc28
1 files changed, 28 insertions, 0 deletions
diff --git a/examples/examples-pcvs/src/site-docs/adoc/fragments/vpnsla/policy.adoc b/examples/examples-pcvs/src/site-docs/adoc/fragments/vpnsla/policy.adoc
new file mode 100644
index 000000000..b5bfcc5ab
--- /dev/null
+++ b/examples/examples-pcvs/src/site-docs/adoc/fragments/vpnsla/policy.adoc
@@ -0,0 +1,28 @@
+//
+// ============LICENSE_START=======================================================
+// Copyright (C) 2016-2018 Ericsson. All rights reserved.
+// ================================================================================
+// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+//
+// SPDX-License-Identifier: CC-BY-4.0
+// ============LICENSE_END=========================================================
+//
+// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+//
+
+== VPN SLA Policy
+
+The VPN SLA policy is designed as a MEDA policy.
+The first state (M = Match) takes the trigger event (a link up or down) and checks if this is a change to the known topology.
+The second state (E = Establish) takes all available information (trigger event, local context) and defines what situation we have.
+The third state (D = Decide) takes the situation and selects which algorithm is best to process it.
+This state can select between `none` (nothing to do), `solved` (a problem is solved now), `sla` (compare the current customer SLA situation and select one to impede), and `priority` (impede non-priority customers).
+The fourth and final state (A = Act) selects the right action for the taken decision and creates the response event sent to the orchestrator.
+
+We have added three more policies to set the local context: one for adding nodes, one for adding edges (links), and one for adding customers.
+These policies do not realize any action, they are only here for updating the local context.
+This mechanism is the fasted way to update local context, and it is independent of any context plugin.
+
+The policy uses data defined in Avro, so we have a number of Avro schema definitions.
+