aboutsummaryrefslogtreecommitdiffstats
path: root/examples/examples-pcvs/src/site-docs/adoc/fragments/install.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/install.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/install.adoc')
-rw-r--r--examples/examples-pcvs/src/site-docs/adoc/fragments/install.adoc133
1 files changed, 133 insertions, 0 deletions
diff --git a/examples/examples-pcvs/src/site-docs/adoc/fragments/install.adoc b/examples/examples-pcvs/src/site-docs/adoc/fragments/install.adoc
new file mode 100644
index 000000000..f849c43ab
--- /dev/null
+++ b/examples/examples-pcvs/src/site-docs/adoc/fragments/install.adoc
@@ -0,0 +1,133 @@
+//
+// ============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)
+//
+
+== Install Demo
+
+Requirements:
+
+* Ubuntu server: 1.4 GB
+* Ubuntu with Xubuntu Desktop, git, Firefox: 2.3 GB
+* Ubuntu with all, system updated: 3 GB
+* With ZK, Kafka, VLC, Mininet, Floodlight, Python: 4.4 GB
+* APEX Build (M2 and built): M2 ~ 2 GB, APEX ~3.5 GB
+* APEX install (not build locally): ~ 300 MB
+
+
+On a Ubuntu OS (install a stable or LTS server first)
+
+----
+# pre for Ubuntu, tools and X
+sudo apt-get -y install --no-install-recommends software-properties-common
+sudo apt-get -y install --no-install-recommends build-essential
+sudo apt-get -y install --no-install-recommends git
+sudo aptitude -y install --no-install-recommends xubuntu-desktop
+sudo apt-get -y install --no-install-recommends firefox
+
+
+# install Java
+sudo add-apt-repository ppa:webupd8team/java
+sudo apt-get update
+sudo apt-get -y install --no-install-recommends oracle-java8-installer
+java -version
+
+
+# reboot system, run system update, then continue
+
+# if VBox additions are needed, install and reboot
+sudo (cd /usr/local/share; wget https://www.virtualbox.org/download/testcase/VBoxGuestAdditions_5.2.7-120528.iso)
+sudo mount /usr/local/share/VBoxGuestAdditions_5.2.7-120528.iso /media/cdrom
+sudo (cd /media/cdrom;VBoxLinuxAdditions.run)
+
+
+# update apt-get DB
+sudo apt-get update
+
+# if APEX is build from source, install maven and rpm
+sudo apt-get install maven rpm
+
+# install ZooKeeper
+sudo apt-get install zookeeperd
+
+# install Kafka
+(cd /tmp;wget http://ftp.heanet.ie/mirrors/www.apache.org/dist/kafka/1.0.0/kafka_2.12-1.0.0.tgz --show-progress)
+sudo mkdir /opt/Kafka
+sudo tar -xvf /tmp/kafka_2.12-1.0.0.tgz -C /opt/Kafka/
+
+# install mininet
+cd /usr/local/src
+sudo git clone https://github.com/mininet/mininet.git
+(cd mininet;util/install.sh -a)
+
+# install floodlight, requires ant
+sudo apt-get install ant
+cd /usr/local/src
+sudo wget --no-check-certificate https://github.com/floodlight/floodlight/archive/master.zip
+sudo unzip master.zip
+cd floodlight-master
+sudo ant
+sudo mkdir /var/lib/floodlight
+sudo chmod 777 /var/lib/floodlight
+
+# install python pip
+sudo apt-get install python-pip
+
+# install kafka-python (need newer version from github)
+cd /usr/local/src
+sudo git clone https://github.com/dpkp/kafka-python
+sudo pip install ./kafka-python
+
+# install vlc
+sudo apt-get install vlc
+----
+
+Install APEX either from source or from a distribution package.
+See the APEX documentation for details.
+We assume that APEX is installed in `/opt/ericsson/apex/apex`
+
+Copy the LinkMonitor file to Kafka-Python
+
+----
+sudo cp /opt/ericsson/apex/apex/examples/scripts/pcvs/vpnsla/LinkMonitor.py /usr/local/src/kafka-python
+----
+
+Change the Logback configuration in APEX to logic logging
+
+----
+(cd /opt/ericsson/apex/apex/etc; sudo cp logback-logic.xml logback.xml)
+----
+
+
+== Get the Demo Video
+
+* For all download options of the movie please visit link:http://bbb3d.renderfarming.net/download.html[]
+* For lower-res downloads and mirrors see link:https://peach.blender.org/download[]
+
+----
+sudo mkdir /usr/local/src/videos
+----
+
+
+Standard 720p (recommended)
+
+----
+(cd /usr/local/src/videos; sudo curl -o big_buck_bunny_480p_surround.avi http://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_480p_surround-fix.avi)
+----
+
+
+Full HD video
+
+----
+(cd videos; sudo curl -o bbb_sunflower_1080p_60fps_normal.mp4 http://distribution.bbb3d.renderfarming.net/video/mp4/bbb_sunflower_1080p_60fps_normal.mp4)
+----
+
+