summaryrefslogtreecommitdiffstats
path: root/examples/examples-pcvs/src/site-docs/adoc/fragments/introduction.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/introduction.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/introduction.adoc')
-rw-r--r--examples/examples-pcvs/src/site-docs/adoc/fragments/introduction.adoc24
1 files changed, 24 insertions, 0 deletions
diff --git a/examples/examples-pcvs/src/site-docs/adoc/fragments/introduction.adoc b/examples/examples-pcvs/src/site-docs/adoc/fragments/introduction.adoc
new file mode 100644
index 000000000..5b4fc1206
--- /dev/null
+++ b/examples/examples-pcvs/src/site-docs/adoc/fragments/introduction.adoc
@@ -0,0 +1,24 @@
+//
+// ============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)
+//
+
+This module contains several demos for Policy-controlled Video Streaming (PCVS).
+Each demo defines a policy using AVRO and Javascript (or other scripting languages for the policy logic).
+To run the demo, a vanilla Ubuntu server with some extra software packages is required:
+
+* Mininet as network simulator
+* Floodlight as SDN controller
+* Kafka as messaging system
+* Zookeeper for Kafka configuration
+* APEX for policy control
+
+