[GNUnet-SVN] r30222 - gnunet-planetlab

[gnunet]

Author: wachs
Date: 2013-10-16 15:15:36 +0200 (Wed, 16 Oct 2013)
New Revision: 30222

Added:
   gnunet-planetlab/installation-guide.pdf
   gnunet-planetlab/installation-guide.tex
Log:
initial commit for the work in progress installation guide


Added: gnunet-planetlab/installation-guide.pdf
===================================================================
(Binary files differ)

Index: gnunet-planetlab/installation-guide.pdf
===================================================================
--- gnunet-planetlab/installation-guide.pdf     2013-10-16 13:15:07 UTC (rev 
30221)
+++ gnunet-planetlab/installation-guide.pdf     2013-10-16 13:15:36 UTC (rev 
30222)

Property changes on: gnunet-planetlab/installation-guide.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: gnunet-planetlab/installation-guide.tex
===================================================================
--- gnunet-planetlab/installation-guide.tex                             (rev 0)
+++ gnunet-planetlab/installation-guide.tex     2013-10-16 13:15:36 UTC (rev 
30222)
@@ -0,0 +1,213 @@
+\documentclass[a4paper,11pt]{report}
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\usepackage{lmodern}
+\usepackage{lmodern}
+\usepackage{hyperref}
+\usepackage{listings}
+\usepackage{graphicx}
+\usepackage[toc,page]{appendix}
+
+\title{Eclectic Experimentation Installation Guide}
+\author{Matthias Wachs \and Omar Tarabai}
+
+\begin{document}
+
+\lstset{ 
+language=bash,
+basicstyle=\ttfamily,  
+upquote=true,
+columns=fullflexible,
+literate={*}{{\char42}}1
+         {-}{{\char45}}1
+}
+
+\newcommand{\gplmt}{\texttt{GPLMT }} 
+\newcommand{\ssh}{\texttt{SSH }} 
+\newcommand{\pl}{PlanetLab } 
+\newcommand{\pip}{\texttt{pip }} 
+
+
+\maketitle
+\tableofcontents
+
+\begin{abstract}
+\end{abstract}
+
+\chapter{Installing Eclectic Experimentation}
+
+\section{Introduction}
+In this document we describe how to install the full Eclectic experimentation 
solution. This solution consists of several components: Zabbix, GPLMT, GPLMT 
GUI and MSH. This installation guide gives a step-by-step description on how to 
install the full experimentation suite on a dedicated control server.
+
+We propose the use of a GNU/Linux server running a recent distribution. This 
installation guide was tested on a system running Ubuntu 12.04 LTS.
+\section{Requirements}
+
+\begin{itemize}
+  \item A user to run the solution
+  \item Apache?
+  \item PHP5
+  \item MySQL
+\end{itemize}
+
+Please add a separate user running the experimentation solution. In this guide 
we suppose the user is called \textit{experimentation} on his home directory is 
\textit{/home/experimentation}.
+
+Install MySQL
+\begin{lstlisting}
+$ sudo apt-get install mysql-server libmysqlclient-dev
+\end{lstlisting}
+
+\chapter{Installing Zabbix}
+For our installation we used Zabbix in version 2.0.4 but our approach is 
supposed to work with newer version from the 2.x branch. An extensive Zabbix 
installation guide can be found on the Zabbix website:
+\href{https://www.zabbix.com/wiki/howto/install/ubuntu/ubuntuinstall}{Installing
 Zabbix on Ubuntu from source files}.
+To install Zabbix on the server the following steps are required:\\
+- Install required dependencies:
+\begin{lstlisting}
+sudo apt-get install build-essential mysql-server libmysqlclient15-dev php5 
php5-gd php5-mysql snmp libsnmp-dev snmpd libcurl4-openssl-dev fping libssh2-1 
libssh2-1-dev
+\end{lstlisting}
+- Download the Zabbix 2.0.4 source:
+\begin{lstlisting}
+$ wget http://sourceforge.net/projects/zabbix/files/\\
+  ZABBIX%20Latest%20Stable/2.0.4/zabbix-2.0.4.tar.gz
+\end{lstlisting}
+Unpack the archive file, compile and install Zabbix:
+\begin{lstlisting}
+$ tar xf zabbix-2.0.4.tar.gz
+$ cd zabbix-2.0.4
+$ ./configure --prefix=/home/experimentation/zabbix --enable-server 
--with-mysql --with-net-snmp --with-libcurl --with-ssh2
+$ make install
+\end{lstlisting}
+
+% done until here...
+
+\begin{verbatim}
+- Using user planetmaster on sam server
+- Run mysql database setup script here: 
https://www.zabbix.com/documentation/2.0/manual/appendix/install/db_scripts [^]
+- ./configure --prefix=/home/planetmaster/zabbix --enable-server --with-mysql 
--with-net-snmp --with-libcurl --with-ssh2
+- make install
+- edited /home/planetmaster/zabbix/etc/zabbix_server.conf
+changed log file location
+db user/pass
+- Installed the web frontend in 
/home/planetmaster/zabbix/zabbix-2.0.4/frontends/php to 
https://gnunet.org/zabbix/ [^] with Christian's help
+- Added .htaccess file to the frontend dir to override some php variables 
needed for the installation
+- Completed the installation through the web frontend
+- ./home/planetmaster/zabbix/sbin/zabbix_server start
+- Changed web admin password
+\end{verbatim}
+
+\section{Installing GPLMT}
+
+
+This chapter covers the installation of \gplmt on a UNIX-style system. The 
steps described here should work for most recent distributions. Installation on 
Microsoft Windows Systems is not covered here.
+
+\subsection{Requirements}
+
+\gplmt is written in Python, so you need a Python interpreter installed. 
Please check your distribution manual how to install python if it is not 
already installed. We recommend the use of Python 2.7, but 2.5 should also work 
fine. More information about Python can be found on the Python website 
\url{http://www.python.org/}. 
+
+\subsection{Installing Additional Requirements}\label{sec:dependencies}
+
+Some few additional python modules are required for \gplmt.  You can install 
them using the \texttt{pip} installer or following the installation 
instructions on the website.  We recommend the use of \texttt{pip} for 
unexperienced users since it is a powerful but easy to use tool to manage 
python packages. To install the dependencies, \texttt{root} permission are 
required on most systems. The following python modules are additionally 
required:
+\subsubsection{ElementTree}
+\begin{itemize}
+\setlength{\itemsep}{0pt}
+  \item XML tasklist parsing
+  \item Version: $>= 1.3$
+  \item Available from: \url{http://effbot.org/zone/element-index.htm}
+\end{itemize}
+
+\subsubsection{minixsv}
+\begin{itemize}
+\setlength{\itemsep}{0pt}
+  \item XML tasklist validation 
+  \item Version: $>= 1.7$
+  \item Available from: \url{http://www.leuthe-net.de/DownloadMiniXsv.html}
+\end{itemize}
+
+\subsubsection{Paramiko}
+\begin{itemize}
+\setlength{\itemsep}{0pt}
+  \item \ssh communication
+  \item Version: $>= 0.9$
+  \item Available from: \url{http://www.lag.net/paramiko/}
+\end{itemize}
+To install the \pip installer run the following commands:
+\begin{lstlisting}
+$ curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
+$ sudo python get-pip.py
+\end{lstlisting}
+To install the requirements with the \pip installer run the following commands:
+\begin{lstlisting}
+$ sudo pip install ElementTree minixsv paramiko
+\end{lstlisting}
+Since now all requirements are satifisied, we can continue with installing 
\gplmt itself.
+
+\subsubsection{Common Errors}
+If you see a message like
+\begin{lstlisting}
+$ pip install ElementTree minixsv paramiko
+bash: /usr/bin/pip: No such file or directory
+\end{lstlisting}
+you have to run the \pip installer with root super user permissions using the 
\texttt{sudo} command. Please run 
+\begin{lstlisting}
+$ sudo pip install ElementTree minixsv paramiko
+bash: /usr/bin/pip: No such file or directory
+\end{lstlisting}
+
+\subsection{Installation}
+
+The \gplmt tool can be obtained from our Subversion repository. To checkout 
the latest version you need 
+a subversion\footnote{\url{http://subversion.tigris.org/}} client installed, 
then run 
+\begin{lstlisting}
+$ svn co https://gnunet.org/svn/gnunet-planetlab/gplmt/
+\end{lstlisting}
+After a successful checkout a new directory \gplmt is created containing the 
tool, documentation and examples. To check if your checkout was successful and 
see how to use the \gplmt command line tool, run 
+
+\begin{lstlisting}
+$ cd gplmt
+$ ./gplmt.py --help
+\end{lstlisting}
+If your installation was successful, you should a list of command line 
arguments you can pass to \gplmt.
+
+\subsubsection{Common Errors}
+If one of the required dependencies, listed in Section \ref{sec:dependencies} 
is not installed, you should see a message like
+\begin{lstlisting}
+paramiko SSH module is required for execution, please check README
+\end{lstlisting}
+
+\section{Installing GPLMT GUI}
+
+\section{Installing MSH}
+MSH depends on GNUnet's networking API and hence requires gnunet-0.9.5a to be
+installed.  Additionally, it requires an MPI implementation to be installed
+together with the MPI compiler wrapper \texttt{mpicc}.
+
+On a Ubuntu system you can use the following command to install the required 
mpi library:
+\begin{lstlisting}
+$ sudo apt-get install mpi-default-dev
+\end{lstlisting}
+
+The latest version of MSH can be obtained from the MSH Subversion repository:
+\begin{lstlisting}
+$ svn co https://gnunet.org/svn/msh
+\end{lstlisting}
+
+To install GNUnet, please follow the GNUnet installation instructions on 
\url{https://gnunet.org/generic_installation}
+
+Once the dependencies are installed, MSH can be installed by running the
+commands listed in Listing~\ref{lst:installation} in the MSH source directory. 
+With the configure command you have to specify the path of the GNUnet 
installation.
+If you want to install MSH in the default locationm, you have to run the last 
command as root.
+\begin{lstlisting}[language=bash,caption=Installation 
commands,label=lst:installation]
+$ cd msh
+$ ./bootstrap
+$ ./configure --with-gnunet=<GNUNET_INSTALLATION_PATH>
+$ make
+$ sudo make install
+\end{lstlisting} %$
+
+If the required dependencies are not in the default search paths of the
+compiler, \texttt{configure} may fail complaining an error.  These can be fixed
+by providing the installation directories of the dependencies to
+\texttt{configure}.  For a list of available options type:
+\texttt{./configure --help}
+
+\end{document}